Added in API level 1

ContextWrapper


open class ContextWrapper : Context
kotlin.Any
   ↳ android.content.Context
   ↳ android.content.ContextWrapper

Proxying implementation of Context that simply delegates all of its calls to another Context. Can be subclassed to modify behavior without changing the original Context.

Summary

Inherited constants
Public constructors

Public methods
open Boolean
bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection)

open Boolean
bindService(service: Intent, conn: ServiceConnection, flags: Int)

open Boolean

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

open Boolean
bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection)

open Boolean
bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection)

See bindService(android.content.Intent,int,java.util.concurrent.Executor,android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object.

open Int

open Int

open IntArray

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

open Int

open Int
checkCallingUriPermission(uri: Uri!, modeFlags: Int)

open IntArray

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

open Int
checkContentUriPermissionFull(uri: Uri, pid: Int, uid: Int, modeFlags: Int)

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

open Int
checkPermission(permission: String, pid: Int, uid: Int)

open Int

open Int
checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)

open Int
checkUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int)

Check both a Uri and normal permission.

open IntArray
checkUriPermissions(uris: MutableList<Uri!>, pid: Int, uid: Int, modeFlags: Int)

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

open Unit

open Context
createAttributionContext(attributionTag: String?)

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

open Context!
createConfigurationContext(overrideConfiguration: Configuration)

open Context
createContext(contextParams: ContextParams)

Creates a context with specific properties and behaviors.

open Context

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

open Context!

open Context!

open Context!
createPackageContext(packageName: String!, flags: Int)

open Context
createWindowContext(type: Int, options: Bundle?)

Creates a Context for a non-activity window.

open Context
createWindowContext(display: Display, type: Int, options: Bundle?)

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

open Array<String!>!

open Boolean

open Boolean

open Boolean

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 SecurityException.

open Unit
enforceCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int, message: String!)

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 SecurityException.

open Unit
enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)

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 SecurityException.

open Unit
enforceUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int, message: String!)

open Unit
enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?)

Enforce both a Uri and normal permission.

open Array<String!>!

open Context!

open ApplicationInfo!

open AssetManager!

open AttributionSource

open Context!

open File!

open ClassLoader!

open File!

open ContentResolver!

open File!

open File!

open Int

open File!
getDir(name: String!, mode: Int)

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!>!

open File?

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!>!

open Array<File!>!

open File!

open File!

open Executor!

open Looper!

open File!

open File!

open Array<File!>!

open String!

open PackageManager!

open String!

open String!

open ContextParams?

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

open Resources!

open SharedPreferences!

open Any!

open String?
getSystemServiceName(serviceClass: Class<*>)

open Resources.Theme!

open Drawable!

open Int

open Int

open Unit
grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)

open Boolean

open Boolean

open Boolean
moveDatabaseFrom(sourceContext: Context!, name: String!)

open Boolean
moveSharedPreferencesFrom(sourceContext: Context!, name: String!)

open FileInputStream!

open FileOutputStream!
openFileOutput(name: String!, mode: Int)

open SQLiteDatabase!

open SQLiteDatabase!

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

open Drawable!

open Unit

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

open Unit

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

open Intent?

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

open Unit

open Unit

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

open Unit
revokeUriPermission(uri: Uri!, modeFlags: Int)

open Unit
revokeUriPermission(targetPackage: String!, uri: Uri!, modeFlags: Int)

open Unit

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?)

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

open Unit

open Unit
sendBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?)

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?, options: Bundle?)

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 sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast.

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

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

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

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.

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

open Unit
sendOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?)

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.

open Unit

open Unit
sendStickyBroadcast(intent: Intent, options: Bundle?)

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).

open Unit

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 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.

open Unit
setTheme(resid: Int)

open Unit
setWallpaper(bitmap: Bitmap!)

open Unit

open Unit

open Unit
startActivities(intents: Array<Intent!>!, options: Bundle?)

Launch multiple new activities.

open Unit

open Unit
startActivity(intent: Intent!, options: Bundle?)

Launch a new activity.

open 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.

open Boolean
startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?)

Start executing an android.app.Instrumentation class.

open Unit
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int)

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

open Unit
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?)

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

open ComponentName?
startService(service: Intent!)

Request that a given application service be started.

open Boolean

open Unit

open Unit

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

open Unit

Removes a device ID changed listener from the Context.

open Unit

open Unit
updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int)

Protected methods
open Unit

Set the base context for this ContextWrapper.

Inherited functions

Public constructors

ContextWrapper

Added in API level 1
ContextWrapper(base: Context!)

Public methods

bindIsolatedService

Added in API level 29
open fun bindIsolatedService(
    service: Intent,
    flags: Int,
    instanceName: String,
    executor: Executor,
    conn: ServiceConnection
): Boolean
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.SecurityException If the caller does not have permission to access the service
java.lang.IllegalArgumentException If the instanceName is invalid.

bindService

Added in API level 1
open fun bindService(
    service: Intent,
    conn: ServiceConnection,
    flags: Int
): 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. 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

Added in API level 34
open fun bindService(
    service: Intent,
    conn: ServiceConnection,
    flags: Context.BindServiceFlags
): Boolean

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

Parameters
service Intent: This value cannot be null.
conn ServiceConnection: This value cannot be null.
flags Context.BindServiceFlags: This value cannot be null.

bindService

Added in API level 29
open fun bindService(
    service: Intent,
    flags: Int,
    executor: Executor,
    conn: ServiceConnection
): Boolean
Parameters
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.
service Intent: This value cannot be null.
flags Int: Value is either 0 or a combination of android.content.Context#BIND_AUTO_CREATE, android.content.Context#BIND_DEBUG_UNBIND, android.content.Context#BIND_NOT_FOREGROUND, android.content.Context#BIND_ABOVE_CLIENT, android.content.Context#BIND_ALLOW_OOM_MANAGEMENT, android.content.Context#BIND_WAIVE_PRIORITY, android.content.Context#BIND_IMPORTANT, android.content.Context#BIND_ADJUST_WITH_ACTIVITY, android.content.Context#BIND_NOT_PERCEPTIBLE, android.content.Context#BIND_ALLOW_ACTIVITY_STARTS, android.content.Context#BIND_INCLUDE_CAPABILITIES, android.content.Context#BIND_SHARED_ISOLATED_PROCESS, android.content.Context#BIND_PACKAGE_ISOLATED_PROCESS, and android.content.Context#BIND_EXTERNAL_SERVICE
conn ServiceConnection: This value cannot be null.
Return
Boolean The result of the binding as described in bindService(Intent, ServiceConnection, int).

