ListenableWatchFaceService

Artifact: androidx.wear.watchface:watchface-guava

Added in 1.0.0

Kotlin |Java

public abstract class ListenableWatchFaceService extends WatchFaceService

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.service.wallpaper.WallpaperService
				↳	androidx.wear.watchface.WatchFaceService
					↳	androidx.wear.watchface.ListenableWatchFaceService

ListenableFuture-based compatibility wrapper around WatchFaceService's suspending WatchFaceService.createWatchFace.

ListenableWatchFaceServices are required to be stateless as multiple can be created in parallel. If per instance state is required please use ListenableStatefulWatchFaceService.

Summary

Public constructors
`ListenableWatchFaceService()`

Protected methods
`@NonNull WatchFace`	`createWatchFace( @NonNull SurfaceHolder surfaceHolder, @NonNull WatchState watchState, @NonNull ComplicationSlotsManager complicationSlotsManager, @NonNull CurrentUserStyleRepository currentUserStyleRepository )` Override this factory method to create your WatchFaceImpl.
`abstract @NonNull ListenableFuture<@NonNull WatchFace>`	`createWatchFaceFuture( @NonNull SurfaceHolder surfaceHolder, @NonNull WatchState watchState, @NonNull ComplicationSlotsManager complicationSlotsManager, @NonNull CurrentUserStyleRepository currentUserStyleRepository )` Override this factory method to create your WatchFaceImpl.

Inherited methods

From android.content.Context

`boolean`	`bindIsolatedService( @NonNull Intent p0, @NonNull Context.BindServiceFlags p1, @NonNull String p2, @NonNull Executor p3, @NonNull ServiceConnection p4 )`
`final int`	`getColor(int p0)`
`final @NonNull ColorStateList`	`getColorStateList(int p0)`
`final @Nullable Drawable`	`getDrawable(int p0)`
`final @NonNull String`	`getString(int p0)`
`final @NonNull String`	`getString(int p0, @NonNull Object p1)`
`final @NonNull T`	`<T extends Object> getSystemService(@NonNull Class<@NonNull T> p0)`
`final @NonNull CharSequence`	`getText(int p0)`
`final @NonNull TypedArray`	`obtainStyledAttributes(@NonNull int[] p0)`
`final @NonNull TypedArray`	`obtainStyledAttributes(@Nullable AttributeSet p0, @NonNull int[] p1)`
`final @NonNull TypedArray`	`obtainStyledAttributes(int p0, @NonNull int[] p1)`
`final @NonNull TypedArray`	`obtainStyledAttributes( @Nullable AttributeSet p0, @NonNull int[] p1, int p2, int p3 )`
`void`	`revokeSelfPermissionOnKill(@NonNull String p0)`
`void`	`sendBroadcastWithMultiplePermissions( @NonNull Intent p0, @NonNull String[] p1 )`

From android.content.ContextWrapper

