# UserStyleSetting

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) 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 sealed class UserStyleSetting
```

<br />

Known direct subclasses [UserStyleSetting.BooleanUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting), [UserStyleSetting.ColorUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting), [UserStyleSetting.ComplicationSlotsUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting), [UserStyleSetting.CustomValueUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.CustomValueUserStyleSetting), [UserStyleSetting.DoubleRangeUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.DoubleRangeUserStyleSetting), [UserStyleSetting.LargeCustomValueUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting), [UserStyleSetting.ListUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting), [UserStyleSetting.LongRangeUserStyleSetting](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LongRangeUserStyleSetting)

|---|---|
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.CustomValueUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.DoubleRangeUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LongRangeUserStyleSetting` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

*** ** * ** ***

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

Watch faces often have user configurable styles, the definition of what is a style is left up to the watch face but it typically incorporates a variety of settings such as: color, visual theme for watch hands, font, tick shape, complication slots, audio elements, etc...

A UserStyleSetting represents one of these dimensions. See also `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSchema` which defines the list of UserStyleSettings provided by the watch face.

Styling data gets shared with the companion phone to support editors (typically over bluetooth), as a result the size of serialized UserStyleSettings could become an issue if large.

It is possible to define a hierarchy of styles, (e.g. a watch face might have support a number of different looks, each with their own settings). A hierarchy is defined by setting child styles in `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option#childSettings()`. A setting is deemed to be active if it's either in the top level of the tree, or if it's the child of an `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` selected by the user in the `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyle`. In a hierarchy multiple `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting` are allowed but only one can be active at any time, for more details see `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSchema#findComplicationSlotsOptionForUserStyle(androidx.wear.watchface.style.UserStyle)`.

use Watch Face Format instead

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting.BooleanOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 34) public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 34) public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ColorUserStyleSetting.ColorOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `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 final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotOverlay` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `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 final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ComplicationSlotsUserStyleSetting.ComplicationSlotsOption.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.CustomValueUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.CustomValueUserStyleSetting.CustomValueOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.DoubleRangeUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.DoubleRangeUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.DoubleRangeUserStyleSetting.DoubleRangeOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Id` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 33) public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting.ListOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.ListUserStyleSetting.ListOption.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LongRangeUserStyleSetting extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LongRangeUserStyleSetting.Builder` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.LongRangeUserStyleSetting.LongRangeOption extends https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public abstract class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option.Id` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `public final class https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData` **This class 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#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/WatchFaceLayer>` | `[getAffectedWatchFaceLayers](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getAffectedWatchFaceLayers())()` **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` | `[getDefaultOption](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDefaultOption())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final int` | `[getDefaultOptionIndex](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDefaultOptionIndex())()` **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` | `[getDescription](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDescription())()` **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#getDisplayName())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final https://developer.android.com/reference/android/graphics/drawable/Icon.html` | `[getIcon](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getIcon())()` **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.Id` | `[getId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getId())()` **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/androidx/wear/watchface/style/UserStyleSetting.Option` | `[getOptionForId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getOptionForId(androidx.wear.watchface.style.UserStyleSetting.Option.Id))(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option.Id optionId)` **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/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option>` | `[getOptions](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getOptions())()` **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#getWatchFaceEditorData())()` **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#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#toString())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#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

### getAffectedWatchFaceLayers

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 @NonNull Collection<@NonNull WatchFaceLayer> [getAffectedWatchFaceLayers](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getAffectedWatchFaceLayers())()
```

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

Used by the style configuration UI. Describes which rendering layers this style affects.

### getDefaultOption

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 @NonNull UserStyleSetting.Option [getDefaultOption](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDefaultOption())()
```

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

Returns the default for when the user hasn't selected an option.

### getDefaultOptionIndex

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 [getDefaultOptionIndex](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDefaultOptionIndex())()
```

> [!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 default option index, used if nothing has been selected within the `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#options()` list.

### getDescription

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 @NonNull CharSequence [getDescription](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getDescription())()
```

> [!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 description string displayed under the displayName.

### getDisplayName

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 @NonNull CharSequence [getDisplayName](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#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 element, used in the userStyle selection UI.

### getIcon

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 Icon [getIcon](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getIcon())()
```

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

`https://developer.android.com/reference/android/graphics/drawable/Icon.html` for use in the companion editor style selection UI.

### getId

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 @NonNull UserStyleSetting.Id [getId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getId())()
```

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

Identifier for the element, must be unique. Styling data gets shared with the companion (typically via bluetooth) so size is a consideration and short ids are encouraged. There is a maximum length see `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Id#MAX_LENGTH()`.

### getOptionForId

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 @NonNull UserStyleSetting.Option [getOptionForId](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getOptionForId(androidx.wear.watchface.style.UserStyleSetting.Option.Id))(@NonNull UserStyleSetting.Option.Id optionId)
```

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

Translates an option name into an option. This will need to be overridden for userStyle categories that can't sensibly be fully enumerated (e.g. a full 24-bit color picker).

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option.Id optionId` | The `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option.Id` of the option |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` | An `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting.Option` corresponding to the name. This could either be one of the options from `https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting`s or a newly constructed Option depending on the nature of the UserStyleSetting. If optionName is unrecognized then the default value for the setting should be returned. |

### getOptions

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 @NonNull List<@NonNull UserStyleSetting.Option> [getOptions](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#getOptions())()
```

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

List of options for this UserStyleSetting. Depending on the type of UserStyleSetting this may be an exhaustive list, or just examples to populate a ListView in case the UserStyleSetting isn't supported by the UI (e.g. a new WatchFace with an old companion).

### getWatchFaceEditorData

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)

```
public final UserStyleSetting.WatchFaceEditorData [getWatchFaceEditorData](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#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.

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#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

### toString

```
public @NonNull String [toString](https://developer.android.com/reference/androidx/wear/watchface/style/UserStyleSetting#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