Android Studio
Added in API level 30

ControlsProviderService


public abstract class ControlsProviderService
extends Service

java.lang.Object
   ↳ android.content.Context
     ↳ android.content.ContextWrapper
       ↳ android.app.Service
         ↳ android.service.controls.ControlsProviderService


Service implementation allowing applications to contribute controls to the System UI.

Summary

Constants

int CONTROLS_SURFACE_ACTIVITY_PANEL

Controls are being shown on the device controls activity panel.

int CONTROLS_SURFACE_DREAM

Controls are being shown as a dream, while the device is idle.

String EXTRA_CONTROLS_SURFACE

Integer extra whose value specifies the surface which controls are being displayed on.

String EXTRA_LOCKSCREEN_ALLOW_TRIVIAL_CONTROLS

Boolean extra containing the value of the setting allowing actions on a locked device.

String META_DATA_PANEL_ACTIVITY

Manifest metadata to show a custom embedded activity as part of device controls.

String SERVICE_CONTROLS

String TAG

Inherited constants

Public constructors

ControlsProviderService()

Public methods

abstract Publisher<Control> createPublisherFor(List<String> controlIds)

Return a valid Publisher for the given controlIds.

abstract Publisher<Control> createPublisherForAllAvailable()

Publisher for all available controls Retrieve all available controls.

Publisher<Control> createPublisherForSuggested()

(Optional) Publisher for suggested controls The service may be asked to provide a small number of recommended controls, in order to suggest some controls to the user for favoriting.

final IBinder onBind(Intent intent)

Return the communication channel to the service.

final boolean onUnbind(Intent intent)

Called when all clients have disconnected from a particular interface published by the service.

abstract void performControlAction(String controlId, ControlAction action, Consumer<Integer> consumer)

The user has interacted with a Control.

static void requestAddControl(Context context, ComponentName componentName, Control control)

Request SystemUI to prompt the user to add a control to favorites.

Inherited methods

From class android.content.ContextWrapper void attachBaseContext(Context base)

Set the base context for this ContextWrapper.

boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn)

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)

See bindService(Intent,ServiceConnection,int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindService(Intent service, ServiceConnection conn, int flags)

Connects to an application service, creating it if needed.

boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)

See bindService(Intent,int,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user)

Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection).

boolean bindServiceAsUser(Intent service, ServiceConnection conn, Context.BindServiceFlags flags, UserHandle user)

See bindServiceAsUser(Intent,ServiceConnection,int,UserHandle) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

int checkCallingOrSelfPermission(String permission)

Determine whether the calling process of an IPC or you have been granted a particular permission.

int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

int[] checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

int checkCallingPermission(String permission)

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

int checkCallingUriPermission(Uri uri, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a specific URI.

int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a list of URIs.

int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific content URI.

int checkPermission(String permission, int pid, int uid)

Determine whether the given permission is allowed for a particular process and user ID running in the system.

int checkSelfPermission(String permission)

Determine whether you have been granted a particular permission.

int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)

Check both a Uri and normal permission.

int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific URI.

int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a list of URIs.

void clearWallpaper() This method is deprecated. Use WallpaperManager.clear() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Context createAttributionContext(String attributionTag)

Return a new Context object for the current Context but attribute to a different tag.

Context createConfigurationContext(Configuration overrideConfiguration)

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Context createContext(ContextParams contextParams)

Creates a context with specific properties and behaviors.

Context createContextForSplit(String splitName)

Return a new Context object for the given split name.

Context createDeviceContext(int deviceId)

Returns a new Context object from the current context but with device association given by the deviceId.

Context createDeviceProtectedStorageContext()

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

Context createDisplayContext(Display display)

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

Context createPackageContext(String packageName, int flags)

Return a new Context object for the given application name.

Context createWindowContext(int type, Bundle options)

Creates a Context for a non-activity window.

Context createWindowContext(Display display, int type, Bundle options)

Creates a Context for a non-activity window on the given Display.

String[] databaseList()

Returns an array of strings naming the private databases associated with this Context's application package.

boolean deleteDatabase(String name)

Delete an existing private SQLiteDatabase associated with this Context's application package.

boolean deleteFile(String name)

Delete the given private file associated with this Context's application package.

