UserStyleSetting.ColorUserStyleSetting.Builder

Artifact: androidx.wear.watchface:watchface-style

Kotlin |Java

class UserStyleSetting.ColorUserStyleSetting.Builder

A Builder for ColorUserStyleSetting.

Summary

Public functions
`UserStyleSetting.ColorUserStyleSetting`	`build()` Constructs the `ColorUserStyleSetting`.
`UserStyleSetting.ColorUserStyleSetting.Builder`	`setDefaultOption( defaultOption: UserStyleSetting.ColorUserStyleSetting.ColorOption )` Sets the default option.
`UserStyleSetting.ColorUserStyleSetting.Builder`	`setIcon(icon: Icon)` Sets an `Icon` for use in the companion userStyle selection UI.
`UserStyleSetting.ColorUserStyleSetting.Builder`	`setIcon(iconProvider: () -> Icon?)` Sets a provider of an `Icon` for use in the companion userStyle selection UI.
`UserStyleSetting.ColorUserStyleSetting.Builder`	`setWatchFaceEditorData( watchFaceEditorData: UserStyleSetting.WatchFaceEditorData )` Sets 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

build

Added in 1.3.0-alpha05

fun build(): UserStyleSetting.ColorUserStyleSetting

Constructs the ColorUserStyleSetting.

setDefaultOption

Added in 1.3.0-alpha05

fun setDefaultOption(
    defaultOption: UserStyleSetting.ColorUserStyleSetting.ColorOption
): UserStyleSetting.ColorUserStyleSetting.Builder

Sets the default option. If not specified, the default will be the first element of options.

Parameters
`defaultOption: UserStyleSetting.ColorUserStyleSetting.ColorOption`	The default option, used when data isn't persisted.

setIcon

Added in 1.3.0-alpha05

fun setIcon(icon: Icon): UserStyleSetting.ColorUserStyleSetting.Builder

Sets an 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).

setIcon

Added in 1.3.0-alpha05

fun setIcon(iconProvider: () -> Icon?): UserStyleSetting.ColorUserStyleSetting.Builder

Sets a provider of an Icon for use in the companion userStyle selection UI. This gets lazily evaluated and is sent to the companion over bluetooth and should be small (ideally a few kb in size). Note this is not guaranteed to be called on the calling thread. Note it will be called shortly after watch face initialization completes.

setWatchFaceEditorData

Added in 1.3.0-alpha05

fun setWatchFaceEditorData(
    watchFaceEditorData: UserStyleSetting.WatchFaceEditorData
): UserStyleSetting.ColorUserStyleSetting.Builder

Sets 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.