TileClient

Artifact: androidx.wear.tiles:tiles-renderer

Added in 1.0.0

Kotlin |Java

public 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 methods
`abstract @NonNull ListenableFuture<Integer>`	`requestApiVersion()` Gets the API version supported by the connected TileService.
`abstract @NonNull ListenableFuture<ResourceBuilders.Resources>`	`requestResources( @NonNull RequestBuilders.ResourcesRequest requestParams )` This method is deprecated. Use `requestTileResourcesAsync` instead.
`abstract @NonNull ListenableFuture<TileBuilders.Tile>`	`requestTile(@NonNull RequestBuilders.TileRequest requestParams)` Request a tile payload from the connected TileService.
`default @NonNull ListenableFuture<ResourceBuilders.Resources>`	`requestTileResourcesAsync( @NonNull RequestBuilders.ResourcesRequest requestParams )` Request a resource bundle from the connected TileService.
`abstract @NonNull ListenableFuture<Void>`	`sendOnTileAddedEvent()` Send a Tile Added notification to the connected TileService.
`abstract @NonNull ListenableFuture<Void>`	`sendOnTileEnterEvent()` Send a Tile Enter notification to the connected TileService.
`abstract @NonNull ListenableFuture<Void>`	`sendOnTileLeaveEvent()` Send a Tile Leave notification to the connected TileService.
`abstract @NonNull ListenableFuture<Void>`	`sendOnTileRemovedEvent()` Send a Tile Removed notification to the connected TileService.

Public methods

requestApiVersion

Added in 1.0.0

abstract @NonNull ListenableFuture<Integer> requestApiVersion()

Gets the API version supported by the connected TileService.

requestResources

Added in 1.0.0

Deprecated in 1.2.0

abstract @NonNull ListenableFuture<ResourceBuilders.Resources> requestResources(
    @NonNull RequestBuilders.ResourcesRequest requestParams
)

Request a resource bundle from the connected TileService.

requestTile

Added in 1.0.0

abstract @NonNull ListenableFuture<TileBuilders.Tile> requestTile(@NonNull RequestBuilders.TileRequest requestParams)

Request a tile payload from the connected TileService.

requestTileResourcesAsync

Added in 1.2.0

default @NonNull ListenableFuture<ResourceBuilders.Resources> requestTileResourcesAsync(
    @NonNull RequestBuilders.ResourcesRequest requestParams
)

Request a resource bundle from the connected TileService.

sendOnTileAddedEvent

Added in 1.0.0

abstract @NonNull ListenableFuture<Void> sendOnTileAddedEvent()

Send a Tile Added notification to the connected TileService.

sendOnTileEnterEvent

Added in 1.0.0

abstract @NonNull ListenableFuture<Void> sendOnTileEnterEvent()

Send a Tile Enter notification to the connected TileService.

sendOnTileLeaveEvent

Added in 1.0.0

abstract @NonNull ListenableFuture<Void> sendOnTileLeaveEvent()

Send a Tile Leave notification to the connected TileService.

sendOnTileRemovedEvent

Added in 1.0.0

abstract @NonNull ListenableFuture<Void> sendOnTileRemovedEvent()

Send a Tile Removed notification to the connected TileService.