boolean deleteSharedPreferences(String name)

Delete an existing shared preferences file.

void enforceCallingOrSelfPermission(String permission, String message)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

void enforceCallingPermission(String permission, String message)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

void enforceCallingUriPermission(Uri uri, int modeFlags, String message)

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

void enforcePermission(String permission, int pid, int uid, String message)

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)

Enforce both a Uri and normal permission.

void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

String[] fileList()

Returns an array of strings naming the private files associated with this Context's application package.

Context getApplicationContext()

Return the context of the single, global Application object of the current process.

ApplicationInfo getApplicationInfo()

Return the full application info for this context's package.

AssetManager getAssets()

Returns an AssetManager instance for the application's package.

AttributionSource getAttributionSource()

String getAttributionTag()

Attribution can be used in complex apps to logically separate parts of the app.

Context getBaseContext() File getCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem.

ClassLoader getClassLoader()

Return a class loader you can use to retrieve classes in this package.

File getCodeCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

ContentResolver getContentResolver()

Return a ContentResolver instance for your application's package.

File getDataDir()

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

File getDatabasePath(String name)

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

int getDeviceId()

Gets the device ID this context is associated with.

File getDir(String name, int mode)

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Display getDisplay()

Get the display this context is associated with.

File getExternalCacheDir()

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

File[] getExternalCacheDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

File getExternalFilesDir(String type)

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

File[] getExternalFilesDirs(String type)

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

File[] getExternalMediaDirs()

This method is deprecated. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

File getFileStreamPath(String name)

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

File getFilesDir()

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Executor getMainExecutor()

Return an Executor that will run enqueued tasks on the main thread associated with this context.

Looper getMainLooper()

Return the Looper for the main thread of the current process.

File getNoBackupFilesDir()

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

File getObbDir()

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

File[] getObbDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

String getOpPackageName()

Return the package name that should be used for AppOpsManager calls from this context, so that app ops manager's uid verification will work with the name.

String getPackageCodePath()

Return the full path to this context's primary Android package.

PackageManager getPackageManager()

Return PackageManager instance to find global package information.

String getPackageName()

Return the name of this application's package.

String getPackageResourcePath()

Return the full path to this context's primary Android package.

ContextParams getParams()

Return the set of parameters which this Context was created with, if it was created via createContext(ContextParams).

Resources getResources()

Returns a Resources instance for the application's package.

SharedPreferences getSharedPreferences(String name, int mode)

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

Object getSystemService(String name)

Return the handle to a system-level service by name.

String getSystemServiceName(Class<?> serviceClass)

Gets the name of the system-level service that is represented by the specified class.

Resources.Theme getTheme()

Return the Theme object associated with this Context.

Drawable getWallpaper()

This method is deprecated. Use WallpaperManager.get() instead.

int getWallpaperDesiredMinimumHeight()

This method is deprecated. Use WallpaperManager.getDesiredMinimumHeight() instead.

int getWallpaperDesiredMinimumWidth()

This method is deprecated. Use WallpaperManager.getDesiredMinimumWidth() instead.

void grantUriPermission(String toPackage, Uri uri, int modeFlags)

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

boolean isDeviceProtectedStorage()

Indicates if the storage APIs of this Context are backed by device-protected storage.

boolean isRestricted()

Indicates whether this Context is restricted.

boolean isUiContext()

Returns true if the context is a UI context which can access UI components such as WindowManager, LayoutInflater or WallpaperManager.

boolean moveDatabaseFrom(Context sourceContext, String name)

Move an existing database file from the given source storage context to this context.

boolean moveSharedPreferencesFrom(Context sourceContext, String name)

Move an existing shared preferences file from the given source storage context to this context.

FileInputStream openFileInput(String name)

Open a private file associated with this Context's application package for reading.

FileOutputStream openFileOutput(String name, int mode)

Open a private file associated with this Context's application package for writing.

SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)

Open a new private SQLiteDatabase associated with this Context's application package.

SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)

Open a new private SQLiteDatabase associated with this Context's application package.

Drawable peekWallpaper()

This method is deprecated. Use WallpaperManager.peek() instead.

void rebindService(ServiceConnection conn, Context.BindServiceFlags flags)

Rebind an application service with updated bind service flags

