SmallImageComplicationData

public final class SmallImageComplicationData extends ComplicationData


Type used for complications which consist only of a SmallImage.

The image is expected to always be displayed.

The contentDescription field and is used to describe what data the icon represents. If the icon is purely stylistic, and does not convey any information to the user, then provide an empty content description. If no content description is provided, a generic content description will be used instead.

Summary

Public fields

final @Nullable ComplicationText
final @NonNull SmallImage
final @Nullable PendingIntent
final @NonNull ComplicationType
final @NonNull TimeRange

Describes when the complication should be displayed.

Public fields

contentDescription

@Nullable
public final @Nullable ComplicationText contentDescription

smallImage

@NonNull
public final @NonNull SmallImage smallImage

tapAction

@Nullable
public final @Nullable PendingIntent tapAction

type

@NonNull
public final @NonNull ComplicationType type

validTimeRange

@NonNull
public final @NonNull TimeRange validTimeRange

Describes when the complication should be displayed.

Whether the complication is active and should be displayed at the given time should be checked with TimeRange.contains.