WatchUiState

Artifact: androidx.wear.watchface:watchface-client

View Source

Added in 1.0.0

---

Kotlin |Java

class WatchUiState

---

Describes the system state of the watch face ui.

Summary

Public constructors
WatchUiState(inAmbientMode: Boolean, interruptionFilter: Int)

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
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.

Public constructors

WatchUiState

Added in 1.0.0

WatchUiState(inAmbientMode: Boolean, interruptionFilter: Int)

Parameters
inAmbientMode: Boolean	Whether the device is is ambient mode or not.
interruptionFilter: Int	The interruption filter defines which notifications are allowed to interrupt the user. For watch faces this value is one of: NotificationManager.INTERRUPTION_FILTER_ALARMS, NotificationManager.INTERRUPTION_FILTER_ALL, NotificationManager.INTERRUPTION_FILTER_NONE, NotificationManager.INTERRUPTION_FILTER_PRIORITY, NotificationManager.INTERRUPTION_FILTER_UNKNOWN. @see NotificationManager for more details.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

inAmbientMode

Added in 1.2.0

val inAmbientMode: Boolean

Whether the device is is ambient mode or not.

interruptionFilter

Added in 1.0.0

val interruptionFilter: Int

The interruption filter defines which notifications are allowed to interrupt the user. For watch faces this value is one of: NotificationManager.INTERRUPTION_FILTER_ALARMS, NotificationManager.INTERRUPTION_FILTER_ALL, NotificationManager.INTERRUPTION_FILTER_NONE, NotificationManager.INTERRUPTION_FILTER_PRIORITY, NotificationManager.INTERRUPTION_FILTER_UNKNOWN. @see NotificationManager for more details.