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.

class SmallImageComplicationData.Builder

Builder for SmallImageComplicationData.

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

Summary

Public constructors
Builder(smallImage: SmallImage, contentDescription: ComplicationText)

Public functions
open SmallImageComplicationData

Builds the MonochromaticImageComplicationData.
SmallImageComplicationData.Builder

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

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

Public constructors

Builder

Added in 1.0.0
Builder(smallImage: SmallImage, contentDescription: ComplicationText)
Parameters
smallImage: SmallImage

The SmallImage to be displayed
contentDescription: ComplicationText

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 functions

build

Added in 1.0.0
open fun build(): SmallImageComplicationData

Builds the MonochromaticImageComplicationData.

setTapAction

Added in 1.0.0
fun setTapAction(tapAction: PendingIntent?): SmallImageComplicationData.Builder

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

setValidTimeRange

Added in 1.0.0
fun setValidTimeRange(validTimeRange: TimeRange?): SmallImageComplicationData.Builder

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