bindService

Added in API level 34
open fun bindService(
    service: Intent,
    flags: Context.BindServiceFlags,
    executor: Executor,
    conn: ServiceConnection
): Boolean

See bindService(android.content.Intent,int,java.util.concurrent.Executor,android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object.

Parameters
service Intent: This value cannot be null.
flags Context.BindServiceFlags: This value cannot be null.
executor Executor: This value cannot be null.
conn ServiceConnection: This value cannot be null.

checkCallingOrSelfPermission

Added in API level 1
open fun checkCallingOrSelfPermission(permission: String): Int
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkCallingOrSelfUriPermission

Added in API level 1
open fun checkCallingOrSelfUriPermission(
    uri: Uri!,
    modeFlags: Int
): Int
Parameters
uri Uri!: The uri that is being checked.
modeFlags Int: The access modes to check. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
Return
Int PackageManager#PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager#PERMISSION_DENIED if it is not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkCallingOrSelfUriPermissions

Added in API level 31
open fun checkCallingOrSelfUriPermissions(
    uris: MutableList<Uri!>,
    modeFlags: Int
): IntArray

Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. This is the same as checkCallingUriPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!

Parameters
uris MutableList<Uri!>: This value cannot be null.
modeFlags Int: The access modes to check. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
Return
IntArray This value cannot be null.

checkCallingPermission

Added in API level 1
open fun checkCallingPermission(permission: String): Int
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkCallingUriPermission

Added in API level 1
open fun checkCallingUriPermission(
    uri: Uri!,
    modeFlags: Int
): Int
Parameters
uri Uri!: The uri that is being checked.
modeFlags Int: The access modes to check. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
Return
Int PackageManager#PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager#PERMISSION_DENIED if it is not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkCallingUriPermissions

Added in API level 31
open fun checkCallingUriPermissions(
    uris: MutableList<Uri!>,
    modeFlags: Int
): IntArray

Determine whether the calling process and uid has been granted permission to access a list of URIs. This is basically the same as calling checkUriPermissions(java.util.List,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
uris MutableList<Uri!>: This value cannot be null.
modeFlags Int: The access modes to check. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
Return
IntArray This value cannot be null.

checkContentUriPermissionFull

Added in API level 35
open fun checkContentUriPermissionFull(
    uri: Uri,
    pid: Int,
    uid: Int,
    modeFlags: Int
): Int

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

Unlike checkUriPermission(android.net.Uri,int,int,int), this method checks for general access to the URI's content provider, as well as explicitly granted permissions.

Note, this check will throw an IllegalArgumentException for non-content URIs.

Parameters
uri Uri: This value cannot be null.
pid Int: (Optional) The process ID being checked against. If the pid is unknown, pass -1.
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkPermission

Added in API level 1
open fun checkPermission(
    permission: String,
    pid: Int,
    uid: Int
): Int
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkSelfPermission

Added in API level 23
open fun checkSelfPermission(permission: String): Int
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkUriPermission

Added in API level 1
open fun checkUriPermission(
    uri: Uri!,
    pid: Int,
    uid: Int,
    modeFlags: Int
): Int
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkUriPermission

Added in API level 1
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?: This value may be null.
readPermission String?: This value may be null.
writePermission String?: This value may 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.
modeFlags Int: The access modes to check. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
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 android.content.pm.PackageManager#PERMISSION_GRANTED, or android.content.pm.PackageManager#PERMISSION_DENIED

checkUriPermissions

Added in API level 31
open fun checkUriPermissions(
    uris: MutableList<Uri!>,
    pid: Int,
    uid: Int,
    modeFlags: Int
): IntArray

Determine whether a particular process and uid has been granted permission to access a list of URIs. 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. Note: On SDK Version android.os.Build.VERSION_CODES#S, calling this method from a secondary-user's context will incorrectly return PackageManager#PERMISSION_DENIED for all {code uris}.

Parameters
uris MutableList<Uri!>: 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.
modeFlags Int: The access modes to check for the list of uris Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
Return
IntArray This value cannot be null.

clearWallpaper

Added in API level 1
open fun clearWallpaper(): Unit

Deprecated: Deprecated in Java.

createAttributionContext

Added in API level 30
open fun createAttributionContext(attributionTag: String?): Context

Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.

Parameters
attributionTag String?: This value may be null.
Return
Context This value cannot be null.

createConfigurationContext

Added in API level 17
open fun createConfigurationContext(overrideConfiguration: Configuration): Context!
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.

createContext

Added in API level 31
open fun createContext(contextParams: ContextParams): Context

Creates a context with specific properties and behaviors.

Parameters
contextParams ContextParams: This value cannot be null.
Return
Context This value cannot be null.

createDeviceContext

Added in API level 34
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

Added in API level 24
open fun createDeviceProtectedStorageContext(): Context!

createDisplayContext

Added in API level 17
open fun createDisplayContext(display: Display): 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

Added in API level 1
open fun createPackageContext(
    packageName: String!,
    flags: Int
): Context!
Parameters
packageName String!: Name of the application's package.
flags Int: Option flags. Value is either 0 or a combination of android.content.Context#CONTEXT_INCLUDE_CODE, android.content.Context#CONTEXT_IGNORE_SECURITY, android.content.Context#CONTEXT_RESTRICTED, android.content.Context.CONTEXT_DEVICE_PROTECTED_STORAGE, android.content.Context.CONTEXT_CREDENTIAL_PROTECTED_STORAGE, and android.content.Context.CONTEXT_REGISTER_PACKAGE
Return
Context! A Context for the application.
Exceptions
java.lang.SecurityException  
android.content.pm.PackageManager.NameNotFoundException if there is no application with the given package name.

createWindowContext

Added in API level 30
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.

Below is sample code to attach an existing token to a window context:
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.

Parameters
type Int: Value is android.view.WindowManager.LayoutParams#TYPE_BASE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_STARTING, android.view.WindowManager.LayoutParams#TYPE_DRAWN_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_MEDIA, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_STATUS_BAR, android.view.WindowManager.LayoutParams#TYPE_SEARCH_BAR, android.view.WindowManager.LayoutParams#TYPE_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, android.view.WindowManager.LayoutParams#TYPE_TOAST, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIORITY_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_DIALOG, android.view.WindowManager.LayoutParams#TYPE_KEYGUARD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ERROR, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_WALLPAPER, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, android.view.WindowManager.LayoutParams#TYPE_ACCESSIBILITY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options Bundle?: This value may be null.
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.

createWindowContext

Added in API level 31
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.

Parameters
display Display: This value cannot be null.
type Int: Value is android.view.WindowManager.LayoutParams#TYPE_BASE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_STARTING, android.view.WindowManager.LayoutParams#TYPE_DRAWN_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_MEDIA, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_STATUS_BAR, android.view.WindowManager.LayoutParams#TYPE_SEARCH_BAR, android.view.WindowManager.LayoutParams#TYPE_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, android.view.WindowManager.LayoutParams#TYPE_TOAST, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIORITY_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_DIALOG, android.view.WindowManager.LayoutParams#TYPE_KEYGUARD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ERROR, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_WALLPAPER, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, android.view.WindowManager.LayoutParams#TYPE_ACCESSIBILITY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options Bundle?: This value may be null.
Return
Context This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the Display is null.

databaseList

Added in API level 1
open fun databaseList(): Array<String!>!
Return
Array<String!>! Array of strings naming the private databases.

deleteDatabase

Added in API level 1
open fun deleteDatabase(name: String!): Boolean
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

Added in API level 1
open fun deleteFile(name: String!): Boolean
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

Added in API level 24
open fun deleteSharedPreferences(name: String!): Boolean
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

Added in API level 1
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?: This value may be null.

enforceCallingOrSelfUriPermission

Added in API level 1
open fun enforceCallingOrSelfUriPermission(
    uri: Uri!,
    modeFlags: Int,
    message: String!
): Unit
Parameters
uri Uri!: The uri that is being checked.
modeFlags Int: The access modes to enforce. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
message String!: A message to include in the exception if it is thrown.

enforceCallingPermission

Added in API level 1
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?: This value may be null.

enforceCallingUriPermission

Added in API level 1
open fun enforceCallingUriPermission(
    uri: Uri!,
    modeFlags: Int,
    message: String!
): Unit
Parameters
uri Uri!: The uri that is being checked.
modeFlags Int: The access modes to enforce. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
message String!: A message to include in the exception if it is thrown.

enforcePermission

Added in API level 1
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?: This value may be null.

enforceUriPermission

Added in API level 1
open fun enforceUriPermission(
    uri: Uri!,
    pid: Int,
    uid: Int,
    modeFlags: Int,
    message: String!
): Unit
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
message String!: A message to include in the exception if it is thrown.

enforceUriPermission

Added in API level 1
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?: This value may be null.
readPermission String?: This value may be null.
writePermission String?: This value may 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.
modeFlags Int: The access modes to enforce. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION
message String?: This value may be null.

fileList

Added in API level 1
open fun fileList(): Array<String!>!
Return
Array<String!>! Array of strings naming the private files.

getApplicationContext

Added in API level 1
open fun getApplicationContext(): Context!

getApplicationInfo

Added in API level 4
open fun getApplicationInfo(): ApplicationInfo!

getAssets

Added in API level 1
open fun getAssets(): AssetManager!
Return
AssetManager! an AssetManager instance for the application's package

getAttributionSource

Added in API level 31
open fun getAttributionSource(): AttributionSource
Return
AttributionSource This value cannot be null.

getBaseContext

Added in API level 1
open fun getBaseContext(): Context!
Return
Context! the base context as set by the constructor or setBaseContext

getCacheDir

Added in API level 1
open fun getCacheDir(): File!
Return
File! The path of the directory holding application cache files.

getClassLoader

Added in API level 1
open fun getClassLoader(): ClassLoader!

getCodeCacheDir

Added in API level 21
open fun getCodeCacheDir(): File!
Return
File! The path of the directory holding application code cache files.

getContentResolver

Added in API level 1
open fun getContentResolver(): ContentResolver!

getDataDir

Added in API level 24
open fun getDataDir(): File!

getDatabasePath

Added in API level 1
open fun getDatabasePath(name: String!): File!
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

Added in API level 34
open fun getDeviceId(): Int
Return
Int the ID of the device this context is associated with.

getDir

Added in API level 1
open fun getDir(
    name: String!,
    mode: Int
): File!
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 android.content.Context#MODE_PRIVATE, android.content.Context#MODE_WORLD_READABLE, android.content.Context#MODE_WORLD_WRITEABLE, and android.content.Context#MODE_APPEND
Return
File! A File object for the requested directory. The directory will have been created if it does not already exist.

getDisplay

Added in API level 30
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! This value may be null.
Exceptions
java.lang.UnsupportedOperationException if the method is called on an instance that is not associated with any display.

getExternalCacheDir

Added in API level 8
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:

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? This value may be null.

getExternalCacheDirs

Added in API level 19
open fun getExternalCacheDirs(): Array<File!>!
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

Added in API level 8
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:

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?: This value may be null.
Return
File? This value may be null.

getExternalFilesDirs

Added in API level 19
open fun getExternalFilesDirs(type: String!): Array<File!>!
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

Added in API level 21
open fun getExternalMediaDirs(): Array<File!>!
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

Added in API level 1
open fun getFileStreamPath(name: String!): File!
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

Added in API level 1
open fun getFilesDir(): File!
Return
File! The path of the directory holding application files.

getMainExecutor

Added in API level 28
open fun getMainExecutor(): Executor!

getMainLooper

Added in API level 1
open fun getMainLooper(): Looper!
Return
Looper! The main looper.

getNoBackupFilesDir

Added in API level 21
open fun getNoBackupFilesDir(): File!
Return
File! The path of the directory holding application files that will not be automatically backed up to remote storage.

getObbDir

Added in API level 11
open fun getObbDir(): File!
Return
File! the absolute path to application-specific directory. May return null if shared storage is not currently available.

getObbDirs

Added in API level 19
open fun getObbDirs(): Array<File!>!
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

Added in API level 1
open fun getPackageCodePath(): String!
Return
String! String Path to the code and assets.

getPackageManager

Added in API level 1
open fun getPackageManager(): PackageManager!

getPackageName

Added in API level 1
open fun getPackageName(): String!

getPackageResourcePath

Added in API level 1
open fun getPackageResourcePath(): String!
Return
String! String Path to the resources.

getParams

Added in API level 31
open fun getParams(): ContextParams?

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

Return
ContextParams? This value may be null.

getResources

Added in API level 1
open fun getResources(): Resources!
Return
Resources! a Resources instance for the application's package

getSharedPreferences

Added in API level 1
open fun getSharedPreferences(
    name: String!,
    mode: Int
): SharedPreferences!
Parameters
name String!: Desired preferences file.
mode Int: Operating mode. Value is either 0 or a combination of android.content.Context#MODE_PRIVATE, android.content.Context#MODE_WORLD_READABLE, android.content.Context#MODE_WORLD_WRITEABLE, and android.content.Context#MODE_MULTI_PROCESS
Return
SharedPreferences! The single SharedPreferences instance that can be used to retrieve and modify the preference values.

getSystemService

Added in API level 1
open fun getSystemService(name: String): Any!
Parameters
name String: The name of the desired service. Value is android.content.Context#POWER_SERVICE, android.content.Context#WINDOW_SERVICE, android.content.Context#LAYOUT_INFLATER_SERVICE, android.content.Context#ACCOUNT_SERVICE, android.content.Context#ACTIVITY_SERVICE, android.content.Context#ALARM_SERVICE, android.content.Context#NOTIFICATION_SERVICE, android.content.Context#ACCESSIBILITY_SERVICE, android.content.Context#CAPTIONING_SERVICE, android.content.Context#KEYGUARD_SERVICE, android.content.Context#LOCATION_SERVICE, android.content.Context#HEALTHCONNECT_SERVICE, android.content.Context#SEARCH_SERVICE, android.content.Context#SENSOR_SERVICE, android.content.Context.SENSOR_PRIVACY_SERVICE, android.content.Context#STORAGE_SERVICE, android.content.Context#STORAGE_STATS_SERVICE, android.content.Context#WALLPAPER_SERVICE, android.content.Context#VIBRATOR_MANAGER_SERVICE, android.content.Context#VIBRATOR_SERVICE, android.content.Context.THREAD_NETWORK_SERVICE, android.content.Context#CONNECTIVITY_SERVICE, android.content.Context.PAC_PROXY_SERVICE, android.content.Context.VCN_MANAGEMENT_SERVICE, android.content.Context#IPSEC_SERVICE, android.content.Context#VPN_MANAGEMENT_SERVICE, android.content.Context.TEST_NETWORK_SERVICE, android.content.Context#NETWORK_STATS_SERVICE, android.content.Context#WIFI_SERVICE, android.content.Context#WIFI_AWARE_SERVICE, android.content.Context#WIFI_P2P_SERVICE, android.content.Context.WIFI_SCANNING_SERVICE, android.content.Context#WIFI_RTT_RANGING_SERVICE, android.content.Context#NSD_SERVICE, android.content.Context#AUDIO_SERVICE, android.content.Context.AUDIO_DEVICE_VOLUME_SERVICE, android.content.Context.AUTH_SERVICE, android.content.Context#FINGERPRINT_SERVICE, android.content.Context#BIOMETRIC_SERVICE, android.content.Context#MEDIA_ROUTER_SERVICE, android.content.Context#TELEPHONY_SERVICE, android.content.Context#TELEPHONY_SUBSCRIPTION_SERVICE, android.content.Context#CARRIER_CONFIG_SERVICE, android.content.Context#EUICC_SERVICE, android.content.Context#TELECOM_SERVICE, android.content.Context#CLIPBOARD_SERVICE, android.content.Context#INPUT_METHOD_SERVICE, android.content.Context#TEXT_SERVICES_MANAGER_SERVICE, android.content.Context#TEXT_CLASSIFICATION_SERVICE, android.content.Context#APPWIDGET_SERVICE, android.content.Context.REBOOT_READINESS_SERVICE, android.content.Context.ROLLBACK_SERVICE, android.content.Context#DROPBOX_SERVICE, android.content.Context#DEVICE_POLICY_SERVICE, android.content.Context#UI_MODE_SERVICE, android.content.Context#DOWNLOAD_SERVICE, android.content.Context#NFC_SERVICE, android.content.Context#BLUETOOTH_SERVICE, android.content.Context#USB_SERVICE, android.content.Context#LAUNCHER_APPS_SERVICE, android.content.Context#INPUT_SERVICE, android.content.Context#DISPLAY_SERVICE, android.content.Context#USER_SERVICE, android.content.Context#RESTRICTIONS_SERVICE, android.content.Context#APP_OPS_SERVICE, android.content.Context#ROLE_SERVICE, android.content.Context#CAMERA_SERVICE, android.content.Context#PRINT_SERVICE, android.content.Context#CONSUMER_IR_SERVICE, android.content.Context#TV_INTERACTIVE_APP_SERVICE, android.content.Context#TV_INPUT_SERVICE, android.content.Context#USAGE_STATS_SERVICE, android.content.Context#MEDIA_SESSION_SERVICE, android.content.Context#MEDIA_COMMUNICATION_SERVICE, android.content.Context#BATTERY_SERVICE, android.content.Context#JOB_SCHEDULER_SERVICE, android.content.Context#PERSISTENT_DATA_BLOCK_SERVICE, android.content.Context#MEDIA_PROJECTION_SERVICE, android.content.Context#MIDI_SERVICE, android.content.Context.RADIO_SERVICE, android.content.Context#HARDWARE_PROPERTIES_SERVICE, android.content.Context#SHORTCUT_SERVICE, android.content.Context#SYSTEM_HEALTH_SERVICE, android.content.Context#COMPANION_DEVICE_SERVICE, android.content.Context#VIRTUAL_DEVICE_SERVICE, android.content.Context#CROSS_PROFILE_APPS_SERVICE, android.content.Context.PERMISSION_SERVICE, android.content.Context.LIGHTS_SERVICE, android.content.Context#LOCALE_SERVICE, android.content.Context.UWB_SERVICE, android.content.Context#MEDIA_METRICS_SERVICE, android.content.Context#DISPLAY_HASH_SERVICE, android.content.Context#CREDENTIAL_SERVICE, android.content.Context#DEVICE_LOCK_SERVICE, android.content.Context.VIRTUALIZATION_SERVICE, android.content.Context#GRAMMATICAL_INFLECTION_SERVICE, android.content.Context#SECURITY_STATE_SERVICE, or android.content.Context#CONTACT_KEYS_SERVICE This value cannot be null.
Return
Any! The service or null if the name does not exist.

getSystemServiceName

Added in API level 23
open fun getSystemServiceName(serviceClass: Class<*>): String?
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

Added in API level 1
open fun getTheme(): Resources.Theme!

getWallpaper

Added in API level 1
open fun getWallpaper(): Drawable!

Deprecated: Deprecated in Java.

getWallpaperDesiredMinimumHeight

Added in API level 1
open fun getWallpaperDesiredMinimumHeight(): Int

Deprecated: Deprecated in Java.

getWallpaperDesiredMinimumWidth

Added in API level 1
open fun getWallpaperDesiredMinimumWidth(): Int

Deprecated: Deprecated in Java.

grantUriPermission

Added in API level 1
open fun grantUriPermission(
    toPackage: String!,
    uri: Uri!,
    modeFlags: Int
): Unit
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION, android.content.Intent#FLAG_GRANT_PERSISTABLE_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_PREFIX_URI_PERMISSION

isDeviceProtectedStorage

Added in API level 24
open fun isDeviceProtectedStorage(): Boolean

isRestricted

Added in API level 4
open fun isRestricted(): Boolean
Return
Boolean true if this Context is restricted, false otherwise.

moveDatabaseFrom

Added in API level 24
open fun moveDatabaseFrom(
    sourceContext: Context!,
    name: String!
): Boolean
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

Added in API level 24
open fun moveSharedPreferencesFrom(
    sourceContext: Context!,
    name: String!
): Boolean
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

Added in API level 1
open fun openFileInput(name: String!): FileInputStream!
Parameters
name String!: The name of the file to open; can not contain path separators.
Return
FileInputStream! The resulting FileInputStream.

openFileOutput

Added in API level 1
open fun openFileOutput(
    name: String!,
    mode: Int
): FileOutputStream!
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 android.content.Context#MODE_PRIVATE, android.content.Context#MODE_WORLD_READABLE, android.content.Context#MODE_WORLD_WRITEABLE, and android.content.Context#MODE_APPEND
Return
FileOutputStream! The resulting FileOutputStream.

openOrCreateDatabase

Added in API level 1
open fun openOrCreateDatabase(
    name: String!,
    mode: Int,
    factory: SQLiteDatabase.CursorFactory!
): SQLiteDatabase!
Parameters
name String!: The name (unique in the application package) of the database.
mode Int: Operating mode. Value is either 0 or a combination of android.content.Context#MODE_PRIVATE, android.content.Context#MODE_WORLD_READABLE, android.content.Context#MODE_WORLD_WRITEABLE, android.content.Context#MODE_ENABLE_WRITE_AHEAD_LOGGING, and android.content.Context#MODE_NO_LOCALIZED_COLLATORS
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

Added in API level 11
open fun openOrCreateDatabase(
    name: 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 String!: The name (unique in the application package) of the database.
mode Int: Operating mode. Value is either 0 or a combination of android.content.Context#MODE_PRIVATE, android.content.Context#MODE_WORLD_READABLE, android.content.Context#MODE_WORLD_WRITEABLE, android.content.Context#MODE_ENABLE_WRITE_AHEAD_LOGGING, and android.content.Context#MODE_NO_LOCALIZED_COLLATORS
factory SQLiteDatabase.CursorFactory!: An optional factory class that is called to instantiate a cursor when query is called.
errorHandler DatabaseErrorHandler?: This value may be null.
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.

peekWallpaper

Added in API level 1
open fun peekWallpaper(): Drawable!

Deprecated: Deprecated in Java.

registerComponentCallbacks

Added in API level 14
open fun registerComponentCallbacks(callback: ComponentCallbacks!): Unit

Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called. Note that you must be sure to use unregisterComponentCallbacks when appropriate in the future; this will not be removed for you.

After Build.VERSION_CODES#TIRAMISU, the ComponentCallbacks will be registered to the base Context, and can be only used after attachBaseContext(android.content.Context). Users can still call to getApplicationContext().registerComponentCallbacks(ComponentCallbacks) to add ComponentCallbacks to the base application.

Parameters
callback ComponentCallbacks!: The interface to call. This can be either a ComponentCallbacks or ComponentCallbacks2 interface.
Exceptions
java.lang.IllegalStateException if this method calls before attachBaseContext(android.content.Context)

registerDeviceIdChangeListener

Added in API level 34
open fun registerDeviceIdChangeListener(
    executor: Executor,
    listener: IntConsumer
): Unit

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

The callback can be called when an app is moved to a different device and the Context is not explicitly associated with a specific device.

When an application receives a device id update callback, this Context is guaranteed to also have an updated display ID(if any) and Configuration.

Parameters
executor Executor: 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.
listener IntConsumer: This value cannot be null.

registerReceiver

Added in API level 1
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 your 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?: 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

Added in API level 26
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?: 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 android.content.Context#RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Context#RECEIVER_EXPORTED, android.content.Context#RECEIVER_NOT_EXPORTED, and android.content.Context.RECEIVER_EXPORTED_UNAUDITED
Return
Intent? The first sticky intent found that matches filter, or null if there are none.

registerReceiver

Added in API level 1
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?: This value may be null.
filter IntentFilter!: Selects the Intent broadcasts to be received.
broadcastPermission String?: This value may be null.
scheduler Handler?: This value may be null.
Return
Intent? The first sticky intent found that matches filter, or null if there are none.

registerReceiver

Added in API level 26
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?: This value may be null.
filter IntentFilter!: Selects the Intent broadcasts to be received.
broadcastPermission String?: This value may be null.
scheduler Handler?: This value may be null.
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 android.content.Context#RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Context#RECEIVER_EXPORTED, android.content.Context#RECEIVER_NOT_EXPORTED, and android.content.Context.RECEIVER_EXPORTED_UNAUDITED
Return
Intent? The first sticky intent found that matches filter, or null if there are none.

removeStickyBroadcast

Added in API level 1
open fun removeStickyBroadcast(intent: Intent!): Unit

Deprecated: Deprecated in Java.

Parameters
intent Intent!: The Intent that was previously broadcast.

removeStickyBroadcastAsUser

Added in API level 17
open fun removeStickyBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!
): Unit

Deprecated: Deprecated in Java.

Parameters
intent Intent!: The Intent that was previously broadcast.
user UserHandle!: UserHandle to remove the sticky broadcast from.

revokeSelfPermissionsOnKill

Added in API level 33
open fun revokeSelfPermissionsOnKill(permissions: MutableCollection<String!>): Unit

Triggers the revocation of one or more permissions for the calling package. A package is only able to revoke runtime permissions. If a permission is not currently granted, it is ignored and will not get revoked (even if later granted by the user). Ultimately, you should never make assumptions about a permission status as users may grant or revoke them at any time.

Background permissions which have no corresponding foreground permission still granted once the revocation is effective will also be revoked.

The revocation happens asynchronously and kills all processes running in the calling UID. It will be triggered once it is safe to do so. In particular, it will not be triggered as long as the package remains in the foreground, or has any active manifest components (e.g. when another app is accessing a content provider in the package).

If you want to revoke the permissions right away, you could call System.exit() in Handler.postDelayed with a delay to allow completion of async IPC, But System.exit() could affect other apps that are accessing your app at the moment. For example, apps accessing a content provider in your app will all crash.

Note that the settings UI shows a permission group as granted as long as at least one permission in the group is granted. If you want the user to observe the revocation in the settings, you should revoke every permission in the target group. To learn the current list of permissions in a group, you may use PackageManager#getGroupOfPlatformPermission(String, Executor, Consumer) and PackageManager#getPlatformPermissionsForGroup(String, Executor, Consumer). This list of permissions may evolve over time, so it is recommended to check whether it contains any permission you wish to retain before trying to revoke an entire group.

Parameters
permissions MutableCollection<String!>: This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if any of the permissions is not a runtime permission

revokeUriPermission

Added in API level 1
open fun revokeUriPermission(
    uri: Uri!,
    modeFlags: Int
): Unit
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION

revokeUriPermission

Added in API level 26
open fun revokeUriPermission(
    targetPackage: String!,
    uri: Uri!,
    modeFlags: Int
): Unit
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 android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION, and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION

sendBroadcast

Added in API level 1
open fun sendBroadcast(intent: Intent!): Unit
Parameters
intent Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast.

sendBroadcast

Added in API level 1
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?: This value may be null.

sendBroadcast

Added in API level 34
open fun sendBroadcast(
    intent: Intent,
    receiverPermission: String?,
    options: Bundle?
): 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: This value cannot be null.
receiverPermission String?: This value may be null.
options Bundle?: This value may be null.

sendBroadcastAsUser

Added in API level 17
open fun sendBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!
): Unit
Parameters
intent Intent!: The intent to broadcast
user UserHandle!: UserHandle to send the intent to.

sendBroadcastAsUser

Added in API level 17
open fun sendBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!,
    receiverPermission: String?
): Unit
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