void registerComponentCallbacks(ComponentCallbacks callback)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

void registerDeviceIdChangeListener(Executor executor, IntConsumer listener)

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)

Register a BroadcastReceiver to be run in the main activity thread.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)

Register to receive intent broadcasts, to run in the context of scheduler.

Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)

Register to receive intent broadcasts, to run in the context of scheduler.

void removeStickyBroadcast(Intent intent)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void removeStickyBroadcastAsUser(Intent intent, UserHandle user)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void revokeSelfPermissionsOnKill(Collection<String> permissions)

Triggers the revocation of one or more permissions for the calling package.

void revokeUriPermission(Uri uri, int modeFlags)

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

void revokeUriPermission(String targetPackage, Uri uri, int modeFlags)

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

void sendBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

void sendBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

void sendBroadcast(Intent intent)

Broadcast the given intent to all interested BroadcastReceivers.

void sendBroadcastAsUser(Intent intent, UserHandle user)

Version of sendBroadcast(Intent) that allows you to specify the user the broadcast will be sent to.

void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)

Version of sendBroadcast(Intent,String) that allows you to specify the user the broadcast will be sent to.

void sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

void sendOrderedBroadcast(Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options)

void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the user the broadcast will be sent to.

void sendStickyBroadcast(Intent intent)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcast(Intent intent, Bundle options)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcastAsUser(Intent intent, UserHandle user)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void setTheme(int resid)

Set the base theme for this context.

void setWallpaper(Bitmap bitmap) This method is deprecated. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

void setWallpaper(InputStream data) This method is deprecated. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

void startActivities(Intent[] intents, Bundle options)

Launch multiple new activities.

void startActivities(Intent[] intents)

Same as startActivities(Intent[],Bundle) with no options specified.

void startActivity(Intent intent)

Same as startActivity(Intent,Bundle) with no options specified.

void startActivity(Intent intent, Bundle options)

Launch a new activity.

ComponentName startForegroundService(Intent service)

Similar to startService(Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)

Start executing an Instrumentation class.

void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)

Same as startIntentSender(IntentSender,Intent,int,int,int,Bundle) with no options specified.

void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)

Like startActivity(Intent,Bundle), but taking a IntentSender to start.

ComponentName startService(Intent service)

Request that a given application service be started.

boolean stopService(Intent name)

Request that a given application service be stopped.

void unbindService(ServiceConnection conn)

Disconnect from an application service.

void unregisterComponentCallbacks(ComponentCallbacks callback)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(ComponentCallbacks).

void unregisterDeviceIdChangeListener(IntConsumer listener)

Removes a device ID changed listener from the Context.

void unregisterReceiver(BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver.

void updateServiceBindings(Collection<Context.UpdateBindingParams> params)

Perform a batch update of existing bindings.

void updateServiceGroup(ServiceConnection conn, int group, int importance)

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

From class android.content.Context boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)

Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.

boolean bindIsolatedService(Intent service, Context.BindServiceFlags flags, String instanceName, Executor executor, ServiceConnection conn)

See bindIsolatedService(Intent,int,String,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn)

Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.

boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)

See bindService(Intent,ServiceConnection,int) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

abstract boolean bindService(Intent service, ServiceConnection conn, int flags)

Connects to an application service, creating it if needed.

boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)

See bindService(Intent,int,Executor,ServiceConnection) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user)

Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection).

boolean bindServiceAsUser(Intent service, ServiceConnection conn, Context.BindServiceFlags flags, UserHandle user)

See bindServiceAsUser(Intent,ServiceConnection,int,UserHandle) Call BindServiceFlags.of(long) to obtain a BindServiceFlags object.

abstract int checkCallingOrSelfPermission(String permission)

Determine whether the calling process of an IPC or you have been granted a particular permission.

abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.

int[] checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.

abstract int checkCallingPermission(String permission)

Determine whether the calling process of an IPC you are handling has been granted a particular permission.

abstract int checkCallingUriPermission(Uri uri, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a specific URI.

int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags)

Determine whether the calling process and uid has been granted permission to access a list of URIs.

int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific content URI.

abstract int checkPermission(String permission, int pid, int uid)

Determine whether the given permission is allowed for a particular process and user ID running in the system.

