UserStyleSetting.Option

Artifact: androidx.wear.watchface:watchface-style

View Source

Added in 1.0.0

Deprecated in 1.3.0-alpha07

---

Kotlin |Java

abstract class UserStyleSetting.Option

Known direct subclasses

UserStyleSetting.BooleanUserStyleSetting.BooleanOption, UserStyleSetting.ColorUserStyleSetting.ColorOption, UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption, UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption, UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption, UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption, UserStyleSetting.ListUserStyleSetting.ListOption, UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

UserStyleSetting.BooleanUserStyleSetting.BooleanOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.ColorUserStyleSetting.ColorOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.ListUserStyleSetting.ListOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption	This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

---

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

Represents a choice within a style setting which can either be an option from the list or a an arbitrary value depending on the nature of the style setting.

Summary

Nested types
class UserStyleSetting.Option.Id This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors
Option(id: UserStyleSetting.Option.Id) This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions
open operator Boolean	equals(other: Any?) This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
open Int	hashCode() This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
open String	toString() This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public properties
Collection<UserStyleSetting>	childSettings This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.Option.Id	id This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

Option

Added in 1.0.0

Deprecated in 1.3.0-alpha07

Option(id: UserStyleSetting.Option.Id)

This function is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

This constructor is unused (the parent class is sealed), but is required to make tooling happy.

Public functions

equals

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

This function is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

hashCode

open fun hashCode(): Int

This function is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

toString

open fun toString(): String

This function is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Public properties

childSettings

Added in 1.1.0

Deprecated in 1.3.0-alpha07

val childSettings: Collection<UserStyleSetting>

This property is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings. These must be in UserStyleSchema.userStyleSettings. Child UserStyleSettings are deemed to be active if the Option is selected by the UserStyle. This is particularly important is there are multiple ComplicationSlotsUserStyleSettings, only one of which is allowed to be active at any time.

id

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val id: UserStyleSetting.Option.Id

This property is deprecated.
AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

Machine readable Id for the style setting. Identifier for the option (or the option itself for CustomValueUserStyleSetting.CustomValueOption), must be unique within the UserStyleSetting. Short ids are encouraged.