Added in API level 1
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?: This value may be null.

sendOrderedBroadcast

Added in API level 34
open fun sendOrderedBroadcast(
    intent: Intent,
    receiverPermission: String?,
    options: Bundle?
): 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: This value cannot be null.
receiverPermission String?: This value may be null.
options Bundle?: This value may be null.

sendOrderedBroadcast

Added in API level 1
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?: This value may be null.
resultReceiver BroadcastReceiver?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

sendOrderedBroadcast

Added in API level 34
open fun sendOrderedBroadcast(
    intent: Intent,
    receiverPermission: String?,
    options: Bundle?,
    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: This value cannot be null.
receiverPermission String?: This value may be null.
options Bundle?: This value may be null.
resultReceiver BroadcastReceiver?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

sendOrderedBroadcast

Added in API level 30
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: This value cannot be null.
receiverPermission String?: This value may be null.
receiverAppOp String?: This value may be null.
resultReceiver BroadcastReceiver?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

sendOrderedBroadcast

Added in API level 30
open fun sendOrderedBroadcast(
    intent: Intent,
    initialCode: Int,
    receiverPermission: String?,
    receiverAppOp: String?,
    resultReceiver: BroadcastReceiver?,
    scheduler: Handler?,
    initialData: String?,
    initialExtras: Bundle?,
    options: Bundle?
): Unit
Parameters
intent Intent: This value cannot be null.
receiverPermission String?: This value may be null.
receiverAppOp String?: This value may be null.
resultReceiver BroadcastReceiver?: This value may be null.
scheduler Handler?: This value may be null.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.
options Bundle?: This value may be null.

sendOrderedBroadcastAsUser

Added in API level 17
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?: This value may be null.
resultReceiver BroadcastReceiver?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

sendStickyBroadcast

Added in API level 1
open fun sendStickyBroadcast(intent: Intent!): Unit

Deprecated: Deprecated in Java.

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

Added in API level 31
open fun sendStickyBroadcast(
    intent: Intent,
    options: Bundle?
): Unit

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

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).

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