abstract int checkSelfPermission(String permission)

Determine whether you have been granted a particular permission.

abstract int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)

Check both a Uri and normal permission.

abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a specific URI.

int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)

Determine whether a particular process and uid has been granted permission to access a list of URIs.

abstract void clearWallpaper() This method was deprecated in API level 15. Use WallpaperManager.clear() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

Context createAttributionContext(String attributionTag)

Return a new Context object for the current Context but attribute to a different tag.

abstract Context createConfigurationContext(Configuration overrideConfiguration)

Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.

Context createContext(ContextParams contextParams)

Creates a context with specific properties and behaviors.

abstract Context createContextForSplit(String splitName)

Return a new Context object for the given split name.

Context createDeviceContext(int deviceId)

Returns a new Context object from the current context but with device association given by the deviceId.

abstract Context createDeviceProtectedStorageContext()

Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

abstract Context createDisplayContext(Display display)

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

abstract Context createPackageContext(String packageName, int flags)

Return a new Context object for the given application name.

Context createWindowContext(int type, Bundle options)

Creates a Context for a non-activity window.

Context createWindowContext(Display display, int type, Bundle options)

Creates a Context for a non-activity window on the given Display.

abstract String[] databaseList()

Returns an array of strings naming the private databases associated with this Context's application package.

abstract boolean deleteDatabase(String name)

Delete an existing private SQLiteDatabase associated with this Context's application package.

abstract boolean deleteFile(String name)

Delete the given private file associated with this Context's application package.

abstract boolean deleteSharedPreferences(String name)

Delete an existing shared preferences file.

abstract void enforceCallingOrSelfPermission(String permission, String message)

If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException.

abstract void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)

If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException.

abstract void enforceCallingPermission(String permission, String message)

If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException.

abstract void enforceCallingUriPermission(Uri uri, int modeFlags, String message)

If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException.

abstract void enforcePermission(String permission, int pid, int uid, String message)

If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.

abstract void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)

Enforce both a Uri and normal permission.

abstract void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)

If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException.

abstract String[] fileList()

Returns an array of strings naming the private files associated with this Context's application package.

abstract Context getApplicationContext()

Return the context of the single, global Application object of the current process.

abstract ApplicationInfo getApplicationInfo()

Return the full application info for this context's package.

abstract AssetManager getAssets()

Returns an AssetManager instance for the application's package.

AttributionSource getAttributionSource() String getAttributionTag()

Attribution can be used in complex apps to logically separate parts of the app.

abstract File getCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem.

abstract ClassLoader getClassLoader()

Return a class loader you can use to retrieve classes in this package.

abstract File getCodeCacheDir()

Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.

final int getColor(int id)

Returns a color associated with a particular resource ID and styled for the current theme.

final ColorStateList getColorStateList(int id)

Returns a color state list associated with a particular resource ID and styled for the current theme.

abstract ContentResolver getContentResolver()

Return a ContentResolver instance for your application's package.

abstract File getDataDir()

Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.

abstract File getDatabasePath(String name)

Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored.

int getDeviceId()

Gets the device ID this context is associated with.

abstract File getDir(String name, int mode)

Retrieve, creating if needed, a new directory in which the application can place its own custom data files.

Display getDisplay()

Get the display this context is associated with.

final Drawable getDrawable(int id)

Returns a drawable object associated with a particular resource ID and styled for the current theme.

abstract File getExternalCacheDir()

Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.

abstract File[] getExternalCacheDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.

abstract File getExternalFilesDir(String type)

Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.

abstract File[] getExternalFilesDirs(String type)

Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.

abstract File[] getExternalMediaDirs()

This method was deprecated in API level 30. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q.

abstract File getFileStreamPath(String name)

Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored.

abstract File getFilesDir()

Returns the absolute path to the directory on the filesystem where files created with openFileOutput(String, int) are stored.

Executor getMainExecutor()

Return an Executor that will run enqueued tasks on the main thread associated with this context.

abstract Looper getMainLooper()

Return the Looper for the main thread of the current process.

abstract File getNoBackupFilesDir()

Returns the absolute path to the directory on the filesystem similar to getFilesDir().

abstract File getObbDir()

Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.

abstract File[] getObbDirs()

Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.

