Google is committed to advancing racial equity for Black communities. See how.

ComplicationsOption

class ComplicationsOption : UserStyleSetting.Option
kotlin.Any
   ↳ androidx.wear.watchface.style.UserStyleSetting.Option
   ↳ androidx.wear.watchface.style.UserStyleSetting.ComplicationsUserStyleSetting.ComplicationsOption

Represents an override to the initial complication configuration.

Summary

Public constructors

Public methods
ComplicationsOptionWireFormat

Properties
Collection<UserStyleSetting.ComplicationsUserStyleSetting.ComplicationOverlay>

Overlays to be applied when this ComplicationsOption is selected.

CharSequence

Localized human readable name for the setting, used in the style selection UI.

Icon?

Icon for use in the style selection UI.

Inherited properties

Public constructors

<init>

ComplicationsOption(
    id: String,
    displayName: CharSequence,
    icon: Icon?,
    complicationOverlays: Collection<UserStyleSetting.ComplicationsUserStyleSetting.ComplicationOverlay>)

Public methods

toWireFormat

fun toWireFormat(): ComplicationsOptionWireFormat

Properties

complicationOverlays

val complicationOverlays: Collection<UserStyleSetting.ComplicationsUserStyleSetting.ComplicationOverlay>

Overlays to be applied when this ComplicationsOption is selected. If this is empty then the net result is the initial complication configuration.

displayName

val displayName: CharSequence

Localized human readable name for the setting, used in the style selection UI.

icon

val icon: Icon?

Icon for use in the style selection UI.