EditorState

Artifact: androidx.wear.watchface:watchface-client

View Source

Added in 1.0.0

---

Kotlin |Java

class EditorState

---

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

Summary

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
Map<Int, ComplicationData>	previewComplicationsData Preview ComplicationData needed for taking screenshots without live complication data.
Bitmap?	previewImage 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.
Boolean	shouldCommitChanges Whether or not this state should be committed (i.e. the user aborted the session).
UserStyleData	userStyle The current UserStyle encoded as a UserStyleData.
WatchFaceId	watchFaceId The system's watch face instance ID.

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

val previewComplicationsData: Map<Int, ComplicationData>

Preview ComplicationData needed for taking screenshots without live complication data.

previewImage

Added in 1.0.0

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

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

val userStyle: UserStyleData

The current UserStyle encoded as a UserStyleData.

watchFaceId

Added in 1.0.0

val watchFaceId: WatchFaceId

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