String getOpPackageName()

Return the package name that should be used for AppOpsManager calls from this context, so that app ops manager's uid verification will work with the name.

abstract String getPackageCodePath()

Return the full path to this context's primary Android package.

abstract PackageManager getPackageManager()

Return PackageManager instance to find global package information.

abstract String getPackageName()

Return the name of this application's package.

abstract String getPackageResourcePath()

Return the full path to this context's primary Android package.

ContextParams getParams()

Return the set of parameters which this Context was created with, if it was created via createContext(ContextParams).

abstract Resources getResources()

Returns a Resources instance for the application's package.

abstract SharedPreferences getSharedPreferences(String name, int mode)

Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.

final String getString(int resId)

Returns a localized string from the application's package's default string table.

final String getString(int resId, Object... formatArgs)

Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and String.format(String, Object).

final <T> T getSystemService(Class<T> serviceClass)

Return the handle to a system-level service by class.

abstract Object getSystemService(String name)

Return the handle to a system-level service by name.

abstract String getSystemServiceName(Class<?> serviceClass)

Gets the name of the system-level service that is represented by the specified class.

final CharSequence getText(int resId)

Return a localized, styled CharSequence from the application's package's default string table.

abstract Resources.Theme getTheme()

Return the Theme object associated with this Context.

Context.BindServiceFlags getUpdateableFlags()

Gets the list of bind flags that may be updated (i.e.

abstract Drawable getWallpaper()

This method was deprecated in API level 15. Use WallpaperManager.get() instead.

abstract int getWallpaperDesiredMinimumHeight()

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumHeight() instead.

abstract int getWallpaperDesiredMinimumWidth()

This method was deprecated in API level 15. Use WallpaperManager.getDesiredMinimumWidth() instead.

abstract void grantUriPermission(String toPackage, Uri uri, int modeFlags)

Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.

abstract boolean isDeviceProtectedStorage()

Indicates if the storage APIs of this Context are backed by device-protected storage.

boolean isRestricted()

Indicates whether this Context is restricted.

boolean isUiContext()

Returns true if the context is a UI context which can access UI components such as WindowManager, LayoutInflater or WallpaperManager.

abstract boolean moveDatabaseFrom(Context sourceContext, String name)

Move an existing database file from the given source storage context to this context.

abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name)

Move an existing shared preferences file from the given source storage context to this context.

final TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(int resid, int[] attrs)

Retrieve styled attribute information in this Context's theme.

final TypedArray obtainStyledAttributes(int[] attrs)

Retrieve styled attribute information in this Context's theme.

abstract FileInputStream openFileInput(String name)

Open a private file associated with this Context's application package for reading.

abstract FileOutputStream openFileOutput(String name, int mode)

Open a private file associated with this Context's application package for writing.

abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)

Open a new private SQLiteDatabase associated with this Context's application package.

abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)

Open a new private SQLiteDatabase associated with this Context's application package.

abstract Drawable peekWallpaper()

This method was deprecated in API level 15. Use WallpaperManager.peek() instead.

void rebindService(ServiceConnection conn, Context.BindServiceFlags flags)

Rebind an application service with updated bind service flags

void registerComponentCallbacks(ComponentCallbacks callback)

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.

void registerDeviceIdChangeListener(Executor executor, IntConsumer listener)

Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)

Register a BroadcastReceiver to be run in the main activity thread.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)

Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)

Register to receive intent broadcasts, to run in the context of scheduler.

abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)

Register to receive intent broadcasts, to run in the context of scheduler.

abstract void removeStickyBroadcast(Intent intent)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void removeStickyBroadcastAsUser(Intent intent, UserHandle user)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void revokeSelfPermissionOnKill(String permName)

Triggers the asynchronous revocation of a runtime permission.

void revokeSelfPermissionsOnKill(Collection<String> permissions)

Triggers the revocation of one or more permissions for the calling package.

abstract void revokeUriPermission(Uri uri, int modeFlags)

Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism.

abstract void revokeUriPermission(String toPackage, Uri uri, int modeFlags)

Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package.

void sendBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

abstract void sendBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.

abstract void sendBroadcast(Intent intent)

Broadcast the given intent to all interested BroadcastReceivers.

