MockContext
open class MockContext : Context
| kotlin.Any | ||
| ↳ | android.content.Context | |
| ↳ | android.test.mock.MockContext | |
A mock android.content.Context class. All methods are non-functional and throw java.lang.UnsupportedOperationException. You can use this to inject other dependencies, mocks, or monitors into the classes you are testing.
Summary
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| open Boolean |
bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection)Variation of #bindService that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. |
| open Boolean |
bindService(service: Intent, conn: ServiceConnection, flags: Int)Connects to an application service, creating it if needed. |
| open Boolean |
bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection)Same as |
| open Boolean |
bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle) |
| open Int |
checkCallingOrSelfPermission(permission: String)Determine whether the calling process of an IPC or you have been granted a particular permission. |
| open Int |
checkCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int)Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. |
| open Int |
checkCallingPermission(permission: String)Determine whether the calling process of an IPC you are handling has been granted a particular permission. |
| open Int |
checkCallingUriPermission(uri: Uri!, modeFlags: Int)Determine whether the calling process and uid has been granted permission to access a specific URI. |
| open Int |
checkPermission(permission: String, pid: Int, uid: Int)Determine whether the given permission is allowed for a particular process and user ID running in the system. |
| open Int |
checkSelfPermission(permission: String)Determine whether you have been granted a particular permission. |
| open Int |
checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)Determine whether a particular process and uid has been granted permission to access a specific URI. |
| open Int |
checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int)Check both a Uri and normal permission. |
| open Unit | |
| open Context! |
createConfigurationContext(overrideConfiguration: Configuration)Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. |
| open Context! |
createContextForSplit(splitName: String!) |
| open Context |
createDeviceContext(deviceId: Int)Returns a new |
| open Context! |
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage. |
| open Context! |
createDisplayContext(display: Display)Returns a new |
| open Context! |
createPackageContext(packageName: String!, flags: Int)Return a new Context object for the given application name. |
| open Context |
createWindowContext(display: Display, type: Int, options: Bundle?)Creates a |
| open Context |
createWindowContext(type: Int, options: Bundle?)Creates a Context for a non-activity window. |
| open Array<String!>! |
Returns an array of strings naming the private databases associated with this Context's application package. |
| open Boolean |
deleteDatabase(name: String!)Delete an existing private SQLiteDatabase associated with this Context's application package. |
| open Boolean |
deleteFile(name: String!)Delete the given private file associated with this Context's application package. |
| open Boolean |
Delete an existing shared preferences file. |
| open Unit |
enforceCallingOrSelfPermission(permission: String, message: String?)If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a |
| open Unit |
enforceCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int, message: String!)If the calling process of an IPC or you has not been granted permission to access a specific URI, throw |
| open Unit |
enforceCallingPermission(permission: String, message: String?)If the calling process of an IPC you are handling has not been granted a particular permission, throw a |
| open Unit |
enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)If the calling process and uid has not been granted permission to access a specific URI, throw |
| open Unit |
enforcePermission(permission: String, pid: Int, uid: Int, message: String?)If the given permission is not allowed for a particular process and user ID running in the system, throw a |
| open Unit |
If a particular process and uid has not been granted permission to access a specific URI, throw |
| open Unit |
enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)Enforce both a Uri and normal permission. |
| open Array<String!>! |
fileList()Returns an array of strings naming the private files associated with this Context's application package. |
| open Context! |
Return the context of the single, global Application object of the current process. |
| open ApplicationInfo! |
Return the full application info for this context's package. |
| open AssetManager! |
Returns an AssetManager instance for the application's package. |
| open File! |
Returns the absolute path to the application specific cache directory on the filesystem. |
| open ClassLoader! |
Return a class loader you can use to retrieve classes in this package. |
| open File! |
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code. |
| open ContentResolver! |
Return a ContentResolver instance for your application's package. |
| open File! |
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. |
| open File! |
getDatabasePath(name: String!)Returns the absolute path on the filesystem where a database created with #openOrCreateDatabase is stored. |
| open Int |
Gets the device ID this context is associated with. |
| open File! |
Retrieve, creating if needed, a new directory in which the application can place its own custom data files. |
| open Display |
Get the display this context is associated with. |
| open File? |
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. |
| open Array<File!>! |
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. |
| open File? |
getExternalFilesDir(type: String?)Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. |
| open Array<File!>! |
getExternalFilesDirs(type: String!)Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. |
| open Array<File!>! |
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files. |
| open File! |
getFileStreamPath(name: String!)Returns the absolute path on the filesystem where a file created with |
| open File! |
Returns the absolute path to the directory on the filesystem where files created with |
| open Executor! |
Return an |
| open Looper! |
Return the Looper for the main thread of the current process. |
| open File! |
Returns the absolute path to the directory on the filesystem similar to |
| open File! |
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. |
| open Array<File!>! |
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. |
| open String | |
| open String! |
Return the full path to this context's primary Android package. |
| open PackageManager! |
Return PackageManager instance to find global package information. |
| open String! |
Return the name of this application's package. |
| open String! |
Return the full path to this context's primary Android package. |
| open Resources! |
Returns a Resources instance for the application's package. |
| open SharedPreferences! |
getSharedPreferences(: String!, : Int)Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. |
| open Any! |
getSystemService(name: String)Return the handle to a system-level service by name. |
| open String? |
getSystemServiceName(serviceClass: Class<*>)Gets the name of the system-level service that is represented by the specified class. |
| open Resources.Theme! |
getTheme()Return the Theme object associated with this Context. |
| open Drawable! | |
| open Int | |
| open Int | |
| open Unit |
grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)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. |
| open Boolean |
Indicates if the storage APIs of this Context are backed by device-protected storage. |
| open Boolean |
Indicates whether this Context is restricted. |
| open Boolean | |
| open Boolean |
moveDatabaseFrom(sourceContext: Context!, name: String!)Move an existing database file from the given source storage context to this context. |
| open Boolean |
moveSharedPreferencesFrom(: Context!, : String!)Move an existing shared preferences file from the given source storage context to this context. |
| open FileInputStream! |
openFileInput(name: String!)Open a private file associated with this Context's application package for reading. |
| open FileOutputStream! |
openFileOutput(name: String!, mode: Int)Open a private file associated with this Context's application package for writing. |
| open SQLiteDatabase! |
openOrCreateDatabase(file: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!)Open a new private SQLiteDatabase associated with this Context's application package. |
| open SQLiteDatabase! |
openOrCreateDatabase(file: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!, errorHandler: DatabaseErrorHandler?)Open a new private SQLiteDatabase associated with this Context's application package. |
| open Drawable! | |
| open Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!)Register a BroadcastReceiver to be run in the main activity thread. |
| open Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!, flags: Int)Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. |
| open Intent? |
registerReceiver(receiver: BroadcastReceiver!, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?)Register to receive intent broadcasts, to run in the context of scheduler. |
| open Intent? |
registerReceiver(receiver: BroadcastReceiver!, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?, flags: Int)Register to receive intent broadcasts, to run in the context of scheduler. |
| open Unit |
removeStickyBroadcast(intent: Intent!)Remove the data previously sent with #sendStickyBroadcast, so that it is as if the sticky broadcast had never happened. |
| open Unit |
removeStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)Version of |
| open Unit |
revokeUriPermission(uri: Uri!, modeFlags: Int)Remove all permissions to access a particular content provider Uri that were previously added with |
| open Unit |
revokeUriPermission(targetPackage: String!, uri: Uri!, modeFlags: Int)Remove permissions to access a particular content provider Uri that were previously added with |
| open Unit |
sendBroadcast(intent: Intent!)Broadcast the given intent to all interested BroadcastReceivers. |
| open Unit |
sendBroadcast(intent: Intent!, receiverPermission: String?)Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. |
| open Unit |
sendBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?) |
| open Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!)Version of |
| open Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?)Version of |
| open Unit |
sendOrderedBroadcast(intent: Intent!, receiverPermission: String?)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. |
| open Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)Version of |
| 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?)Version of |
| open Unit |
sendOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?, resultReceiver: BroadcastReceiver!, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)Version of |
| open Unit |
sendStickyBroadcast(intent: Intent!)Perform a |
| open Unit |
sendStickyBroadcast(intent: Intent, options: Bundle?)Perform a |
| open Unit |
sendStickyBroadcastAsUser(intent: Intent!, user: UserHandle!)Version of |
| open Unit |
sendStickyOrderedBroadcast(intent: Intent!, resultReceiver: BroadcastReceiver!, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)Version of #sendStickyBroadcast that allows you to receive data back from the broadcast. |
| open Unit |
sendStickyOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, resultReceiver: BroadcastReceiver!, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)Version of |
| open Unit |
Set the base theme for this context. |
| open Unit |
setWallpaper(bitmap: Bitmap!) |
| open Unit |
setWallpaper(data: InputStream!) |
| open Unit |
startActivities(intents: Array<Intent!>!)Same as |
| open Unit |
startActivities(intents: Array<Intent!>!, options: Bundle!)Launch multiple new activities. |
| open Unit |
startActivity(intent: Intent!)Same as |
| open Unit |
startActivity(intent: Intent!, options: Bundle?)Launch a new activity. |
| open ComponentName? |
startForegroundService(service: Intent!)Similar to |
| open Boolean |
startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?)Start executing an |
| open Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)Same as |
| open Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)Like |
| open ComponentName? |
startService(service: Intent!)Request that a given application service be started. |
| open Boolean |
stopService(service: Intent!)Request that a given application service be stopped. |
| open Unit |
unbindService(conn: ServiceConnection)Disconnect from an application service. |
| open Unit |
unregisterReceiver(receiver: BroadcastReceiver!)Unregister a previously registered BroadcastReceiver. |
| open Unit |
updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)For a service previously bound with #bindService or a related method, change how the system manages that service's process in relation to other processes. |
| Inherited functions | |
|---|---|
Public constructors
MockContext
MockContext()
Public methods
bindIsolatedService
open fun bindIsolatedService(
service: Intent,
flags: Int,
instanceName: String,
executor: Executor,
conn: ServiceConnection
): Boolean
Variation of #bindService that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. In other words, you can use this to bind to a service that has specified android.R.attr#isolatedProcess and, in addition to the existing behavior of running in an isolated process, you can also through the arguments here have the system bring up multiple concurrent processes hosting their own instances of that service. The instanceName you provide here identifies the different instances, and you can use updateServiceGroup(android.content.ServiceConnection,int,int) to tell the system how it should manage each of these instances.
| Parameters | |
|---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null. |
flags |
Int: Operation options for the binding as per #bindService. |
instanceName |
String: Unique identifier for the service instance. Each unique name here will result in a different service instance being created. Identifiers must only contain ASCII letters, digits, underscores, and periods. This value cannot be null. |
executor |
Executor: Callbacks on ServiceConnection will be called on executor. Must use same instance for the same instance of ServiceConnection. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread. |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
| Return | |
|---|---|
Boolean |
Returns success of binding as per #bindService. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
If the instanceName is invalid. |
java.lang.SecurityException |
If the caller does not have permission to access the service |
bindService
open fun bindService(
service: Intent,
conn: ServiceConnection,
flags: Int
): Boolean
Connects to an application service, creating it if needed. This defines a dependency between your application and the service. The given conn will receive the service object when it is created and be told if it dies and restarts. The service will be considered required by the system only for as long as the calling context exists. For example, if this Context is an Activity that is stopped, the service will not be required to continue running until the Activity is resumed.
If the service does not support binding, it may return null from its onBind() method. If it does, then the ServiceConnection's onNullBinding() method will be invoked instead of onServiceConnected().
Note: This method cannot be called from a BroadcastReceiver component. A pattern you can use to communicate from a BroadcastReceiver to a Service is to call startService with the arguments containing the command to be sent, with the service calling its android.app.Service#stopSelf(int) method when done executing that command. See the API demo App/Service/Service Start Arguments Controller for an illustration of this. It is okay, however, to use this method from a BroadcastReceiver that has been registered with #registerReceiver, since the lifetime of this BroadcastReceiver is tied to another object (the one that registered it).
This method only accepts a int type flag, to pass in a long type flag, call bindService(android.content.Intent,android.content.ServiceConnection,android.content.Context.BindServiceFlags) instead.
| Parameters | |
|---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null. |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
flags |
Int: Operation options for the binding. Can be: |
| Return | |
|---|---|
Boolean |
true if the system is in the process of bringing up a service that your client has permission to bind to; false if the system couldn't find the service or if your client doesn't have permission to bind to it. Regardless of the return value, you should later call unbindService to release the connection. |
| Exceptions | |
|---|---|
java.lang.SecurityException |
If the caller does not have permission to access the service or the service cannot be found. Call unbindService to release the connection when this exception is thrown. |
bindService
open fun bindService(
service: Intent,
flags: Int,
executor: Executor,
conn: ServiceConnection
): Boolean
Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks.
This method only accepts a 32 bits flag, to pass in a 64 bits flag, call bindService(android.content.Intent,android.content.Context.BindServiceFlags,java.util.concurrent.Executor,android.content.ServiceConnection) instead.
| Parameters | |
|---|---|
service |
Intent: This value cannot be null. |
flags |
Int: Value is either 0 or a combination of the following:
|
executor |
Executor: Callbacks on ServiceConnection will be called on executor. Must use same instance for the same instance of ServiceConnection. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread. |
conn |
ServiceConnection: This value cannot be null. |
| Return | |
|---|---|
Boolean |
The result of the binding as described in bindService(Intent, ServiceConnection, int). |
bindServiceAsUser
open fun bindServiceAsUser(
service: Intent,
conn: ServiceConnection,
flags: Int,
user: UserHandle
): Boolean
| Parameters | |
|---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null. |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
flags |
Int: Operation options for the binding. May be 0, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_NOT_FOREGROUND, BIND_ABOVE_CLIENT, BIND_ALLOW_OOM_MANAGEMENT, BIND_WAIVE_PRIORITY. BIND_IMPORTANT, or BIND_ADJUST_WITH_ACTIVITY. |
user |
UserHandle: This value cannot be null. |
| Return | |
|---|---|
Boolean |
true if the system is in the process of bringing up a service that your client has permission to bind to; false if the system couldn't find the service. You should call unbindService to release the connection even if this method returned false. |
| Exceptions | |
|---|---|
java.lang.SecurityException |
if the client does not have the required permission to bind. |
checkCallingOrSelfPermission
open fun checkCallingOrSelfPermission(permission: String): Int
Determine whether the calling process of an IPC or you have been granted a particular permission. This is the same as checkCallingPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkCallingOrSelfUriPermission
open fun checkCallingOrSelfUriPermission(
uri: Uri!,
modeFlags: Int
): Int
Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. This is the same as checkCallingUriPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkCallingPermission
open fun checkCallingPermission(permission: String): Int
Determine whether the calling process of an IPC you are handling has been granted a particular permission. This is basically the same as calling checkPermission(java.lang.String,int,int) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always fail. This is done to protect against accidentally leaking permissions; you can use checkCallingOrSelfPermission to avoid this protection.
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkCallingUriPermission
open fun checkCallingUriPermission(
uri: Uri!,
modeFlags: Int
): Int
Determine whether the calling process and uid has been granted permission to access a specific URI. This is basically the same as calling checkUriPermission(android.net.Uri,int,int,int) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always fail.
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkPermission
open fun checkPermission(
permission: String,
pid: Int,
uid: Int
): Int
Determine whether the given permission is allowed for a particular process and user ID running in the system.
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the given pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkSelfPermission
open fun checkSelfPermission(permission: String): Int
Determine whether you have been granted a particular permission.
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if you have the permission, or PackageManager.PERMISSION_DENIED if not. Value is one of the following: |
checkUriPermission
open fun checkUriPermission(
uri: Uri!,
pid: Int,
uid: Int,
modeFlags: Int
): Int
Determine whether a particular process and uid has been granted permission to access a specific URI. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the given pid/uid is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
checkUriPermission
open fun checkUriPermission(
uri: Uri?,
readPermission: String?,
writePermission: String?,
pid: Int,
uid: Int,
modeFlags: Int
): Int
Check both a Uri and normal permission. This allows you to perform both checkPermission and #checkUriPermission in one call.
| Parameters | |
|---|---|
uri |
Uri?: The Uri whose permission is to be checked, or null to not do this check. |
readPermission |
String?: The permission that provides overall read access, or null to not do this check. |
writePermission |
String?: The permission that provides overall write access, or null to not do this check. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Int |
PackageManager.PERMISSION_GRANTED if the caller is allowed to access that uri or holds one of the given permissions, or PackageManager.PERMISSION_DENIED if it is not. Value is one of the following: |
createConfigurationContext
open fun createConfigurationContext(overrideConfiguration: Configuration): Context!
Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
| Parameters | |
|---|---|
overrideConfiguration |
Configuration: A Configuration specifying what values to modify in the base Configuration of the original Context's resources. If the base configuration changes (such as due to an orientation change), the resources of this context will also change except for those that have been explicitly overridden with a value here. This value cannot be null. |
| Return | |
|---|---|
Context! |
A Context with the given configuration override. |
createContextForSplit
open fun createContextForSplit(splitName: String!): Context!
| Parameters | |
|---|---|
splitName |
String!: The name of the split to include, as declared in the split's AndroidManifest.xml. |
| Return | |
|---|---|
Context! |
A Context with the given split's code and/or resources loaded. |
createDeviceContext
open fun createDeviceContext(deviceId: Int): Context
Returns a new Context object from the current context but with device association given by the deviceId. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader and other resources for the same configuration) can be shared, so the Context itself is lightweight.
Applications that run on virtual devices may use this method to access the default device capabilities and functionality (by passing Context.DEVICE_ID_DEFAULT. Similarly, applications running on the default device may access the functionality of virtual devices.
Note that the newly created instance will be associated with the same display as the parent Context, regardless of the device ID passed here.
| Parameters | |
|---|---|
deviceId |
Int: The ID of the device to associate with this context. |
| Return | |
|---|---|
Context |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the given device ID is not a valid ID of the default device or a virtual device. |
createDeviceProtectedStorageContext
open fun createDeviceProtectedStorageContext(): Context!
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).
Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.
If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.
Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
createDisplayContext
open fun createDisplayContext(display: Display): Context!
Returns a new Context object from the current context but with resources adjusted to match the metrics of display. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader and other resources for the same configuration) can be shared, so the Context itself is lightweight.
Note: This Context is not expected to be updated with new configuration if the underlying display configuration changes and the cached Resources it returns could be stale. It is suggested to use android.hardware.display.DisplayManager.DisplayListener to listen for changes and re-create an instance if necessary.
This Context is not a UI context, do not use it to access UI components or obtain a WindowManager instance.
To obtain an instance of WindowManager configured to show windows on the given display, call createWindowContext(int,android.os.Bundle) on the returned display context, then call getSystemService(java.lang.String) or getSystemService(java.lang.Class) on the returned window context.
| Parameters | |
|---|---|
display |
Display: The display to which the current context's resources are adjusted. This value cannot be null. |
| Return | |
|---|---|
Context! |
A context for the display. |
createPackageContext
open fun createPackageContext(
packageName: String!,
flags: Int
): Context!
Return a new Context object for the given application name. This Context is the same as what the named application gets when it is launched, containing the same resources and class loader. Each call to this method returns a new instance of a Context object; Context objects are not shared, however they share common state (Resources, ClassLoader, etc) so the Context instance itself is fairly lightweight.
Throws android.content.pm.PackageManager.NameNotFoundException if there is no application with the given package name.
Throws java.lang.SecurityException if the Context requested can not be loaded into the caller's process for security reasons (see CONTEXT_INCLUDE_CODE for more information}.
| Parameters | |
|---|---|
packageName |
String!: Name of the application's package. |
flags |
Int: Option flags. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Context! |
A Context for the application. |
| Exceptions | |
|---|---|
android.content.pm.PackageManager.NameNotFoundException |
if there is no application with the given package name. |
java.lang.SecurityException |
|
createWindowContext
open fun createWindowContext(
display: Display,
type: Int,
options: Bundle?
): Context
Creates a Context for a non-activity window on the given Display.
Similar to createWindowContext(int,android.os.Bundle), but the display is passed in, instead of implicitly using the original Context's Display.
| Return | |
|---|---|
Context |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the Display is null. |
createWindowContext
open fun createWindowContext(
type: Int,
options: Bundle?
): Context
Creates a Context for a non-activity window.
A window context is a context that can be used to add non-activity windows, such as android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY. A window context must be created from a context that has an associated Display, such as Activity or a context created with createDisplayContext(android.view.Display).
The window context is created with the appropriate Configuration for the area of the display that the windows created with it can occupy; it must be used when inflating views, such that they can be inflated with proper Resources. Below is a sample code to add an application overlay window on the primary display:
... final DisplayManager dm = anyContext.getSystemService(DisplayManager.class); final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY); final Context windowContext = anyContext.createDisplayContext(primaryDisplay) .createWindowContext(TYPE_APPLICATION_OVERLAY, null); final View overlayView = Inflater.from(windowContext).inflate(someLayoutXml, null); // WindowManager.LayoutParams initialization ... // The types used in addView and createWindowContext must match. mParams.type = TYPE_APPLICATION_OVERLAY; ... windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
This context's configuration and resources are adjusted to an area of the display where the windows with provided type will be added. Note that all windows associated with the same context will have an affinity and can only be moved together between different displays or areas on a display. If there is a need to add different window types, or non-associated windows, separate Contexts should be used.
Creating a window context is an expensive operation. Misuse of this API may lead to a huge performance drop. The best practice is to use the same window context when possible. An approach is to create one window context with specific window type and display and use it everywhere it's needed.
After Build.VERSION_CODES.S, window context provides the capability to receive configuration changes for existing token by overriding the token of the android.view.WindowManager.LayoutParams passed in WindowManager.addView(View, LayoutParams). This is useful when an application needs to attach its window to an existing activity for window token sharing use-case.
Note that the window context in Build.VERSION_CODES.R didn't have this capability. This is a no-op for the window context in Build.VERSION_CODES.R.
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class); final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY); final Context windowContext = anyContext.createWindowContext(primaryDisplay, TYPE_APPLICATION, null); // Get an existing token. final IBinder existingToken = activity.getWindow().getAttributes().token; // The types used in addView() and createWindowContext() must match. final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION); params.token = existingToken; // After WindowManager#addView(), the server side will extract the provided token from // LayoutParams#token (existingToken in the sample code), and switch to propagate // configuration changes from the node associated with the provided token. windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
After Build.VERSION_CODES.S, window context provides the capability to listen to its Configuration changes by calling registerComponentCallbacks(android.content.ComponentCallbacks), while other kinds of Context will register the ComponentCallbacks to its. Note that window context only propagate ComponentCallbacks.onConfigurationChanged(Configuration) callback. ComponentCallbacks.onLowMemory() or other callbacks in ComponentCallbacks2 won't be invoked.
Note that using android.app.Application or android.app.Service context for UI-related queries may result in layout or continuity issues on devices with variable screen sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect the Configuration changes for the visual container.
| Return | |
|---|---|
Context |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.UnsupportedOperationException |
if this Context does not attach to a display, such as Application or Service. |
databaseList
open fun databaseList(): Array<String!>!
Returns an array of strings naming the private databases associated with this Context's application package.
| Return | |
|---|---|
Array<String!>! |
Array of strings naming the private databases. |
deleteDatabase
open fun deleteDatabase(name: String!): Boolean
Delete an existing private SQLiteDatabase associated with this Context's application package.
| Parameters | |
|---|---|
name |
String!: The name (unique in the application package) of the database. |
| Return | |
|---|---|
Boolean |
true if the database was successfully deleted; else false. |
deleteFile
open fun deleteFile(name: String!): Boolean
Delete the given private file associated with this Context's application package.
| Parameters | |
|---|---|
name |
String!: The name of the file to delete; can not contain path separators. |
| Return | |
|---|---|
Boolean |
true if the file was successfully deleted; else false. |
deleteSharedPreferences
open fun deleteSharedPreferences(: String!): Boolean
Delete an existing shared preferences file.
| Parameters | |
|---|---|
name |
String!: The name (unique in the application package) of the shared preferences file. |
| Return | |
|---|---|
Boolean |
true if the shared preferences file was successfully deleted; else false. |
enforceCallingOrSelfPermission
open fun enforceCallingOrSelfPermission(
permission: String,
message: String?
): Unit
If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException. This is the same as enforceCallingPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
message |
String?: A message to include in the exception if it is thrown. This value may be null. |
enforceCallingOrSelfUriPermission
open fun enforceCallingOrSelfUriPermission(
uri: Uri!,
modeFlags: Int,
message: String!
): Unit
If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException. This is the same as enforceCallingUriPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of the following:
|
message |
String!: A message to include in the exception if it is thrown. |
enforceCallingPermission
open fun enforceCallingPermission(
permission: String,
message: String?
): Unit
If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException. This is basically the same as calling enforcePermission(java.lang.String,int,int,java.lang.String) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always throw the SecurityException. This is done to protect against accidentally leaking permissions; you can use enforceCallingOrSelfPermission to avoid this protection.
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
message |
String?: A message to include in the exception if it is thrown. This value may be null. |
enforceCallingUriPermission
open fun enforceCallingUriPermission(
uri: Uri!,
modeFlags: Int,
message: String!
): Unit
If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException. This is basically the same as calling enforceUriPermission(android.net.Uri,int,int,int,java.lang.String) with the pid and uid returned by android.os.Binder#getCallingPid and android.os.Binder#getCallingUid. One important difference is that if you are not currently processing an IPC, this function will always throw a SecurityException.
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of the following:
|
message |
String!: A message to include in the exception if it is thrown. |
enforcePermission
open fun enforcePermission(
permission: String,
pid: Int,
uid: Int,
message: String?
): Unit
If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.
| Parameters | |
|---|---|
permission |
String: The name of the permission being checked. This value cannot be null. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
message |
String?: A message to include in the exception if it is thrown. This value may be null. |
enforceUriPermission
open fun enforceUriPermission(
uri: Uri!,
pid: Int,
uid: Int,
modeFlags: Int,
message: String!
): Unit
If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.
| Parameters | |
|---|---|
uri |
Uri!: The uri that is being checked. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of the following:
|
message |
String!: A message to include in the exception if it is thrown. |
enforceUriPermission
open fun enforceUriPermission(
uri: Uri?,
readPermission: String?,
writePermission: String?,
pid: Int,
uid: Int,
modeFlags: Int,
message: String?
): Unit
Enforce both a Uri and normal permission. This allows you to perform both enforcePermission and #enforceUriPermission in one call.
| Parameters | |
|---|---|
uri |
Uri?: The Uri whose permission is to be checked, or null to not do this check. |
readPermission |
String?: The permission that provides overall read access, or null to not do this check. |
writePermission |
String?: The permission that provides overall write access, or null to not do this check. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of the following:
|
message |
String?: A message to include in the exception if it is thrown. This value may be null. |
fileList
open fun fileList(): Array<String!>!
Returns an array of strings naming the private files associated with this Context's application package.
| Return | |
|---|---|
Array<String!>! |
Array of strings naming the private files. |
getApplicationContext
open fun getApplicationContext(): Context!
Return the context of the single, global Application object of the current process. This generally should only be used if you need a Context whose lifecycle is separate from the current context, that is tied to the lifetime of the process rather than the current component.
Consider for example how this interacts with registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter):
-
If used from an Activity context, the receiver is being registered within that activity. This means that you are expected to unregister before the activity is done being destroyed; in fact if you do not do so, the framework will clean up your leaked registration as it removes the activity and log an error. Thus, if you use the Activity context to register a receiver that is static (global to the process, not associated with an Activity instance) then that registration will be removed on you at whatever point the activity you used is destroyed.
-
If used from the Context returned here, the receiver is being registered with the global state associated with your application. Thus it will never be unregistered for you. This is necessary if the receiver is associated with static data, not a particular component. However using the ApplicationContext elsewhere can easily lead to serious leaks if you forget to unregister, unbind, etc.
getApplicationInfo
open fun getApplicationInfo(): ApplicationInfo!
Return the full application info for this context's package.
getAssets
open fun getAssets(): AssetManager!
Returns an AssetManager instance for the application's package.
Note: Implementations of this method should return an AssetManager instance that is consistent with the Resources instance returned by getResources(). For example, they should share the same Configuration object.
| Return | |
|---|---|
AssetManager! |
an AssetManager instance for the application's package |
getCacheDir
open fun getCacheDir(): File!
Returns the absolute path to the application specific cache directory on the filesystem.
The system will automatically delete files in this directory as disk space is needed elsewhere on the device. The system will always delete older files first, as reported by File.lastModified(). If desired, you can exert more control over how files are deleted using StorageManager.setCacheBehaviorGroup(File, boolean) and StorageManager.setCacheBehaviorTombstone(File, boolean).
Apps are strongly encouraged to keep their usage of cache space below the quota returned by StorageManager.getCacheQuotaBytes(java.util.UUID). If your app goes above this quota, your cached files will be some of the first to be deleted when additional disk space is needed. Conversely, if your app stays under this quota, your cached files will be some of the last to be deleted when additional disk space is needed.
Note that your cache quota will change over time depending on how frequently the user interacts with your app, and depending on how much system-wide disk space is used.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
| Return | |
|---|---|
File! |
The path of the directory holding application cache files. |
getClassLoader
open fun getClassLoader(): ClassLoader!
Return a class loader you can use to retrieve classes in this package.
getCodeCacheDir
open fun getCodeCacheDir(): File!
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
The system will delete any files stored in this location both when your specific application is upgraded, and when the entire platform is upgraded.
This location is optimal for storing compiled or optimized code generated by your application at runtime.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
| Return | |
|---|---|
File! |
The path of the directory holding application code cache files. |
getContentResolver
open fun getContentResolver(): ContentResolver!
Return a ContentResolver instance for your application's package.
getDataDir
open fun getDataDir(): File!
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. Apps should not use this path directly; they should instead use getFilesDir(), getCacheDir(), getDir(java.lang.String,int), or other storage APIs on this class.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
getDatabasePath
open fun getDatabasePath(name: String!): File!
Returns the absolute path on the filesystem where a database created with #openOrCreateDatabase is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
| Parameters | |
|---|---|
name |
String!: The name of the database for which you would like to get its path. |
| Return | |
|---|---|
File! |
An absolute path to the given database. |
getDeviceId
open fun getDeviceId(): Int
Gets the device ID this context is associated with. Applications can use this method to determine whether they are running on a virtual device and identify that device. The device ID of the host device is Context.DEVICE_ID_DEFAULT
If the underlying device ID is changed by the system, for example, when an Activity is moved to a different virtual device, applications can register to listen to changes by calling Context.registerDeviceIdChangeListener(Executor, IntConsumer).
This method will only return a reliable value for this instance if it was created with Context.createDeviceContext(int), or if this instance is a UI or Display Context. Contexts created with Context.createDeviceContext(int) will have an explicit device association, which will never change, even if the underlying device is closed or is removed. UI Contexts and Display Contexts are already associated with a display, so if the device association is not explicitly given, Context.getDeviceId() will return the ID of the device associated with the associated display. The system can assign an arbitrary device id value for Contexts not logically associated with a device.
| Return | |
|---|---|
Int |
the ID of the device this context is associated with. |
getDir
open fun getDir(
name: String!,
mode: Int
): File!
Retrieve, creating if needed, a new directory in which the application can place its own custom data files. You can use the returned File object to create and access files in this directory. Note that files created through a File object will only be accessible by your own application; you can only set the mode of the entire directory, not of individual files.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
| Parameters | |
|---|---|
name |
String!: Name of the directory to retrieve. This is a directory that is created as part of your application data. |
mode |
Int: Operating mode. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
File! |
A File object for the requested directory. The directory will have been created if it does not already exist. |
getDisplay
open fun getDisplay(): Display
Get the display this context is associated with. Applications should use this method with android.app.Activity or a context associated with a Display via createDisplayContext(android.view.Display) to get a display object associated with a Context, or android.hardware.display.DisplayManager#getDisplay to get a display object by id.
| Return | |
|---|---|
Display |
Returns the Display object this context is associated with. This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.UnsupportedOperationException |
if the method is called on an instance that is not associated with any display. |
getExternalCacheDir
open fun getExternalCacheDir(): File?
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- The platform does not always monitor the space available in shared storage, and thus may not automatically delete these files. Apps should always manage the maximum space used in this location. Currently the only time files here will be deleted by the platform is when running on
android.os.Build.VERSION_CODES#JELLY_BEAN_MR1or later andEnvironment.isExternalStorageEmulated(File)returns true. - Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir().
Starting in android.os.Build.VERSION_CODES#KITKAT, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.
On devices with multiple users (as described by UserManager), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
| Return | |
|---|---|
File? |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getExternalCacheDirs
open fun getExternalCacheDirs(): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- The platform does not always monitor the space available in shared storage, and thus may not automatically delete these files. Apps should always manage the maximum space used in this location. Currently the only time files here will be deleted by the platform is when running on
android.os.Build.VERSION_CODES#JELLY_BEAN_MR1or later andEnvironment.isExternalStorageEmulated(File)returns true. - Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir().
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
| Return | |
|---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getExternalCacheDir(). |
getExternalFilesDir
open fun getExternalFilesDir(type: String?): File?
Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media.
This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir(), etc.
Starting in android.os.Build.VERSION_CODES#KITKAT, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE and/or android.Manifest.permission#READ_EXTERNAL_STORAGE are required.
On devices with multiple users (as described by UserManager), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Here is an example of typical code to manipulate a file in an application's shared storage:
If you supply a non-null type to this function, the returned file will be a path to a sub-directory of the given type. Though these files are not automatically scanned by the media scanner, you can explicitly add them to the media database with MediaScannerConnection.scanFile. Note that this is not the same as Environment.getExternalStoragePublicDirectory(), which provides directories of media shared by all applications. The directories returned here are owned by the application, and their contents will be removed when the application is uninstalled. Unlike Environment.getExternalStoragePublicDirectory(), the directory returned here will be automatically created for you.
Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:
| Parameters | |
|---|---|
type |
String?: The type of files directory to return. May be null for the root of the files directory or one of the following constants for a subdirectory: android.os.Environment#DIRECTORY_MUSIC, android.os.Environment#DIRECTORY_PODCASTS, android.os.Environment#DIRECTORY_RINGTONES, android.os.Environment#DIRECTORY_ALARMS, android.os.Environment#DIRECTORY_NOTIFICATIONS, android.os.Environment#DIRECTORY_PICTURES, or android.os.Environment#DIRECTORY_MOVIES. |
| Return | |
|---|---|
File? |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getExternalFilesDirs
open fun getExternalFilesDirs(type: String!): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir(), etc.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
| Parameters | |
|---|---|
type |
String!: The type of files directory to return. May be null for the root of the files directory or one of the following constants for a subdirectory: android.os.Environment#DIRECTORY_MUSIC, android.os.Environment#DIRECTORY_PODCASTS, android.os.Environment#DIRECTORY_RINGTONES, android.os.Environment#DIRECTORY_ALARMS, android.os.Environment#DIRECTORY_NOTIFICATIONS, android.os.Environment#DIRECTORY_PICTURES, or android.os.Environment#DIRECTORY_MOVIES. |
| Return | |
|---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getExternalFilesDir(java.lang.String). |
getExternalMediaDirs
open fun getExternalMediaDirs(): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files. These files are scanned and made available to other apps through MediaStore.
This is like getExternalFilesDirs in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
| Return | |
|---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. |
getFileStreamPath
open fun getFileStreamPath(name: String!): File!
Returns the absolute path on the filesystem where a file created with openFileOutput is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
| Parameters | |
|---|---|
name |
String!: The name of the file for which you would like to get its path. |
| Return | |
|---|---|
File! |
An absolute path to the given file. |
getFilesDir
open fun getFilesDir(): File!
Returns the absolute path to the directory on the filesystem where files created with openFileOutput are stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
| Return | |
|---|---|
File! |
The path of the directory holding application files. |
getMainExecutor
open fun getMainExecutor(): Executor!
Return an Executor that will run enqueued tasks on the main thread associated with this context. This is the thread used to dispatch calls to application components (activities, services, etc).
getMainLooper
open fun getMainLooper(): Looper!
Return the Looper for the main thread of the current process. This is the thread used to dispatch calls to application components (activities, services, etc).
By definition, this method returns the same result as would be obtained by calling Looper.getMainLooper().
| Return | |
|---|---|
Looper! |
The main looper. |
getNoBackupFilesDir
open fun getNoBackupFilesDir(): File!
Returns the absolute path to the directory on the filesystem similar to getFilesDir(). The difference is that files placed under this directory will be excluded from automatic backup to remote storage. See BackupAgent for a full discussion of the automatic backup mechanism in Android.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
| Return | |
|---|---|
File! |
The path of the directory holding application files that will not be automatically backed up to remote storage. |
getObbDir
open fun getObbDir(): File!
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. Note if the application does not have any OBB files, this directory may not exist.
This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
Starting in android.os.Build.VERSION_CODES#KITKAT, no permissions are required to read or write to the path that this method returns. However, starting from android.os.Build.VERSION_CODES#M, to read the OBB expansion files, you must declare the android.Manifest.permission#READ_EXTERNAL_STORAGE permission in the app manifest and ask for permission at runtime as follows:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="23" />
Starting from android.os.Build.VERSION_CODES#N, android.Manifest.permission#READ_EXTERNAL_STORAGE permission is not required, so don’t ask for this permission at runtime. To handle both cases, your app must first try to read the OBB file, and if it fails, you must request android.Manifest.permission#READ_EXTERNAL_STORAGE permission at runtime.
The following code snippet shows how to do this:
File obb = new File(obb_filename); boolean open_failed = false; try { BufferedReader br = new BufferedReader(new FileReader(obb)); open_failed = false; ReadObbFile(br); } catch (IOException e) { open_failed = true; } if (open_failed) { // request READ_EXTERNAL_STORAGE permission before reading OBB file ReadObbFileWithPermission(); }
UserManager), multiple users may share the same OBB storage location. Applications should ensure that multiple instances running under different users don't interfere with each other.
| Return | |
|---|---|
File! |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getObbDirs
open fun getObbDirs(): Array<File!>!
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. Note if the application does not have any OBB files, these directories may not exist.
This is like getFilesDir() in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment.getExternalStorageState(File). - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGEcan write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
| Return | |
|---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getObbDir() |
getPackageCodePath
open fun getPackageCodePath(): String!
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains application's primary code and assets.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
| Return | |
|---|---|
String! |
String Path to the code and assets. |
getPackageManager
open fun getPackageManager(): PackageManager!
Return PackageManager instance to find global package information.
getPackageName
open fun getPackageName(): String!
Return the name of this application's package.
getPackageResourcePath
open fun getPackageResourcePath(): String!
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains the application's primary resources.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
| Return | |
|---|---|
String! |
String Path to the resources. |
getResources
open fun getResources(): Resources!
Returns a Resources instance for the application's package.
Note: Implementations of this method should return a Resources instance that is consistent with the AssetManager instance returned by getAssets(). For example, they should share the same Configuration object.
| Return | |
|---|---|
Resources! |
a Resources instance for the application's package |
getSharedPreferences
open fun getSharedPreferences(
: String!,
: Int
): SharedPreferences!
Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. Only one instance of the SharedPreferences object is returned to any callers for the same name, meaning they will see each other's edits as soon as they are made.
This method is thread-safe.
If the preferences directory does not already exist, it will be created when this method is called.
If a preferences file by this name does not exist, it will be created when you retrieve an editor (SharedPreferences.edit()) and then commit changes (SharedPreferences.Editor.commit() or SharedPreferences.Editor.apply()).
| Parameters | |
|---|---|
name |
String!: Desired preferences file. |
mode |
Int: Operating mode. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
SharedPreferences! |
The single SharedPreferences instance that can be used to retrieve and modify the preference values. |
getSystemService
open fun getSystemService(name: String): Any!
Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:
-
WINDOW_SERVICE("window") - The top-level window manager in which you can place custom windows. The returned object is a
android.view.WindowManager. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen. -
LAYOUT_INFLATER_SERVICE("layout_inflater") - A
android.view.LayoutInflaterfor inflating layout resources in this context. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen. -
ACTIVITY_SERVICE("activity") - A
android.app.ActivityManagerfor interacting with the global activity state of the system. -
WALLPAPER_SERVICE("wallpaper") - A
android.service.wallpaper.WallpaperServicefor accessing wallpapers in this context. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle), which are adjusted to the configuration and visual bounds of an area on screen. -
POWER_SERVICE("power") - A
android.os.PowerManagerfor controlling power management. -
ALARM_SERVICE("alarm") - A
android.app.AlarmManagerfor receiving intents at the time of your choosing. -
NOTIFICATION_SERVICE("notification") - A
android.app.NotificationManagerfor informing the user of background events. -
KEYGUARD_SERVICE("keyguard") - A
android.app.KeyguardManagerfor controlling keyguard. -
LOCATION_SERVICE("location") - A
android.location.LocationManagerfor controlling location (e.g., GPS) updates. -
SEARCH_SERVICE("search") - A
android.app.SearchManagerfor handling search. -
VIBRATOR_MANAGER_SERVICE("vibrator_manager") - A
android.os.VibratorManagerfor accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators. -
VIBRATOR_SERVICE("vibrator") - A
android.os.Vibratorfor interacting with the vibrator hardware. -
CONNECTIVITY_SERVICE("connectivity") - A
ConnectivityManagerfor handling management of network connections. -
IPSEC_SERVICE("ipsec") - A
IpSecManagerfor managing IPSec on sockets and networks. -
WIFI_SERVICE("wifi") - A
WifiManagerfor management of Wi-Fi connectivity. On releases before Android 7, it should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process. -
WIFI_AWARE_SERVICE("wifiaware") - A
WifiAwareManagerfor management of Wi-Fi Aware discovery and connectivity. -
WIFI_P2P_SERVICE("wifip2p") - A
WifiP2pManagerfor management of Wi-Fi Direct connectivity. -
INPUT_METHOD_SERVICE("input_method") - An
InputMethodManagerfor management of input methods. -
UI_MODE_SERVICE("uimode") - An
android.app.UiModeManagerfor controlling UI modes. -
DOWNLOAD_SERVICE("download") - A
android.app.DownloadManagerfor requesting HTTP downloads -
BATTERY_SERVICE("batterymanager") - A
android.os.BatteryManagerfor managing battery state -
JOB_SCHEDULER_SERVICE("taskmanager") - A
android.app.job.JobSchedulerfor managing scheduled tasks -
NETWORK_STATS_SERVICE("netstats") - A
NetworkStatsManagerfor querying network usage statistics. -
HARDWARE_PROPERTIES_SERVICE("hardware_properties") - A
android.os.HardwarePropertiesManagerfor accessing hardware properties. -
DOMAIN_VERIFICATION_SERVICE("domain_verification") - A
android.content.pm.verify.domain.DomainVerificationManagerfor accessing web domain approval state. -
DISPLAY_HASH_SERVICE("display_hash") - A
android.view.displayhash.DisplayHashManagerfor management of display hashes. - #AUTHENTICATION_POLICY_SERVICE ("authentication_policy")
- A
android.security.authenticationpolicy.AuthenticationPolicyManagerfor managing authentication related policies on the device.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager.isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE, #FINGERPRINT_SERVICE, KEYGUARD_SERVICE, SHORTCUT_SERVICE, USB_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE. For these services this method will return null. Generally, if you are running as an instant app you should always check whether the result of this method is null.
Note: When implementing this method, keep in mind that new services can be added on newer Android releases, so if you're looking for just the explicit names mentioned above, make sure to return null when you don't recognize the name — if you throw a RuntimeException exception instead, your app might break on new Android releases.
| Return | |
|---|---|
Any! |
The service or null if the name does not exist. |
getSystemServiceName
open fun getSystemServiceName(serviceClass: Class<*>): String?
Gets the name of the system-level service that is represented by the specified class.
| Parameters | |
|---|---|
serviceClass |
Class<*>: The class of the desired service. This value cannot be null. |
| Return | |
|---|---|
String? |
The service name or null if the class is not a supported system service. |
getTheme
open fun getTheme(): Resources.Theme!
Return the Theme object associated with this Context.
getWallpaperDesiredMinimumHeight
open fun getWallpaperDesiredMinimumHeight(): Int
getWallpaperDesiredMinimumWidth
open fun getWallpaperDesiredMinimumWidth(): Int
grantUriPermission
open fun grantUriPermission(
toPackage: String!,
uri: Uri!,
modeFlags: Int
): Unit
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. This can be used to grant specific, temporary permissions, typically in response to user interaction (such as the user opening an attachment that you would like someone else to display).
Normally you should use Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION with the Intent being used to start an activity instead of this function directly. If you use this function directly, you should be sure to call #revokeUriPermission when the target should no longer be allowed to access it.
To succeed, the content provider owning the Uri must have set the grantUriPermissions attribute in its manifest or included the <grant-uri-permissions> tag.
| Parameters | |
|---|---|
toPackage |
String!: The package you would like to allow to access the Uri. |
uri |
Uri!: The Uri you would like to grant access to. |
modeFlags |
Int: The desired access modes. Value is either 0 or a combination of the following:
|
isDeviceProtectedStorage
open fun isDeviceProtectedStorage(): Boolean
Indicates if the storage APIs of this Context are backed by device-protected storage.
isRestricted
open fun isRestricted(): Boolean
Indicates whether this Context is restricted.
| Return | |
|---|---|
Boolean |
true if this Context is restricted, false otherwise. |
isUiContext
open fun isUiContext(): Boolean
moveDatabaseFrom
open fun moveDatabaseFrom(
sourceContext: Context!,
name: String!
): Boolean
Move an existing database file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as migrating to device protected storage.
The database must be closed before being moved.
| Parameters | |
|---|---|
sourceContext |
Context!: The source context which contains the existing database to move. |
name |
String!: The name of the database file. |
| Return | |
|---|---|
Boolean |
true if the move was successful or if the database didn't exist in the source context, otherwise false. |
moveSharedPreferencesFrom
open fun moveSharedPreferencesFrom(
: Context!,
: String!
): Boolean
Move an existing shared preferences file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as moving to device protected storage.
| Parameters | |
|---|---|
sourceContext |
Context!: The source context which contains the existing shared preferences to move. |
name |
String!: The name of the shared preferences file. |
| Return | |
|---|---|
Boolean |
true if the move was successful or if the shared preferences didn't exist in the source context, otherwise false. |
openFileInput
open fun openFileInput(name: String!): FileInputStream!
Open a private file associated with this Context's application package for reading.
| Parameters | |
|---|---|
name |
String!: The name of the file to open; can not contain path separators. |
| Return | |
|---|---|
FileInputStream! |
The resulting FileInputStream. |
openFileOutput
open fun openFileOutput(
name: String!,
mode: Int
): FileOutputStream!
Open a private file associated with this Context's application package for writing. Creates the file if it doesn't already exist.
No additional permissions are required for the calling app to read or write the returned file.
| Parameters | |
|---|---|
name |
String!: The name of the file to open; can not contain path separators. |
mode |
Int: Operating mode. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
FileOutputStream! |
The resulting FileOutputStream. |
openOrCreateDatabase
open fun openOrCreateDatabase(
file: String!,
mode: Int,
factory: SQLiteDatabase.CursorFactory!
): SQLiteDatabase!
Open a new private SQLiteDatabase associated with this Context's application package. Create the database file if it doesn't exist.
| Parameters | |
|---|---|
name |
The name (unique in the application package) of the database. |
mode |
Int: Operating mode. Value is either 0 or a combination of the following:
|
factory |
SQLiteDatabase.CursorFactory!: An optional factory class that is called to instantiate a cursor when query is called. |
| Return | |
|---|---|
SQLiteDatabase! |
The contents of a newly created database with the given name. |
| Exceptions | |
|---|---|
android.database.sqlite.SQLiteException |
if the database file could not be opened. |
openOrCreateDatabase
open fun openOrCreateDatabase(
file: String!,
mode: Int,
factory: SQLiteDatabase.CursorFactory!,
errorHandler: DatabaseErrorHandler?
): SQLiteDatabase!
Open a new private SQLiteDatabase associated with this Context's application package. Creates the database file if it doesn't exist.
Accepts input param: a concrete instance of DatabaseErrorHandler to be used to handle corruption when sqlite reports database corruption.
| Parameters | |
|---|---|
name |
The name (unique in the application package) of the database. |
mode |
Int: Operating mode. Value is either 0 or a combination of the following:
|
factory |
SQLiteDatabase.CursorFactory!: An optional factory class that is called to instantiate a cursor when query is called. |
errorHandler |
DatabaseErrorHandler?: the DatabaseErrorHandler to be used when sqlite reports database corruption. if null, android.database.DefaultDatabaseErrorHandler is assumed. |
| Return | |
|---|---|
SQLiteDatabase! |
The contents of a newly created database with the given name. |
| Exceptions | |
|---|---|
android.database.sqlite.SQLiteException |
if the database file could not be opened. |
registerReceiver
open fun registerReceiver(
receiver: BroadcastReceiver?,
filter: IntentFilter!
): Intent?
Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread.
The system may broadcast Intents that are "sticky" -- these stay around after the broadcast has finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.
There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.
If you know the Intent you are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) to register a receiver with flags.
Note: this method cannot be called from a BroadcastReceiver component; that is, from a BroadcastReceiver that is declared in an application's manifest. It is okay, however, to call this method from another BroadcastReceiver that has itself been registered at run time with #registerReceiver, since the lifetime of such a registered BroadcastReceiver is tied to the object that registered it.
| Parameters | |
|---|---|
receiver |
BroadcastReceiver?: The BroadcastReceiver to handle the broadcast. This value may be null. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
| Return | |
|---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
open fun registerReceiver(
receiver: BroadcastReceiver?,
filter: IntentFilter!,
flags: Int
): Intent?
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. By default Instant Apps cannot interact with receivers in other applications, this allows you to expose a receiver that Instant Apps can interact with.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
| Parameters | |
|---|---|
receiver |
BroadcastReceiver?: The BroadcastReceiver to handle the broadcast. This value may be null. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
flags |
Int: Additional options for the receiver. For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered for system broadcasts or a SecurityException will be thrown. If RECEIVER_EXPORTED is specified, a receiver may additionally specify RECEIVER_VISIBLE_TO_INSTANT_APPS. For a complete list of system broadcast actions, see the BROADCAST_ACTIONS.TXT file in the Android SDK. If both RECEIVER_EXPORTED and RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
open fun registerReceiver(
receiver: BroadcastReceiver!,
filter: IntentFilter!,
broadcastPermission: String?,
scheduler: Handler?
): Intent?
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter) for more information. This allows you to enforce permissions on who can broadcast intents to your receiver, or have the receiver run in a different thread than the main application thread.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver is not being registered for system broadcasts or a SecurityException will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler,int) to register a receiver with flags.
| Parameters | |
|---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to handle the broadcast. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
broadcastPermission |
String?: String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required. |
scheduler |
Handler?: Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used. |
| Return | |
|---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
open fun registerReceiver(
receiver: BroadcastReceiver!,
filter: IntentFilter!,
broadcastPermission: String?,
scheduler: Handler?,
flags: Int
): Intent?
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int) and registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler) for more information.
See BroadcastReceiver for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH, receivers registered with this method will correctly respect the Intent.setPackage(String) specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
| Parameters | |
|---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to handle the broadcast. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
broadcastPermission |
String?: String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required. |
scheduler |
Handler?: Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used. |
flags |
Int: Additional options for the receiver. For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered for system broadcasts or a SecurityException will be thrown. If RECEIVER_EXPORTED is specified, a receiver may additionally specify RECEIVER_VISIBLE_TO_INSTANT_APPS. For a complete list of system broadcast actions, see the BROADCAST_ACTIONS.TXT file in the Android SDK. If both RECEIVER_EXPORTED and RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown. Value is either 0 or a combination of the following:
|
| Return | |
|---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
removeStickyBroadcast
open fun removeStickyBroadcast(intent: Intent!): Unit
Remove the data previously sent with #sendStickyBroadcast, so that it is as if the sticky broadcast had never happened.
Requires android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent that was previously broadcast. |
removeStickyBroadcastAsUser
open fun removeStickyBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): Unit
Version of removeStickyBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
You must hold the android.Manifest.permission#BROADCAST_STICKY permission in order to use this API. If you do not hold that permission, SecurityException will be thrown.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent that was previously broadcast. |
user |
UserHandle!: UserHandle to remove the sticky broadcast from. |
revokeUriPermission
open fun revokeUriPermission(
uri: Uri!,
modeFlags: Int
): Unit
Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission or any other mechanism. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.
Prior to android.os.Build.VERSION_CODES#LOLLIPOP, if you did not have regular permission access to a Uri, but had received access to it through a specific Uri permission grant, you could not revoke that grant with this function and a SecurityException would be thrown. As of android.os.Build.VERSION_CODES#LOLLIPOP, this function will not throw a security exception, but will remove whatever permission grants to the Uri had been given to the app (or none).
Unlike revokeUriPermission(java.lang.String,android.net.Uri,int), this method impacts all permission grants matching the given Uri, for any package they had been granted to, through any mechanism this had happened (such as indirectly through the clipboard, activity launch, service start, etc). That means this can be potentially dangerous to use, as it can revoke grants that another app could be strongly expecting to stick around.
| Parameters | |
|---|---|
uri |
Uri!: The Uri you would like to revoke access to. |
modeFlags |
Int: The access modes to revoke. Value is either 0 or a combination of the following:
|
revokeUriPermission
open fun revokeUriPermission(
targetPackage: String!,
uri: Uri!,
modeFlags: Int
): Unit
Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission for a specific target package. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.
Unlike revokeUriPermission(android.net.Uri,int), this method will only revoke permissions that had been explicitly granted through grantUriPermission and only for the package specified. Any matching grants that have happened through other mechanisms (clipboard, activity launching, service starting, etc) will not be removed.
| Parameters | |
|---|---|
toPackage |
The package you had previously granted access to. |
uri |
Uri!: The Uri you would like to revoke access to. |
modeFlags |
Int: The access modes to revoke. Value is either 0 or a combination of the following:
|
sendBroadcast
open fun sendBroadcast(intent: Intent!): Unit
Broadcast the given intent to all interested BroadcastReceivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String).
See BroadcastReceiver for more information on Intent broadcasts.
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
sendBroadcast
open fun sendBroadcast(
intent: Intent!,
receiverPermission: String?
): Unit
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String).
See BroadcastReceiver for more information on Intent broadcasts.
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
sendBroadcast
open fun sendBroadcast(
intent: Intent,
receiverPermission: String?,
options: Bundle?
): Unit
| Parameters | |
|---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null. |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions. This value may be null. |
sendBroadcastAsUser
open fun sendBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): Unit
Version of sendBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
| Parameters | |
|---|---|
intent |
Intent!: The intent to broadcast |
user |
UserHandle!: UserHandle to send the intent to. |
sendBroadcastAsUser
open fun sendBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
receiverPermission: String?
): Unit
Version of sendBroadcast(android.content.Intent,java.lang.String) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent!,
receiverPermission: String?
): Unit
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. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver for more information on Intent broadcasts.
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
receiverPermission |
String?: (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String).
Like sendBroadcast(android.content.Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.
See BroadcastReceiver for more information on Intent broadcasts.
| Parameters | |
|---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null. |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
options: Bundle?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
| Parameters | |
|---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null. |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions. This value may be null. |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
receiverAppOp: String?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.
See BroadcastReceiver for more information on Intent broadcasts.
| Parameters | |
|---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null. |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
receiverAppOp |
String?: The app op associated with the broadcast. If null, no appOp is required. If both receiverAppOp and receiverPermission are non-null, a receiver must have both of them to receive the broadcast |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcastAsUser
open fun sendOrderedBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
receiverPermission: String?,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendStickyBroadcast
open fun sendStickyBroadcast(intent: Intent!): Unit
Perform a sendBroadcast(android.content.Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter). In all other ways, this behaves the same as sendBroadcast(android.content.Intent).
Requires android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. |
sendStickyBroadcast
open fun sendStickyBroadcast(
intent: Intent,
options: Bundle?
): Unit
Perform a sendBroadcast(android.content.Intent) that is "sticky," meaning the Intent you are sending stays around after the broadcast is complete, so that others can quickly retrieve that data through the return value of registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter). In all other ways, this behaves the same as sendBroadcast(android.content.Intent).
Requires android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. This value cannot be null. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions. This value may be null. |
sendStickyBroadcastAsUser
open fun sendStickyBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): Unit
Version of sendStickyBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. |
user |
UserHandle!: UserHandle to send the intent to. |
sendStickyOrderedBroadcast
open fun sendStickyOrderedBroadcast(
intent: Intent!,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of #sendStickyBroadcast that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String).
Like sendBroadcast(android.content.Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called. Note that the sticky data stored is only the data you initially supply to the broadcast, not the result of any changes made by the receivers.
See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendStickyOrderedBroadcastAsUser
open fun sendStickyOrderedBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendStickyOrderedBroadcast(android.content.Intent,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle) that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
| Parameters | |
|---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
setTheme
open fun setTheme(resid: Int): Unit
Set the base theme for this context. Note that this should be called before any views are instantiated in the Context (for example before calling android.app.Activity#setContentView or android.view.LayoutInflater#inflate).
| Parameters | |
|---|---|
resid |
Int: The style resource describing the theme. |
startActivities
open fun startActivities(intents: Array<Intent!>!): Unit
Same as startActivities(android.content.Intent[],android.os.Bundle) with no options specified.
| Parameters | |
|---|---|
intents |
Array<Intent!>!: An array of Intents to be started. |
| Exceptions | |
|---|---|
android.content.ActivityNotFoundException |
|
startActivities
open fun startActivities(
intents: Array<Intent!>!,
options: Bundle!
): Unit
Launch multiple new activities. This is generally the same as calling startActivity(android.content.Intent) for the first Intent in the array, that activity during its creation calling startActivity(android.content.Intent) for the second entry, etc. Note that unlike that approach, generally none of the activities except the last in the array will be created at this point, but rather will be created when the user first visits them (due to pressing back from the activity on top).
This method throws ActivityNotFoundException if there was no Activity found for any given Intent. In this case the state of the activity stack is undefined (some Intents in the list may be on it, some not), so you probably want to avoid such situations.
| Parameters | |
|---|---|
intents |
Array<Intent!>!: An array of Intents to be started. |
options |
Bundle!: Additional options for how the Activity should be started. See android.content.Context#startActivity(Intent, Bundle) Context.startActivity(Intent, Bundle)} for more details. |
| Exceptions | |
|---|---|
android.content.ActivityNotFoundException |
|
startActivity
open fun startActivity(intent: Intent!): Unit
Same as startActivity(android.content.Intent,android.os.Bundle) with no options specified.
| Parameters | |
|---|---|
intent |
Intent!: The description of the activity to start. |
| Exceptions | |
|---|---|
android.content.ActivityNotFoundException |
` |
startActivity
open fun startActivity(
intent: Intent!,
options: Bundle?
): Unit
Launch a new activity. You will not receive any information about when the activity exits.
Note that if this method is being called from outside of an android.app.Activity Context, then the Intent must include the Intent.FLAG_ACTIVITY_NEW_TASK launch flag. This is because, without being started from an existing Activity, there is no existing task in which to place the new activity and thus it needs to be placed in its own separate task.
This method throws ActivityNotFoundException if there was no Activity found to run the given Intent.
| Parameters | |
|---|---|
intent |
Intent!: The description of the activity to start. |
options |
Bundle?: Additional options for how the Activity should be started. May be null if there are no options. See android.app.ActivityOptions for how to build the Bundle supplied here; there are no supported definitions for building it manually. |
| Exceptions | |
|---|---|
android.content.ActivityNotFoundException |
|
startForegroundService
open fun startForegroundService(service: Intent!): ComponentName?
Similar to startService(android.content.Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running. The service is given an amount of time comparable to the ANR interval to do this, otherwise the system will automatically crash the process, in which case an internal exception ForegroundServiceDidNotStartInTimeException is logged on logcat on devices running SDK Version android.os.Build.VERSION_CODES#S or later. On older Android versions, an internal exception RemoteServiceException is logged instead, with a corresponding message.
Unlike the ordinary startService(android.content.Intent), this method can be used at any time, regardless of whether the app hosting the service is in a foreground state.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
| Parameters | |
|---|---|
service |
Intent!: Identifies the service to be started. The Intent must be fully explicit (supplying a component name). Additional values may be included in the Intent extras to supply arguments along with this specific start call. |
| Return | |
|---|---|
ComponentName? |
If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned. |
| Exceptions | |
|---|---|
android.app.ForegroundServiceStartNotAllowedException |
If the caller app's targeting API is android.os.Build.VERSION_CODES#S or later, and the foreground service is restricted from start due to background restriction. |
java.lang.SecurityException |
If the caller does not have permission to access the service or the service can not be found. |
startInstrumentation
open fun startInstrumentation(
className: ComponentName,
profileFile: String?,
arguments: Bundle?
): Boolean
Start executing an android.app.Instrumentation class. The given Instrumentation component will be run by killing its target application (if currently running), starting the target process, instantiating the instrumentation component, and then letting it drive the application.
This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.
Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).
| Parameters | |
|---|---|
className |
ComponentName: Name of the Instrumentation component to be run. This value cannot be null. |
profileFile |
String?: Optional path to write profiling data as the instrumentation runs, or null for no profiling. |
arguments |
Bundle?: Additional optional arguments to pass to the instrumentation, or null. |
| Return | |
|---|---|
Boolean |
true if the instrumentation was successfully started, else false if it could not be found. |
startIntentSender
open fun startIntentSender(
intent: IntentSender!,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int
): Unit
Same as startIntentSender(android.content.IntentSender,android.content.Intent,int,int,int,android.os.Bundle) with no options specified.
startIntentSender
open fun startIntentSender(
intent: IntentSender!,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?
): Unit
Like startActivity(android.content.Intent,android.os.Bundle), but taking a IntentSender to start. If the IntentSender is for an activity, that activity will be started as if you had called the regular startActivity(android.content.Intent) here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called android.content.IntentSender#sendIntent on it.
startService
open fun startService(service: Intent!): ComponentName?
Request that a given application service be started. The Intent should either contain the complete class name of a specific service implementation to start, or a specific package name to target. If the Intent is less specified, it logs a warning about this. In this case any of the multiple matching services may be used. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.
Every call to this method will result in a corresponding call to the target service's android.app.Service#onStartCommand method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.
Using startService() overrides the default service lifetime that is managed by #bindService: it requires the service to remain running until stopService is called, regardless of whether any clients are connected to it. Note that calls to startService() do not nest: no matter how many times you call startService(), a single call to stopService will stop it.
The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.
This function will throw SecurityException if you do not have permission to start the given service.
Note: Each call to startService() results in significant work done by the system to manage service lifecycle surrounding the processing of the intent, which can take multiple milliseconds of CPU time. Due to this cost, startService() should not be used for frequent intent delivery to a service, and only for scheduling significant work. Use #bindService for high frequency calls.
Beginning with SDK Versionandroid.os.Build.VERSION_CODES#O, apps targeting SDK Version android.os.Build.VERSION_CODES#O or higher are not allowed to start background services from the background. See Background Execution Limits for more details.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S, apps targeting SDK Version android.os.Build.VERSION_CODES#S or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
| Parameters | |
|---|---|
service |
Intent!: Identifies the service to be started. The Intent must be fully explicit (supplying a component name). Additional values may be included in the Intent extras to supply arguments along with this specific start call. |
| Return | |
|---|---|
ComponentName? |
If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned. |
| Exceptions | |
|---|---|
android.app.BackgroundServiceStartNotAllowedException |
On Android android.os.Build.VERSION_CODES#S and later, if the application is in a state where the service can not be started (such as not in the foreground in a state when services are allowed), android.app.BackgroundServiceStartNotAllowedException is thrown. This exception extends IllegalStateException, so apps can use catch (IllegalStateException) to catch both. |
java.lang.IllegalStateException |
Before Android android.os.Build.VERSION_CODES#S, if the application is in a state where the service can not be started (such as not in the foreground in a state when services are allowed), IllegalStateException was thrown. |
java.lang.SecurityException |
If the caller does not have permission to access the service or the service can not be found. |
stopService
open fun stopService(service: Intent!): Boolean
Request that a given application service be stopped. If the service is not running, nothing happens. Otherwise it is stopped. Note that calls to startService() are not counted -- this stops the service no matter how many times it was started.
If the service is running as a foreground service when it is stopped, its associated notification will be removed. To avoid this, apps can use stopForeground(STOP_FOREGROUND_DETACH) to decouple the notification from the service's lifecycle before stopping it.
Note that if a stopped service still has ServiceConnection objects bound to it with the BIND_AUTO_CREATE set, it will not be destroyed until all of these bindings are removed. See the android.app.Service documentation for more details on a service's lifecycle.
This function will throw SecurityException if you do not have permission to stop the given service.
| Parameters | |
|---|---|
service |
Intent!: Description of the service to be stopped. The Intent must be either fully explicit (supplying a component name) or specify a specific package name it is targeted to. |
| Return | |
|---|---|
Boolean |
If there is a service matching the given Intent that is already running, then it is stopped and true is returned; else false is returned. |
| Exceptions | |
|---|---|
java.lang.IllegalStateException |
If the application is in a state where the service can not be started (such as not in the foreground in a state when services are allowed). |
java.lang.SecurityException |
If the caller does not have permission to access the service or the service can not be found. |
unbindService
open fun unbindService(conn: ServiceConnection): Unit
Disconnect from an application service. You will no longer receive calls as the service is restarted, and the service is now allowed to stop at any time.
| Parameters | |
|---|---|
conn |
ServiceConnection: The connection interface previously supplied to bindService(). This parameter must not be null. |
unregisterReceiver
open fun unregisterReceiver(receiver: BroadcastReceiver!): Unit
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
| Parameters | |
|---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to unregister. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the receiver was not previously registered or already unregistered. |
updateServiceGroup
open fun updateServiceGroup(
conn: ServiceConnection,
group: Int,
importance: Int
): Unit
For a service previously bound with #bindService or a related method, change how the system manages that service's process in relation to other processes. This doesn't modify the original bind flags that were passed in when binding, but adjusts how the process will be managed in some cases based on those flags. Currently only works on isolated processes (will be ignored for non-isolated processes).
Note that this call does not take immediate effect, but will be applied the next time the impacted process is adjusted for some other reason. Typically you would call this before then calling a new #bindIsolatedService on the service of interest, with that binding causing the process to be shuffled accordingly.
| Parameters | |
|---|---|
conn |
ServiceConnection: The connection interface previously supplied to bindService(). This parameter must not be null. |
group |
Int: A group to put this connection's process in. Upon calling here, this will override any previous group that was set for that process. The group tells the system about processes that are logically grouped together, so should be managed as one unit of importance (such as when being considered a recently used app). All processes in the same app with the same group are considered to be related. Supplying 0 reverts to the default behavior of not grouping. |
importance |
Int: Additional importance of the processes within a group. Upon calling here, this will override any previous importance that was set for that process. The most important process is 0, and higher values are successively less important. You can view this as describing how to order the processes in an array, with the processes at the end of the array being the least important. This value has no meaning besides indicating how processes should be ordered in that array one after the other. This provides a way to fine-tune the system's process killing, guiding it to kill processes at the end of the array first. |