WatchFace
class WatchFace
The return value of WatchFaceService.createWatchFace which brings together rendering, styling, complicationSlots and state observers.
use Watch Face Format instead
Summary
Nested types |
|---|
|
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
class WatchFace.OverlayStyleThis class is deprecated. OverlayStyle will be removed in a future release. |
interface WatchFace.TapListenerThis interface is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public companion functions |
|
|---|---|
Boolean |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public constructors |
|---|
|
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public functions |
|
|---|---|
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace |
This function is deprecated. OverlayStyle will be removed in a future release. |
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public properties |
|
|---|---|
WatchFace.LegacyWatchFaceOverlayStyle |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
WatchFace.OverlayStyle |
This property is deprecated. OverlayStyle will be removed in a future release. |
Instant? |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Renderer |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Int |
This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public companion functions
isLegacyWatchFaceOverlayStyleSupported
funisLegacyWatchFaceOverlayStyleSupported(): Boolean
Returns whether LegacyWatchFaceOverlayStyle is supported on this device.
Public constructors
WatchFace
WatchFace(watchFaceType: Int, renderer: Renderer)
Public functions
setComplicationDeniedDialogIntent
funsetComplicationDeniedDialogIntent(
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.
setComplicationRationaleDialogIntent
funsetComplicationRationaleDialogIntent(
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.
setLegacyWatchFaceStyle
funsetLegacyWatchFaceStyle(
legacyWatchFaceStyle: WatchFace.LegacyWatchFaceOverlayStyle
): WatchFace
Sets the legacy LegacyWatchFaceOverlayStyle which only affects Wear 2.0 devices.
funsetOverlayStyle(watchFaceOverlayStyle: WatchFace.OverlayStyle): WatchFace
Sets the OverlayStyle which is ignored because this feature is unimplemented on any platform, and will be removed.
setOverridePreviewReferenceInstant
funsetOverridePreviewReferenceInstant(previewReferenceTimeMillis: Instant): WatchFace
Overrides the reference time for editor preview images.
| Parameters | |
|---|---|
previewReferenceTimeMillis: Instant |
The UTC preview time in milliseconds since the epoch |
setTapListener
funsetTapListener(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.
setUpdateScreenshotOnConfigurationChange
funsetUpdateScreenshotOnConfigurationChange(
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.
Public properties
legacyWatchFaceStyle
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.
overridePreviewReferenceInstant
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.
renderer
val renderer: Renderer
The Renderer for this WatchFace.
watchFaceType
var watchFaceType: Int
The type of watch face, whether it's digital or analog. Used to determine the default time for editor preview screenshots.