# 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 />

```
public final 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/androidx/wear/watchface/ComplicationSlot`'s initial config (as specified in it's constructor) when the setting is selected.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/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/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int))( int complicationSlotId, https://developer.android.com/reference/java/lang/Boolean.html enabled, https://developer.android.com/reference/androidx/wear/watchface/complications/ComplicationSlotBounds complicationSlotBounds, https://developer.android.com/reference/java/lang/Integer.html accessibilityTraversalIndex )` **This method is deprecated.** This constructor is deprecated in favour of the one that specifies optional parameters nameResourceId and screenReaderNameResourceId |
| `[ComplicationSlotOverlay](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#ComplicationSlotOverlay(kotlin.Int,kotlin.Boolean,androidx.wear.watchface.complications.ComplicationSlotBounds,kotlin.Int,kotlin.Int,kotlin.Int))( int complicationSlotId, https://developer.android.com/reference/java/lang/Boolean.html enabled, https://developer.android.com/reference/androidx/wear/watchface/complications/ComplicationSlotBounds complicationSlotBounds, https://developer.android.com/reference/java/lang/Integer.html accessibilityTraversalIndex, https://developer.android.com/reference/java/lang/Integer.html nameResourceId, https://developer.android.com/reference/java/lang/Integer.html screenReaderNameResourceId )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `boolean` | `[equals](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#equals(kotlin.Any))(https://developer.android.com/reference/java/lang/Object.html other)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/java/lang/Integer.html` | `[getAccessibilityTraversalIndex](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getAccessibilityTraversalIndex())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/androidx/wear/watchface/complications/ComplicationSlotBounds` | `[getComplicationSlotBounds](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getComplicationSlotBounds())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final int` | `[getComplicationSlotId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getComplicationSlotId())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/java/lang/Integer.html` | `[getNameResourceId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getNameResourceId())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/java/lang/Integer.html` | `[getScreenReaderNameResourceId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getScreenReaderNameResourceId())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `int` | `[hashCode](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#hashCode())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/java/lang/Boolean.html` | `[isEnabled](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#isEnabled())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `[toString](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#toString())()` **This method 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)

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

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

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

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

| Parameters |
|---|---|
| `int complicationSlotId` | The id of the `https://developer.android.com/reference/androidx/wear/watchface/ComplicationSlot` to configure. |
| `https://developer.android.com/reference/java/lang/Boolean.html enabled` | If non null, whether the complication should be enabled for this configuration. If null then no changes are made. |
| `https://developer.android.com/reference/androidx/wear/watchface/complications/ComplicationSlotBounds complicationSlotBounds` | If non null, the `https://developer.android.com/reference/androidx/wear/watchface/complications/ComplicationSlotBounds` for this configuration. If null then no changes are made. |
| `https://developer.android.com/reference/java/lang/Integer.html accessibilityTraversalIndex` | 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. |
| `https://developer.android.com/reference/java/lang/Integer.html nameResourceId` | 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. |
| `https://developer.android.com/reference/java/lang/Integer.html screenReaderNameResourceId` | 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/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 methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#equals(kotlin.Any))(Object other)
```

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

### getAccessibilityTraversalIndex

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)

```
public final Integer [getAccessibilityTraversalIndex](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getAccessibilityTraversalIndex())()
```

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

### getComplicationSlotBounds

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)

```
public final ComplicationSlotBounds [getComplicationSlotBounds](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getComplicationSlotBounds())()
```

> [!CAUTION]
> **This method 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/androidx/wear/watchface/complications/ComplicationSlotBounds` for this configuration. If null then no changes are made.

### getComplicationSlotId

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)

```
public final int [getComplicationSlotId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getComplicationSlotId())()
```

> [!CAUTION]
> **This method 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/androidx/wear/watchface/ComplicationSlot` to configure.

### getNameResourceId

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)

```
public final Integer [getNameResourceId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getNameResourceId())()
```

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

### getScreenReaderNameResourceId

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)

```
public final Integer [getScreenReaderNameResourceId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#getScreenReaderNameResourceId())()
```

> [!CAUTION]
> **This method 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/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'.

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#hashCode())()
```

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

### isEnabled

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)

```
public final Boolean [isEnabled](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#isEnabled())()
```

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

### toString

```
public @NonNull String [toString](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay#toString())()
```

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