# UserStyleSetting.BooleanUserStyleSetting

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.BooleanUserStyleSetting) 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.BooleanUserStyleSetting "View this page in Java")


```
class UserStyleSetting.BooleanUserStyleSetting : UserStyleSetting
```

<br />

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

*** ** * ** ***

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

A BooleanUserStyleSetting represents a setting with a true and a false setting.

## Summary

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

| ### Public constructors |
|---|
| `[BooleanUserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting#BooleanUserStyleSetting(androidx.wear.watchface.style.UserStyleSetting.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,kotlin.Boolean,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData))( id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.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, descriptionResourceId: @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?, affectsWatchFaceLayers: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>, defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, watchFaceEditorData: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.WatchFaceEditorData? )` **This function is deprecated.** Use the Builder instead |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[getDefaultValue](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting#getDefaultValue())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Inherited functions |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting) |---|---| | `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#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://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option` | `[getOptionForId](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#getOptionForId(androidx.wear.watchface.style.UserStyleSetting.Option.Id))(optionId: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option.Id)` **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#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#toString())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

| ### Inherited properties |
|---|
| From [androidx.wear.watchface.style.UserStyleSetting](https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting) |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#affectedWatchFaceLayers()` **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` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#defaultOption()` **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#defaultOptionIndex()` **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#description()` **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#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#icon()` **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.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#id()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Option>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#options()` **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#watchFaceEditorData()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. | |

## Public constructors

### BooleanUserStyleSetting

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

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

Constructs a BooleanUserStyleSetting where `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#displayName()` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting#description()` are specified as resources.

| Parameters |
|---|---|
| `id: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.Id` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.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.BooleanUserStyleSetting#(androidx.wear.watchface.style.UserStyleSetting.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,kotlin.Boolean,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData)` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSetting.BooleanUserStyleSetting#(androidx.wear.watchface.style.UserStyleSetting.Id,android.content.res.Resources,kotlin.Int,kotlin.Int,android.graphics.drawable.Icon,kotlin.collections.Collection,kotlin.Boolean,androidx.wear.watchface.style.UserStyleSetting.WatchFaceEditorData)` are loaded. |
| `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. |
| `descriptionResourceId: @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 description string displayed under the displayName. |
| `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 userStyle selection UI. This gets sent to the companion over bluetooth and should be small (ideally a few kb in size). |
| `affectsWatchFaceLayers: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/WatchFaceLayer>` | Used by the style configuration UI. Describes which watch face rendering layers this style affects. |
| `defaultValue: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | The default value for this BooleanUserStyleSetting. |
| `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 functions

### getDefaultValue

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)

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

Returns the default value.