abstract void sendBroadcastAsUser(Intent intent, UserHandle user)

Version of sendBroadcast(Intent) that allows you to specify the user the broadcast will be sent to.

abstract void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)

Version of sendBroadcast(Intent,String) that allows you to specify the user the broadcast will be sent to.

void sendBroadcastWithMultiplePermissions(Intent intent, String[] receiverPermissions)

Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced.

void sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.

abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendBroadcast(Intent) that allows you to receive data back from the broadcast.

abstract void sendOrderedBroadcast(Intent intent, String receiverPermission)

Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.

abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

Version of sendOrderedBroadcast(Intent,String,BroadcastReceiver,Handler,int,String,Bundle) that allows you to specify the user the broadcast will be sent to.

abstract void sendStickyBroadcast(Intent intent)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

void sendStickyBroadcast(Intent intent, Bundle options)

This method was deprecated in API level 31. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)

This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.

abstract void setTheme(int resid)

Set the base theme for this context.

abstract void setWallpaper(Bitmap bitmap) This method was deprecated in API level 15. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

abstract void setWallpaper(InputStream data) This method was deprecated in API level 15. Use WallpaperManager.set() instead.

This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER.

abstract void startActivities(Intent[] intents, Bundle options)

Launch multiple new activities.

abstract void startActivities(Intent[] intents)

Same as startActivities(Intent[],Bundle) with no options specified.

abstract void startActivity(Intent intent)

Same as startActivity(Intent,Bundle) with no options specified.

abstract void startActivity(Intent intent, Bundle options)

Launch a new activity.

abstract ComponentName startForegroundService(Intent service)

Similar to startService(Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running.

abstract boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)

Start executing an Instrumentation class.

abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)

Same as startIntentSender(IntentSender,Intent,int,int,int,Bundle) with no options specified.

abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)

Like startActivity(Intent,Bundle), but taking a IntentSender to start.

abstract ComponentName startService(Intent service)

Request that a given application service be started.

abstract boolean stopService(Intent service)

Request that a given application service be stopped.

abstract void unbindService(ServiceConnection conn)

Disconnect from an application service.

void unregisterComponentCallbacks(ComponentCallbacks callback)

Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(ComponentCallbacks).

void unregisterDeviceIdChangeListener(IntConsumer listener)

Removes a device ID changed listener from the Context.

abstract void unregisterReceiver(BroadcastReceiver receiver)

Unregister a previously registered BroadcastReceiver.

void updateServiceBindings(Collection<Context.UpdateBindingParams> params)

Perform a batch update of existing bindings.

void updateServiceGroup(ServiceConnection conn, int group, int importance)

For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.

Constants

CONTROLS_SURFACE_ACTIVITY_PANEL

Added in API level 35
public static final int CONTROLS_SURFACE_ACTIVITY_PANEL

Controls are being shown on the device controls activity panel.

Constant Value: 0 (0x00000000)

CONTROLS_SURFACE_DREAM

Added in API level 35
public static final int CONTROLS_SURFACE_DREAM

Controls are being shown as a dream, while the device is idle.

Constant Value: 1 (0x00000001)

EXTRA_CONTROLS_SURFACE

Added in API level 35
public static final String EXTRA_CONTROLS_SURFACE

Integer extra whose value specifies the surface which controls are being displayed on.

The possible values are:

This is passed with the intent when the panel specified by META_DATA_PANEL_ACTIVITY is launched.

Constant Value: "android.service.controls.extra.CONTROLS_SURFACE"

EXTRA_LOCKSCREEN_ALLOW_TRIVIAL_CONTROLS

Added in API level 34
public static final String EXTRA_LOCKSCREEN_ALLOW_TRIVIAL_CONTROLS

Boolean extra containing the value of the setting allowing actions on a locked device. This corresponds to the setting that indicates whether the user has consented to allow actions on devices that declare Control.isAuthRequired() as false when the device is locked. This is passed with the intent when the panel specified by META_DATA_PANEL_ACTIVITY is launched.

Constant Value: "android.service.controls.extra.LOCKSCREEN_ALLOW_TRIVIAL_CONTROLS"

META_DATA_PANEL_ACTIVITY

Added in API level 34
public static final String META_DATA_PANEL_ACTIVITY

