ComplicationData

Kotlin |Java

sealed class ComplicationData

kotlin.Any
↳	androidx.wear.complications.data.ComplicationData

Known Direct Subclasses

BackgroundImageComplicationData, EmptyComplicationData, LongTextComplicationData, MonochromaticImageComplicationData, NoDataComplicationData, NoPermissionComplicationData, NotConfiguredComplicationData, RangedValueComplicationData, ShortTextComplicationData, SmallImageComplicationData

BackgroundImageComplicationData	Type used for complications which consist only of a BackgroundImage.
EmptyComplicationData	Type sent when the user has specified that an active complication should have no provider, i.
LongTextComplicationData	Type used for complications where the primary piece of data is a piece of text.
MonochromaticImageComplicationData	Type used for complications which consist only of a MonochromaticImage.
NoDataComplicationData	Type that can be sent by any provider, regardless of the configured type, when the provider has no data to be displayed.
NoPermissionComplicationData	Type sent by the system when the watch face does not have permission to receive complication data.
NotConfiguredComplicationData	Type sent when a complication does not have a provider configured.
RangedValueComplicationData	Type used for complications including a numerical value within a range, such as a percentage.
ShortTextComplicationData	Type used for complications where the primary piece of data is a short piece of text (expected to be no more than seven characters in length).
SmallImageComplicationData	Type used for complications which consist only of a SmallImage.

Base type for all different types of ComplicationData types.

Summary

Public methods
abstract WireComplicationData	`asWireComplicationData()` Converts this value to WireComplicationData object used for serialization.
Boolean	`isActiveAt(dateTimeMillis: Long)` Returns true if the complication is active and should be displayed at the given time.

Properties
PendingIntent?	`tapAction`
ComplicationType	`type`

Public methods

asWireComplicationData

abstract fun asWireComplicationData(): WireComplicationData

Converts this value to WireComplicationData object used for serialization.

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

isActiveAt

fun isActiveAt(dateTimeMillis: Long): Boolean

Returns true if the complication is active and should be displayed at the given time. If this returns false, the complication should not be displayed.

This must be checked for any time for which the complication will be displayed.

Properties

tapAction

val tapAction: PendingIntent?

type

val type: ComplicationType