# TileClient

Artifact: [androidx.wear.tiles:tiles-renderer](https://developer.android.com/jetpack/androidx/releases/wear-tiles) [View Source](https://cs.android.com/search?q=file:androidx/wear/tiles/client/TileClient.java+class:androidx.wear.tiles.client.TileClient) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

*** ** * ** ***

<br />

```
public interface TileClient
```

<br />

Known direct subclasses [DefaultTileClient](https://developer.android.com/reference/androidx/wear/tiles/connection/DefaultTileClient), [TestTileClient](https://developer.android.com/reference/androidx/wear/tiles/testing/TestTileClient)

|---|---|
| `https://developer.android.com/reference/androidx/wear/tiles/connection/DefaultTileClient` | Implementation of `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient` which can connect to a `TileService` in either the local process, or in a remote app. |
| `https://developer.android.com/reference/androidx/wear/tiles/testing/TestTileClient` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient` for testing purposes. |

*** ** * ** ***

Client to connect and interact with a TileService.

## Summary

| ### Public methods |
|---|---|
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/java/lang/Integer.html>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestApiVersion()()` Gets the API version supported by the connected TileService. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/androidx/wear/tiles/ResourceBuilders.Resources>` | `[requestResources](https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestResources(androidx.wear.tiles.RequestBuilders.ResourcesRequest))( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/tiles/RequestBuilders.ResourcesRequest requestParams )` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestTileResourcesAsync(androidx.wear.tiles.RequestBuilders.ResourcesRequest)` instead. <br /> |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/androidx/wear/tiles/TileBuilders.Tile>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestTile(androidx.wear.tiles.RequestBuilders.TileRequest)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/tiles/RequestBuilders.TileRequest requestParams)` Request a tile payload from the connected TileService. |
| `default @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/androidx/wear/protolayout/ResourceBuilders.Resources>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestTileResourcesAsync(androidx.wear.tiles.RequestBuilders.ResourcesRequest)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/wear/tiles/RequestBuilders.ResourcesRequest requestParams )` Request a resource bundle from the connected TileService. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/java/lang/Void.html>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#sendOnTileAddedEvent()()` Send a Tile Added notification to the connected TileService. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/java/lang/Void.html>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#sendOnTileEnterEvent()()` Send a Tile Enter notification to the connected TileService. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/java/lang/Void.html>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#sendOnTileLeaveEvent()()` Send a Tile Leave notification to the connected TileService. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://developer.android.com/reference/java/lang/Void.html>` | `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#sendOnTileRemovedEvent()()` Send a Tile Removed notification to the connected TileService. |

## Public methods

### requestApiVersion

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

```
abstract @NonNull ListenableFuture<Integer> requestApiVersion()
```

Gets the API version supported by the connected TileService.

### requestResources

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.2.0)

```
abstract @NonNull ListenableFuture<ResourceBuilders.Resources> [requestResources](https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestResources(androidx.wear.tiles.RequestBuilders.ResourcesRequest))(
    @NonNull RequestBuilders.ResourcesRequest requestParams
)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/wear/tiles/client/TileClient#requestTileResourcesAsync(androidx.wear.tiles.RequestBuilders.ResourcesRequest)` instead.

Request a resource bundle from the connected TileService.

### requestTile

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#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](https://developer.android.com/jetpack/androidx/releases/wear-tiles#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](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

```
abstract @NonNull ListenableFuture<Void> sendOnTileAddedEvent()
```

Send a Tile Added notification to the connected TileService.

### sendOnTileEnterEvent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

```
abstract @NonNull ListenableFuture<Void> sendOnTileEnterEvent()
```

Send a Tile Enter notification to the connected TileService.

### sendOnTileLeaveEvent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

```
abstract @NonNull ListenableFuture<Void> sendOnTileLeaveEvent()
```

Send a Tile Leave notification to the connected TileService.

### sendOnTileRemovedEvent

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-tiles#1.0.0)

```
abstract @NonNull ListenableFuture<Void> sendOnTileRemovedEvent()
```

Send a Tile Removed notification to the connected TileService.