StateBuilders.State

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
class StateBuilders.State

---

State information.

Summary

Nested types
class StateBuilders.State.Builder Builder for State

Public functions
(Mutable)Map<AppDataKey<Any!>!, DynamicDataBuilders.DynamicDataValue<Any!>!>	getKeyToValueMapping() Gets any shared state between the provider and renderer.
String	getLastClickableId() Gets the ID of the clickable that was last clicked.
java-static Int	getMaxStateEntryCount() Returns the maximum number for state entries that can be added to the State using addKeyToValueMapping.
String	toString()

Public functions

getKeyToValueMapping

Added in 1.0.0

fun getKeyToValueMapping(): (Mutable)Map<AppDataKey<Any!>!, DynamicDataBuilders.DynamicDataValue<Any!>!>

Gets any shared state between the provider and renderer.

getLastClickableId

Added in 1.0.0

fun getLastClickableId(): String

Gets the ID of the clickable that was last clicked.

getMaxStateEntryCount

Added in 1.0.0

java-static fun getMaxStateEntryCount(): Int

Returns the maximum number for state entries that can be added to the State using addKeyToValueMapping.

The ProtoLayout state model is not designed to handle large volumes of layout provided state. So we limit the number of state entries to keep the on-the-wire size and state store update times manageable.

toString

fun toString(): String