# InteractiveWatchFaceClient
Artifact: [androidx.wear.watchface:watchface-client](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/client/InteractiveWatchFaceClient.kt+class:androidx.wear.watchface.client.InteractiveWatchFaceClient) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
*** ** * ** ***
```
public interface InteractiveWatchFaceClient extends AutoCloseable
```
*** ** * ** ***
> [!CAUTION]
> **This interface is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Controls a stateful remote interactive watch face. Typically this will be used for the current active watch face.
Note clients should call `https://developer.android.com/reference/java/lang/AutoCloseable.html#close()` when finished.
use Watch Face Format instead
## Summary
| ### Nested types |
|---|
| `public interface https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` **This interface is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public fun interface https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` **This interface is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| ### Constants |
|---|---|
| `default static final int` | `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_CANCEL()` **This field is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default static final int` | `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` **This field is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default static final int` | `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_UP()` **This field is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| ### Public methods |
|---|---|
| `abstract void` | `@https://developer.android.com/reference/androidx/annotation/AnyThread [addClientDisconnectListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener listener, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default void` | `@https://developer.android.com/reference/androidx/wear/watchface/client/WatchFaceClientExperimental [addOnWatchFaceColorsListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/core/util/Consumer listener )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[addOnWatchFaceReadyListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener listener )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost` | `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 30) [createRemoteWatchFaceViewHost](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#createRemoteWatchFaceViewHost(android.os.IBinder,kotlin.Int,kotlin.Int))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/IBinder.html hostToken, @https://developer.android.com/reference/androidx/annotation/Px int width, @https://developer.android.com/reference/androidx/annotation/Px int height )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default https://developer.android.com/reference/java/lang/Integer.html` | `[getComplicationIdAt](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationIdAt(kotlin.Int,kotlin.Int))(@https://developer.android.com/reference/androidx/annotation/Px int x, @https://developer.android.com/reference/androidx/annotation/Px int y)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/ComplicationSlotState>` | `[getComplicationSlotsState](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationSlotsState())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/ContentDescriptionLabel>` | `[getContentDescriptionLabels](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getContentDescriptionLabels())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `[getInstanceId](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getInstanceId())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/OverlayStyle` | `[getOverlayStyle](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getOverlayStyle())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html` | `[getPreviewReferenceInstant](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getPreviewReferenceInstant())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleFlavors` | `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 34) [getUserStyleFlavors](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleFlavors())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSchema` | `[getUserStyleSchema](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleSchema())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default boolean` | `[isComplicationDisplayPolicySupported](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isComplicationDisplayPolicySupported())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract boolean` | `@https://developer.android.com/reference/androidx/annotation/AnyThread [isConnectionAlive](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isConnectionAlive())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default boolean` | `[isRemoteWatchFaceViewHostSupported](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isRemoteWatchFaceViewHostSupported())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[performAmbientTick](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#performAmbientTick())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `@https://developer.android.com/reference/androidx/annotation/AnyThread [removeClientDisconnectListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener listener )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `default void` | `@https://developer.android.com/reference/androidx/wear/watchface/client/WatchFaceClientExperimental [removeOnWatchFaceColorsListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceColorsListener(androidx.core.util.Consumer))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/core/util/Consumer listener )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[removeOnWatchFaceReadyListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceReadyListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener listener )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html` | `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 27) [renderWatchFaceToBitmap](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters renderParameters, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html instant, https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle userStyle, https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData> idAndComplicationData )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[sendTouchEvent](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#sendTouchEvent(kotlin.Int,kotlin.Int,kotlin.Int))(@https://developer.android.com/reference/androidx/annotation/Px int xPosition, @https://developer.android.com/reference/androidx/annotation/Px int yPosition, int tapType)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[setWatchUiState](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState watchUiState)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[updateComplicationData](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateComplicationData(kotlin.collections.Map))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData> slotIdToComplicationData )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[updateWatchFaceInstance](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html newInstanceId, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle userStyle )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract void` | `[updateWatchFaceInstance](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html newInstanceId, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleData userStyle )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
### Inherited methods
From [java.lang.AutoCloseable](https://developer.android.com/reference/java/lang/AutoCloseable.html) `abstract void` `[close](https://developer.android.com/reference/java/lang/AutoCloseable.html#close())()`
**This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead.
## Constants
### TAP_TYPE_CANCEL
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default static final int TAP_TYPE_CANCEL
```
> [!CAUTION]
> **This field is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Indicates that a previous `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` event has been canceled. This generally happens when the watch face is touched but then a move or long press occurs.
### TAP_TYPE_DOWN
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default static final int TAP_TYPE_DOWN
```
> [!CAUTION]
> **This field is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Indicates a "down" touch event on the watch face.
### TAP_TYPE_UP
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default static final int TAP_TYPE_UP
```
> [!CAUTION]
> **This field is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Indicates that an "up" event on the watch face has occurred that has not been consumed by another activity. A `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_DOWN()` always occur first. This event will not occur if a `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#TAP_TYPE_CANCEL()` is sent.
## Public methods
### addClientDisconnectListener
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@AnyThread
abstract void [addClientDisconnectListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor))(
@NonNull InteractiveWatchFaceClient.ClientDisconnectListener listener,
@NonNull Executor executor
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Registers a `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener`.
### addOnWatchFaceColorsListener
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@WatchFaceClientExperimental
default void [addOnWatchFaceColorsListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer))(
@NonNull Executor executor,
@NonNull Consumer listener
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Registers a `https://developer.android.com/reference/androidx/core/util/Consumer` which gets called initially with the current `https://developer.android.com/reference/androidx/wear/watchface/Renderer#watchfaceColors()` if known or `null` if not, and subsequently whenever the watch face's `https://developer.android.com/reference/androidx/wear/watchface/Renderer#watchfaceColors()` change.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which to run `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer)`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/core/util/Consumer listener` | The `https://developer.android.com/reference/androidx/core/util/Consumer` to run whenever the watch face's `https://developer.android.com/reference/androidx/wear/watchface/Renderer#watchfaceColors()` change. |
### addOnWatchFaceReadyListener
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [addOnWatchFaceReadyListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))(
@NonNull Executor executor,
@NonNull InteractiveWatchFaceClient.OnWatchFaceReadyListener listener
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Registers a `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` which gets called when the watch face is ready to render.
Note in the event of the watch face disconnecting (e.g. due to a crash) the listener will never get called. Use `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` to observe disconnects.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/concurrent/Executor.html executor` | The `https://developer.android.com/reference/java/util/concurrent/Executor.html` on which to run `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener`. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener listener` | The `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.OnWatchFaceReadyListener` to run when the watchface is ready to render. |
### createRemoteWatchFaceViewHost
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@RequiresApi(value = 30)
default RemoteWatchFaceViewHost [createRemoteWatchFaceViewHost](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#createRemoteWatchFaceViewHost(android.os.IBinder,kotlin.Int,kotlin.Int))(
@NonNull IBinder hostToken,
@Px int width,
@Px int height
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Constructs a `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost` whose `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost#surfacePackage()` can be attached to a `https://developer.android.com/reference/android/view/SurfaceView.html` owned by the client with `https://developer.android.com/reference/android/view/SurfaceView.html#setChildSurfacePackage(android.view.SurfaceControlViewHost.SurfacePackage)`. The watch face will render into this view upon demand (see `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost#renderWatchFace(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map)`).
This is more efficient than calling `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map)` multiple times, although there is some overhead (memory and cpu) to setting up a RemoteWatchFaceViewHost.
Requires the watchface to be compiled with a compatible library, to check if that's the case use `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isRemoteWatchFaceViewHostSupported()`.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/IBinder.html hostToken` | The return value of View.getHostToken() |
| `@https://developer.android.com/reference/androidx/annotation/Px int width` | The width of the view in pixels |
| `@https://developer.android.com/reference/androidx/annotation/Px int height` | The height of the view in pixels |
| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost` | The `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost` or null if the client has already been closed or if the watch face is not compatible. |
### getComplicationIdAt
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default Integer [getComplicationIdAt](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationIdAt(kotlin.Int,kotlin.Int))(@Px int x, @Px int y)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Returns the ID of the `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot` at the given coordinates or `null` if there isn't one.
Note this currently doesn't support Edge complications.
### getComplicationSlotsState
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract @NonNull Map<@NonNull Integer, @NonNull ComplicationSlotState> [getComplicationSlotsState](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getComplicationSlotsState())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Map of `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot` ids to `https://developer.android.com/reference/androidx/wear/watchface/client/ComplicationSlotState` for each `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot` registered with the watch face's `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlotsManager`. The ComplicationSlotState is based on the initial state of each `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot` plus any overrides from a `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting`. As a consequence ComplicationSlotState may update based on style changes.
### getContentDescriptionLabels
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract @NonNull List<@NonNull ContentDescriptionLabel> [getContentDescriptionLabels](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getContentDescriptionLabels())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Returns the `https://developer.android.com/reference/androidx/wear/watchface/ContentDescriptionLabel`s describing the watch face, for the use by screen readers.
### getInstanceId
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract @NonNull String [getInstanceId](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getInstanceId())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Returns the ID of this watch face instance.
### getOverlayStyle
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)
```
default @NonNull OverlayStyle [getOverlayStyle](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getOverlayStyle())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
The watchface's `https://developer.android.com/reference/androidx/wear/watchface/client/OverlayStyle` which may be null.
Note while this plumbing got built, it was never used by the system ui on any platform and it will be removed.
### getPreviewReferenceInstant
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract @NonNull Instant [getPreviewReferenceInstant](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getPreviewReferenceInstant())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
The UTC reference preview time for this watch face in milliseconds since the epoch.
### getUserStyleFlavors
Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@RequiresApi(value = 34)
default @NonNull UserStyleFlavors [getUserStyleFlavors](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleFlavors())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Returns the watch face's `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleFlavors`.
| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-runtime-exception/index.html` | if the watch face threw an exception while trying to service the request or there was a communication problem with watch face process. |
### getUserStyleSchema
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract @NonNull UserStyleSchema [getUserStyleSchema](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#getUserStyleSchema())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
The watch face's `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSchema`.
### isComplicationDisplayPolicySupported
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default boolean [isComplicationDisplayPolicySupported](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isComplicationDisplayPolicySupported())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Whether or not the watch face supports `https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationDisplayPolicy`. If it doesn't then the client is responsible for emulating it by observing the state of the keyguard and sending NoData complications when the device becomes locked and subsequently restoring them when it becomes unlocked for affected complications.
### isConnectionAlive
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@AnyThread
abstract boolean [isConnectionAlive](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isConnectionAlive())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Returns true if the connection to the server side is alive.
### isRemoteWatchFaceViewHostSupported
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
default boolean [isRemoteWatchFaceViewHostSupported](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#isRemoteWatchFaceViewHostSupported())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Whether or not the watch face supports `https://developer.android.com/reference/androidx/wear/watchface/client/RemoteWatchFaceViewHost`.
### performAmbientTick
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [performAmbientTick](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#performAmbientTick())()
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Triggers watch face rendering into the surface when in ambient mode.
### removeClientDisconnectListener
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@AnyThread
abstract void [removeClientDisconnectListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener))(
@NonNull InteractiveWatchFaceClient.ClientDisconnectListener listener
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Removes a `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient.ClientDisconnectListener` previously registered by `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addClientDisconnectListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.ClientDisconnectListener,java.util.concurrent.Executor)`.
### removeOnWatchFaceColorsListener
Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
@WatchFaceClientExperimental
default void [removeOnWatchFaceColorsListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceColorsListener(androidx.core.util.Consumer))(
@NonNull Consumer listener
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Stops listening for events registered by `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceColorsListener(java.util.concurrent.Executor,androidx.core.util.Consumer)`.
### removeOnWatchFaceReadyListener
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [removeOnWatchFaceReadyListener](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#removeOnWatchFaceReadyListener(androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener))(
@NonNull InteractiveWatchFaceClient.OnWatchFaceReadyListener listener
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Stops listening for events registered by `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#addOnWatchFaceReadyListener(java.util.concurrent.Executor,androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceReadyListener)`.
### renderWatchFaceToBitmap
```
@RequiresApi(value = 27)
abstract @NonNull Bitmap [renderWatchFaceToBitmap](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#renderWatchFaceToBitmap(androidx.wear.watchface.RenderParameters,java.time.Instant,androidx.wear.watchface.style.UserStyle,kotlin.collections.Map))(
@NonNull RenderParameters renderParameters,
@NonNull Instant instant,
UserStyle userStyle,
Map<@NonNull Integer, @NonNull ComplicationData> idAndComplicationData
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Renders the watchface to a shared memory backed `https://developer.android.com/reference/android/graphics/Bitmap.html` with the given settings. Note this will be fairly slow since either software canvas or glReadPixels will be invoked.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters renderParameters` | The `https://developer.android.com/reference/androidx/wear/watchface/RenderParameters` to draw with. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/time/Instant.html instant` | The `https://developer.android.com/reference/java/time/Instant.html` render with. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle userStyle` | Optional `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle` to render with, if null the current style is used. |
| `https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData> idAndComplicationData` | Map of complication ids to `https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData` to render with, or if null then the existing complication data if any is used. |
| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html` | A shared memory backed `https://developer.android.com/reference/android/graphics/Bitmap.html` containing a screenshot of the watch face with the given settings. |
### sendTouchEvent
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [sendTouchEvent](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#sendTouchEvent(kotlin.Int,kotlin.Int,kotlin.Int))(@Px int xPosition, @Px int yPosition, int tapType)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Sends a tap event to the watch face for processing.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Px int xPosition` | The x-coordinate of the tap in pixels |
| `@https://developer.android.com/reference/androidx/annotation/Px int yPosition` | The y-coordinate of the tap in pixels |
| `int tapType` | The `https://developer.android.com/reference/androidx/wear/watchface/TapTypeIntDef` of the event Value is one of the following: - `0` - `2` - `1`
|
### setWatchUiState
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [setWatchUiState](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState))(@NonNull WatchUiState watchUiState)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Updates the watch faces `https://developer.android.com/reference/androidx/wear/watchface/data/WatchUiState`. NB `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState)` and `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` can be called in any order.
### updateComplicationData
```
abstract void [updateComplicationData](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateComplicationData(kotlin.collections.Map))(
@NonNull Map<@NonNull Integer, @NonNull ComplicationData> slotIdToComplicationData
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Sends new `https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData` to the watch face. Note this doesn't have to be a full update, it's possible to update just one complication at a time, but doing so may result in a less visually clean transition.
| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData> slotIdToComplicationData` | The `https://developer.android.com/reference/androidx/wear/watchface/complications/data/ComplicationData` for each `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot`. |
### updateWatchFaceInstance
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [updateWatchFaceInstance](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle))(
@NonNull String newInstanceId,
@NonNull UserStyle userStyle
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Renames this instance to `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` (must be unique, usually this would be different from the old ID but that's not a requirement). Sets the current `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle` and clears any complication data. Setting the new UserStyle may have a side effect of enabling or disabling complicationSlots, which will be visible via `https://developer.android.com/reference/androidx/wear/watchface/client/ComplicationSlotState#isEnabled()`.
NB `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#setWatchUiState(androidx.wear.watchface.client.WatchUiState)` and `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyle)` can be called in any order.
### updateWatchFaceInstance
Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)
```
abstract void [updateWatchFaceInstance](https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData))(
@NonNull String newInstanceId,
@NonNull UserStyleData userStyle
)
```
> [!CAUTION]
> **This method is deprecated.**
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff
Renames this instance to `https://developer.android.com/reference/androidx/wear/watchface/client/InteractiveWatchFaceClient#updateWatchFaceInstance(kotlin.String,androidx.wear.watchface.style.UserStyleData)` (must be unique, usually this would be different from the old ID but that's not a requirement). Sets the current `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle` represented as a \[UserStyleData\> and clears any complication data. Setting the new UserStyle may have a side effect of enabling or disabling complicationSlots, which will be visible via `https://developer.android.com/reference/androidx/wear/watchface/client/ComplicationSlotState#isEnabled()`.