ComplicationDataSourceService

const val ACTION_COMPLICATION_UPDATE_REQUEST: String

The intent action used to send update requests to the data source. ComplicationDataSourceService must declare an intent filter for this action in the manifest.

const val CATEGORY_DATA_SOURCE_CONFIG: String

Category for complication data source config activities. The configuration activity for a complication complication data source must specify this category in its intent filter.

const val EXTRA_CONFIG_COMPLICATION_ID: String

Extra used to supply the complication id to a complication data source configuration activity.

const val EXTRA_CONFIG_COMPLICATION_TYPE: String

Extra used to supply the complication type to a complication data source configuration activity.

const val EXTRA_CONFIG_DATA_SOURCE_COMPONENT: String

Extra used to supply the complication data source component to a complication data source configuration activity.

@RequiresApi(value = 34)
const val METADATA_KEY_CONFIG_RESTORE_SUPPORTED: String

Metadata key used to declare that the complication data source service supports backup and restore (B&R) of complication configuration data. The system is responsible for backup and restore of the assignment of complications to watch faces, but responsibility for backup and restore for any complication data source configuration data is left to the data source.

If this flag is set to false, then the system will restore any complications using this provider in the "not configured" state, i.e. the complication will show a + sign with a tap action leading to the complication data source's configuration action as defined by METADATA_KEY_DATA_SOURCE_CONFIG_ACTION, instead of real data.

This is a boolean value, defaulting to true, which means apps are opted in by default but can explicitly opt out by setting this meta-data tag to false.

