Material3TileService

Kotlin |Java

abstract class Material3TileService : TileService

kotlin.Any
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.wear.tiles.TileService
				↳	androidx.wear.tiles.Material3TileService

Base class for a service providing data for an app's tile that includes ProtoLayoutScope for automatic resource registration and opinionated MaterialScope for Material3 styling of components and layout.

A provider service must implement tileResponse to respond to requests for updates from the system. Tile response should contain layout and resources in the same response.

The manifest declaration of this service must include an intent filter for TileService.ACTION_BIND_TILE_PROVIDER.

The manifest entry should also include android:permission="com.google.android.wearable.permission.BIND_TILE_PROVIDER" to ensure that only the system can bind to it.

import androidx.wear.protolayout.TimelineBuilders.Timeline
import androidx.wear.protolayout.layout.imageResource
import androidx.wear.protolayout.layout.lottieResource
import androidx.wear.protolayout.material3.ColorScheme
import androidx.wear.protolayout.material3.MaterialScope
import androidx.wear.protolayout.material3.backgroundImage
import androidx.wear.protolayout.material3.imageButton
import androidx.wear.protolayout.material3.primaryLayout
import androidx.wear.protolayout.modifiers.clickable
import androidx.wear.tiles.Material3TileService
import androidx.wear.tiles.RequestBuilders.TileRequest
import androidx.wear.tiles.TileBuilders.Tile

object : Material3TileService(defaultColorScheme = myColorScheme) {
        override suspend fun MaterialScope.tileResponse(requestParams: TileRequest): Tile =
            Tile.Builder()
                .setTileTimeline(
                    Timeline.fromLayoutElement(
                        primaryLayout(
                            mainSlot = {
                                imageButton(
                                    onClick = clickable(),
                                    backgroundContent = {
                                        backgroundImage(
                                            resource =
                                                imageResource(
                                                    lottie =
                                                        lottieResource(rawResourceId = lottieResId)
                                                )
                                        )
                                    },
                                )
                            }
                        )
                    )
                )
                .build()
    }

Summary

Public constructors
`Material3TileService( allowDynamicTheme: Boolean, defaultColorScheme: ColorScheme, serviceScope: CoroutineScope? )`

Public functions
`open Unit`	`@CallSuper onCreate()`
`open Unit`	`@CallSuper onDestroy()`

Protected functions
`abstract suspend TileBuilders.Tile`	`MaterialScope.tileResponse(requestParams: RequestBuilders.TileRequest)` Called when the system is requesting a new timeline from this Tile Provider.

Inherited functions

From android.content.ComponentCallbacks

`open Unit`	`onConfigurationChanged(newConfig: Configuration)`
`open Unit`	`onLowMemory()`

From android.content.ComponentCallbacks2

open Unit

onTrimMemory(level: Int)

From android.content.Context