`boolean`	`bindIsolatedService( @NonNull Intent p0, int p1, @NonNull String p2, @NonNull Executor p3, @NonNull ServiceConnection p4 )`
`boolean`	`bindService( @NonNull Intent p0, @NonNull ServiceConnection p1, @NonNull Context.BindServiceFlags p2 )`
`boolean`	`bindService(@NonNull Intent p0, @NonNull ServiceConnection p1, int p2)`
`boolean`	`bindService( @NonNull Intent p0, @NonNull Context.BindServiceFlags p1, @NonNull Executor p2, @NonNull ServiceConnection p3 )`
`boolean`	`bindService( @NonNull Intent p0, int p1, @NonNull Executor p2, @NonNull ServiceConnection p3 )`
`boolean`	`bindServiceAsUser( @NonNull Intent p0, @NonNull ServiceConnection p1, @NonNull Context.BindServiceFlags p2, @NonNull UserHandle p3 )`
`boolean`	`bindServiceAsUser( @NonNull Intent p0, @NonNull ServiceConnection p1, int p2, @NonNull UserHandle p3 )`
`int`	`checkCallingOrSelfPermission(@NonNull String p0)`
`int`	`checkCallingOrSelfUriPermission(@NonNull Uri p0, int p1)`
`@NonNull int[]`	`checkCallingOrSelfUriPermissions(@NonNull List<@NonNull Uri> p0, int p1)`
`int`	`checkCallingPermission(@NonNull String p0)`
`int`	`checkCallingUriPermission(@NonNull Uri p0, int p1)`
`@NonNull int[]`	`checkCallingUriPermissions(@NonNull List<@NonNull Uri> p0, int p1)`
`int`	`checkPermission(@NonNull String p0, int p1, int p2)`
`int`	`checkSelfPermission(@NonNull String p0)`
`int`	`checkUriPermission(@NonNull Uri p0, int p1, int p2, int p3)`
`int`	`checkUriPermission( @Nullable Uri p0, @Nullable String p1, @Nullable String p2, int p3, int p4, int p5 )`
`@NonNull int[]`	`checkUriPermissions(@NonNull List<@NonNull Uri> p0, int p1, int p2, int p3)`
`void`	`clearWallpaper()` This method is deprecated. Deprecated in Java
`@NonNull Context`	`createAttributionContext(@Nullable String p0)`
`@NonNull Context`	`createConfigurationContext(@NonNull Configuration p0)`
`@NonNull Context`	`createContext(@NonNull ContextParams p0)`
`@NonNull Context`	`createContextForSplit(@NonNull String p0)`
`@NonNull Context`	`createDeviceContext(int p0)`
`@NonNull Context`	`createDeviceProtectedStorageContext()`
`@NonNull Context`	`createDisplayContext(@NonNull Display p0)`
`@NonNull Context`	`createPackageContext(@NonNull String p0, int p1)`
`@NonNull Context`	`createWindowContext(int p0, @Nullable Bundle p1)`
`@NonNull Context`	`createWindowContext(@NonNull Display p0, int p1, @Nullable Bundle p2)`
`@NonNull String[]`	`databaseList()`
`boolean`	`deleteDatabase(@NonNull String p0)`
`boolean`	`deleteFile(@NonNull String p0)`
`boolean`	`deleteSharedPreferences(@NonNull String p0)`
`void`	`enforceCallingOrSelfPermission(@NonNull String p0, @Nullable String p1)`
`void`	`enforceCallingOrSelfUriPermission( @NonNull Uri p0, int p1, @NonNull String p2 )`
`void`	`enforceCallingPermission(@NonNull String p0, @Nullable String p1)`
`void`	`enforceCallingUriPermission(@NonNull Uri p0, int p1, @NonNull String p2)`
`void`	`enforcePermission(@NonNull String p0, int p1, int p2, @Nullable String p3)`
`void`	`enforceUriPermission( @NonNull Uri p0, int p1, int p2, int p3, @NonNull String p4 )`
`void`	`enforceUriPermission( @Nullable Uri p0, @Nullable String p1, @Nullable String p2, int p3, int p4, int p5, @Nullable String p6 )`
`@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 p0)`
`int`	`getDeviceId()`
`@NonNull File`	`getDir(@NonNull String p0, int p1)`
`@Nullable Display`	`getDisplay()`
`@Nullable File`	`getExternalCacheDir()`
`@NonNull File[]`	`getExternalCacheDirs()`
`@Nullable File`	`getExternalFilesDir(@Nullable String p0)`
`@NonNull File[]`	`getExternalFilesDirs(@NonNull String p0)`
`@NonNull File[]`	`getExternalMediaDirs()`
`@NonNull File`	`getFileStreamPath(@NonNull String p0)`
`@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 p0, int p1)`
`@NonNull Object`	`getSystemService(@NonNull String p0)`
`String`	`getSystemServiceName(@NonNull Class<@NonNull ?> p0)`
`@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 p0, @NonNull Uri p1, int p2)`
`boolean`	`isDeviceProtectedStorage()`
`boolean`	`isRestricted()`
`boolean`	`isUiContext()`
`boolean`	`moveDatabaseFrom(@NonNull Context p0, @NonNull String p1)`
`boolean`	`moveSharedPreferencesFrom(@NonNull Context p0, @NonNull String p1)`
`@NonNull FileInputStream`	`openFileInput(@NonNull String p0)`
`@NonNull FileOutputStream`	`openFileOutput(@NonNull String p0, int p1)`
`@NonNull SQLiteDatabase`	`openOrCreateDatabase( @NonNull String p0, int p1, @NonNull SQLiteDatabase.CursorFactory p2 )`
`@NonNull SQLiteDatabase`	`openOrCreateDatabase( @NonNull String p0, int p1, @NonNull SQLiteDatabase.CursorFactory p2, @Nullable DatabaseErrorHandler p3 )`
`@NonNull Drawable`	`peekWallpaper()` This method is deprecated. Deprecated in Java
`void`	`registerComponentCallbacks(@NonNull ComponentCallbacks p0)`
`void`	`registerDeviceIdChangeListener( @NonNull Executor p0, @NonNull IntConsumer p1 )`
`Intent`	`registerReceiver(@Nullable BroadcastReceiver p0, @NonNull IntentFilter p1)`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, int p2 )`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, @Nullable String p2, @Nullable Handler p3 )`
`Intent`	`registerReceiver( @Nullable BroadcastReceiver p0, @NonNull IntentFilter p1, @Nullable String p2, @Nullable Handler p3, int p4 )`
`void`	`removeStickyBroadcast(@NonNull Intent p0)` This method is deprecated. Deprecated in Java
`void`	`removeStickyBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)` This method is deprecated. Deprecated in Java
`void`	`revokeSelfPermissionsOnKill(@NonNull Collection<@NonNull String> p0)`
`void`	`revokeUriPermission(@NonNull Uri p0, int p1)`
`void`	`revokeUriPermission(@NonNull String p0, @NonNull Uri p1, int p2)`
`void`	`sendBroadcast(@NonNull Intent p0)`
`void`	`sendBroadcast(@NonNull Intent p0, @Nullable String p1)`
`void`	`sendBroadcast(@NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2)`
`void`	`sendBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)`
`void`	`sendBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1, String p2)`
`void`	`sendOrderedBroadcast(@NonNull Intent p0, @Nullable String p1)`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable BroadcastReceiver p2, @Nullable Handler p3, int p4, @Nullable String p5, @Nullable Bundle p6 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable Bundle p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, @Nullable String p1, @Nullable String p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendOrderedBroadcast( @NonNull Intent p0, int p1, @Nullable String p2, @Nullable String p3, @Nullable BroadcastReceiver p4, @Nullable Handler p5, @Nullable String p6, @Nullable Bundle p7, @Nullable Bundle p8 )`
`void`	`sendOrderedBroadcastAsUser( @NonNull Intent p0, @NonNull UserHandle p1, @Nullable String p2, @Nullable BroadcastReceiver p3, @Nullable Handler p4, int p5, @Nullable String p6, @Nullable Bundle p7 )`
`void`	`sendStickyBroadcast(@NonNull Intent p0)` This method is deprecated. Deprecated in Java
`void`	`sendStickyBroadcast(@NonNull Intent p0, @Nullable Bundle p1)` This method is deprecated. Deprecated in Java
`void`	`sendStickyBroadcastAsUser(@NonNull Intent p0, @NonNull UserHandle p1)` This method is deprecated. Deprecated in Java
`void`	`sendStickyOrderedBroadcast( @NonNull Intent p0, @Nullable BroadcastReceiver p1, @Nullable Handler p2, int p3, @Nullable String p4, @Nullable Bundle p5 )` This method is deprecated. Deprecated in Java
`void`	`sendStickyOrderedBroadcastAsUser( @NonNull Intent p0, @NonNull UserHandle p1, @Nullable BroadcastReceiver p2, @Nullable Handler p3, int p4, @Nullable String p5, @Nullable Bundle p6 )` This method is deprecated. Deprecated in Java
`void`	`setTheme(int p0)`
`void`	`setWallpaper(@NonNull Bitmap p0)` This method is deprecated. Deprecated in Java
`void`	`setWallpaper(@NonNull InputStream p0)` This method is deprecated. Deprecated in Java
`void`	`startActivities(@NonNull Intent[] p0)`
`void`	`startActivities(@NonNull Intent[] p0, @Nullable Bundle p1)`
`void`	`startActivity(@NonNull Intent p0)`
`void`	`startActivity(@NonNull Intent p0, @Nullable Bundle p1)`
`@Nullable ComponentName`	`startForegroundService(@NonNull Intent p0)`
`boolean`	`startInstrumentation( @NonNull ComponentName p0, @Nullable String p1, @Nullable Bundle p2 )`
`void`	`startIntentSender( @NonNull IntentSender p0, @Nullable Intent p1, int p2, int p3, int p4 )`
`void`	`startIntentSender( @NonNull IntentSender p0, @Nullable Intent p1, int p2, int p3, int p4, @Nullable Bundle p5 )`
`@Nullable ComponentName`	`startService(@NonNull Intent p0)`
`boolean`	`stopService(@NonNull Intent p0)`
`void`	`unbindService(@NonNull ServiceConnection p0)`
`void`	`unregisterComponentCallbacks(@NonNull ComponentCallbacks p0)`
`void`	`unregisterDeviceIdChangeListener(@NonNull IntConsumer p0)`
`void`	`unregisterReceiver(@NonNull BroadcastReceiver p0)`
`void`	`updateServiceGroup(@NonNull ServiceConnection p0, int p1, int p2)`

From android.app.Service

`void`	`attachBaseContext(@NonNull Context p0)`
`final @NonNull Application`	`getApplication()`
`final int`	`getForegroundServiceType()`
`void`	`onLowMemory()`
`void`	`onRebind(@NonNull Intent p0)`
`void`	`onStart(@NonNull Intent p0, int p1)` This method is deprecated. Deprecated in Java
`int`	`onStartCommand(@NonNull Intent p0, int p1, int p2)`
`void`	`onTaskRemoved(@NonNull Intent p0)`
`void`	`onTimeout(int p0)`
`void`	`onTrimMemory(int p0)`
`boolean`	`onUnbind(@NonNull Intent p0)`
`final void`	`startForeground(int p0, @NonNull Notification p1)`
`final void`	`startForeground(int p0, @NonNull Notification p1, int p2)`
`final void`	`stopForeground(boolean p0)` This method is deprecated. Deprecated in Java
`final void`	`stopForeground(int p0)`
`final void`	`stopSelf()`
`final void`	`stopSelf(int p0)`
`final boolean`	`stopSelfResult(int p0)`

From android.service.wallpaper.WallpaperService

`final IBinder`	`onBind(@NonNull Intent p0)`
`void`	`onCreate()`
`void`	`onDestroy()`

From androidx.wear.watchface.WatchFaceService

`@NonNull ComplicationSlotsManager`	`@WorkerThread createComplicationSlotsManager( @NonNull CurrentUserStyleRepository currentUserStyleRepository )` If the WatchFaceService's manifest doesn't define a androidx.wear.watchface.XmlSchemaAndComplicationSlotsDefinition meta data tag then override this factory method to create a non-empty `ComplicationSlotsManager`.
`@NonNull UserStyleFlavors`	`@WorkerThread createUserStyleFlavors( @NonNull CurrentUserStyleRepository currentUserStyleRepository, @NonNull ComplicationSlotsManager complicationSlotsManager )` If the WatchFaceService's manifest doesn't define a androidx.wear.watchface.XmlSchemaAndComplicationSlotsDefinition meta data tag then override this factory method to create non-empty `UserStyleFlavors`.
`@NonNull UserStyleSchema`	`@WorkerThread createUserStyleSchema()` If the WatchFaceService's manifest doesn't define an androidx.wear.watchface.XmlSchemaAndComplicationSlotsDefinition meta data tag then override this factory method to create a non-empty `UserStyleSchema`.
`void`	`@UiThread dump( @NonNull FileDescriptor fd, @NonNull PrintWriter writer, @NonNull String[] args )`
`final @NonNull Handler`	`getBackgroundThreadHandler()` Returns the lazily constructed background thread `Handler`.
`ComplicationSlotInflationFactory`	`@WorkerThread getComplicationSlotInflationFactory()` This method is deprecated. Use the version with currentUserStyleRepository argument instead
`@NonNull ComplicationSlotInflationFactory`	`@WorkerThread getComplicationSlotInflationFactory( @NonNull CurrentUserStyleRepository currentUserStyleRepository )` Used when inflating `ComplicationSlot`s from XML (i.e the manifest contains androidx.wear.watchface.XmlSchemaAndComplicationSlotsDefinition metadata) to provide a `ComplicationSlotInflationFactory` which provides the `CanvasComplicationFactory` and where necessary edge complication `ComplicationTapFilter`s needed for inflating `ComplicationSlot`s.
`final @NonNull Handler`	`getUiThreadHandler()` Returns the ui thread `Handler`.
`void`	`onConfigurationChanged(@NonNull Configuration newConfig)`
`final @NonNull WallpaperService.Engine`	`onCreateEngine()` Creates an interactive engine for WallpaperService.

Public constructors

ListenableWatchFaceService

Added in 1.0.0

public ListenableWatchFaceService()

Protected methods

createWatchFace

protected @NonNull WatchFace createWatchFace(
    @NonNull SurfaceHolder surfaceHolder,
    @NonNull WatchState watchState,
    @NonNull ComplicationSlotsManager complicationSlotsManager,
    @NonNull CurrentUserStyleRepository currentUserStyleRepository
)

Override this factory method to create your WatchFaceImpl. This method will be called by the library on a background thread, if possible any expensive initialization should be done asynchronously. The WatchFace and its Renderer should be accessed exclusively from the UiThread afterwards. There is a memory barrier between construction and rendering so no special threading primitives are required.

Warning the system will likely time out waiting for watch face initialization if it takes longer than MAX_CREATE_WATCHFACE_TIME_MILLIS milliseconds.

Parameters
`@NonNull SurfaceHolder surfaceHolder`	The `SurfaceHolder` to pass to the `Renderer`'s constructor.
`@NonNull WatchState watchState`	The `WatchState` for the watch face.
`@NonNull ComplicationSlotsManager complicationSlotsManager`	The `ComplicationSlotsManager` returned by `createComplicationSlotsManager`.
`@NonNull CurrentUserStyleRepository currentUserStyleRepository`	The `CurrentUserStyleRepository` constructed using the `UserStyleSchema` returned by `createUserStyleSchema`.

Returns
`@NonNull WatchFace`	A `WatchFace` whose `Renderer` uses the provided `surfaceHolder`.

createWatchFaceFuture

Added in 1.0.0

protected abstract @NonNull ListenableFuture<@NonNull WatchFace> createWatchFaceFuture(
    @NonNull SurfaceHolder surfaceHolder,
    @NonNull WatchState watchState,
    @NonNull ComplicationSlotsManager complicationSlotsManager,
    @NonNull CurrentUserStyleRepository currentUserStyleRepository
)

Warning the system will likely time out waiting for watch face initialization if it takes longer than MAX_CREATE_WATCHFACE_TIME_MILLIS milliseconds.

Note cancellation of the returned future is not supported.

Parameters
`@NonNull SurfaceHolder surfaceHolder`	The `SurfaceHolder` to pass to the `Renderer`'s constructor.
`@NonNull WatchState watchState`	The `WatchState` for the watch face.
`@NonNull ComplicationSlotsManager complicationSlotsManager`	The `ComplicationSlotsManager` returned by `createComplicationSlotsManager`.
`@NonNull CurrentUserStyleRepository currentUserStyleRepository`	The `CurrentUserStyleRepository` constructed using the `UserStyleSchema` returned by `createUserStyleSchema`.

Returns
`@NonNull ListenableFuture<@NonNull WatchFace>`	A `ListenableFuture` for a `WatchFace` whose `Renderer` uses the provided `surfaceHolder`.