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

ComplicationOverlay

class ComplicationOverlay
kotlin.Any
   ↳ androidx.wear.watchface.style.UserStyleSetting.ComplicationsUserStyleSetting.ComplicationOverlay

Overrides to be applied to the corresponding complication's initial config (as specified in androidx.wear.watchface.Complication) when the setting is selected.

Summary

Nested classes

Public constructors
<init>(complicationId: Int, enabled: Boolean? = null, complicationBounds: ComplicationBounds? = null, supportedTypes: List<ComplicationType>? = null, defaultProviderPolicy: DefaultComplicationProviderPolicy? = null, defaultProviderType: ComplicationType? = null)

Overrides to be applied to the corresponding complication's initial config (as specified in androidx.wear.watchface.Complication) when the setting is selected.

Properties
ComplicationBounds?

If non null, the new ComplicationBounds for this configuration.

Int

The id of the complication to configure.

DefaultComplicationProviderPolicy?

If non null, the new default complication provider for this configuration.

ComplicationType?

If non null, the new default complication provider data type.

Boolean?

If non null, whether the complication should be enabled for this configuration.

List<ComplicationType>?

If non null, the new types of complication supported by this complication for this configuration.

Public constructors

<init>

ComplicationOverlay(
    complicationId: Int,
    enabled: Boolean? = null,
    complicationBounds: ComplicationBounds? = null,
    supportedTypes: List<ComplicationType>? = null,
    defaultProviderPolicy: DefaultComplicationProviderPolicy? = null,
    defaultProviderType: ComplicationType? = null)

Overrides to be applied to the corresponding complication's initial config (as specified in androidx.wear.watchface.Complication) when the setting is selected.

Properties

complicationBounds

val complicationBounds: ComplicationBounds?

If non null, the new ComplicationBounds for this configuration. If null then no changes are made.

complicationId

val complicationId: Int

The id of the complication to configure.

defaultProviderPolicy

val defaultProviderPolicy: DefaultComplicationProviderPolicy?

If non null, the new default complication provider for this configuration. If null then no changes are made.

defaultProviderType

val defaultProviderType: ComplicationType?

If non null, the new default complication provider data type. If null then no changes are made.

enabled

val enabled: Boolean?

If non null, whether the complication should be enabled for this configuration. If null then no changes are made.

supportedTypes

val supportedTypes: List<ComplicationType>?

If non null, the new types of complication supported by this complication for this configuration. If null then no changes are made.