`open Boolean`	`bindIsolatedService( service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection )`
`open Boolean`	`bindIsolatedService( service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection )`
`open Boolean`	`bindService( service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags )`
`open Boolean`	`bindService(service: Intent, conn: ServiceConnection, flags: Int)`
`open Boolean`	`bindService( service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection )`
`open Boolean`	`bindService( service: Intent, flags: Int, executor: Executor, conn: ServiceConnection )`
`open Boolean`	`bindServiceAsUser( service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags, user: UserHandle )`
`open Boolean`	`bindServiceAsUser( service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle )`
`open Int`	`checkCallingOrSelfPermission(permission: String)`
`open Int`	`checkCallingOrSelfUriPermission(uri: Uri, modeFlags: Int)`
`open IntArray`	`checkCallingOrSelfUriPermissions(uris: MutableList<Uri>, modeFlags: Int)`
`open Int`	`checkCallingPermission(permission: String)`
`open Int`	`checkCallingUriPermission(uri: Uri, modeFlags: Int)`
`open IntArray`	`checkCallingUriPermissions(uris: MutableList<Uri>, modeFlags: Int)`
`open Int`	`checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int)`
`open Int`	`checkPermission(permission: String, pid: Int, uid: Int)`
`open Int`	`checkSelfPermission(permission: String)`
`open Int`	`checkUriPermission(uri: Uri, pid: Int, uid: Int, modeFlags: Int)`
`open Int`	`checkUriPermission( uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int )`
`open IntArray`	`checkUriPermissions( uris: MutableList<Uri>, pid: Int, uid: Int, modeFlags: Int )`
`open Unit`	`clearWallpaper()` This function is deprecated. Deprecated in Java
`open Context`	`createAttributionContext(attributionTag: String?)`
`open Context`	`createConfigurationContext(overrideConfiguration: Configuration)`
`open Context`	`createContext(contextParams: ContextParams)`
`open Context`	`createContextForSplit(splitName: String)`
`open Context`	`createDeviceContext(deviceId: Int)`
`open Context`	`createDeviceProtectedStorageContext()`
`open Context`	`createDisplayContext(display: Display)`
`open Context`	`createPackageContext(packageName: String, flags: Int)`
`open Context`	`createWindowContext(type: Int, options: Bundle?)`
`open Context`	`createWindowContext(display: Display, type: Int, options: Bundle?)`
`open Array<String>`	`databaseList()`
`open Boolean`	`deleteDatabase(name: String)`
`open Boolean`	`deleteFile(name: String)`
`open Boolean`	`deleteSharedPreferences(name: String)`
`open Unit`	`enforceCallingOrSelfPermission(permission: String, message: String?)`
`open Unit`	`enforceCallingOrSelfUriPermission( uri: Uri, modeFlags: Int, message: String )`
`open Unit`	`enforceCallingPermission(permission: String, message: String?)`
`open Unit`	`enforceCallingUriPermission(uri: Uri, modeFlags: Int, message: String)`
`open Unit`	`enforcePermission(permission: String, pid: Int, uid: Int, message: String?)`
`open Unit`	`enforceUriPermission( uri: Uri, pid: Int, uid: Int, modeFlags: Int, message: String )`
`open Unit`	`enforceUriPermission( uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String? )`
`open Array<String>`	`fileList()`
`Int`	`getColor(id: Int)`
`ColorStateList`	`getColorStateList(id: Int)`
`open File`	`getDatabasePath(name: String)`
`open File`	`getDir(name: String, mode: Int)`
`Drawable?`	`getDrawable(id: Int)`
`open File?`	`getExternalFilesDir(type: String?)`
`open Array<File>`	`getExternalFilesDirs(type: String)`
`open File`	`getFileStreamPath(name: String)`
`open SharedPreferences`	`getSharedPreferences(name: String, mode: Int)`
`String`	`getString(resId: Int)`
`String`	`getString(resId: Int, vararg formatArgs: Any)`
`open Any`	`getSystemService(name: String)`
`T`	`<T : Any> getSystemService(serviceClass: Class<T>)`
`open String?`	`getSystemServiceName(serviceClass: Class<*>)`
`CharSequence`	`getText(resId: Int)`
`open Unit`	`grantUriPermission(toPackage: String, uri: Uri, modeFlags: Int)`
`open Boolean`	`moveDatabaseFrom(sourceContext: Context, name: String)`
`open Boolean`	`moveSharedPreferencesFrom(sourceContext: Context, name: String)`
`TypedArray`	`obtainStyledAttributes(attrs: IntArray)`
`TypedArray`	`obtainStyledAttributes(resid: Int, attrs: IntArray)`
`TypedArray`	`obtainStyledAttributes(set: AttributeSet?, attrs: IntArray)`
`TypedArray`	`obtainStyledAttributes( set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int )`
`open FileInputStream`	`openFileInput(name: String)`
`open FileOutputStream`	`openFileOutput(name: String, mode: Int)`
`open SQLiteDatabase`	`openOrCreateDatabase( name: String, mode: Int, factory: SQLiteDatabase.CursorFactory )`
`open SQLiteDatabase`	`openOrCreateDatabase( name: String, mode: Int, factory: SQLiteDatabase.CursorFactory, errorHandler: DatabaseErrorHandler? )`
`open Drawable`	`peekWallpaper()` This function is deprecated. Deprecated in Java
`open Unit`	`registerComponentCallbacks(callback: ComponentCallbacks)`
`open Unit`	`registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer)`
`open Intent?`	`registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter)`
`open Intent?`	`registerReceiver( receiver: BroadcastReceiver?, filter: IntentFilter, flags: Int )`
`open Intent?`	`registerReceiver( receiver: BroadcastReceiver?, filter: IntentFilter, broadcastPermission: String?, scheduler: Handler? )`
`open Intent?`	`registerReceiver( receiver: BroadcastReceiver?, filter: IntentFilter, broadcastPermission: String?, scheduler: Handler?, flags: Int )`
`open Unit`	`removeStickyBroadcast(intent: Intent)` This function is deprecated. Deprecated in Java
`open Unit`	`removeStickyBroadcastAsUser(intent: Intent, user: UserHandle)` This function is deprecated. Deprecated in Java
`open Unit`	`revokeSelfPermissionOnKill(permName: String)`
`open Unit`	`revokeSelfPermissionsOnKill(permissions: MutableCollection<String>)`
`open Unit`	`revokeUriPermission(uri: Uri, modeFlags: Int)`
`open Unit`	`revokeUriPermission(targetPackage: String, uri: Uri, modeFlags: Int)`
`open Unit`	`sendBroadcast(intent: Intent)`
`open Unit`	`sendBroadcast(intent: Intent, receiverPermission: String?)`
`open Unit`	`sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?)`
`open Unit`	`sendBroadcastAsUser(intent: Intent, user: UserHandle)`
`open Unit`	`sendBroadcastAsUser( intent: Intent, user: UserHandle, receiverPermission: String? )`
`open Unit`	`sendBroadcastWithMultiplePermissions( intent: Intent, receiverPermissions: Array<String> )`
`open Unit`	`sendOrderedBroadcast(intent: Intent, receiverPermission: String?)`
`open Unit`	`sendOrderedBroadcast( intent: Intent, receiverPermission: String?, options: Bundle? )`
`open Unit`	`sendOrderedBroadcast( intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )`
`open Unit`	`sendOrderedBroadcast( intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )`
`open Unit`	`sendOrderedBroadcast( intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )`
`open Unit`	`sendOrderedBroadcastAsUser( intent: Intent, user: UserHandle, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )`
`open Unit`	`sendStickyBroadcast(intent: Intent)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyBroadcast(intent: Intent, options: Bundle?)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyBroadcastAsUser(intent: Intent, user: UserHandle)` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyOrderedBroadcast( intent: Intent, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )` This function is deprecated. Deprecated in Java
`open Unit`	`sendStickyOrderedBroadcastAsUser( intent: Intent, user: UserHandle, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle? )` This function is deprecated. Deprecated in Java
`open Unit`	`setTheme(resid: Int)`
`open Unit`	`setWallpaper(bitmap: Bitmap)` This function is deprecated. Deprecated in Java
`open Unit`	`setWallpaper(data: InputStream)` This function is deprecated. Deprecated in Java
`open Unit`	`startActivities(intents: Array<Intent>)`
`open Unit`	`startActivities(intents: Array<Intent>, options: Bundle?)`
`open Unit`	`startActivity(intent: Intent)`
`open Unit`	`startActivity(intent: Intent, options: Bundle?)`
`open ComponentName?`	`startForegroundService(service: Intent)`
`open Boolean`	`startInstrumentation( className: ComponentName, profileFile: String?, arguments: Bundle? )`
`open Unit`	`startIntentSender( intent: IntentSender, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int )`
`open Unit`	`startIntentSender( intent: IntentSender, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle? )`
`open ComponentName?`	`startService(service: Intent)`
`open Boolean`	`stopService(name: Intent)`
`open Unit`	`unbindService(conn: ServiceConnection)`
`open Unit`	`unregisterComponentCallbacks(callback: ComponentCallbacks)`
`open Unit`	`unregisterDeviceIdChangeListener(listener: IntConsumer)`
`open Unit`	`unregisterReceiver(receiver: BroadcastReceiver)`
`open Unit`	`updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)`

From android.content.ContextWrapper

`open Unit`	`attachBaseContext(newBase: Context)`
`open Unit`	`sendOrderedBroadcast( intent: Intent, initialCode: Int, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialData: String?, initialExtras: Bundle?, options: Bundle? )`

From android.app.Service

`open Unit`	`dump(fd: FileDescriptor, writer: PrintWriter, args: Array<String>)`
`open IBinder?`	`onBind(intent: Intent)`
`open Unit`	`onRebind(intent: Intent)`
`open Unit`	`onStart(intent: Intent, startId: Int)` This function is deprecated. Deprecated in Java
`open Int`	`onStartCommand(intent: Intent, flags: Int, startId: Int)`
`open Unit`	`onTaskRemoved(rootIntent: Intent)`
`open Unit`	`onTimeout(startId: Int)`
`open Unit`	`onTimeout(startId: Int, fgsType: Int)`
`open Boolean`	`onUnbind(intent: Intent)`
`Unit`	`startForeground(id: Int, notification: Notification)`
`Unit`	`startForeground( id: Int, notification: Notification, foregroundServiceType: Int )`
`Unit`	`stopForeground(notificationBehavior: Int)`
`Unit`	`stopForeground(removeNotification: Boolean)` This function is deprecated. Deprecated in Java
`Unit`	`stopSelf()`
`Unit`	`stopSelf(startId: Int)`
`Boolean`	`stopSelfResult(startId: Int)`

From androidx.wear.tiles.TileService

`open ListenableFuture<Void>`	`@MainThread onRecentInteractionEventsAsync( events: MutableList<EventBuilders.TileInteractionEvent> )` Called when the system sends a batch of Tile interaction events that happened since the last time this method was called.
`open ListenableFuture<ResourceBuilders.Resources>`	`@MainThread onResourcesRequest(requestParams: RequestBuilders.ResourcesRequest)` This function is deprecated. Use `onTileResourcesRequest` instead.
`open Unit`	`@MainThread onTileAddEvent(requestParams: EventBuilders.TileAddEvent)` Called when a tile provided by this Tile Provider is added to the carousel.
`open Unit`	`@MainThread onTileRemoveEvent(requestParams: EventBuilders.TileRemoveEvent)` Called when a tile provided by this Tile Provider is removed from the carousel.

Inherited properties

From android.content.ContextWrapper

`open Context`	`applicationContext`
`open ApplicationInfo`	`applicationInfo`
`open AssetManager`	`assets`
`open AttributionSource`	`attributionSource`
`open String?`	`attributionTag`
`open Context`	`baseContext`
`open File`	`cacheDir`
`open ClassLoader`	`classLoader`
`open File`	`codeCacheDir`
`open ContentResolver`	`contentResolver`
`open File`	`dataDir`
`open Int`	`deviceId`
`open Display`	`display`
`open File?`	`externalCacheDir`
`open Array<File>`	`externalCacheDirs`
`open Array<File>`	`externalMediaDirs`
`open File`	`filesDir`
`open Boolean`	`isDeviceProtectedStorage`
`open Boolean`	`isRestricted`
`open Boolean`	`isUiContext`
`open Executor`	`mainExecutor`
`open Looper`	`mainLooper`
`open File`	`noBackupFilesDir`
`open File`	`obbDir`
`open Array<File>`	`obbDirs`
`open String`	`opPackageName`
`open String`	`packageCodePath`
`open PackageManager`	`packageManager`
`open String`	`packageName`
`open String`	`packageResourcePath`
`open ContextParams?`	`params`
`open Resources`	`resources`
`open Resources.Theme`	`theme`
`open Drawable`	`wallpaper`
`open Int`	`wallpaperDesiredMinimumHeight`
`open Int`	`wallpaperDesiredMinimumWidth`

From android.app.Service

`Application`	`application`
`Int`	`foregroundServiceType`

Public constructors

Material3TileService

Added in 1.6.0-beta01

Material3TileService(
    allowDynamicTheme: Boolean = true,
    defaultColorScheme: ColorScheme = ColorScheme(),
    serviceScope: CoroutineScope? = null
)

Parameters
`allowDynamicTheme: Boolean = true`	if dynamic colors theme should be used on Material3 components, meaning that colors will follow the system theme if enabled on the device. If not overridden, defaults to using the system theme.
`defaultColorScheme: ColorScheme = ColorScheme()`	the default static color theme to be used, when `allowDynamicTheme` is false, or when dynamic theming is disabled by the system or user. If not overridden, defaults to default theme.
`serviceScope: CoroutineScope? = null`	the scope to be used for `tileResponse` call, otherwise the scope running on a main thread will be used.

Public functions

onCreate

@CallSuper
open fun onCreate(): Unit

onDestroy

@CallSuper
open fun onDestroy(): Unit

Protected functions

tileResponse

Artifact: androidx.wear.tiles:tiles

View Source

protected abstract suspend fun MaterialScope.tileResponse(requestParams: RequestBuilders.TileRequest): TileBuilders.Tile

Called when the system is requesting a new timeline from this Tile Provider.

Resulting Tile can be created within the receiver MaterialScope which is used by all ProtoLayout Material3 components and layout to support opinionated defaults and to provide the global information for styling Material3 components. Additionally, the MaterialScope contains ProtoLayoutScope for automatic resource registration for any Image elements used within a Tile.

Note that, all resources used within the tile layout should be directly embedded as ResourceBuilders.ImageResource in layout using the corresponding API (such as androidx.wear.protolayout.layout.basicImage or Material3 counterparts (for example androidx.wear.protolayout.material3.backgroundImage).

This runs a suspending function on the Main thread, unless serviceScope is overridden.

Parameters
`requestParams: RequestBuilders.TileRequest`	Parameters about the request. See `TileRequest` for more info. Note that handle to some of them exists in the `MaterialScope` (for example `deviceConfiguration` for `DeviceParameters`.