UserStyleSetting.BooleanUserStyleSetting

Artifact: androidx.wear.watchface:watchface-style

View Source

Added in 1.0.0

Deprecated in 1.3.0-alpha07

---

Kotlin |Java

class UserStyleSetting.BooleanUserStyleSetting : UserStyleSetting

kotlin.Any
↳	androidx.wear.watchface.style.UserStyleSetting
	↳	androidx.wear.watchface.style.UserStyleSetting.BooleanUserStyleSetting

---

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 UserStyleSetting.BooleanUserStyleSetting.BooleanOption : UserStyleSetting.Option This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
class UserStyleSetting.BooleanUserStyleSetting.Builder This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors
BooleanUserStyleSetting(     id: UserStyleSetting.Id,     resources: Resources,     displayNameResourceId: @StringRes Int,     descriptionResourceId: @StringRes Int,     icon: Icon?,     affectsWatchFaceLayers: Collection<WatchFaceLayer>,     defaultValue: Boolean,     watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? ) This function is deprecated. Use the Builder instead

Public functions
Boolean	getDefaultValue() This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Inherited functions

From androidx.wear.watchface.style.UserStyleSetting open operator Boolean equals(other: Any?) This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. open UserStyleSetting.Option getOptionForId(optionId: UserStyleSetting.Option.Id) This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. open Int hashCode() This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. open String toString() This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Inherited properties

From androidx.wear.watchface.style.UserStyleSetting Collection<WatchFaceLayer> affectedWatchFaceLayers This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. UserStyleSetting.Option defaultOption This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. Int defaultOptionIndex This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. CharSequence description This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. CharSequence displayName This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. Icon? icon This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. UserStyleSetting.Id id This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. List<UserStyleSetting.Option> options This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. UserStyleSetting.WatchFaceEditorData? watchFaceEditorData This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

BooleanUserStyleSetting

BooleanUserStyleSetting(
    id: UserStyleSetting.Id,
    resources: Resources,
    displayNameResourceId: @StringRes Int,
    descriptionResourceId: @StringRes Int,
    icon: Icon?,
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: Boolean,
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData? = null
)

This function is deprecated.
Use the Builder instead

Constructs a BooleanUserStyleSetting where BooleanUserStyleSetting.displayName and BooleanUserStyleSetting.description are specified as resources.

Parameters
id: UserStyleSetting.Id	Id for the element, must be unique.
resources: Resources	The Resources from which displayNameResourceId and descriptionResourceId are loaded.
displayNameResourceId: @StringRes Int	String resource id for a human readable name for the element, used in the userStyle selection UI.
descriptionResourceId: @StringRes Int	String resource id for a human readable description string displayed under the displayName.
icon: Icon?	Icon 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: Collection<WatchFaceLayer>	Used by the style configuration UI. Describes which watch face rendering layers this style affects.
defaultValue: Boolean	The default value for this BooleanUserStyleSetting.
watchFaceEditorData: 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

Deprecated in 1.3.0-alpha07

fun getDefaultValue(): Boolean

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.