SuspendingComplicationDataSourceService

Artifact: androidx.wear.watchface:watchface-complications-data-source-ktx

Added in 1.0.0

Kotlin |Java

abstract class SuspendingComplicationDataSourceService : ComplicationDataSourceService

kotlin.Any
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.wear.watchface.complications.datasource.ComplicationDataSourceService
				↳	androidx.wear.watchface.complications.datasource.SuspendingComplicationDataSourceService

Kotlin coroutine wrapper for ComplicationDataSourceService producing ComplicationData.

Summary

Public constructors
`SuspendingComplicationDataSourceService()`

Public functions
`abstract suspend ComplicationData?`	`@UiThread onComplicationRequest(request: ComplicationRequest)` Computes the `ComplicationData` for the given `request`.
`final Unit`	`onComplicationRequest( request: ComplicationRequest, listener: ComplicationDataSourceService.ComplicationRequestListener )` Called when a complication data update is requested for the given complication id.
`open Unit`	`@CallSuper onDestroy()`

Inherited functions

From androidx.wear.watchface.complications.datasource.ComplicationDataSourceService

`abstract ComplicationData?`	`getPreviewData(type: ComplicationType)` A request for representative preview data for the complication, for use in the editor UI.
`final IBinder?`	`onBind(intent: Intent)`
`open Unit`	`@MainThread onComplicationActivated( complicationInstanceId: Int, type: ComplicationType )` Called when a complication is activated.
`open Unit`	`@MainThread onComplicationDeactivated(complicationInstanceId: Int)` Called when a complication is deactivated.
`open Unit`	`@MainThread onStartImmediateComplicationRequests(complicationInstanceId: Int)` 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.
`open Unit`	`@MainThread onStopImmediateComplicationRequests(complicationInstanceId: Int)` 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.

From android.content.Context

`open Boolean`	`bindIsolatedService( p0: Intent, p1: Context.BindServiceFlags, p2: String, p3: Executor, p4: ServiceConnection )`
`Int`	`getColor(p0: Int)`
`ColorStateList`	`getColorStateList(p0: Int)`
`Drawable?`	`getDrawable(p0: Int)`
`String`	`getString(p0: Int)`
`String`	`getString(p0: Int, vararg p1: Any)`
`T`	`<T : Any> getSystemService(p0: Class<T>)`
`CharSequence`	`getText(p0: Int)`
`TypedArray`	`obtainStyledAttributes(p0: IntArray)`
`TypedArray`	`obtainStyledAttributes(p0: AttributeSet?, p1: IntArray)`
`TypedArray`	`obtainStyledAttributes(p0: Int, p1: IntArray)`
`TypedArray`	`obtainStyledAttributes(p0: AttributeSet?, p1: IntArray, p2: Int, p3: Int)`
`open Unit`	`revokeSelfPermissionOnKill(p0: String)`
`open Unit`	`sendBroadcastWithMultiplePermissions(p0: Intent, p1: Array<String>)`

From android.content.ContextWrapper

