Option

Kotlin |Java

abstract class Option

kotlin.Any
↳	androidx.wear.watchface.style.UserStyleSetting.Option

Known Direct Subclasses

UserStyleSetting.BooleanUserStyleSetting.BooleanOption, UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption, UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption, UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption, UserStyleSetting.ListUserStyleSetting.ListOption, UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption

UserStyleSetting.BooleanUserStyleSetting.BooleanOption	Represents a true or false option in the BooleanUserStyleSetting.
UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption	Represents an override to the initial complication configuration.
UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption	An application specific custom value.
UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption	Represents an option as a Double in the range minimumValue..maximumValue.
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

Public constructors
`<init>(id: String)` 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.

Public methods
UserStyleSetting.BooleanUserStyleSetting.BooleanOption?	`toBooleanOption()`
UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption?	`toComplicationsOption()`
UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption?	`toCustomValueOption()`
UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption?	`toDoubleRangeOption()`
UserStyleSetting.ListUserStyleSetting.ListOption?	`toListOption()`
UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption?	`toLongRangeOption()`
abstract OptionWireFormat	`toWireFormat()`

Companion functions
UserStyleSetting.Option	`createFromWireFormat(wireFormat: OptionWireFormat)`

Properties
String	`id` Identifier for the option (or the option itself for CustomValueUserStyleSetting.CustomValueOption), must be unique within the UserStyleSetting.

Companion properties
Int	`maxIdLength` Maximum length of the id field.

Public constructors

<init>

Option(id: String)

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.

Public methods

toBooleanOption

fun toBooleanOption(): UserStyleSetting.BooleanUserStyleSetting.BooleanOption?

toComplicationsOption

fun toComplicationsOption(): UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption?

toCustomValueOption

fun toCustomValueOption(): UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption?

toDoubleRangeOption

fun toDoubleRangeOption(): UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption?

toListOption

fun toListOption(): UserStyleSetting.ListUserStyleSetting.ListOption?

toLongRangeOption

fun toLongRangeOption(): UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption?

toWireFormat

abstract fun toWireFormat(): OptionWireFormat

Properties

id

val id: String

Identifier for the option (or the option itself for CustomValueUserStyleSetting.CustomValueOption), must be unique within the UserStyleSetting. Short ids are encouraged. There is a maximum length see maxIdLength.

Companion functions

createFromWireFormat

fun createFromWireFormat(wireFormat: OptionWireFormat): UserStyleSetting.Option

Companion properties

maxIdLength

val maxIdLength: Int

Maximum length of the id field.