NoPermissionComplicationData


class NoPermissionComplicationData : ComplicationData


Type sent by the system when the watch face does not have permission to receive complication data.

The text, title, and icon may be displayed by watch faces, but this is not required.

It is recommended that, where possible, tapping on the complication when in this state should trigger a permission request. Note this is done by androidx.wear.watchface.ComplicationSlotsManager for androidx watch faces.

Summary

Public companion properties

ComplicationType

The ComplicationType corresponding to objects of this type.

Public functions

open Instant

Returns the next Instant after afterInstant at which any field of the complication may change.

open String

Public properties

MonochromaticImage?

A simple MonochromaticImage image that can be tinted by the watch face.

SmallImage?

A SmallImage that is expected to cover a small fraction of a watch face occupied by a single complication

ComplicationText?

The body ComplicationText of the complication.

ComplicationText?

The optional title ComplicationText.

Inherited functions

From androidx.wear.watchface.complications.data.ComplicationData
open operator Boolean
equals(other: Any?)
open Boolean

Returns true if any of the fields of this ComplicationData are placeholders.

open Int

Inherited properties

From androidx.wear.watchface.complications.data.ComplicationData
ComponentName?

The ComponentName of the androidx.wear.watchface.complications.datasource.ComplicationDataSourceService that provided the ComplicationData.

Int

The display policy for this complication.

ComplicationData?

Used in case any dynamic value has been invalidated.

Int

The persistence policy for this complication.

PendingIntent?

The PendingIntent to send when the complication is tapped on.

Boolean

tapAction which is a PendingIntent unfortunately can't be serialized.

ComplicationType

The ComplicationType of this complication data.

TimeRange

The TimeRange within which the complication should be displayed.

Public companion properties

TYPE

val TYPEComplicationType

The ComplicationType corresponding to objects of this type.

Public functions

getNextChangeInstant

open fun getNextChangeInstant(afterInstant: Instant): Instant

Returns the next Instant after afterInstant at which any field of the complication may change. If there's no scheduled changes then Instant.MAX will be returned.

See ComplicationText.getNextChangeTime

Parameters
afterInstant: Instant

The reference Instant, after which changes will be reported.

toString

open fun toString(): String

Public properties

monochromaticImage

Added in 1.0.0
val monochromaticImageMonochromaticImage?

A simple MonochromaticImage image that can be tinted by the watch face.

smallImage

Added in 1.2.0
val smallImageSmallImage?

A SmallImage that is expected to cover a small fraction of a watch face occupied by a single complication

text

Added in 1.0.0
val textComplicationText?

The body ComplicationText of the complication. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated.

title

Added in 1.0.0
val titleComplicationText?

The optional title ComplicationText. The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated.