EditorState

Artifact: androidx.wear.watchface:watchface-client

Added in 1.0.0

Kotlin |Java

class EditorState

The state of the editing session. See androidx.wear.watchface.editor.EditorSession.

use Watch Face Format instead

Summary

Public functions
`open operator Boolean`	`equals(other: Any?)` 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.

Public properties
`Map<Int, ComplicationData>`	`previewComplicationsData` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Bitmap?`	`previewImage` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Boolean`	`shouldCommitChanges` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`UserStyleData`	`userStyle` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`WatchFaceId`	`watchFaceId` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

previewComplicationsData

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val previewComplicationsData: Map<Int, ComplicationData>

Preview ComplicationData needed for taking screenshots without live complication data.

previewImage

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val previewImage: Bitmap?

If non-null this Bitmap contains a preview image of the watch face rendered with the final style and complications and the androidx.wear.watchface.editor.PreviewScreenshotParams specified in the androidx.wear.watchface.editor.EditorRequest. If shouldCommitChanges is false then this will also be null (see implementation of androidx.wear.watchface.editor.EditorSession.close).

shouldCommitChanges

Added in 1.2.0

Deprecated in 1.3.0-alpha07

val shouldCommitChanges: Boolean

Whether or not this state should be committed (i.e. the user aborted the session). If it's not committed then any changes (E.g. complication data source changes) should be abandoned. There's no need to resend the style to the watchface because the library will have restored the previous style.

userStyle

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val userStyle: UserStyleData

The current UserStyle encoded as a UserStyleData.

watchFaceId

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val watchFaceId: WatchFaceId

The system's watch face instance ID. See WatchFaceId for details.