SuspendingTimelineComplicationDataSourceService

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

View Source

Added in 1.1.0

---

Kotlin |Java

public abstract class SuspendingTimelineComplicationDataSourceService extends ComplicationDataSourceService

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.wear.watchface.complications.datasource.ComplicationDataSourceService
				↳	androidx.wear.watchface.complications.datasource.SuspendingTimelineComplicationDataSourceService

---

Kotlin coroutine wrapper for ComplicationDataSourceService producing ComplicationDataTimeline.

Summary

Public constructors
SuspendingTimelineComplicationDataSourceService()

Public methods
abstract ComplicationDataTimeline	@UiThread onComplicationRequest(@NonNull ComplicationRequest request) Computes the ComplicationDataTimeline for the given request.
final void	onComplicationRequest(     @NonNull ComplicationRequest request,     @NonNull ComplicationDataSourceService.ComplicationRequestListener listener ) Called when a complication data update is requested for the given complication id.
void	onDestroy()

Inherited methods
From androidx.wear.watchface.complications.datasource.ComplicationDataSourceService abstract ComplicationData getPreviewData(@NonNull ComplicationType type) A request for representative preview data for the complication, for use in the editor UI. final IBinder onBind(@NonNull Intent intent) void @MainThread onComplicationActivated(     int complicationInstanceId,     @NonNull ComplicationType type ) Called when a complication is activated. void @MainThread onComplicationDeactivated(int complicationInstanceId) Called when a complication is deactivated. void @MainThread onStartImmediateComplicationRequests(int complicationInstanceId) 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. void @MainThread onStopImmediateComplicationRequests(int complicationInstanceId) 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 boolean bindIsolatedService(     @NonNull Intent service,     @NonNull Context.BindServiceFlags flags,     @NonNull String instanceName,     @NonNull Executor executor,     @NonNull ServiceConnection conn ) final int getColor(int id) final @NonNull ColorStateList getColorStateList(int id) final Drawable getDrawable(int id) final @NonNull String getString(int resId) final @NonNull String getString(int resId, @NonNull Object... formatArgs) final @NonNull T <T extends Object> getSystemService(@NonNull Class<@NonNull T> serviceClass) final @NonNull CharSequence getText(int resId) @NonNull Context.BindServiceFlags getUpdateableFlags() final @NonNull TypedArray obtainStyledAttributes(@NonNull int[] attrs) final @NonNull TypedArray obtainStyledAttributes(int resid, @NonNull int[] attrs) final @NonNull TypedArray obtainStyledAttributes(AttributeSet set, @NonNull int[] attrs) final @NonNull TypedArray obtainStyledAttributes(     AttributeSet set,     @NonNull int[] attrs,     int defStyleAttr,     int defStyleRes ) void revokeSelfPermissionOnKill(@NonNull String permName) void sendBroadcastWithMultiplePermissions(     @NonNull Intent intent,     @NonNull String[] receiverPermissions )
From android.content.ContextWrapper boolean bindIsolatedService(     @NonNull Intent service,     int flags,     @NonNull String instanceName,     @NonNull Executor executor,     @NonNull ServiceConnection conn ) boolean bindService(     @NonNull Intent service,     @NonNull ServiceConnection conn,     @NonNull Context.BindServiceFlags flags ) boolean bindService(     @NonNull Intent service,     @NonNull ServiceConnection conn,     int flags ) boolean bindService(     @NonNull Intent service,     @NonNull Context.BindServiceFlags flags,     @NonNull Executor executor,     @NonNull ServiceConnection conn ) boolean bindService(     @NonNull Intent service,     int flags,     @NonNull Executor executor,     @NonNull ServiceConnection conn ) boolean bindServiceAsUser(     @NonNull Intent service,     @NonNull ServiceConnection conn,     @NonNull Context.BindServiceFlags flags,     @NonNull UserHandle user ) boolean bindServiceAsUser(     @NonNull Intent service,     @NonNull ServiceConnection conn,     int flags,     @NonNull UserHandle user ) int checkCallingOrSelfPermission(@NonNull String permission) int checkCallingOrSelfUriPermission(@NonNull Uri uri, int modeFlags) @NonNull int[] checkCallingOrSelfUriPermissions(     @NonNull List<@NonNull Uri> uris,     int modeFlags ) int checkCallingPermission(@NonNull String permission) int checkCallingUriPermission(@NonNull Uri uri, int modeFlags) @NonNull int[] checkCallingUriPermissions(@NonNull List<@NonNull Uri> uris, int modeFlags) int checkContentUriPermissionFull(     @NonNull Uri uri,     int pid,     int uid,     int modeFlags ) int checkPermission(@NonNull String permission, int pid, int uid) int checkSelfPermission(@NonNull String permission) int checkUriPermission(@NonNull Uri uri, int pid, int uid, int modeFlags) int checkUriPermission(     Uri uri,     String readPermission,     String writePermission,     int pid,     int uid,     int modeFlags ) @NonNull int[] checkUriPermissions(     @NonNull List<@NonNull Uri> uris,     int pid,     int uid,     int modeFlags ) void clearWallpaper() @NonNull Context createAttributionContext(String attributionTag) @NonNull Context createConfigurationContext(@NonNull Configuration overrideConfiguration) @NonNull Context createContext(@NonNull ContextParams contextParams) @NonNull Context createContextForSplit(@NonNull String splitName) @NonNull Context createDeviceContext(int deviceId) @NonNull Context createDeviceProtectedStorageContext() @NonNull Context createDisplayContext(@NonNull Display display) @NonNull Context createPackageContext(@NonNull String packageName, int flags) @NonNull Context createWindowContext(int type, Bundle options) @NonNull Context createWindowContext(@NonNull Display display, int type, Bundle options) @NonNull String[] databaseList() boolean deleteDatabase(@NonNull String name) boolean deleteFile(@NonNull String name) boolean deleteSharedPreferences(@NonNull String name) void enforceCallingOrSelfPermission(     @NonNull String permission,     String message ) void enforceCallingOrSelfUriPermission(     @NonNull Uri uri,     int modeFlags,     @NonNull String message ) void enforceCallingPermission(@NonNull String permission, String message) void enforceCallingUriPermission(     @NonNull Uri uri,     int modeFlags,     @NonNull String message ) void enforcePermission(     @NonNull String permission,     int pid,     int uid,     String message ) void enforceUriPermission(     @NonNull Uri uri,     int pid,     int uid,     int modeFlags,     @NonNull String message ) void enforceUriPermission(     Uri uri,     String readPermission,     String writePermission,     int pid,     int uid,     int modeFlags,     String message ) @NonNull String[] fileList() @NonNull Context getApplicationContext() @NonNull ApplicationInfo getApplicationInfo() @NonNull AssetManager getAssets() @NonNull AttributionSource getAttributionSource() @Nullable String getAttributionTag() @NonNull Context getBaseContext() @NonNull File getCacheDir() @NonNull ClassLoader getClassLoader() @NonNull File getCodeCacheDir() @NonNull ContentResolver getContentResolver() @NonNull File getDataDir() @NonNull File getDatabasePath(@NonNull String name) int getDeviceId() @NonNull File getDir(@NonNull String name, int mode) @Nullable Display getDisplay() @Nullable File getExternalCacheDir() @NonNull File[] getExternalCacheDirs() File getExternalFilesDir(String type) @NonNull File[] getExternalFilesDirs(@NonNull String type) @NonNull File[] getExternalMediaDirs() @NonNull File getFileStreamPath(@NonNull String name) @NonNull File getFilesDir() @NonNull Executor getMainExecutor() @NonNull Looper getMainLooper() @NonNull File getNoBackupFilesDir() @NonNull File getObbDir() @NonNull File[] getObbDirs() @NonNull String getOpPackageName() @NonNull String getPackageCodePath() @NonNull PackageManager getPackageManager() @NonNull String getPackageName() @NonNull String getPackageResourcePath() @Nullable ContextParams getParams() @NonNull Resources getResources() @NonNull SharedPreferences getSharedPreferences(@NonNull String name, int mode) @NonNull Object getSystemService(@NonNull String name) String getSystemServiceName(@NonNull Class<@NonNull ?> serviceClass) @NonNull Resources.Theme getTheme() @NonNull Drawable getWallpaper() This method is deprecated. Deprecated in Java int getWallpaperDesiredMinimumHeight() This method is deprecated. Deprecated in Java int getWallpaperDesiredMinimumWidth() This method is deprecated. Deprecated in Java void grantUriPermission(     @NonNull String toPackage,     @NonNull Uri uri,     int modeFlags ) boolean isDeviceProtectedStorage() boolean isRestricted() boolean isUiContext() boolean moveDatabaseFrom(@NonNull Context sourceContext, @NonNull String name) boolean moveSharedPreferencesFrom(     @NonNull Context sourceContext,     @NonNull String name ) @NonNull FileInputStream openFileInput(@NonNull String name) @NonNull FileOutputStream openFileOutput(@NonNull String name, int mode) @NonNull SQLiteDatabase openOrCreateDatabase(     @NonNull String name,     int mode,     @NonNull SQLiteDatabase.CursorFactory factory ) @NonNull SQLiteDatabase openOrCreateDatabase(     @NonNull String name,     int mode,     @NonNull SQLiteDatabase.CursorFactory factory,     DatabaseErrorHandler errorHandler ) @NonNull Drawable peekWallpaper() void rebindService(     @NonNull ServiceConnection conn,     @NonNull Context.BindServiceFlags flags ) void registerComponentCallbacks(@NonNull ComponentCallbacks callback) void registerDeviceIdChangeListener(     @NonNull Executor executor,     @NonNull IntConsumer listener ) Intent registerReceiver(     BroadcastReceiver receiver,     @NonNull IntentFilter filter ) Intent registerReceiver(     BroadcastReceiver receiver,     @NonNull IntentFilter filter,     int flags ) Intent registerReceiver(     BroadcastReceiver receiver,     @NonNull IntentFilter filter,     String broadcastPermission,     Handler scheduler ) Intent registerReceiver(     BroadcastReceiver receiver,     @NonNull IntentFilter filter,     String broadcastPermission,     Handler scheduler,     int flags ) void removeStickyBroadcast(@NonNull Intent intent) void removeStickyBroadcastAsUser(     @NonNull Intent intent,     @NonNull UserHandle user ) void revokeSelfPermissionsOnKill(     @NonNull Collection<@NonNull String> permissions ) void revokeUriPermission(@NonNull Uri uri, int modeFlags) void revokeUriPermission(     @NonNull String targetPackage,     @NonNull Uri uri,     int modeFlags ) void sendBroadcast(@NonNull Intent intent) void sendBroadcast(@NonNull Intent intent, String receiverPermission) void sendBroadcast(     @NonNull Intent intent,     String receiverPermission,     Bundle options ) void sendBroadcastAsUser(@NonNull Intent intent, @NonNull UserHandle user) void sendBroadcastAsUser(     @NonNull Intent intent,     @NonNull UserHandle user,     String receiverPermission ) void sendOrderedBroadcast(@NonNull Intent intent, String receiverPermission) void sendOrderedBroadcast(     @NonNull Intent intent,     String receiverPermission,     Bundle options ) void sendOrderedBroadcast(     @NonNull Intent intent,     String receiverPermission,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void sendOrderedBroadcast(     @NonNull Intent intent,     String receiverPermission,     Bundle options,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void sendOrderedBroadcast(     @NonNull Intent intent,     String receiverPermission,     String receiverAppOp,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void sendOrderedBroadcast(     @NonNull Intent intent,     int initialCode,     String receiverPermission,     String receiverAppOp,     BroadcastReceiver resultReceiver,     Handler scheduler,     String initialData,     Bundle initialExtras,     Bundle options ) void sendOrderedBroadcastAsUser(     @NonNull Intent intent,     @NonNull UserHandle user,     String receiverPermission,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void sendStickyBroadcast(@NonNull Intent intent) void sendStickyBroadcast(@NonNull Intent intent, Bundle options) void sendStickyBroadcastAsUser(@NonNull Intent intent, @NonNull UserHandle user) void sendStickyOrderedBroadcast(     @NonNull Intent intent,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void sendStickyOrderedBroadcastAsUser(     @NonNull Intent intent,     @NonNull UserHandle user,     BroadcastReceiver resultReceiver,     Handler scheduler,     int initialCode,     String initialData,     Bundle initialExtras ) void setTheme(int resid) void setWallpaper(@NonNull Bitmap bitmap) void setWallpaper(@NonNull InputStream data) void startActivities(@NonNull Intent[] intents) void startActivities(@NonNull Intent[] intents, Bundle options) void startActivity(@NonNull Intent intent) void startActivity(@NonNull Intent intent, Bundle options) ComponentName startForegroundService(@NonNull Intent service) boolean startInstrumentation(     @NonNull ComponentName className,     String profileFile,     Bundle arguments ) void startIntentSender(     @NonNull IntentSender intent,     Intent fillInIntent,     int flagsMask,     int flagsValues,     int extraFlags ) void startIntentSender(     @NonNull IntentSender intent,     Intent fillInIntent,     int flagsMask,     int flagsValues,     int extraFlags,     Bundle options ) ComponentName startService(@NonNull Intent service) boolean stopService(@NonNull Intent name) void unbindService(@NonNull ServiceConnection conn) void unregisterComponentCallbacks(@NonNull ComponentCallbacks callback) void unregisterDeviceIdChangeListener(@NonNull IntConsumer listener) void unregisterReceiver(@NonNull BroadcastReceiver receiver) void updateServiceBindings(     @NonNull Collection<@NonNull Context.UpdateBindingParams> params ) void updateServiceGroup(     @NonNull ServiceConnection conn,     int group,     int importance )
From android.app.Service void attachBaseContext(@NonNull Context newBase) void dump(     @NonNull FileDescriptor fd,     @NonNull PrintWriter writer,     @NonNull String[] args ) final @NonNull Application getApplication() final int getForegroundServiceType() void onConfigurationChanged(@NonNull Configuration newConfig) void onCreate() void onLowMemory() void onRebind(@NonNull Intent intent) void onStart(@NonNull Intent intent, int startId) int onStartCommand(@NonNull Intent intent, int flags, int startId) void onTaskRemoved(@NonNull Intent rootIntent) void onTimeout(int startId) void onTimeout(int startId, int fgsType) void onTrimMemory(int level) boolean onUnbind(@NonNull Intent intent) final void startForeground(int id, @NonNull Notification notification) final void startForeground(     int id,     @NonNull Notification notification,     int foregroundServiceType ) final void stopForeground(int notificationBehavior) final void stopForeground(boolean removeNotification) final void stopSelf() final void stopSelf(int startId) final boolean stopSelfResult(int startId)

Public constructors

SuspendingTimelineComplicationDataSourceService

Added in 1.1.0

public SuspendingTimelineComplicationDataSourceService()

Public methods

onComplicationRequest

@UiThread
public abstract ComplicationDataTimeline onComplicationRequest(@NonNull ComplicationRequest request)

Computes the ComplicationDataTimeline for the given request.

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

See also
onComplicationRequest
onComplicationData

onComplicationRequest

Added in 1.1.0

public final void onComplicationRequest(
    @NonNull ComplicationRequest request,
    @NonNull ComplicationDataSourceService.ComplicationRequestListener listener
)

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
@NonNull ComplicationRequest request	The details about the complication that has been requested.
@NonNull ComplicationDataSourceService.ComplicationRequestListener listener	The callback to pass the result to the system.

onDestroy

public void onDestroy()