Google is committed to advancing racial equity for Black communities. See how.

BackgroundImageComplicationData

class BackgroundImageComplicationData : ComplicationData
kotlin.Any
   ↳ androidx.wear.complications.data.ComplicationData
   ↳ androidx.wear.complications.data.BackgroundImageComplicationData

Type used for complications which consist only of a BackgroundImage.

The image is expected to always be displayed. The image may be shown as the background, any other part of the watch face or within a complication. The image is large enough to be cover the entire screen. The image may be cropped to fit the watch face or complication.

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

Nested classes

Builder for BackgroundImageComplicationData.

Public methods
WireComplicationData

Converts this value to WireComplicationData object used for serialization.

Inherited functions
Properties
ComplicationText?

BackgroundImage

Companion properties
ComplicationType

The ComplicationType corresponding to objects of this type.

Inherited properties

Public methods

asWireComplicationData

fun asWireComplicationData(): WireComplicationData

Converts this value to WireComplicationData object used for serialization.

This is only needed internally to convert to the underlying communication protocol.

Properties

contentDescription

val contentDescription: ComplicationText?

image

val image: BackgroundImage

Companion properties

TYPE

val TYPE: ComplicationType

The ComplicationType corresponding to objects of this type.