PhotoImageComplicationData
class PhotoImageComplicationData : ComplicationData
| kotlin.Any | ||
| ↳ | androidx.wear.complications.data.ComplicationData | |
| ↳ | androidx.wear.complications.data.PhotoImageComplicationData | |
Type used for complications which consist only of a PhotoImage.
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 PhotoImageComplicationData. |
|
| Public methods | |
|---|---|
| WireComplicationData |
Converts this value to WireComplicationData object used for serialization. |
| Inherited functions | |
|---|---|
| Properties | |
|---|---|
| ComplicationText? | |
| PhotoImage | |
| 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: PhotoImage