NoDataComplicationData

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

View Source

Added in 1.0.0

---

Kotlin |Java

public final class NoDataComplicationData extends ComplicationData

java.lang.Object
↳	androidx.wear.watchface.complications.data.ComplicationData
	↳	androidx.wear.watchface.complications.data.NoDataComplicationData

---

Type that can be sent by any complication data source, regardless of the configured type, when the complication data source has no data to be displayed. If no placeholder is included then watch faces may choose whether to render this in some way or leave the slot empty.

If a placeholder is included than its expected that it will be rendered. Its suggested the watch face renders the placeholder elements (text, title, smallImage, etc...) using solid grey blocks. Any non-placeholder elements included in placeholder must be rendered normally.

Some watchfaces may not support placeholders and in that case the NoDataComplicationData will be treated as being empty.

Summary

Public fields
static final @NonNull ComplicationType	TYPE The ComplicationType corresponding to objects of this type.

Public constructors
NoDataComplicationData() Constructs a NoDataComplicationData without a placeholder.
NoDataComplicationData(@NonNull ComplicationData placeholder) Constructs a NoDataComplicationData with a placeholder which is allowed to contain placeholder fields (see hasPlaceholderFields) which must be drawn to look like placeholders.

Public methods
final ComplicationText	getContentDescription() The content description field for accessibility.
final ComplicationData	getInvalidatedData() An optional value that describes the original ComplicationData that was provided by the data source, following invalidation (see evaluation description in ComplicationData).
final ComplicationData	getPlaceholder() An optional ComplicationData which may contain placeholder fields (see hasPlaceholderFields).
@NonNull String	toString()

Inherited methods

From androidx.wear.watchface.complications.data.ComplicationData boolean equals(Object other) final ComponentName getDataSource() The ComponentName of the androidx.wear.watchface.complications.datasource.ComplicationDataSourceService that provided the ComplicationData. final int getDisplayPolicy() The display policy for this complication. final ComplicationData getDynamicValueInvalidationFallback() Used in case any dynamic value has been invalidated. @NonNull Instant getNextChangeInstant(@NonNull Instant afterInstant) Returns the next Instant after afterInstant at which any field of the complication may change. final int getPersistencePolicy() The persistence policy for this complication. final PendingIntent getTapAction() The PendingIntent to send when the complication is tapped on. final boolean isTapActionLostDueToSerialization() tapAction which is a PendingIntent unfortunately can't be serialized. final @NonNull ComplicationType getType() The ComplicationType of this complication data. final @NonNull TimeRange getValidTimeRange() The TimeRange within which the complication should be displayed. boolean hasPlaceholderFields() Returns true if any of the fields of this ComplicationData are placeholders. int hashCode() final void setTapActionLostDueToSerialization(     boolean tapActionLostDueToSerialization ) tapAction which is a PendingIntent unfortunately can't be serialized.

Public fields

TYPE

public static final @NonNull ComplicationType TYPE

The ComplicationType corresponding to objects of this type.

Public constructors

NoDataComplicationData

Added in 1.0.0

public NoDataComplicationData()

Constructs a NoDataComplicationData without a placeholder.

NoDataComplicationData

Added in 1.1.0

public NoDataComplicationData(@NonNull ComplicationData placeholder)

Constructs a NoDataComplicationData with a placeholder which is allowed to contain placeholder fields (see hasPlaceholderFields) which must be drawn to look like placeholders. E.g. with grey boxes / arcs.

Public methods

getContentDescription

Added in 1.1.0

public final ComplicationText getContentDescription()

The content description field for accessibility.

getInvalidatedData

Added in 1.3.0-alpha04

public final ComplicationData getInvalidatedData()

An optional value that describes the original ComplicationData that was provided by the data source, following invalidation (see evaluation description in ComplicationData). This is set by the system for privileged watch faces with the com.google.wear.permission.GET_COMPLICATION_DYNAMIC_VALUE permission.

getPlaceholder

Added in 1.1.0

public final ComplicationData getPlaceholder()

An optional ComplicationData which may contain placeholder fields (see hasPlaceholderFields). The type of the placeholder must match the type of the ComplicationData that would have otherwise been sent. The placeholder is expected to be rendered if the watch face has been built with a compatible library, older libraries which don't support placeholders will ignore this field.

toString

public @NonNull String toString()