# UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay

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.ComplicationSlotOverlay) 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)

*** ** * ** ***

<br />

```
class UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay
```

<br />

*** ** * ** ***

> [!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

Overrides to be applied to the corresponding `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot`'s initial config (as specified in it's constructor) when the setting is selected.

## Summary

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

| ### Public constructors |
|---|
| `[ComplicationSlotOverlay](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int))( complicationSlotId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html?, complicationSlotBounds: https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds?, accessibilityTraversalIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html? )` **This function is deprecated.** This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId |
| `[ComplicationSlotOverlay](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int,kotlin.Int,kotlin.Int))( complicationSlotId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html?, complicationSlotBounds: https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds?, accessibilityTraversalIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?, nameResourceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?, screenReaderNameResourceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html? )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public functions |
|---|---|
| `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.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#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.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#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.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#toString())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#accessibilityTraversalIndex()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#complicationSlotBounds()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#complicationSlotId()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#enabled()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#nameResourceId()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html?` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#screenReaderNameResourceId()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### ComplicationSlotOverlay

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

```
[ComplicationSlotOverlay](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int))(
    complicationSlotId: Int,
    enabled: Boolean? = null,
    complicationSlotBounds: ComplicationSlotBounds? = null,
    accessibilityTraversalIndex: Int? = null
)
```

> [!CAUTION]
> **This function is deprecated.**   
> This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId

This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId ComplicationSlotOverlay(Int, Boolean?, ComplicationSlotBounds?, Int?, Int?, Int?

### ComplicationSlotOverlay

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)

```
[ComplicationSlotOverlay](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int,kotlin.Int,kotlin.Int))(
    complicationSlotId: Int,
    enabled: Boolean? = null,
    complicationSlotBounds: ComplicationSlotBounds? = null,
    accessibilityTraversalIndex: Int? = null,
    nameResourceId: Int? = null,
    screenReaderNameResourceId: Int? = null
)
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

| Parameters |
|---|---|
| `complicationSlotId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The id of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` to configure. |
| `enabled: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html? = null` | If non null, whether the complication should be enabled for this configuration. If null then no changes are made. |
| `complicationSlotBounds: https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds? = null` | If non null, the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds` for this configuration. If null then no changes are made. |
| `accessibilityTraversalIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html? = null` | If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user. |
| `nameResourceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html? = null` | If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing. |
| `screenReaderNameResourceId: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html? = null` | If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#nameResourceId()` this string can be longer and should be more descriptive. E.g. saying 'left complication' rather than just 'left'. |

## Public functions

### equals

```
open operator fun [equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#equals(kotlin.Any))(other: Any?): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

### hashCode

```
open fun [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#hashCode())(): Int
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

### toString

```
open fun [toString](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#toString())(): String
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

## Public properties

### accessibilityTraversalIndex

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 accessibilityTraversalIndex: Int?
```

> [!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

If non null the accessibility traversal index for this configuration. This is used to determine the order in which accessibility labels for the watch face are read to the user.

### complicationSlotBounds

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 complicationSlotBounds: ComplicationSlotBounds?
```

> [!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

If non null, the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/complications/ComplicationSlotBounds` for this configuration. If null then no changes are made.

### complicationSlotId

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 complicationSlotId: Int
```

> [!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

The id of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot` to configure.

### enabled

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 enabled: Boolean?
```

> [!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

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

### nameResourceId

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 nameResourceId: Int?
```

> [!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

If non null, the string resource identifier for name of the complication slot, for this configuration. These strings should be short (perhaps 10 characters max) E.g. complication slots named 'left' and 'right' might be shown by the editor in a list from which the user selects a complication slot for editing.

### screenReaderNameResourceId

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 screenReaderNameResourceId: Int?
```

> [!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

If non null, the string resource identifier for the screen reader name of the complication slot, for this configuration. While similar to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#nameResourceId()` this string can be longer and should be more descriptive. E.g. saying 'left complication' rather than just 'left'.