`open Boolean`	`bindIsolatedService( p0: Intent, p1: Int, p2: String, p3: Executor, p4: ServiceConnection )`
`open Boolean`	`bindService( p0: Intent, p1: ServiceConnection, p2: Context.BindServiceFlags )`
`open Boolean`	`bindService(p0: Intent, p1: ServiceConnection, p2: Int)`
`open Boolean`	`bindService( p0: Intent, p1: Context.BindServiceFlags, p2: Executor, p3: ServiceConnection )`
`open Boolean`	`bindService(p0: Intent, p1: Int, p2: Executor, p3: ServiceConnection)`
`open Boolean`	`bindServiceAsUser( p0: Intent, p1: ServiceConnection, p2: Context.BindServiceFlags, p3: UserHandle )`
`open Boolean`	`bindServiceAsUser(p0: Intent, p1: ServiceConnection, p2: Int, p3: UserHandle)`
`open Int`	`checkCallingOrSelfPermission(p0: String)`
`open Int`	`checkCallingOrSelfUriPermission(p0: Uri, p1: Int)`
`open IntArray`	`checkCallingOrSelfUriPermissions(p0: MutableList<Uri>, p1: Int)`
`open Int`	`checkCallingPermission(p0: String)`
`open Int`	`checkCallingUriPermission(p0: Uri, p1: Int)`
`open IntArray`	`checkCallingUriPermissions(p0: MutableList<Uri>, p1: Int)`
`open Int`	`checkPermission(p0: String, p1: Int, p2: Int)`
`open Int`	`checkSelfPermission(p0: String)`
`open Int`	`checkUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int)`
`open Int`	`checkUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int)`
`open IntArray`	`checkUriPermissions(p0: MutableList<Uri>, p1: Int, p2: Int, p3: Int)`
`open Unit`	`clearWallpaper()` This function is deprecated. Deprecated in Java
`open Context`	`createAttributionContext(p0: String?)`
`open Context`	`createConfigurationContext(p0: Configuration)`
`open Context`	`createContext(p0: ContextParams)`
`open Context`	`createContextForSplit(p0: String)`
`open Context`	`createDeviceContext(p0: Int)`
`open Context`	`createDeviceProtectedStorageContext()`
`open Context`	`createDisplayContext(p0: Display)`
`open Context`	`createPackageContext(p0: String, p1: Int)`
`open Context`	`createWindowContext(p0: Int, p1: Bundle?)`
`open Context`	`createWindowContext(p0: Display, p1: Int, p2: Bundle?)`
`open Array<String>`	`databaseList()`
`open Boolean`	`deleteDatabase(p0: String)`
`open Boolean`	`deleteFile(p0: String)`
`open Boolean`	`deleteSharedPreferences(p0: String)`
`open Unit`	`enforceCallingOrSelfPermission(p0: String, p1: String?)`
`open Unit`	`enforceCallingOrSelfUriPermission(p0: Uri, p1: Int, p2: String)`
`open Unit`	`enforceCallingPermission(p0: String, p1: String?)`
`open Unit`	`enforceCallingUriPermission(p0: Uri, p1: Int, p2: String)`
`open Unit`	`enforcePermission(p0: String, p1: Int, p2: Int, p3: String?)`
`open Unit`	`enforceUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int, p4: String)`
`open Unit`	`enforceUriPermission( p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int, p6: String? )`
`open Array<String>`	`fileList()`
`open Context`	`getApplicationContext()`
`open ApplicationInfo`	`getApplicationInfo()`
`open AssetManager`	`getAssets()`
`open AttributionSource`	`getAttributionSource()`
`open String?`	`getAttributionTag()`
`open Context`	`getBaseContext()`
`open File`	`getCacheDir()`
`open ClassLoader`	`getClassLoader()`
`open File`	`getCodeCacheDir()`
`open ContentResolver`	`getContentResolver()`
`open File`	`getDataDir()`
`open File`	`getDatabasePath(p0: String)`
`open Int`	`getDeviceId()`
`open File`	`getDir(p0: String, p1: Int)`
`open Display?`	`getDisplay()`
`open File?`	`getExternalCacheDir()`
`open Array<File>`	`getExternalCacheDirs()`
`open File?`	`getExternalFilesDir(p0: String?)`
`open Array<File>`	`getExternalFilesDirs(p0: String)`
`open Array<File>`	`getExternalMediaDirs()`
`open File`	`getFileStreamPath(p0: String)`
`open File`	`getFilesDir()`
`open Executor`	`getMainExecutor()`
`open Looper`	`getMainLooper()`
`open File`	`getNoBackupFilesDir()`
`open File`	`getObbDir()`
`open Array<File>`	`getObbDirs()`
`open String`	`getOpPackageName()`
`open String`	`getPackageCodePath()`
`open PackageManager`	`getPackageManager()`
`open String`	`getPackageName()`
`open String`	`getPackageResourcePath()`
`open ContextParams?`	`getParams()`
`open Resources`	`getResources()`
`open SharedPreferences`	`getSharedPreferences(p0: String, p1: Int)`
`open Any`	`getSystemService(p0: String)`
`open String?`	`getSystemServiceName(p0: Class<*>)`
`open Resources.Theme`	`getTheme()`
`open Drawable`	`getWallpaper()` This function is deprecated. Deprecated in Java
`open Int`	`getWallpaperDesiredMinimumHeight()` This function is deprecated. Deprecated in Java
`open Int`	`getWallpaperDesiredMinimumWidth()` This function is deprecated. Deprecated in Java
`open Unit`	`grantUriPermission(p0: String, p1: Uri, p2: Int)`
`open Boolean`	`isDeviceProtectedStorage()`
`open Boolean`	`isRestricted()`
`open Boolean`	`isUiContext()`
`open Boolean`	`moveDatabaseFrom(p0: Context, p1: String)`
`open Boolean`	`moveSharedPreferencesFrom(p0: Context, p1: String)`
`open FileInputStream`	`openFileInput(p0: String)`
`open FileOutputStream`	`openFileOutput(p0: String, p1: Int)`
`open SQLiteDatabase`	`openOrCreateDatabase(p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory)`
`open SQLiteDatabase`	`openOrCreateDatabase( p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory, p3: DatabaseErrorHandler? )`
`open Drawable`	`peekWallpaper()` This function is deprecated. Deprecated in Java
`open Unit`	`registerComponentCallbacks(p0: ComponentCallbacks)`
`open Unit`	`registerDeviceIdChangeListener(p0: Executor, p1: IntConsumer)`
`open Intent?`	`registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter)`
`open Intent?`	`registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: Int)`
`open Intent?`	`registerReceiver( p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler? )`
`open Intent?`	`registerReceiver( p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler?, p4: Int )`
`open Unit`	`removeStickyBroadcast(p0: Intent)` This function is deprecated. Deprecated in Java
`open Unit`	`removeStickyBroadcastAsUser(p0: Intent, p1: UserHandle)` This function is deprecated. Deprecated in Java
`open Unit`	`revokeSelfPermissionsOnKill(p0: MutableCollection<String>)`
`open Unit`	`revokeUriPermission(p0: Uri, p1: Int)`
`open Unit`	`revokeUriPermission(p0: String, p1: Uri, p2: Int)`
`open Unit`	`sendBroadcast(p0: Intent)`
`open Unit`	`sendBroadcast(p0: Intent, p1: String?)`
`open Unit`	`sendBroadcast(p0: Intent, p1: String?, p2: Bundle?)`
`open Unit`	`sendBroadcastAsUser(p0: Intent, p1: UserHandle)`
`open Unit`	`sendBroadcastAsUser(p0: Intent, p1: UserHandle, p2: String?)`
`open Unit`	`sendOrderedBroadcast(p0: Intent, p1: String?)`
`open Unit`	`sendOrderedBroadcast(p0: Intent, p1: String?, p2: Bundle?)`
`open Unit`	`sendOrderedBroadcast( p0: Intent, p1: String?, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle? )`
`open Unit`	`sendOrderedBroadcast( p0: Intent, p1: String?, p2: Bundle?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle? )`
`open Unit`	`sendOrderedBroadcast( p0: Intent, p1: String?, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle? )`
`open Unit`	`sendOrderedBroadcast( p0: Intent, p1: Int, p2: String?, p3: String?, p4: BroadcastReceiver?, p5: Handler?, p6: String?, p7: Bundle?, p8: Bundle? )`
`open Unit`	`sendOrderedBroadcastAsUser( p0: Intent, p1: UserHandle, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle? )`
`open Unit`	`sendStickyBroadcast(p0: Intent)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyBroadcast(p0: Intent, p1: Bundle?)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyBroadcastAsUser(p0: Intent, p1: UserHandle)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyOrderedBroadcast( p0: Intent, p1: BroadcastReceiver?, p2: Handler?, p3: Int, p4: String?, p5: Bundle? )` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyOrderedBroadcastAsUser( p0: Intent, p1: UserHandle, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle? )` This function is deprecated. Deprecated in Java
`open Unit`	`setTheme(p0: Int)`
`open Unit`	`setWallpaper(p0: Bitmap)` This function is deprecated. Deprecated in Java
`open Unit`	`setWallpaper(p0: InputStream)` This function is deprecated. Deprecated in Java
`open Unit`	`startActivities(p0: Array<Intent>)`
`open Unit`	`startActivities(p0: Array<Intent>, p1: Bundle?)`
`open Unit`	`startActivity(p0: Intent)`
`open Unit`	`startActivity(p0: Intent, p1: Bundle?)`
`open ComponentName?`	`startForegroundService(p0: Intent)`
`open Boolean`	`startInstrumentation(p0: ComponentName, p1: String?, p2: Bundle?)`
`open Unit`	`startIntentSender(p0: IntentSender, p1: Intent?, p2: Int, p3: Int, p4: Int)`
`open Unit`	`startIntentSender( p0: IntentSender, p1: Intent?, p2: Int, p3: Int, p4: Int, p5: Bundle? )`
`open ComponentName?`	`startService(p0: Intent)`
`open Boolean`	`stopService(p0: Intent)`
`open Unit`	`unbindService(p0: ServiceConnection)`
`open Unit`	`unregisterComponentCallbacks(p0: ComponentCallbacks)`
`open Unit`	`unregisterDeviceIdChangeListener(p0: IntConsumer)`
`open Unit`	`unregisterReceiver(p0: BroadcastReceiver)`
`open Unit`	`updateServiceGroup(p0: ServiceConnection, p1: Int, p2: Int)`

From android.app.Service

`open Unit`	`attachBaseContext(p0: Context)`
`open Unit`	`dump(p0: FileDescriptor, p1: PrintWriter, p2: Array<String>)`
`Application`	`getApplication()`
`Int`	`getForegroundServiceType()`
`open Unit`	`onConfigurationChanged(p0: Configuration)`
`open Unit`	`onCreate()`
`open Unit`	`onLowMemory()`
`open Unit`	`onRebind(p0: Intent)`
`open Unit`	`onStart(p0: Intent, p1: Int)` This function is deprecated. Deprecated in Java
`open Int`	`onStartCommand(p0: Intent, p1: Int, p2: Int)`
`open Unit`	`onTaskRemoved(p0: Intent)`
`open Unit`	`onTimeout(p0: Int)`
`open Unit`	`onTrimMemory(p0: Int)`
`open Boolean`	`onUnbind(p0: Intent)`
`Unit`	`startForeground(p0: Int, p1: Notification)`
`Unit`	`startForeground(p0: Int, p1: Notification, p2: Int)`
`Unit`	`stopForeground(p0: Boolean)` This function is deprecated. Deprecated in Java
`Unit`	`stopForeground(p0: Int)`
`Unit`	`stopSelf()`
`Unit`	`stopSelf(p0: Int)`
`Boolean`	`stopSelfResult(p0: Int)`

Public constructors

SuspendingComplicationDataSourceService

Added in 1.0.0

SuspendingComplicationDataSourceService()

Public functions

onComplicationRequest

@UiThread
abstract suspend fun onComplicationRequest(request: ComplicationRequest): ComplicationData?

Computes the ComplicationData for the given request.

The ComplicationData returned from this method will be passed to the ComplicationDataSourceService.ComplicationRequestListener provided to onComplicationRequest. Return null to indicate that the previous complication data shouldn't be overwritten.

See also
`onComplicationRequest`
`onComplicationData`

onComplicationRequest

Added in 1.0.0

final 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.

Parameters
`request: ComplicationRequest`	The details about the complication that has been requested.
`listener: ComplicationDataSourceService.ComplicationRequestListener`	The callback to pass the result to the system.

onDestroy

@CallSuper
open fun onDestroy(): Unit