WatchFace

fun isLegacyWatchFaceOverlayStyleSupported(): Boolean

Returns whether LegacyWatchFaceOverlayStyle is supported on this device.

fun setComplicationDeniedDialogIntent(
    complicationDeniedDialogIntent: Intent?
): WatchFace

Sets the Intent to launch an activity which explains the watch face needs permission to display complications. It is recommended the activity have a button which launches an intent with Settings.ACTION_APPLICATION_DETAILS_SETTINGS to allow the user to grant permissions if they wish.

This complicationDeniedDialogIntent is launched when the user tries to configure a complication slot when the com.google.android.wearable.permission.RECEIVE_COMPLICATION_DATA permission has been denied. If the intent is not set or is null then no dialog will be displayed.

fun setComplicationRationaleDialogIntent(
    complicationRationaleDialogIntent: Intent?
): WatchFace

Sets the Intent to launch an activity that explains the rational for the requesting the com.google.android.wearable.permission.RECEIVE_COMPLICATION_DATApermission prior to requesting it, if [Activity.shouldShowRequestPermissionRationale] returns true`.

If the intent is not set or is null then no dialog will be displayed.

fun setLegacyWatchFaceStyle(
    legacyWatchFaceStyle: WatchFace.LegacyWatchFaceOverlayStyle
): WatchFace

Sets the legacy LegacyWatchFaceOverlayStyle which only affects Wear 2.0 devices.

fun setOverlayStyle(watchFaceOverlayStyle: WatchFace.OverlayStyle): WatchFace

Sets the OverlayStyle which is ignored because this feature is unimplemented on any platform, and will be removed.

fun setOverridePreviewReferenceInstant(previewReferenceTimeMillis: Instant): WatchFace

Overrides the reference time for editor preview images.

fun setTapListener(tapListener: WatchFace.TapListener?): WatchFace

Sets an optional TapListener which if not null gets called on the ui thread whenever the user taps on the watchface.

fun setUpdateScreenshotOnConfigurationChange(
    updateScreenshotOnConfigurationChange: Boolean
): WatchFace

If updateScreenshotOnConfigurationChange is true then whenever WatchFaceService.onConfigurationChanged gets called while this watch face is active then a request will be made for the system to update the watch's screenshot displayed in the picker.

By default this is off.

Note if WatchFaceService.onConfigurationChanged or Renderer.sendPreviewImageNeedsUpdateRequest get called very frequently then the system may throttle the rate at which screenshots are taken.

val legacyWatchFaceStyle: WatchFace.LegacyWatchFaceOverlayStyle

The legacy LegacyWatchFaceOverlayStyle which only affects Wear 2.0 devices.

val overlayStyle: WatchFace.OverlayStyle

The OverlayStyle. This feature is unimplemented on any platform, and will be removed.

val overridePreviewReferenceInstant: Instant?

The Instant to use for preview rendering, or null if not set in which case the system chooses the Instant to use.

val renderer: Renderer

The Renderer for this WatchFace.

var watchFaceType: Int

The type of watch face, whether it's digital or analog. Used to determine the default time for editor preview screenshots.