TileClient

interface TileClient

Known direct subclasses
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<@NonNull Integer>

Gets the API version supported by the connected TileService.

abstract @NonNull ListenableFuture<@NonNull ResourceBuilders.Resources>

Request a resource bundle from the connected TileService.

abstract @NonNull ListenableFuture<@NonNull TileBuilders.Tile>

Request a tile payload from the connected TileService.

abstract @NonNull ListenableFuture<@NonNull Void>

Send a Tile Added notification to the connected TileService.

abstract @NonNull ListenableFuture<@NonNull Void>

Send a Tile Enter notification to the connected TileService.

abstract @NonNull ListenableFuture<@NonNull Void>

Send a Tile Leave notification to the connected TileService.

abstract @NonNull ListenableFuture<@NonNull Void>

Send a Tile Removed notification to the connected TileService.

Public methods

requestApiVersion

@NonNull
abstract ListenableFuture<@NonNull IntegerrequestApiVersion()

Gets the API version supported by the connected TileService.

requestResources

@NonNull
abstract ListenableFuture<@NonNull ResourceBuilders.ResourcesrequestResources(
    @NonNull RequestBuilders.ResourcesRequest requestParams
)

Request a resource bundle from the connected TileService.

requestTile

@NonNull
abstract ListenableFuture<@NonNull TileBuilders.TilerequestTile(@NonNull RequestBuilders.TileRequest requestParams)

Request a tile payload from the connected TileService.

sendOnTileAddedEvent

@NonNull
abstract ListenableFuture<@NonNull VoidsendOnTileAddedEvent()

Send a Tile Added notification to the connected TileService.

sendOnTileEnterEvent

@NonNull
abstract ListenableFuture<@NonNull VoidsendOnTileEnterEvent()

Send a Tile Enter notification to the connected TileService.

sendOnTileLeaveEvent

@NonNull
abstract ListenableFuture<@NonNull VoidsendOnTileLeaveEvent()

Send a Tile Leave notification to the connected TileService.

sendOnTileRemovedEvent

@NonNull
abstract ListenableFuture<@NonNull VoidsendOnTileRemovedEvent()

Send a Tile Removed notification to the connected TileService.