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 TileRequest

Public functions

StateBuilders.State

Gets the androidx.wear.protolayout.StateBuilders.State that should be used when building the tile.

DeviceParametersBuilders.DeviceParameters

Gets the androidx.wear.protolayout.DeviceParametersBuilders.DeviceParameters object describing the device requesting the tile update.

DeviceParametersBuilders.DeviceParameters?

This function is deprecated.

Use getDeviceConfiguration instead.

Instant
@RequiresSchemaVersion(major = 1, minor = 600)
getLastVisibleTime()

Gets the Instant representing the last time the tile was visible.

ProtoLayoutScope

Returns ProtoLayoutScope object that is required for methods to create resources or pending intents, and it will automatically register them for a tile.

StateBuilders.State?

This function is deprecated.

Use getCurrentState instead.

Int

Gets the instance ID of the tile being requested, allocated when the tile instance is added to the carousel.

String

Public functions

getCurrentState

Added in 1.2.0
fun getCurrentState(): StateBuilders.State

Gets the androidx.wear.protolayout.StateBuilders.State that should be used when building the tile.

getDeviceConfiguration

Added in 1.2.0
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.

getDeviceParameters

Added in 1.0.0
Deprecated in 1.2.0
fun getDeviceParameters(): DeviceParametersBuilders.DeviceParameters?

Gets the androidx.wear.tiles.DeviceParametersBuilders.DeviceParameters object describing the device requesting the tile update.

getLastVisibleTime

Added in 1.6.0-alpha01
@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

Added in 1.6.0-alpha01
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.

getState

Added in 1.0.0
Deprecated in 1.2.0
fun getState(): StateBuilders.State?

Gets the androidx.wear.tiles.StateBuilders.State that should be used when building the tile.

getTileId

Added in 1.2.0
fun getTileId(): Int

Gets the instance ID of the tile being requested, allocated when the tile instance is added to the carousel. This ID will remain the same for this tile instance as long it is not removed from the carousel.

toString

fun toString(): String