SmallImage.Builder

Artifact: androidx.wear.watchface:watchface-complications-data

View Source

Added in 1.0.0

---

Kotlin |Java

public final class SmallImage.Builder

---

Builder for SmallImage.

Summary

Public constructors
Builder(@NonNull Icon image, @NonNull SmallImageType type)

Public methods
final @NonNull SmallImage	build() Builds a SmallImage.
final @NonNull SmallImage.Builder	setAmbientImage(Icon ambientImage) Sets a different image for when the device is ambient mode to save power and prevent burn in.

Public constructors

Builder

Added in 1.0.0

public Builder(@NonNull Icon image, @NonNull SmallImageType type)

Parameters
@NonNull Icon image	The Icon representing the image
@NonNull SmallImageType type	The style of the image provided, to guide how it should be displayed

Public methods

build

Added in 1.0.0

public final @NonNull SmallImage build()

Builds a SmallImage.

setAmbientImage

Added in 1.0.0

public final @NonNull SmallImage.Builder setAmbientImage(Icon ambientImage)

Sets a different image for when the device is ambient mode to save power and prevent burn in. If no ambient variant is provided, the watch face may not show anything while in ambient mode.