UserStyleSetting.Option

abstract class UserStyleSetting.Option

Known direct subclasses
UserStyleSetting.BooleanUserStyleSetting.BooleanOption

Represents a true or false option in the BooleanUserStyleSetting.
UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption

Represents an override to the initial androidx.wear.watchface.ComplicationSlotsManager configuration.
UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption

An application specific custom value.
UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption

Represents an option as a Double in the range minimumValue .. maximumValue.
UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption

An application specific custom value.
UserStyleSetting.ListUserStyleSetting.ListOption

Represents choice within a ListUserStyleSetting, these must be enumerated up front.
UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

Represents an option a Long in the range minimumValue .. maximumValue.

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

Machine readable identifier for Options.

Public constructors

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

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

Public properties
Collection<UserStyleSetting>

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings.
UserStyleSetting.Option.Id

Machine readable Id for the style setting.

Public constructors

Option

Added in 1.0.0
Option(id: UserStyleSetting.Option.Id)

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

childSettings

Added in 1.1.0
val childSettings: Collection<UserStyleSetting>

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
val id: UserStyleSetting.Option.Id

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.