SmallImageComplicationData.Builder

public final class SmallImageComplicationData.Builder

Builder for SmallImageComplicationData.

You must at a minimum set the smallImage and contentDescription fields.

Summary

Public constructors
Builder(
    @NonNull SmallImage smallImage,
    @NonNull ComplicationText contentDescription
)

Public methods
@NonNull SmallImageComplicationData

Builds the MonochromaticImageComplicationData.
final @NonNull SmallImageComplicationData.Builder

Sets optional pending intent to be invoked when the complication is tapped.
final @NonNull SmallImageComplicationData.Builder
setValidTimeRange(TimeRange validTimeRange)

Sets optional time range during which the complication has to be shown.

Public constructors

Builder

Added in 1.0.0
public Builder(
    @NonNull SmallImage smallImage,
    @NonNull ComplicationText contentDescription
)
Parameters
@NonNull SmallImage smallImage

The SmallImage to be displayed
@NonNull ComplicationText contentDescription

The content description field for accessibility and is used to describe what data the image represents. If the image 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. Please do not include the word 'complication' in the description.

Public methods

build

Added in 1.0.0
public @NonNull SmallImageComplicationData build()

Builds the MonochromaticImageComplicationData.

setTapAction

Added in 1.0.0
public final @NonNull SmallImageComplicationData.Builder setTapAction(PendingIntent tapAction)

Sets optional pending intent to be invoked when the complication is tapped.

setValidTimeRange

Added in 1.0.0
public final @NonNull SmallImageComplicationData.Builder setValidTimeRange(TimeRange validTimeRange)

Sets optional time range during which the complication has to be shown.