EditorSession

Artifact: androidx.wear.watchface:watchface-editor

Added in 1.0.0

Kotlin |Java

interface EditorSession : AutoCloseable

Known direct subclasses

ListenableEditorSession

ListenableEditorSession

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

Interface for manipulating watch face state during a watch face editing session. The editor should adjust userStyle and call openComplicationDataSourceChooser to configure the watch face and call close when done. This reports the updated EditorState to the EditorListeners registered via EditorServiceClient.addListener.

For EditorSessions backed by a headless instance (see createHeadlessEditorSession and EditorRequest.headlessDeviceConfig), style changes are not applied to the interactive instance and it's up to the system to apply them. For EditorSessions backed by an interactive instance style changes are applied immediately. Its possible the system might fail to persist the style changes (e.g. to data base write failure or a crash) and if this happens it's the responsibility of the system to revert the style change.

use Watch Face Format instead

Summary

Public companion functions
`EditorSession`	`@RequiresApi(value = 27) @UiThread createHeadlessEditorSession( activity: ComponentActivity, editIntent: Intent, headlessWatchFaceClient: HeadlessWatchFaceClient )` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`suspend EditorSession`	`@UiThread createOnWatchEditorSession(activity: ComponentActivity)` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public companion properties
`Instant`	`DEFAULT_PREVIEW_INSTANT` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Duration`	`EDITING_SESSION_TIMEOUT` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions
`Int?`	`@UiThread getComplicationSlotIdAt(x: @Px Int, y: @Px Int)` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`suspend ChosenComplicationDataSource?`	`@UiThread openComplicationDataSourceChooser(complicationSlotId: Int)` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Bitmap`	`@UiThread renderWatchFaceToBitmap( renderParameters: RenderParameters, instant: Instant, slotIdToComplicationData: Map<Int, ComplicationData>? )` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`open Unit`	`setOverrideComplications( slotIdToComplicationData: Map<Int, ComplicationData> )` This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public properties
`Int?`	`backgroundComplicationSlotId` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Boolean`	`commitChangesOnClose` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`StateFlow<Map<Int, ComplicationSlotState>>`	`complicationSlotsState` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`StateFlow<Map<Int, ComplicationDataSourceInfo?>>`	`complicationsDataSourceInfo` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`StateFlow<Map<Int, ComplicationData>>`	`complicationsPreviewData` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`Instant`	`previewReferenceInstant` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`MutableStateFlow<UserStyle>`	`userStyle` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`UserStyleSchema`	`userStyleSchema` This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`ComponentName`	`watchFaceComponentName` 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.

Inherited functions

From java.lang.AutoCloseable

Unit

close()

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

Public companion functions

createHeadlessEditorSession

Added in 1.0.0

Deprecated in 1.3.0-alpha07

@RequiresApi(value = 27)
@UiThread
fun createHeadlessEditorSession(
    activity: ComponentActivity,
    editIntent: Intent,
    headlessWatchFaceClient: HeadlessWatchFaceClient
): EditorSession

Constructs an EditorSession for a remote watch face editor.

Caution the remote watchface must have been built with the same version of the watch face libraries.

Parameters
`activity: ComponentActivity`	The `ComponentActivity` associated with the EditorSession.
`editIntent: Intent`	The `Intent` sent by SysUI to launch the editing session.
`headlessWatchFaceClient: HeadlessWatchFaceClient`	The `HeadlessWatchFaceClient` to use for rendering etc...

Returns
`EditorSession`	The `EditorSession` or `null` if it could not be constructed.

createOnWatchEditorSession

@UiThread
suspend fun createOnWatchEditorSession(activity: ComponentActivity): EditorSession

Constructs an EditorSession for an on watch face editor. This registers an activity result handler and so it must be called during an Activity or Fragment initialization path. The EditorSession is lifecycle aware and will automatically close when onDestroy is received.

Parameters
`activity: ComponentActivity`	The `ComponentActivity` associated with the `EditorSession`.

Returns
`EditorSession`	Deferred which is resolved with either the `EditorSession` or `null` if it can't be constructed.

Throws
`kotlinx.coroutines.TimeoutCancellationException`	if it takes longer than `EDITING_SESSION_TIMEOUT` to create a watch face editor.

Public companion properties

DEFAULT_PREVIEW_INSTANT

val DEFAULT_PREVIEW_INSTANT: Instant

If passed renderWatchFaceToBitmap this will signal that the watch face's default preview time should be used.

EDITING_SESSION_TIMEOUT

val EDITING_SESSION_TIMEOUT: Duration

Timeout allowed for waiting for creating the watch face editing session.

Public functions

getComplicationSlotIdAt

Added in 1.0.0

Deprecated in 1.3.0-alpha07

@UiThread
fun getComplicationSlotIdAt(x: @Px Int, y: @Px Int): Int?

Returns the ID of the complication at the given coordinates or null if there isn't one. Only androidx.wear.watchface.ComplicationSlots with ComplicationSlotBoundsType.ROUND_RECT are supported by this function.

openComplicationDataSourceChooser

@UiThread
suspend fun openComplicationDataSourceChooser(complicationSlotId: Int): ChosenComplicationDataSource?

Opens the complication data source chooser and returns the chosen complication data source for the specified androidx.wear.watchface.ComplicationSlot.

The result returns null if the operation was cancelled and otherwise returned an instance of ChosenComplicationDataSource that contains information about the chosen data source.

Parameters
`complicationSlotId: Int`	The id of the `androidx.wear.watchface.ComplicationSlot` to select a complication data source for.

Throws
`kotlin.IllegalStateException`	if a previous invocation of openComplicationDataSourceChooser is still running when openComplicationDataSourceChooser is called.

renderWatchFaceToBitmap

@UiThread
fun renderWatchFaceToBitmap(
    renderParameters: RenderParameters,
    instant: Instant,
    slotIdToComplicationData: Map<Int, ComplicationData>?
): Bitmap

Renders the watch face to a Bitmap using the current userStyle.

Parameters
`renderParameters: RenderParameters`	The `RenderParameters` to render with. Must be `DrawMode.INTERACTIVE`
`instant: Instant`	The `Instant` to render with
`slotIdToComplicationData: Map<Int, ComplicationData>?`	Override `ComplicationData` for each `androidx.wear.watchface.ComplicationSlot` to render with. Note using this feature is somewhat computationally expensive because under the hood it saves and restores the backing watch face instance's complications. If you need to render multiple times with the same slotIdToComplicationData, consider using `renderWatchFaceToBitmap` for a more efficient alternative.

Returns
`Bitmap`	A `Bitmap` containing the screen shot with the specified parameters

setOverrideComplications

open fun setOverrideComplications(
    slotIdToComplicationData: Map<Int, ComplicationData>
): Unit

For the duration of the editor session, applies an override to complications rendered via renderWatchFaceToBitmap. If you need to render multiple times with the same slotIdToComplicationData it's more efficient to use this API and call renderWatchFaceToBitmap with null slotIdToComplicationData. When the editor session ends this override will be removed.

Note if after this call updated complications are sent via InteractiveWatchFaceClient.updateComplicationData, they will only be applied once the editor session has ended.

Parameters
`slotIdToComplicationData: Map<Int, ComplicationData>`	The complications you wish to set. Any slots not covered by this map will be unchanged.

Public properties

backgroundComplicationSlotId

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val backgroundComplicationSlotId: Int?

The ID of the background complication or null if there isn't one.

commitChangesOnClose

Added in 1.0.0

Deprecated in 1.3.0-alpha07

var commitChangesOnClose: Boolean

Whether any changes should be committed when the session is closed (defaults to true).

Note due to SysUI requirements EditorState can't reliably be sent in the activity result because there are circumstances where ComponentActivity.onStop doesn't get called but the UX requires us to commit changes.

Regardless of the value, on completion of the editor session, the original UserStyle is restored. Note we need SysUI's help to revert any complication data source changes. Caveat some complication data sources have their own config (e.g. the world clock has a timezone setting) and that config currently can't be reverted.

complicationSlotsState

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val complicationSlotsState: StateFlow<Map<Int, ComplicationSlotState>>

A Flow of a Map of complication slot ids to ComplicationSlotState for each complication slot.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

complicationsDataSourceInfo

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val complicationsDataSourceInfo: StateFlow<Map<Int, ComplicationDataSourceInfo?>>

Returns a flow of maps of androidx.wear.watchface.ComplicationSlot ids to ComplicationDataSourceInfo that represent the information available about the data source for each complication. This data is fetched asynchronously and the map will initially be empty. For watch faces without complications this will always be empty.

Note new data may be pushed as result of running openComplicationDataSourceChooser.

Note a null ComplicationDataSourceInfo will be associated with a complication slot id if the androidx.wear.watchface.ComplicationSlot is configured to show the empty complication data source.

complicationsPreviewData

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val complicationsPreviewData: StateFlow<Map<Int, ComplicationData>>

Returns a flow of maps of androidx.wear.watchface.ComplicationSlot ids to preview ComplicationData suitable for use in rendering a preview of the watch face. This data is fetched asynchronously and the map will initially be empty. For watch faces without complications this will always be empty.

Note new data may be pushed as a result of running openComplicationDataSourceChooser.

Note if a slot is configured to be empty then the map will contain an instance of EmptyComplicationData for that slot. Disabled complicationSlots are included in the map.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

previewReferenceInstant

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val previewReferenceInstant: Instant

The reference preview Instant for this watch face to render previews with.

userStyle

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val userStyle: MutableStateFlow<UserStyle>

The current UserStyle. Assigning to this will cause the style to update. However, styling changes to the watch face will be reverted upon exit.

If accessed from java, consider using androidx.lifecycle.FlowLiveDataConversions.asLiveData to observe changes.

userStyleSchema

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val userStyleSchema: UserStyleSchema

The watch face's UserStyleSchema.

watchFaceComponentName

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val watchFaceComponentName: ComponentName

The ComponentName of the watch face being edited.

watchFaceId

Added in 1.0.0

Deprecated in 1.3.0-alpha07

val watchFaceId: WatchFaceId

Unique ID for the instance of the watch face being edited. Note each distinct ComponentName can sometimes have multiple instances. See WatchFaceId for more details.