UserStyleSetting.LargeCustomValueUserStyleSetting

@RequiresApi(value = 33)
class UserStyleSetting.LargeCustomValueUserStyleSetting : UserStyleSetting

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

An application specific style setting which supports a larger maximum size than CustomValueUserStyleSetting. This style is ignored by the system editor. This is expected to be used in conjunction with an on watch face editor. Only a single ComplicationSlotsUserStyleSetting or LargeCustomValueUserStyleSetting is permitted in the UserStyleSchema.

The CustomValueOption can store at most Option.Id.MAX_LENGTH bytes.

Summary

Nested types

This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors
LargeCustomValueUserStyleSetting(
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: ByteArray
)

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions
open UserStyleSetting.Option

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 Int

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
open String

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Inherited properties
From androidx.wear.watchface.style.UserStyleSetting
Collection<WatchFaceLayer>

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.Option

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
Int

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
CharSequence

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
CharSequence

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
Icon?

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.Id

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
List<UserStyleSetting.Option>

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
UserStyleSetting.WatchFaceEditorData?

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

LargeCustomValueUserStyleSetting

LargeCustomValueUserStyleSetting(
    affectsWatchFaceLayers: Collection<WatchFaceLayer>,
    defaultValue: ByteArray
)

Constructs a LargeCustomValueUserStyleSetting.

Parameters
affectsWatchFaceLayers: Collection<WatchFaceLayer>

Used by the style configuration UI. Describes which watch face rendering layers this style affects.
defaultValue: ByteArray

The default value ByteArray.

Public functions

getOptionForId

open fun getOptionForId(optionId: UserStyleSetting.Option.Id): UserStyleSetting.Option

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
optionId: UserStyleSetting.Option.Id

The Option.Id of the option
Returns
UserStyleSetting.Option

An Option corresponding to the name. This could either be one of the options from UserStyleSettings 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.