# WatchUiState

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/WatchUiState.kt+class:androidx.wear.watchface.client.WatchUiState) 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 final class WatchUiState
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Describes the system state of the watch face ui.

use Watch Face Format instead

## Summary

| ### Public constructors |
|---|
| `[WatchUiState](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#WatchUiState(kotlin.Boolean,kotlin.Int))(boolean inAmbientMode, int interruptionFilter)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `boolean` | `[equals](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#equals(kotlin.Any))(https://developer.android.com/reference/java/lang/Object.html other)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final int` | `[getInterruptionFilter](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#getInterruptionFilter())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `int` | `[hashCode](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#hashCode())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final boolean` | `[inAmbientMode](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#inAmbientMode())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `[toString](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#toString())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### WatchUiState

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 [WatchUiState](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#WatchUiState(kotlin.Boolean,kotlin.Int))(boolean inAmbientMode, int interruptionFilter)
```

> [!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

| Parameters |
|---|---|
| `boolean inAmbientMode` | Whether the device is is ambient mode or not. |
| `int interruptionFilter` | The interruption filter defines which notifications are allowed to interrupt the user. For watch faces this value is one of: `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALARMS`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALL`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_UNKNOWN`. @see `https://developer.android.com/reference/android/app/NotificationManager.html` for more details. Value is one of the following: - `4` - `1` - `3` - `2` - `0` <br /> |

## Public methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#equals(kotlin.Any))(Object other)
```

> [!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

### getInterruptionFilter

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 final int [getInterruptionFilter](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#getInterruptionFilter())()
```

> [!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 interruption filter defines which notifications are allowed to interrupt the user. For watch faces this value is one of: `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALARMS`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_ALL`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_NONE`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_PRIORITY`, `https://developer.android.com/reference/android/app/NotificationManager.html#INTERRUPTION_FILTER_UNKNOWN`. @see `https://developer.android.com/reference/android/app/NotificationManager.html` for more details.

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#hashCode())()
```

> [!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

### inAmbientMode

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)

```
public final boolean [inAmbientMode](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#inAmbientMode())()
```

> [!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 the device is is ambient mode or not.

### toString

```
public @NonNull String [toString](https://developer.android.com/reference/androidx/wear/watchface/client/WatchUiState#toString())()
```

> [!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