RequestBuilders.TileRequest
@RequiresSchemaVersion(major = 1, minor = 0)
class RequestBuilders.TileRequest
Parameters passed to a androidx.wear.tiles.TileBuilders.Tile Service when the renderer is requesting a new version of the tile.
Summary
Nested types |
|---|
|
Builder for |
Public functions |
|
|---|---|
StateBuilders.State |
Gets the |
DeviceParametersBuilders.DeviceParameters |
Gets the |
DeviceParametersBuilders.DeviceParameters? |
This function is deprecated. Use |
Instant |
@RequiresSchemaVersion(major = 1, minor = 600)Gets the |
ProtoLayoutScope |
getScope()Returns |
StateBuilders.State? |
This function is deprecated. Use |
Int |
Gets the instance ID of the tile being requested, allocated when the tile instance is added to the carousel. |
String |
toString() |
Public functions
getCurrentState
fun getCurrentState(): StateBuilders.State
Gets the androidx.wear.protolayout.StateBuilders.State that should be used when building the tile.
getDeviceConfiguration
fun getDeviceConfiguration(): DeviceParametersBuilders.DeviceParameters
Gets the androidx.wear.protolayout.DeviceParametersBuilders.DeviceParameters object describing the device requesting the tile update. If not set, a default empty instance is used.
fungetDeviceParameters(): DeviceParametersBuilders.DeviceParameters?
Gets the androidx.wear.tiles.DeviceParametersBuilders.DeviceParameters object describing the device requesting the tile update.
getLastVisibleTime
@RequiresSchemaVersion(major = 1, minor = 600)
fun getLastVisibleTime(): Instant
Gets the Instant representing the last time the tile was visible.
If the tile has never been visible, or the last time it was visible is not known, this will return EPOCH.
The returned value is not persistent across reboots or when the tile is removed from the carousel and added again.
getScope
fun getScope(): ProtoLayoutScope
Returns ProtoLayoutScope object that is required for methods to create resources or pending intents, and it will automatically register them for a tile.
fungetState(): StateBuilders.State?
Gets the androidx.wear.tiles.StateBuilders.State that should be used when building the tile.