Added in API level 17
open fun sendStickyBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!
): Unit

Deprecated: Deprecated in Java.

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

Added in API level 5
open fun sendStickyOrderedBroadcast(
    intent: Intent!,
    resultReceiver: BroadcastReceiver?,
    scheduler: Handler?,
    initialCode: Int,
    initialData: String?,
    initialExtras: Bundle?
): Unit

Deprecated: Deprecated in Java.

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?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

sendStickyOrderedBroadcastAsUser

Added in API level 17
open fun sendStickyOrderedBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!,
    resultReceiver: BroadcastReceiver?,
    scheduler: Handler?,
    initialCode: Int,
    initialData: String?,
    initialExtras: Bundle?
): Unit

Deprecated: Deprecated in Java.

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?: This value may be null.
scheduler Handler?: This value may be null.
initialCode Int: An initial value for the result code. Often Activity.RESULT_OK.
initialData String?: This value may be null.
initialExtras Bundle?: This value may be null.

setTheme

Added in API level 1
open fun setTheme(resid: Int): Unit
Parameters
resid Int: The style resource describing the theme.

setWallpaper

Added in API level 1
open fun setWallpaper(bitmap: Bitmap!): Unit

Deprecated: Deprecated in Java.

setWallpaper

Added in API level 1
open fun setWallpaper(data: InputStream!): Unit

