# UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption

Artifact: [androidx.wear.watchface:watchface-style](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/style/UserStyleSetting.kt+class:androidx.wear.watchface.style.UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption "View this page in Java")


```
class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption : UserStyleSetting.Option
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) ||
|   | ↳ | [androidx.wear.watchface.style.UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption) |

*** ** * ** ***

> [!CAUTION]
> **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 an override to the initial `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlotsManager` configuration.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public constructors |
|---|
| `[ComplicationSlotsOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#ComplicationSlotsOption(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData))( id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id, resources: https://developer.android.com/reference/android/content/res/Resources.html, displayNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html?, complicationSlotOverlays: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>, watchFaceEditorData: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData? )` **This function is deprecated.** Use the Builder instead |
| `[ComplicationSlotsOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#ComplicationSlotsOption(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData))( id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id, resources: https://developer.android.com/reference/android/content/res/Resources.html, displayNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, screenReaderNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html?, complicationSlotOverlays: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>, watchFaceEditorData: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData? )` **This function is deprecated.** Use the Builder instead |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#complicationSlotOverlays()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#displayName()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/android/graphics/drawable/Icon.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#icon()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#screenReaderName()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#watchFaceEditorData()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Inherited functions |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) |---|---| | `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#equals(kotlin.Any))(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#hashCode())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `[toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#toString())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

| ### Inherited properties |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option) |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#childSettings()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option#id()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

## Public constructors

### ComplicationSlotsOption

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0)

```
[ComplicationSlotsOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#ComplicationSlotsOption(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData))(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)
```

> [!CAUTION]
> **This function is deprecated.**   
> Use the Builder instead

Constructs a ComplicationSlotsOption with `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#displayName()` constructed from Resources.

| Parameters |
|---|---|
| `id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` for the element, must be unique. |
| `resources: https://developer.android.com/reference/android/content/res/Resources.html` | The `https://developer.android.com/reference/android/content/res/Resources.html` from which `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData)` is load. |
| `displayNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | String resource id for a human readable name for the element, used in the userStyle selection UI. This should be short, ideally \< 20 characters. Note if the resource string contains `%1$s` that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions. |
| `icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html?` | `https://developer.android.com/reference/android/graphics/drawable/Icon.html` for use in the companion style selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size). |
| `complicationSlotOverlays: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>` | Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration. |
| `watchFaceEditorData: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData? = null` | Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor. |

### ComplicationSlotsOption

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
[ComplicationSlotsOption](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#ComplicationSlotsOption(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData))(
    id: UserStyleSetting.Option.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    screenReaderNameResourceId: @StringRes Int,
    icon: Icon?,
    complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)
```

> [!CAUTION]
> **This function is deprecated.**   
> Use the Builder instead

Constructs a ComplicationSlotsUserStyleSetting with `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#displayName()` constructed from Resources.

| Parameters |
|---|---|
| `id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id` for the element, must be unique. |
| `resources: https://developer.android.com/reference/android/content/res/Resources.html` | The `https://developer.android.com/reference/android/content/res/Resources.html` from which `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData)` is load. |
| `displayNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | String resource id for a human readable name for the element, used in the userStyle selection UI. This should be short, ideally \< 20 characters. Note if the resource string contains `%1$s` that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions. |
| `screenReaderNameResourceId: @https://developer.android.com/reference/kotlin/androidx/annotation/StringRes https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | String resource id for a human readable name for the element, used by screen readers. This should be more descriptive than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#(androidx.wear.watchface.style.UserStyleSetting.Option.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData)`. Note if the resource string contains `%1$s` that will get replaced with the 1-based ordinal (1st, 2nd, 3rd etc...) of the ComplicationSlotsOption in the list of ComplicationSlotsOptions. Note prior to android T this is ignored by companion editors. |
| `icon: https://developer.android.com/reference/android/graphics/drawable/Icon.html?` | `https://developer.android.com/reference/android/graphics/drawable/Icon.html` for use in the companion style selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size). |
| `complicationSlotOverlays: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>` | Overlays to be applied when this ComplicationSlotsOption is selected. If this is empty then the net result is the initial complication configuration. |
| `watchFaceEditorData: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData? = null` | Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor. |

## Public properties

### complicationSlotOverlays

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val complicationSlotOverlays: Collection<UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay>
```

> [!CAUTION]
> **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

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

### displayName

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val displayName: CharSequence
```

> [!CAUTION]
> **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

Localized human readable name for the setting, used in the editor style selection UI. This should be short (ideally \< 20 characters).

### icon

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val icon: Icon?
```

> [!CAUTION]
> **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

Icon for use in the companion style selection UI.

### screenReaderName

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.2.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val screenReaderName: CharSequence?
```

> [!CAUTION]
> **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

Optional localized human readable name for the setting, used by screen readers. This should be more descriptive than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption#displayName()`. Note prior to android T this is ignored by companion editors.

### watchFaceEditorData

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.1.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val watchFaceEditorData: UserStyleSetting.WatchFaceEditorData?
```

> [!CAUTION]
> **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

Optional data for an on watch face editor, this will not be sent to the companion and its contents may be used in preference to other fields by an on watch face editor.