ListenableWatchFaceService

Artifact: androidx.wear.watchface:watchface-guava

Added in 1.0.0

Kotlin |Java

abstract class ListenableWatchFaceService : WatchFaceService

kotlin.Any
↳	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 functions
`open suspend WatchFace`	`createWatchFace( surfaceHolder: SurfaceHolder, watchState: WatchState, complicationSlotsManager: ComplicationSlotsManager, currentUserStyleRepository: CurrentUserStyleRepository )` Override this factory method to create your WatchFaceImpl.
`abstract ListenableFuture<WatchFace>`	`createWatchFaceFuture( surfaceHolder: SurfaceHolder, watchState: WatchState, complicationSlotsManager: ComplicationSlotsManager, currentUserStyleRepository: CurrentUserStyleRepository )` Override this factory method to create your WatchFaceImpl.

Inherited functions

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)`
`Application`	`getApplication()`
`Int`	`getForegroundServiceType()`
`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)`

From android.service.wallpaper.WallpaperService

`final IBinder?`	`onBind(p0: Intent)`
`open Unit`	`onCreate()`
`open Unit`	`onDestroy()`

From androidx.wear.watchface.WatchFaceService

`open ComplicationSlotsManager`	`@WorkerThread createComplicationSlotsManager( 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`.
`open UserStyleFlavors`	`@WorkerThread createUserStyleFlavors( currentUserStyleRepository: CurrentUserStyleRepository, 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`.
`open 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`.
`open Unit`	`@UiThread dump(fd: FileDescriptor, writer: PrintWriter, args: Array<String>)`
`Handler`	`getBackgroundThreadHandler()` Returns the lazily constructed background thread `Handler`.
`open ComplicationSlotInflationFactory?`	`@WorkerThread getComplicationSlotInflationFactory()` This function is deprecated. Use the version with currentUserStyleRepository argument instead
`open ComplicationSlotInflationFactory`	`@WorkerThread getComplicationSlotInflationFactory( 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.
`Handler`	`getUiThreadHandler()` Returns the ui thread `Handler`.
`open Unit`	`onConfigurationChanged(newConfig: Configuration)`
`final WallpaperService.Engine`	`onCreateEngine()` Creates an interactive engine for WallpaperService.

Public constructors

ListenableWatchFaceService

Added in 1.0.0

ListenableWatchFaceService()

Protected functions

createWatchFace

protected open suspend fun createWatchFace(
    surfaceHolder: SurfaceHolder,
    watchState: WatchState,
    complicationSlotsManager: ComplicationSlotsManager,
    currentUserStyleRepository: CurrentUserStyleRepository
): WatchFace

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
`surfaceHolder: SurfaceHolder`	The `SurfaceHolder` to pass to the `Renderer`'s constructor.
`watchState: WatchState`	The `WatchState` for the watch face.
`complicationSlotsManager: ComplicationSlotsManager`	The `ComplicationSlotsManager` returned by `createComplicationSlotsManager`.
`currentUserStyleRepository: CurrentUserStyleRepository`	The `CurrentUserStyleRepository` constructed using the `UserStyleSchema` returned by `createUserStyleSchema`.

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

createWatchFaceFuture

Added in 1.0.0

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

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
`surfaceHolder: SurfaceHolder`	The `SurfaceHolder` to pass to the `Renderer`'s constructor.
`watchState: WatchState`	The `WatchState` for the watch face.
`complicationSlotsManager: ComplicationSlotsManager`	The `ComplicationSlotsManager` returned by `createComplicationSlotsManager`.
`currentUserStyleRepository: CurrentUserStyleRepository`	The `CurrentUserStyleRepository` constructed using the `UserStyleSchema` returned by `createUserStyleSchema`.

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