TileClient

Artifact: androidx.wear.tiles:tiles-renderer

View Source

Added in 1.0.0

---

Kotlin |Java

interface TileClient

Known direct subclasses

DefaultTileClient, TestTileClient

DefaultTileClient	Implementation of TileClient which can connect to a TileService in either the local process, or in a remote app.
TestTileClient	TileClient for testing purposes.

---

Client to connect and interact with a TileService.

Summary

Public functions
ListenableFuture<Int!>	requestApiVersion() Gets the API version supported by the connected TileService.
ListenableFuture<ResourceBuilders.Resources!>	requestResources(requestParams: RequestBuilders.ResourcesRequest) This function is deprecated. Use requestTileResourcesAsync instead.
ListenableFuture<TileBuilders.Tile!>	requestTile(requestParams: RequestBuilders.TileRequest) Request a tile payload from the connected TileService.
ListenableFuture<ResourceBuilders.Resources!>	requestTileResourcesAsync(     requestParams: RequestBuilders.ResourcesRequest ) Request a resource bundle from the connected TileService.
ListenableFuture<Void!>	sendOnTileAddedEvent() Send a Tile Added notification to the connected TileService.
ListenableFuture<Void!>	sendOnTileEnterEvent() Send a Tile Enter notification to the connected TileService.
ListenableFuture<Void!>	sendOnTileLeaveEvent() Send a Tile Leave notification to the connected TileService.
ListenableFuture<Void!>	sendOnTileRemovedEvent() Send a Tile Removed notification to the connected TileService.

Public functions

requestApiVersion

Added in 1.0.0

fun requestApiVersion(): ListenableFuture<Int!>

Gets the API version supported by the connected TileService.

requestResources

Added in 1.0.0

Deprecated in 1.2.0

fun requestResources(requestParams: RequestBuilders.ResourcesRequest): ListenableFuture<ResourceBuilders.Resources!>

This function is deprecated.

Use requestTileResourcesAsync instead.

Request a resource bundle from the connected TileService.

requestTile

Added in 1.0.0

fun requestTile(requestParams: RequestBuilders.TileRequest): ListenableFuture<TileBuilders.Tile!>

Request a tile payload from the connected TileService.

requestTileResourcesAsync

Added in 1.2.0

fun requestTileResourcesAsync(
    requestParams: RequestBuilders.ResourcesRequest
): ListenableFuture<ResourceBuilders.Resources!>

Request a resource bundle from the connected TileService.

sendOnTileAddedEvent

Added in 1.0.0

fun sendOnTileAddedEvent(): ListenableFuture<Void!>

Send a Tile Added notification to the connected TileService.

sendOnTileEnterEvent

Added in 1.0.0

fun sendOnTileEnterEvent(): ListenableFuture<Void!>

Send a Tile Enter notification to the connected TileService.

sendOnTileLeaveEvent

Added in 1.0.0

fun sendOnTileLeaveEvent(): ListenableFuture<Void!>

Send a Tile Leave notification to the connected TileService.

sendOnTileRemovedEvent

Added in 1.0.0

fun sendOnTileRemovedEvent(): ListenableFuture<Void!>

Send a Tile Removed notification to the connected TileService.