SmallImageComplicationData.Builder
Note: As of July 10, 2024, watch faces must use the Watch Face Format in order to be installed on new watches that launch with Wear OS 5 pre-installed. Learn more about the user-facing changes in this Help Center article.
Additionally, starting in early 2025 (specific date to be announced during Q4 2024), all new watch faces published on Google Play must use the Watch Face Format.
public final class SmallImageComplicationData.Builder
Builder for SmallImageComplicationData.
You must at a minimum set the smallImage and contentDescription fields.
Summary
Public constructors |
|---|
Builder( |
Public methods |
|
|---|---|
@NonNull SmallImageComplicationData |
build()Builds the |
final @NonNull SmallImageComplicationData.Builder |
setTapAction(PendingIntent tapAction)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
public Builder(
@NonNull SmallImage smallImage,
@NonNull ComplicationText contentDescription
)
| Parameters | |
|---|---|
@NonNull SmallImage smallImage |
The |
@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
public @NonNull SmallImageComplicationData build()
Builds the MonochromaticImageComplicationData.
setTapAction
public final @NonNull SmallImageComplicationData.Builder setTapAction(PendingIntent tapAction)
Sets optional pending intent to be invoked when the complication is tapped.
setValidTimeRange
public final @NonNull SmallImageComplicationData.Builder setValidTimeRange(TimeRange validTimeRange)
Sets optional time range during which the complication has to be shown.