EditorRequest

fun createFromIntent(intent: Intent): EditorRequest

Returns an EditorRequest saved to a Intent by WatchFaceEditorContract.createIntent if there is one or null otherwise. Intended for use by the watch face editor activity.

EditorRequest(
    watchFaceComponentName: ComponentName,
    editorPackageName: String,
    initialUserStyle: UserStyleData?
)

Constructs an EditorRequest without a WatchFaceId. This is for use pre-android R.

val editorPackageName: String

The package name of the watch face editor APK.

val headlessDeviceConfig: DeviceConfig?

If non-null then this is the DeviceConfig to use when creating a headless instance to back the EditorSession. If null then the current interactive instance will be used. If there isn't one then the EditorSession won't launch until it's been created. Note supportsWatchFaceHeadlessEditing can be used to determine if this feature is supported. If it's not supported this parameter will be ignored.

val initialUserStyle: UserStyleData?

The initial UserStyle stored as a UserStyleData or null. Only required for a headless EditorSession.

val previewScreenshotParams: PreviewScreenshotParams?

If non-null then EditorSession upon closing will render a screenshot with PreviewScreenshotParams using the existing interactive or headless instance which will be sent in EditorState to any registered clients.

val watchFaceComponentName: ComponentName

The ComponentName of the watch face being edited.

@RequiresApi(value = 30)
val watchFaceId: WatchFaceId

Unique ID for the instance of the watch face being edited, only defined for Android R and beyond, it's null on Android P and earlier. Note each distinct ComponentName can have multiple instances.