# UserStyleSetting.ColorUserStyleSetting.ColorOption

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.ColorUserStyleSetting.ColorOption) Added in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***


```
@RequiresApi(value = 34)
public final class UserStyleSetting.ColorUserStyleSetting.ColorOption extends UserStyleSetting.Option
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option) ||
|   | ↳ | [androidx.wear.watchface.style.UserStyleSetting.ColorUserStyleSetting.ColorOption](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption) |

*** ** * ** ***

> [!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 choice within a `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting`, these must be enumerated up front.

## Summary

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

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html>` | `[getColors](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getColors())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/CharSequence.html` | `[getDisplayName](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getDisplayName())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/CharSequence.html` | `[getScreenReaderName](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getScreenReaderName())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData` | `[getWatchFaceEditorData](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getWatchFaceEditorData())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Inherited methods |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting.Option](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option) |---|---| | `boolean` | `[equals](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option#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/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Collection.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting>` | `[getChildSettings](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option#getChildSettings())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option.Id` | `[getId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option#getId())()` **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.Option#hashCode())()` **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.Option#toString())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

## Public methods

### getColors

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

```
public final @NonNull List<@NonNull Integer> [getColors](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getColors())()
```

> [!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 colors for this option. The colors should be listed in order of decreasing importance. The number of provided colors must be the same for all `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption`s in the list. The number of colors specified is up to the user, but 1 or 3 are common choices.

### getDisplayName

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

```
public final @NonNull CharSequence [getDisplayName](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getDisplayName())()
```

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

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

### getScreenReaderName

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

```
public final @NonNull CharSequence [getScreenReaderName](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getScreenReaderName())()
```

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

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

### getWatchFaceEditorData

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

```
public final UserStyleSetting.WatchFaceEditorData [getWatchFaceEditorData](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption#getWatchFaceEditorData())()
```

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

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.