The value is ignored (equivalent to false) if the app does not enable Android B&R ( https://developer.android.com/guide/topics/data/backup). This value is also ignored prior to Android U.

const val METADATA_KEY_DATA_SOURCE_CONFIG_ACTION: String

Metadata key used to declare an action for a configuration activity for a complication data source.

A ComplicationDataSourceService can include a meta-data tag with this name in its manifest entry to cause a configuration activity to be shown when the complication data source is selected.

The configuration activity must reside in the same package as the complication data source, and must register an intent filter for the action specified here, including CATEGORY_DATA_SOURCE_CONFIG as well as Intent.CATEGORY_DEFAULT as categories.

The complication id being configured will be included in the intent that starts the config activity using the extra key EXTRA_CONFIG_COMPLICATION_ID.

The complication type that will be requested from the complication data source will also be included, using the extra key EXTRA_CONFIG_COMPLICATION_TYPE.

The complication data source's ComponentName will also be included in the intent that starts the config activity, using the extra key EXTRA_CONFIG_DATA_SOURCE_COMPONENT.

The config activity must call Activity.setResult with either Activity.RESULT_OK or Activity.RESULT_CANCELED before it is finished, to tell the system whether or not the complication data source should be set on the given complication.

const val METADATA_KEY_DATA_SOURCE_DEFAULT_CONFIG_SUPPORTED: String

Metadata key. Setting to "true" indicates to the system that this complication data source with a PROVIDER_CONFIG_ACTION metadata tag is able to provide complication data before it is configured. See METADATA_KEY_DATA_SOURCE_CONFIG_ACTION.

const val METADATA_KEY_IMMEDIATE_UPDATE_PERIOD_MILLISECONDS: String

Metadata key used to request elevated frequency of onComplicationRequests when the watch face is visible and non-ambient.

To do this ComplicationDataSourceService should include a meta-data tag with this name in its manifest entry. The value of this tag is the number of milliseconds the complication data source would like to elapse between onComplicationRequests requests when the watch face is visible and non-ambient.

Note in addition to this meta-data, the data source must also request the privileged permission com.google.android.wearable.permission.USE_IMMEDIATE_COMPLICATION_UPDATE.

Note that update requests are not guaranteed to be sent with this frequency and a lower limit exists (initially 1 second).

const val METADATA_KEY_SAFE_WATCH_FACES: String

Metadata key used to declare a list of watch faces that may receive data from a complication data source before they are granted the RECEIVE_COMPLICATION_DATA permission. This allows the listed watch faces to set the complication data source as a default and have the complication populate when the watch face is first seen.

Only trusted watch faces that will set this complication data source as a default should be included in this list.

Note that if a watch face is in the same app package as the complication data source, it does not need to be added to this list.

The value of this tag should be a comma separated list of watch faces or packages. An entry can be a flattened component, as if ComponentName.flattenToString had been called, to declare a specific watch face as safe. An entry can also be a package name, as if ComponentName.getPackageName had been called, in which case any watch face under the app with that package name will be considered safe for this complication data source.

From Android T, if this provider has the privileged permission com.google.wear.permission.GET_IS_FOR_SAFE_WATCH_FACE, then ComplicationRequest.isForSafeWatchFace will be populated.

const val METADATA_KEY_SAFE_WATCH_FACE_SUPPORTED_TYPES: String

Metadata key used to declare supported complication types for safe watch faces.

Gated behind the privileged permission `com.google.wear.permission.GET_IS_FOR_SAFE_WATCH_FACE', this overrides the METADATA_KEY_SUPPORTED_TYPES list for 'safe' watch faces. I.e. watch faces in the METADATA_KEY_SAFE_WATCH_FACES metadata list.

This means for example trusted watch faces could receive ComplicationType.SHORT_TEXT and untrusted ones ComplicationType.MONOCHROMATIC_IMAGE.

const val METADATA_KEY_SUPPORTED_TYPES: String

Metadata key used to declare supported complication types.

A ComplicationDataSourceService must include a meta-data tag with this name in its manifest entry. The value of this tag should be a comma separated list of types supported by the complication data source. Types should be given as named as per the type fields in the ComplicationData, but omitting the "TYPE_" prefix, e.g. SHORT_TEXT, LONG_TEXT, RANGED_VALUE.

The order of types in METADATA_KEY_SUPPORTED_TYPES has no significance. During complication data source selection, each item in the complication slot's supported types is checked against entries in the data source's METADATA_KEY_SUPPORTED_TYPES and the first matching entry from the slot's support types (if any) is chosen. If there are no matches then this data source is not eligible to be selected in that slot.

For example, a complication data source that supports the RANGED_VALUE, SHORT_TEXT, and ICON type would include the following in its manifest entry:

<meta-data
    android:name="android.support.wearable.complications.SUPPORTED_TYPES"
    android:value="RANGED_VALUE,SHORT_TEXT,ICON" />

const val METADATA_KEY_UPDATE_PERIOD_SECONDS: String

Metadata key used to declare the requested frequency of update requests.

A ComplicationDataSourceService should include a meta-data tag with this name in its manifest entry. The value of this tag is the number of seconds the complication data source would like to elapse between update requests.

Note that update requests are not guaranteed to be sent with this frequency.

If a complication data source never needs to receive update requests beyond the one sent when a complication is activated, the value of this tag should be 0.

For example, a complication data source that would like to update every ten minutes should include the following in its manifest entry:

<meta-data
    android:name="android.support.wearable.complications.UPDATE_PERIOD_SECONDS"
    android:value="600" />

abstract fun getPreviewData(type: ComplicationType): ComplicationData?

A request for representative preview data for the complication, for use in the editor UI. Preview data is assumed to be static per type. E.g. for a complication that displays the date and time of an event, rather than returning the real time it should return a fixed date and time such as 10:10 Aug 1st. This data may be cached by the system and the result should be constant based on the current locale.

This will be called on a background thread.

@MainThread
open fun onComplicationActivated(
    complicationInstanceId: Int,
    type: ComplicationType
): Unit

Called when a complication is activated.

This occurs when the watch face calls setActiveComplications, or when this data source is chosen for a complication which is already active.

This will usually be followed by a call to onComplicationRequest.

This will be called on the main thread.

@MainThread
open fun onComplicationDeactivated(complicationInstanceId: Int): Unit

Called when a complication is deactivated.

This occurs when the current watch face changes, or when the watch face calls setActiveComplications and does not include the given complication (usually because the watch face has stopped displaying it).

This will be called on the main thread.

@MainThread
abstract fun onComplicationRequest(
    request: ComplicationRequest,
    listener: ComplicationDataSourceService.ComplicationRequestListener
): Unit

Called when a complication data update is requested for the given complication id.

In response to this request the result callback should be called with the data to be displayed. If the request can not be fulfilled or no update is needed then null should be passed to the callback.

The callback doesn't have be called within onComplicationRequest but it should be called soon after. If this does not occur within around 20 seconds (exact timeout length subject to change), then the system will unbind from this service which may cause your eventual update to not be received. However if ComplicationRequest.immediateResponseRequired is true then provider should try to deliver the response in under 100 milliseconds, if false the deadline is 20 seconds. ComplicationRequest.immediateResponseRequired will only ever be true if METADATA_KEY_IMMEDIATE_UPDATE_PERIOD_MILLISECONDS is present in the manifest, and the provider has the privileged permission com.google.android.wearable.permission.USE_IMMEDIATE_COMPLICATION_UPDATE, and the complication is visible and non-ambient.

@MainThread
open fun onStartImmediateComplicationRequests(complicationInstanceId: Int): Unit

If a metadata key with METADATA_KEY_IMMEDIATE_UPDATE_PERIOD_MILLISECONDS is present in the manifest, and the provider has privileged permission com.google.android.wearable.permission.USE_IMMEDIATE_COMPLICATION_UPDATE, then onStartImmediateComplicationRequests will be called when the watch face is visible and non-ambient. A series of onComplicationRequests will follow where ComplicationRequest.immediateResponseRequired is true, ending with a call to onStopImmediateComplicationRequests.

@MainThread
open fun onStopImmediateComplicationRequests(complicationInstanceId: Int): Unit

If a metadata key with METADATA_KEY_IMMEDIATE_UPDATE_PERIOD_MILLISECONDS is present in the manifest, and the provider has privileged permission com.google.android.wearable.permission.USE_IMMEDIATE_COMPLICATION_UPDATE, then onStartImmediateComplicationRequests will be called when the watch face ceases to be visible and non-ambient. No subsequent calls to onComplicationRequest where ComplicationRequest.immediateResponseRequired is true will be made unless the complication becomes visible and non-ambient again.