NoDataComplicationData
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 |
The |
Public constructors |
|---|
|
Constructs a NoDataComplicationData without a |
NoDataComplicationData(@NonNull ComplicationData placeholder)Constructs a NoDataComplicationData with a |
Public methods |
|
|---|---|
final ComplicationText |
The content description field for accessibility. |
final ComplicationData |
An optional value that describes the original |
final ComplicationData |
An optional |
@NonNull String |
toString() |
Inherited methods |
||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Public fields
TYPE
public static final @NonNull ComplicationType TYPE
The ComplicationType corresponding to objects of this type.
Public constructors
NoDataComplicationData
public NoDataComplicationData()
Constructs a NoDataComplicationData without a placeholder.
NoDataComplicationData
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
public final ComplicationText getContentDescription()
The content description field for accessibility.
getInvalidatedData
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
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.