Complication

Kotlin |Java

class Complication

kotlin.Any
↳	androidx.wear.watchface.Complication

Represents a individual complication on the screen. The number of complications is fixed (see ComplicationsManager) but complications can be enabled or disabled via UserStyleSetting.ComplicationsUserStyleSetting.

Summary

Nested classes
	`Builder` Builder for constructing Complications.

Public methods
Rect	`computeBounds(screen: Rect)` Computes the bounds of the complication by converting the unitSquareBounds to pixels.
Unit	`invalidate()` Requests redraw of the watch face.
Boolean	`isActiveAt(dateTimeMillis: Long)` Whether or not the complication should be considered active and should be rendered at the specified time.
Unit	`render(canvas: Canvas, calendar: Calendar, renderParameters: RenderParameters)` Watch faces should use this method to render a complication.

Companion functions
Complication.Builder	`createBackgroundComplicationBuilder(id: Int, renderer: CanvasComplication, supportedTypes: List<ComplicationType>, defaultProviderPolicy: DefaultComplicationProviderPolicy)` Constructs a Builder for a complication with bound type ComplicationBoundsType.BACKGROUND whose bounds cover the entire screen.
Complication.Builder	`createRoundRectComplicationBuilder(id: Int, renderer: CanvasComplication, supportedTypes: List<ComplicationType>, defaultProviderPolicy: DefaultComplicationProviderPolicy, complicationBounds: ComplicationBounds)` Constructs a Builder for a complication with bounds type ComplicationBoundsType.ROUND_RECT.

Properties
Int	`boundsType`
ComplicationBounds	`complicationBounds` The complication's ComplicationBounds which are converted to pixels during rendering.
Bundle?	`complicationConfigExtras` Extras to be merged into the Intent sent when invoking the provider chooser activity.
ObservableWatchData<ComplicationData>	`complicationData` The androidx.wear.complications.data.ComplicationData associated with the Complication.
DefaultComplicationProviderPolicy	`defaultProviderPolicy` The DefaultComplicationProviderPolicy which defines the default complications providers selected when the user hasn't yet made a choice.
ComplicationType	`defaultProviderType` The default ComplicationData.ComplicationType to use alongside defaultProviderPolicy.
Boolean	`enabled` Whether or not the complication should be drawn and accept taps.
Boolean	`fixedComplicationProvider` Whether or not the complication provider is fixed.
CanvasComplication	`renderer` The CanvasComplication used to render the complication.
List<ComplicationType>	`supportedTypes` The types of complications the complication supports.

fun computeBounds(screen: Rect): Rect

Computes the bounds of the complication by converting the unitSquareBounds to pixels.

fun invalidate(): Unit

Requests redraw of the watch face. Useful when initialization is asynchronous, e.g. when loading a Drawable.

fun isActiveAt(dateTimeMillis: Long): Boolean

Whether or not the complication should be considered active and should be rendered at the specified time.

@UiThread fun render(
    canvas: Canvas, 
    calendar: Calendar, 
    renderParameters: RenderParameters
): Unit

Watch faces should use this method to render a complication. Note the system may call this.

Parameters