Manifest metadata to show a custom embedded activity as part of device controls. The value of this metadata must be the ComponentName as a string of an activity in the same package that will be launched embedded in the device controls space. The activity must be exported, enabled and protected by Manifest.permission.BIND_CONTROLS. It is recommended that the activity is declared android:resizeableActivity="true".

Constant Value: "android.service.controls.META_DATA_PANEL_ACTIVITY"

SERVICE_CONTROLS

Added in API level 30
public static final String SERVICE_CONTROLS

Constant Value: "android.service.controls.ControlsProviderService"

TAG

Added in API level 30
public static final String TAG

Constant Value: "ControlsProviderService"

Public constructors

ControlsProviderService

public ControlsProviderService ()

Public methods

createPublisherFor

Added in API level 30
public abstract Publisher<Control> createPublisherFor (List<String> controlIds)

Return a valid Publisher for the given controlIds. This publisher will be asked to provide updates for the given list of controlIds as long as the Subscription is valid. Calls to Subscriber.onComplete will not be expected. Instead, wait for the call from Subscription.cancel to indicate that updates are no longer required. It is expected that controls provided by this publisher were created using Control.StatefulBuilder. By default, all controls require the device to be unlocked in order for the user to interact with it. This can be modified per Control by Control.StatefulBuilder.setAuthRequired.

Parameters
controlIds List: This value cannot be null.
Returns
Publisher<Control> This value cannot be null.

createPublisherForAllAvailable

Added in API level 30
public abstract Publisher<Control> createPublisherForAllAvailable ()

Publisher for all available controls Retrieve all available controls. Use the stateless builder Control.StatelessBuilder to build each Control. Call Subscriber.onComplete when done loading all unique controls, or Subscriber.onError for error scenarios. Duplicate Controls will replace the original.

Returns
Publisher<Control> This value cannot be null.

createPublisherForSuggested

Added in API level 30
public Publisher<Control> createPublisherForSuggested ()

(Optional) Publisher for suggested controls The service may be asked to provide a small number of recommended controls, in order to suggest some controls to the user for favoriting. The controls shall be built using the stateless builder Control.StatelessBuilder. The total number of controls requested through Subscription.request will be restricted to a maximum. Within this larger limit, only 6 controls per structure will be loaded. Therefore, it is advisable to seed multiple structures if they exist. Any control sent over this limit will be discarded. Call Subscriber.onComplete when done, or Subscriber.onError for error scenarios.

Returns
Publisher<Control> This value may be null.

onBind

Added in API level 30
public final IBinder onBind (Intent intent)

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl.

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about the main thread can be found in Processes and Threads.

Parameters
intent Intent: This value cannot be null.
Returns
IBinder This value cannot be null.

onUnbind

Added in API level 30
public final boolean onUnbind (Intent intent)

Called when all clients have disconnected from a particular interface published by the service. The default implementation does nothing and returns false.

Parameters
intent Intent: This value cannot be null.
Returns
boolean Return true if you would like to have the service's onRebind(Intent) method later called when new clients bind to it.

performControlAction

Added in API level 30
public abstract void performControlAction (String controlId, 
                ControlAction action, 
                Consumer<Integer> consumer)

The user has interacted with a Control. The action is dictated by the type of ControlAction that was sent. A response can be sent via Consumer.accept, with the Integer argument being one of the provided ControlAction response results. The Integer should indicate whether the action was received successfully, or if additional prompts should be presented to the user. Any visual control updates should be sent via the Publisher. By default, all invocations of this method will require the device be unlocked. This can be modified per Control by Control.StatefulBuilder.setAuthRequired.

Parameters
controlId String: This value cannot be null.
action ControlAction: This value cannot be null.
consumer Consumer: This value cannot be null.

requestAddControl

Added in API level 30
public static void requestAddControl (Context context, 
                ComponentName componentName, 
                Control control)

Request SystemUI to prompt the user to add a control to favorites.
SystemUI may not honor this request in some cases, for example if the requested Control is already a favorite, or the requesting package is not currently in the foreground.

Parameters
context Context: A context.
This value cannot be null.
componentName ComponentName: Component name of the ControlsProviderService
This value cannot be null.
control Control: A stateless control to show to the user.
This value cannot be null.