Deprecated: Deprecated in Java.

startActivities

Added in API level 11
open fun startActivities(intents: Array<Intent!>!): Unit
Parameters
intents Array<Intent!>!: An array of Intents to be started.
Exceptions
android.content.ActivityNotFoundException  

startActivities

Added in API level 16
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?: This value may be null.
Exceptions
android.content.ActivityNotFoundException  

startActivity

Added in API level 1
open fun startActivity(intent: Intent!): Unit
Parameters
intent Intent!: The description of the activity to start.
Exceptions
android.content.ActivityNotFoundException   `

startActivity

Added in API level 16
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?: This value may be null.
Exceptions
android.content.ActivityNotFoundException  

startForegroundService

Added in API level 26
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? This value may be null.
Exceptions
java.lang.SecurityException If the caller does not have permission to access the service or the service can not be found.
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.

startInstrumentation

Added in API level 1
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?: This value may be null.
arguments Bundle?: This value may be null.
Return
Boolean true if the instrumentation was successfully started, else false if it could not be found.

startIntentSender

Added in API level 5
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.

Parameters
intent IntentSender!: The IntentSender to launch.
fillInIntent Intent?: This value may be null.
flagsMask Int: Intent flags in the original IntentSender that you would like to change. Value is either 0 or a combination of android.content.Intent#FLAG_FROM_BACKGROUND, android.content.Intent#FLAG_DEBUG_LOG_RESOLUTION, android.content.Intent#FLAG_EXCLUDE_STOPPED_PACKAGES, android.content.Intent#FLAG_INCLUDE_STOPPED_PACKAGES, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, android.content.Intent#FLAG_ACTIVITY_MATCH_EXTERNAL, android.content.Intent#FLAG_ACTIVITY_NO_HISTORY, android.content.Intent#FLAG_ACTIVITY_SINGLE_TOP, android.content.Intent#FLAG_ACTIVITY_NEW_TASK, android.content.Intent#FLAG_ACTIVITY_MULTIPLE_TASK, android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP, android.content.Intent#FLAG_ACTIVITY_FORWARD_RESULT, android.content.Intent#FLAG_ACTIVITY_PREVIOUS_IS_TOP, android.content.Intent#FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS, android.content.Intent#FLAG_ACTIVITY_BROUGHT_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_RESET_TASK_IF_NEEDED, android.content.Intent#FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NEW_DOCUMENT, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NO_USER_ACTION, android.content.Intent#FLAG_ACTIVITY_REORDER_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_NO_ANIMATION, android.content.Intent#FLAG_ACTIVITY_CLEAR_TASK, android.content.Intent#FLAG_ACTIVITY_TASK_ON_HOME, android.content.Intent#FLAG_ACTIVITY_RETAIN_IN_RECENTS, android.content.Intent#FLAG_ACTIVITY_LAUNCH_ADJACENT, android.content.Intent#FLAG_RECEIVER_REGISTERED_ONLY, android.content.Intent#FLAG_RECEIVER_REPLACE_PENDING, android.content.Intent#FLAG_RECEIVER_FOREGROUND, android.content.Intent#FLAG_RECEIVER_NO_ABORT, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, android.content.Intent#FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Intent.FLAG_RECEIVER_OFFLOAD, and android.content.Intent.FLAG_RECEIVER_OFFLOAD_FOREGROUND
flagsValues Int: Desired values for any bits set in flagsMask Value is either 0 or a combination of android.content.Intent#FLAG_FROM_BACKGROUND, android.content.Intent#FLAG_DEBUG_LOG_RESOLUTION, android.content.Intent#FLAG_EXCLUDE_STOPPED_PACKAGES, android.content.Intent#FLAG_INCLUDE_STOPPED_PACKAGES, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, android.content.Intent#FLAG_ACTIVITY_MATCH_EXTERNAL, android.content.Intent#FLAG_ACTIVITY_NO_HISTORY, android.content.Intent#FLAG_ACTIVITY_SINGLE_TOP, android.content.Intent#FLAG_ACTIVITY_NEW_TASK, android.content.Intent#FLAG_ACTIVITY_MULTIPLE_TASK, android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP, android.content.Intent#FLAG_ACTIVITY_FORWARD_RESULT, android.content.Intent#FLAG_ACTIVITY_PREVIOUS_IS_TOP, android.content.Intent#FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS, android.content.Intent#FLAG_ACTIVITY_BROUGHT_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_RESET_TASK_IF_NEEDED, android.content.Intent#FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NEW_DOCUMENT, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NO_USER_ACTION, android.content.Intent#FLAG_ACTIVITY_REORDER_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_NO_ANIMATION, android.content.Intent#FLAG_ACTIVITY_CLEAR_TASK, android.content.Intent#FLAG_ACTIVITY_TASK_ON_HOME, android.content.Intent#FLAG_ACTIVITY_RETAIN_IN_RECENTS, android.content.Intent#FLAG_ACTIVITY_LAUNCH_ADJACENT, android.content.Intent#FLAG_RECEIVER_REGISTERED_ONLY, android.content.Intent#FLAG_RECEIVER_REPLACE_PENDING, android.content.Intent#FLAG_RECEIVER_FOREGROUND, android.content.Intent#FLAG_RECEIVER_NO_ABORT, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, android.content.Intent#FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Intent.FLAG_RECEIVER_OFFLOAD, and android.content.Intent.FLAG_RECEIVER_OFFLOAD_FOREGROUND
extraFlags Int: Always set to 0.

startIntentSender

Added in API level 16
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.

Parameters
intent IntentSender!: The IntentSender to launch.
fillInIntent Intent?: This value may be null.
flagsMask Int: Intent flags in the original IntentSender that you would like to change. Value is either 0 or a combination of android.content.Intent#FLAG_FROM_BACKGROUND, android.content.Intent#FLAG_DEBUG_LOG_RESOLUTION, android.content.Intent#FLAG_EXCLUDE_STOPPED_PACKAGES, android.content.Intent#FLAG_INCLUDE_STOPPED_PACKAGES, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, android.content.Intent#FLAG_ACTIVITY_MATCH_EXTERNAL, android.content.Intent#FLAG_ACTIVITY_NO_HISTORY, android.content.Intent#FLAG_ACTIVITY_SINGLE_TOP, android.content.Intent#FLAG_ACTIVITY_NEW_TASK, android.content.Intent#FLAG_ACTIVITY_MULTIPLE_TASK, android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP, android.content.Intent#FLAG_ACTIVITY_FORWARD_RESULT, android.content.Intent#FLAG_ACTIVITY_PREVIOUS_IS_TOP, android.content.Intent#FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS, android.content.Intent#FLAG_ACTIVITY_BROUGHT_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_RESET_TASK_IF_NEEDED, android.content.Intent#FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NEW_DOCUMENT, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NO_USER_ACTION, android.content.Intent#FLAG_ACTIVITY_REORDER_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_NO_ANIMATION, android.content.Intent#FLAG_ACTIVITY_CLEAR_TASK, android.content.Intent#FLAG_ACTIVITY_TASK_ON_HOME, android.content.Intent#FLAG_ACTIVITY_RETAIN_IN_RECENTS, android.content.Intent#FLAG_ACTIVITY_LAUNCH_ADJACENT, android.content.Intent#FLAG_RECEIVER_REGISTERED_ONLY, android.content.Intent#FLAG_RECEIVER_REPLACE_PENDING, android.content.Intent#FLAG_RECEIVER_FOREGROUND, android.content.Intent#FLAG_RECEIVER_NO_ABORT, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, android.content.Intent#FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Intent.FLAG_RECEIVER_OFFLOAD, and android.content.Intent.FLAG_RECEIVER_OFFLOAD_FOREGROUND
flagsValues Int: Desired values for any bits set in flagsMask Value is either 0 or a combination of android.content.Intent#FLAG_FROM_BACKGROUND, android.content.Intent#FLAG_DEBUG_LOG_RESOLUTION, android.content.Intent#FLAG_EXCLUDE_STOPPED_PACKAGES, android.content.Intent#FLAG_INCLUDE_STOPPED_PACKAGES, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, android.content.Intent#FLAG_ACTIVITY_MATCH_EXTERNAL, android.content.Intent#FLAG_ACTIVITY_NO_HISTORY, android.content.Intent#FLAG_ACTIVITY_SINGLE_TOP, android.content.Intent#FLAG_ACTIVITY_NEW_TASK, android.content.Intent#FLAG_ACTIVITY_MULTIPLE_TASK, android.content.Intent#FLAG_ACTIVITY_CLEAR_TOP, android.content.Intent#FLAG_ACTIVITY_FORWARD_RESULT, android.content.Intent#FLAG_ACTIVITY_PREVIOUS_IS_TOP, android.content.Intent#FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS, android.content.Intent#FLAG_ACTIVITY_BROUGHT_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_RESET_TASK_IF_NEEDED, android.content.Intent#FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NEW_DOCUMENT, android.content.Intent#FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET, android.content.Intent#FLAG_ACTIVITY_NO_USER_ACTION, android.content.Intent#FLAG_ACTIVITY_REORDER_TO_FRONT, android.content.Intent#FLAG_ACTIVITY_NO_ANIMATION, android.content.Intent#FLAG_ACTIVITY_CLEAR_TASK, android.content.Intent#FLAG_ACTIVITY_TASK_ON_HOME, android.content.Intent#FLAG_ACTIVITY_RETAIN_IN_RECENTS, android.content.Intent#FLAG_ACTIVITY_LAUNCH_ADJACENT, android.content.Intent#FLAG_RECEIVER_REGISTERED_ONLY, android.content.Intent#FLAG_RECEIVER_REPLACE_PENDING, android.content.Intent#FLAG_RECEIVER_FOREGROUND, android.content.Intent#FLAG_RECEIVER_NO_ABORT, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, android.content.Intent#FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS, android.content.Intent.FLAG_RECEIVER_OFFLOAD, and android.content.Intent.FLAG_RECEIVER_OFFLOAD_FOREGROUND
extraFlags Int: Always set to 0.
options Bundle?: This value may be null.

startService

Added in API level 1
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 Version android.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? This value may be null.
Exceptions
java.lang.SecurityException If the caller does not have permission to access the service or the service can not be found.
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.
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.

stopService

Added in API level 1
open fun stopService(name: Intent!): Boolean
Parameters
service 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.SecurityException If the caller does not have permission to access the service or the service can not be found.
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).

unbindService

Added in API level 1
open fun unbindService(conn: ServiceConnection): Unit
Parameters
conn ServiceConnection: The connection interface previously supplied to bindService(). This parameter must not be null.

unregisterComponentCallbacks

Added in API level 14
open fun unregisterComponentCallbacks(callback: ComponentCallbacks!): Unit

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

After Build.VERSION_CODES#TIRAMISU, the ComponentCallbacks will be unregistered to the base Context, and can be only used after attachBaseContext(android.content.Context)

Parameters
callback ComponentCallbacks!: The interface to call. This can be either a ComponentCallbacks or ComponentCallbacks2 interface.
Exceptions
java.lang.IllegalStateException if this method calls before attachBaseContext(android.content.Context)

unregisterDeviceIdChangeListener

Added in API level 34
open fun unregisterDeviceIdChangeListener(listener: IntConsumer): Unit

Removes a device ID changed listener from the Context. It's a no-op if the listener is not already registered.

Parameters
listener IntConsumer: This value cannot be null.

unregisterReceiver

Added in API level 1
open fun unregisterReceiver(receiver: BroadcastReceiver!): Unit
Parameters
receiver BroadcastReceiver!: The BroadcastReceiver to unregister.
Exceptions
java.lang.IllegalArgumentException if the receiver was not previously registered or already unregistered.

updateServiceGroup

Added in API level 29
open fun updateServiceGroup(
    conn: ServiceConnection,
    group: Int,
    importance: Int
): Unit
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.

Protected methods

attachBaseContext

Added in API level 1
protected open fun attachBaseContext(base: Context!): Unit

Set the base context for this ContextWrapper. All calls will then be delegated to the base context. Throws IllegalStateException if a base context has already been set.

Parameters
base Context!: The new base context for this wrapper.