Context
abstract class Context
kotlin.Any | |
↳ | android.content.Context |
Interface to global information about an application environment. This is an abstract class whose implementation is provided by the Android system. It allows access to application-specific resources and classes, as well as up-calls for application-level operations such as launching activities, broadcasting and receiving intents, etc.
Summary
Nested classes | |
---|---|
Specific flags used for bindService() call, which encapsulates a 64 bits long integer. |
Constants | |
---|---|
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static Int |
Flag for #bindService: indicates that the client application binding to this service considers the service to be more important than the app itself. |
static Int |
Flag for #bindService: If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it. |
static Int |
Flag for #bindService: If binding from an app that is visible, the bound service is allowed to start an activity from background. |
static Int |
Flag for #bindService: allow the process hosting the bound service to go through its normal memory management. |
static Int |
Flag for #bindService: automatically create the service as long as the binding exists. |
static Int |
Flag for #bindService: include debugging help for mismatched calls to unbind. |
static Int |
Flag for #bindService: The service being bound is an |
static Long |
Works in the same way as |
static Int |
Flag for #bindService: this service is very important to the client, so should be brought to the foreground process level when the client is. |
static Int |
Flag for #bindService: If binding from an app that has specific capabilities due to its foreground state such as an activity or foreground service, then this flag will allow the bound app to get the same capabilities, as long as it has the required permissions as well. |
static Int |
Flag for #bindService: don't allow this binding to raise the target service's process to the foreground scheduling priority. |
static Int |
Flag for #bindService: If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level. |
static Int |
Flag for #bindIsolatedService: Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name. |
static Int |
Flag for #bindIsolatedService: Bind the service into a shared isolated process. |
static Int |
Flag for #bindService: don't impact the scheduling or memory management priority of the target service's hosting process. |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Service to capture a bugreport. |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static Int |
Flag for use with |
static Int |
Flag for use with |
static Int |
Flag for use with |
static String |
Use with |
static String |
Use with |
static Int |
The default device ID, which is the ID of the primary (non-virtual) device. |
static Int |
Invalid device ID. |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with #getSystemService to retrieve a |
static String |
Use with |
static String |
Use with |
static Int |
File creation mode: for use with |
static Int |
Database open flag: when set, the database is opened with write-ahead logging enabled by default. |
static Int |
SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. |
static Int |
Database open flag: when set, the database is opened without support for localized collators. |
static Int |
File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID). |
static Int |
File creation mode: allow all other applications to have read access to the created file. |
static Int |
File creation mode: allow all other applications to have write access to the created file. |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
|
static String |
Use with |
static Int |
Flag for #registerReceiver: The receiver can receive broadcasts from other Apps. |
static Int |
Flag for #registerReceiver: The receiver cannot receive broadcasts from other Apps. |
static Int |
Flag for #registerReceiver: The receiver can receive broadcasts from Instant Apps. |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
static String |
Use with |
Public constructors | |
---|---|
Context() |
Public methods | |
---|---|
open Boolean |
bindIsolatedService(service: Intent, flags: Int, instanceName: String, executor: Executor, conn: ServiceConnection) Variation of #bindService that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. |
open Boolean |
bindIsolatedService(service: Intent, flags: Context.BindServiceFlags, instanceName: String, executor: Executor, conn: ServiceConnection) See |
abstract Boolean |
bindService(service: Intent, conn: ServiceConnection, flags: Int) Connects to an application service, creating it if needed. |
open Boolean |
bindService(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags) See |
open Boolean |
bindService(service: Intent, flags: Int, executor: Executor, conn: ServiceConnection) Same as |
open Boolean |
bindService(service: Intent, flags: Context.BindServiceFlags, executor: Executor, conn: ServiceConnection) See |
open Boolean |
bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Int, user: UserHandle) Binds to a service in the given |
open Boolean |
bindServiceAsUser(service: Intent, conn: ServiceConnection, flags: Context.BindServiceFlags, user: UserHandle) See |
abstract Int |
checkCallingOrSelfPermission(permission: String) Determine whether the calling process of an IPC or you have been granted a particular permission. |
abstract Int |
checkCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. |
open IntArray |
checkCallingOrSelfUriPermissions(uris: MutableList<Uri!>, modeFlags: Int) Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. |
abstract Int |
checkCallingPermission(permission: String) Determine whether the calling process of an IPC you are handling has been granted a particular permission. |
abstract Int |
checkCallingUriPermission(uri: Uri!, modeFlags: Int) Determine whether the calling process and uid has been granted permission to access a specific URI. |
open IntArray |
checkCallingUriPermissions(uris: MutableList<Uri!>, modeFlags: Int) 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. |
abstract Int |
checkPermission(permission: String, pid: Int, uid: Int) Determine whether the given permission is allowed for a particular process and user ID running in the system. |
abstract Int |
checkSelfPermission(permission: String) Determine whether you have been granted a particular permission. |
abstract Int |
checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int) Determine whether a particular process and uid has been granted permission to access a specific URI. |
abstract 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. |
abstract Unit | |
open Context |
createAttributionContext(attributionTag: String?) Return a new Context object for the current Context but attribute to a different tag. |
abstract Context! |
createConfigurationContext(overrideConfiguration: Configuration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. |
open Context |
createContext(contextParams: ContextParams) Creates a context with specific properties and behaviors. |
abstract Context! |
createContextForSplit(splitName: String!) Return a new Context object for the given split name. |
open Context |
createDeviceContext(deviceId: Int) Returns a new |
abstract Context! |
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage. |
abstract Context! |
createDisplayContext(display: Display) Returns a new |
abstract Context! |
createPackageContext(packageName: String!, flags: Int) Return a new Context object for the given application name. |
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 |
abstract Array<String!>! |
Returns an array of strings naming the private databases associated with this Context's application package. |
abstract Boolean |
deleteDatabase(name: String!) Delete an existing private SQLiteDatabase associated with this Context's application package. |
abstract Boolean |
deleteFile(name: String!) Delete the given private file associated with this Context's application package. |
abstract Boolean |
Delete an existing shared preferences file. |
abstract 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 |
abstract Unit |
enforceCallingOrSelfUriPermission(uri: Uri!, modeFlags: Int, message: String!) If the calling process of an IPC or you has not been granted permission to access a specific URI, throw |
abstract 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 |
abstract Unit |
enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!) If the calling process and uid has not been granted permission to access a specific URI, throw |
abstract 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 |
abstract Unit |
If a particular process and uid has not been granted permission to access a specific URI, throw |
abstract Unit |
enforceUriPermission(uri: Uri?, readPermission: String?, writePermission: String?, pid: Int, uid: Int, modeFlags: Int, message: String?) Enforce both a Uri and normal permission. |
abstract Array<String!>! |
fileList() Returns an array of strings naming the private files associated with this Context's application package. |
abstract Context! |
Return the context of the single, global Application object of the current process. |
abstract ApplicationInfo! |
Return the full application info for this context's package. |
abstract AssetManager! |
Returns an AssetManager instance for the application's package. |
open AttributionSource | |
open String? |
Attribution can be used in complex apps to logically separate parts of the app. |
abstract File! |
Returns the absolute path to the application specific cache directory on the filesystem. |
abstract ClassLoader! |
Return a class loader you can use to retrieve classes in this package. |
abstract File! |
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code. |
Int |
Returns a color associated with a particular resource ID and styled for the current theme. |
ColorStateList |
getColorStateList(id: Int) Returns a color state list associated with a particular resource ID and styled for the current theme. |
abstract ContentResolver! |
Return a ContentResolver instance for your application's package. |
abstract File! |
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. |
abstract File! |
getDatabasePath(name: String!) Returns the absolute path on the filesystem where a database created with #openOrCreateDatabase is stored. |
open Int |
Gets the device ID this context is associated with. |
abstract File! |
Retrieve, creating if needed, a new directory in which the application can place its own custom data files. |
open Display |
Get the display this context is associated with. |
Drawable? |
getDrawable(id: Int) Returns a drawable object associated with a particular resource ID and styled for the current theme. |
abstract File? |
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. |
abstract Array<File!>! |
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. |
abstract File? |
getExternalFilesDir(type: String?) Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. |
abstract Array<File!>! |
getExternalFilesDirs(type: String!) Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. |
abstract Array<File!>! |
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files. |
abstract File! |
getFileStreamPath(name: String!) Returns the absolute path on the filesystem where a file created with |
abstract File! |
Returns the absolute path to the directory on the filesystem where files created with |
open Executor! |
Return an |
abstract Looper! |
Return the Looper for the main thread of the current process. |
abstract File! |
Returns the absolute path to the directory on the filesystem similar to |
abstract File! |
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. |
abstract Array<File!>! |
Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found. |
open String |
Return the package name that should be used for |
abstract String! |
Return the full path to this context's primary Android package. |
abstract PackageManager! |
Return PackageManager instance to find global package information. |
abstract String! |
Return the name of this application's package. |
abstract String! |
Return the full path to this context's primary Android package. |
open ContextParams? |
Return the set of parameters which this Context was created with, if it was created via |
abstract Resources! |
Returns a Resources instance for the application's package. |
abstract SharedPreferences! |
getSharedPreferences(: String!, : Int) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. |
String |
Returns a localized string from the application's package's default string table. |
String |
Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in |
abstract Any! |
getSystemService(name: String) Return the handle to a system-level service by name. |
T |
getSystemService(serviceClass: Class<T>) Return the handle to a system-level service by class. |
abstract String? |
getSystemServiceName(serviceClass: Class<*>) Gets the name of the system-level service that is represented by the specified class. |
CharSequence |
Return a localized, styled CharSequence from the application's package's default string table. |
abstract Resources.Theme! |
getTheme() Return the Theme object associated with this Context. |
abstract Drawable! | |
abstract Int | |
abstract Int | |
abstract Unit |
grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. |
abstract Boolean |
Indicates if the storage APIs of this Context are backed by device-protected storage. |
open Boolean |
Indicates whether this Context is restricted. |
open Boolean |
Returns |
abstract Boolean |
moveDatabaseFrom(sourceContext: Context!, name: String!) Move an existing database file from the given source storage context to this context. |
abstract Boolean |
moveSharedPreferencesFrom(: Context!, : String!) Move an existing shared preferences file from the given source storage context to this context. |
TypedArray |
obtainStyledAttributes(attrs: IntArray) Retrieve styled attribute information in this Context's theme. |
TypedArray |
obtainStyledAttributes(resid: Int, attrs: IntArray) Retrieve styled attribute information in this Context's theme. |
TypedArray |
obtainStyledAttributes(set: AttributeSet?, attrs: IntArray) Retrieve styled attribute information in this Context's theme. |
TypedArray |
obtainStyledAttributes(set: AttributeSet?, attrs: IntArray, defStyleAttr: Int, defStyleRes: Int) Retrieve styled attribute information in this Context's theme. |
abstract FileInputStream! |
openFileInput(name: String!) Open a private file associated with this Context's application package for reading. |
abstract FileOutputStream! |
openFileOutput(name: String!, mode: Int) Open a private file associated with this Context's application package for writing. |
abstract SQLiteDatabase! |
openOrCreateDatabase(name: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!) Open a new private SQLiteDatabase associated with this Context's application package. |
abstract SQLiteDatabase! |
openOrCreateDatabase(name: String!, mode: Int, factory: SQLiteDatabase.CursorFactory!, errorHandler: DatabaseErrorHandler?) Open a new private SQLiteDatabase associated with this Context's application package. |
abstract Drawable! | |
open Unit |
registerComponentCallbacks(callback: ComponentCallbacks!) Add a new |
open Unit |
registerDeviceIdChangeListener(executor: Executor, listener: IntConsumer) Adds a new device ID changed listener to the |
abstract Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!) Register a BroadcastReceiver to be run in the main activity thread. |
abstract Intent? |
registerReceiver(receiver: BroadcastReceiver?, filter: IntentFilter!, flags: Int) Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. |
abstract Intent? |
registerReceiver(receiver: BroadcastReceiver!, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?) Register to receive intent broadcasts, to run in the context of scheduler. |
abstract Intent? |
registerReceiver(receiver: BroadcastReceiver!, filter: IntentFilter!, broadcastPermission: String?, scheduler: Handler?, flags: Int) Register to receive intent broadcasts, to run in the context of scheduler. |
abstract Unit |
removeStickyBroadcast(intent: Intent!) Remove the data previously sent with #sendStickyBroadcast, so that it is as if the sticky broadcast had never happened. |
abstract Unit |
removeStickyBroadcastAsUser(intent: Intent!, user: UserHandle!) Version of |
open Unit |
revokeSelfPermissionOnKill(permName: String) Triggers the asynchronous revocation of a runtime permission. |
open Unit |
revokeSelfPermissionsOnKill(permissions: MutableCollection<String!>) Triggers the revocation of one or more permissions for the calling package. |
abstract Unit |
revokeUriPermission(uri: Uri!, modeFlags: Int) Remove all permissions to access a particular content provider Uri that were previously added with |
abstract Unit |
revokeUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int) Remove permissions to access a particular content provider Uri that were previously added with |
abstract Unit |
sendBroadcast(intent: Intent!) Broadcast the given intent to all interested BroadcastReceivers. |
abstract 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. |
abstract Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!) Version of |
abstract Unit |
sendBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?) Version of |
open Unit |
sendBroadcastWithMultiplePermissions(intent: Intent, receiverPermissions: Array<String!>) Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced. |
abstract 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. |
abstract Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?) Version of |
open Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, options: Bundle?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?) Version of |
open Unit |
sendOrderedBroadcast(intent: Intent, receiverPermission: String?, receiverAppOp: String?, resultReceiver: BroadcastReceiver?, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?) Version of |
abstract Unit |
sendOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, receiverPermission: String?, resultReceiver: BroadcastReceiver!, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?) Version of |
abstract Unit |
sendStickyBroadcast(intent: Intent!) Perform a |
open Unit |
sendStickyBroadcast(intent: Intent, options: Bundle?) Perform a |
abstract Unit |
sendStickyBroadcastAsUser(intent: Intent!, user: UserHandle!) Version of |
abstract 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. |
abstract Unit |
sendStickyOrderedBroadcastAsUser(intent: Intent!, user: UserHandle!, resultReceiver: BroadcastReceiver!, scheduler: Handler?, initialCode: Int, initialData: String?, initialExtras: Bundle?) Version of |
abstract Unit |
Set the base theme for this context. |
abstract Unit |
setWallpaper(bitmap: Bitmap!) |
abstract Unit |
setWallpaper(data: InputStream!) |
abstract Unit |
startActivities(intents: Array<Intent!>!) Same as |
abstract Unit |
startActivities(intents: Array<Intent!>!, options: Bundle!) Launch multiple new activities. |
abstract Unit |
startActivity(intent: Intent!) Same as |
abstract Unit |
startActivity(intent: Intent!, options: Bundle?) Launch a new activity. |
abstract ComponentName? |
startForegroundService(service: Intent!) Similar to |
abstract Boolean |
startInstrumentation(className: ComponentName, profileFile: String?, arguments: Bundle?) Start executing an |
abstract Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int) Same as |
abstract Unit |
startIntentSender(intent: IntentSender!, fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle?) Like |
abstract ComponentName? |
startService(service: Intent!) Request that a given application service be started. |
abstract Boolean |
stopService(service: Intent!) Request that a given application service be stopped. |
abstract Unit |
unbindService(conn: ServiceConnection) Disconnect from an application service. |
open Unit |
unregisterComponentCallbacks(callback: ComponentCallbacks!) Remove a |
open Unit |
unregisterDeviceIdChangeListener(listener: IntConsumer) Removes a device ID changed listener from the Context. |
abstract Unit |
unregisterReceiver(receiver: BroadcastReceiver!) Unregister a previously registered BroadcastReceiver. |
open Unit |
updateServiceGroup(conn: ServiceConnection, group: Int, importance: Int) For a service previously bound with #bindService or a related method, change how the system manages that service's process in relation to other processes. |
Constants
ACCESSIBILITY_SERVICE
static val ACCESSIBILITY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.accessibility.AccessibilityManager
for giving the user feedback for UI events through the registered event listeners.
Value: "accessibility"
ACCOUNT_SERVICE
static val ACCOUNT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.accounts.AccountManager
for receiving intents at a time of your choosing.
Value: "account"
ACTIVITY_SERVICE
static val ACTIVITY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.ActivityManager
for interacting with the global system state.
Value: "activity"
ALARM_SERVICE
static val ALARM_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.AlarmManager
for receiving intents at a time of your choosing.
Value: "alarm"
APPWIDGET_SERVICE
static val APPWIDGET_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.appwidget.AppWidgetManager
for accessing AppWidgets.
Value: "appwidget"
See Also
APP_OPS_SERVICE
static val APP_OPS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.AppOpsManager
for tracking application operations on the device.
Value: "appops"
APP_SEARCH_SERVICE
static val APP_SEARCH_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve an android.app.appsearch.AppSearchManager
for indexing and querying app data managed by the system.
Value: "app_search"
See Also
AUDIO_SERVICE
static val AUDIO_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.AudioManager
for handling management of volume, ringer modes and audio routing.
Value: "audio"
BATTERY_SERVICE
static val BATTERY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.BatteryManager
for managing battery state.
Value: "batterymanager"
See Also
BIND_ABOVE_CLIENT
static val BIND_ABOVE_CLIENT: Int
Flag for #bindService: indicates that the client application binding to this service considers the service to be more important than the app itself. When set, the platform will try to have the out of memory killer kill the app before it kills the service it is bound to, though this is not guaranteed to be the case.
Value: 8
BIND_ADJUST_WITH_ACTIVITY
static val BIND_ADJUST_WITH_ACTIVITY: Int
Flag for #bindService: If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it.
Value: 128
BIND_ALLOW_ACTIVITY_STARTS
static val BIND_ALLOW_ACTIVITY_STARTS: Int
Flag for #bindService: If binding from an app that is visible, the bound service is allowed to start an activity from background. This was the default behavior before SDK version android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE
. Since then, the default behavior changed to disallow the bound service to start a background activity even if the app bound to it is in foreground, unless this flag is specified when binding.
Value: 512
BIND_ALLOW_OOM_MANAGEMENT
static val BIND_ALLOW_OOM_MANAGEMENT: Int
Flag for #bindService: allow the process hosting the bound service to go through its normal memory management. It will be treated more like a running service, allowing the system to (temporarily) expunge the process if low on memory or for some other whim it may have, and being more aggressive about making it a candidate to be killed (and restarted) if running for a long time.
Value: 16
BIND_AUTO_CREATE
static val BIND_AUTO_CREATE: Int
Flag for #bindService: automatically create the service as long as the binding exists. Note that while this will create the service, its android.app.Service#onStartCommand
method will still only be called due to an explicit call to startService
. Even without that, though, this still provides you with access to the service object while the service is created.
Note that prior to android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH
, not supplying this flag would also impact how important the system consider's the target service's process to be. When set, the only way for it to be raised was by binding from a service in which case it will only be important when that activity is in the foreground. Now to achieve this behavior you must explicitly supply the new flag BIND_ADJUST_WITH_ACTIVITY
. For compatibility, old applications that don't specify BIND_AUTO_CREATE
will automatically have the flags BIND_WAIVE_PRIORITY
and BIND_ADJUST_WITH_ACTIVITY
set for them in order to achieve the same result.
Value: 1
BIND_DEBUG_UNBIND
static val BIND_DEBUG_UNBIND: Int
Flag for #bindService: include debugging help for mismatched calls to unbind. When this flag is set, the callstack of the following unbindService
call is retained, to be printed if a later incorrect unbind call is made. Note that doing this requires retaining information about the binding that was made for the lifetime of the app, resulting in a leak -- this should only be used for debugging.
Value: 2
BIND_EXTERNAL_SERVICE
static val BIND_EXTERNAL_SERVICE: Int
Flag for #bindService: The service being bound is an isolated
, external
service. This binds the service into the calling application's package, rather than the package in which the service is declared.
When using this flag, the code for the service being bound will execute under the calling application's package name and user ID. Because the service must be an isolated process, it will not have direct access to the application's data, though. The purpose of this flag is to allow applications to provide services that are attributed to the app using the service, rather than the application providing the service.
This flag is NOT compatible withBindServiceFlags
. If you need to use BindServiceFlags
, you must use BIND_EXTERNAL_SERVICE_LONG
instead.
Value: -2147483648
BIND_EXTERNAL_SERVICE_LONG
static val BIND_EXTERNAL_SERVICE_LONG: Long
Works in the same way as BIND_EXTERNAL_SERVICE
, but it's defined as a long
value that is compatible to BindServiceFlags
.
Value: 4611686018427387904L
BIND_IMPORTANT
static val BIND_IMPORTANT: Int
Flag for #bindService: this service is very important to the client, so should be brought to the foreground process level when the client is. Normally a process can only be raised to the visibility level by a client, even if that client is in the foreground.
Value: 64
BIND_INCLUDE_CAPABILITIES
static val BIND_INCLUDE_CAPABILITIES: Int
Flag for #bindService: If binding from an app that has specific capabilities due to its foreground state such as an activity or foreground service, then this flag will allow the bound app to get the same capabilities, as long as it has the required permissions as well. If binding from a top app and its target SDK version is at or above android.os.Build.VERSION_CODES#R
, the app needs to explicitly use BIND_INCLUDE_CAPABILITIES flag to pass all capabilities to the service so the other app can have while-in-use access such as location, camera, microphone from background. If binding from a top app and its target SDK version is below android.os.Build.VERSION_CODES#R
, BIND_INCLUDE_CAPABILITIES is implicit.
Value: 4096
BIND_NOT_FOREGROUND
static val BIND_NOT_FOREGROUND: Int
Flag for #bindService: don't allow this binding to raise the target service's process to the foreground scheduling priority. It will still be raised to at least the same memory priority as the client (so that its process will not be killable in any situation where the client is not killable), but for CPU scheduling purposes it may be left in the background. This only has an impact in the situation where the binding client is a foreground process and the target service is in a background process.
Value: 4
BIND_NOT_PERCEPTIBLE
static val BIND_NOT_PERCEPTIBLE: Int
Flag for #bindService: If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level. This allows the system to (temporarily) expunge the bound process from memory to make room for more important user-perceptible processes.
Value: 256
BIND_PACKAGE_ISOLATED_PROCESS
static val BIND_PACKAGE_ISOLATED_PROCESS: Int
Flag for #bindIsolatedService: Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name.
Specifying this flag allows multiple isolated services defined in the same package to be running in a single shared isolated process. This shared isolated process must be specified since this flag will not work with the default application process.
This flag is different from BIND_SHARED_ISOLATED_PROCESS
since it only allows binding services from the same package in the same shared isolated process. This also means the shared package isolated process is global, and not scoped to each potential calling app.
The shared isolated process instance is identified by the "android:process" attribute defined by the service. This flag cannot be used without this attribute set.
Value: 16384
BIND_SHARED_ISOLATED_PROCESS
static val BIND_SHARED_ISOLATED_PROCESS: Int
Flag for #bindIsolatedService: Bind the service into a shared isolated process. Specifying this flag allows multiple isolated services to be running in a single shared isolated process. The shared isolated process instance is identified by the instanceName parameter in bindIsolatedService(android.content.Intent,int,java.lang.String,java.util.concurrent.Executor,android.content.ServiceConnection)
. Subsequent calls to #bindIsolatedService with the same instanceName will cause the isolated service to be co-located in the same shared isolated process. Note that the shared isolated process is scoped to the calling app; once created, only the calling app can bind additional isolated services into the shared process. However, the services themselves can come from different APKs and therefore different vendors. Only services that set the android.R.attr#allowSharedIsolatedProcess
attribute to true
are allowed to be bound into a shared isolated process.
Value: 8192
BIND_WAIVE_PRIORITY
static val BIND_WAIVE_PRIORITY: Int
Flag for #bindService: don't impact the scheduling or memory management priority of the target service's hosting process. Allows the service's process to be managed on the background LRU list just like a regular application process in the background.
Value: 32
BIOMETRIC_SERVICE
static val BIOMETRIC_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.biometrics.BiometricManager
for handling biometric and PIN/pattern/password authentication.
Value: "biometric"
BLOB_STORE_SERVICE
static val BLOB_STORE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for contributing and accessing data blobs from the blob store maintained by the system.
Value: "blob_store"
BLUETOOTH_SERVICE
static val BLUETOOTH_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.bluetooth.BluetoothManager
for using Bluetooth.
Value: "bluetooth"
See Also
BUGREPORT_SERVICE
static val BUGREPORT_SERVICE: String
Service to capture a bugreport.
Value: "bugreport"
CAMERA_SERVICE
static val CAMERA_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.camera2.CameraManager
for interacting with camera devices.
Value: "camera"
CAPTIONING_SERVICE
static val CAPTIONING_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.accessibility.CaptioningManager
for obtaining captioning properties and listening for changes in captioning preferences.
Value: "captioning"
CARRIER_CONFIG_SERVICE
static val CARRIER_CONFIG_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.telephony.CarrierConfigManager
for reading carrier configuration values.
Value: "carrier_config"
CLIPBOARD_SERVICE
static val CLIPBOARD_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.content.ClipboardManager
for accessing and modifying the contents of the global clipboard.
Value: "clipboard"
COMPANION_DEVICE_SERVICE
static val COMPANION_DEVICE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.companion.CompanionDeviceManager
for managing companion devices
Value: "companiondevice"
CONNECTIVITY_DIAGNOSTICS_SERVICE
static val CONNECTIVITY_DIAGNOSTICS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for performing network connectivity diagnostics as well as receiving network connectivity information from the system.
Value: "connectivity_diagnostics"
CONNECTIVITY_SERVICE
static val CONNECTIVITY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for handling management of network connections.
Value: "connectivity"
CONSUMER_IR_SERVICE
static val CONSUMER_IR_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.ConsumerIrManager
for transmitting infrared signals from the device.
Value: "consumer_ir"
CONTACT_KEYS_SERVICE
static val CONTACT_KEYS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a E2eeContactKeysManager
to managing contact keys.
Value: "contact_keys"
CONTEXT_IGNORE_SECURITY
static val CONTEXT_IGNORE_SECURITY: Int
Flag for use with createPackageContext
: ignore any security restrictions on the Context being requested, allowing it to always be loaded. For use with CONTEXT_INCLUDE_CODE
to allow code to be loaded into a process even when it isn't safe to do so. Use with extreme care!
Value: 2
CONTEXT_INCLUDE_CODE
static val CONTEXT_INCLUDE_CODE: Int
Flag for use with createPackageContext
: include the application code with the context. This means loading code into the caller's process, so that getClassLoader()
can be used to instantiate the application's classes. Setting this flags imposes security restrictions on what application context you can access; if the requested application can not be safely loaded into your process, java.lang.SecurityException will be thrown. If this flag is not set, there will be no restrictions on the packages that can be loaded, but getClassLoader
will always return the default system class loader.
Value: 1
CONTEXT_RESTRICTED
static val CONTEXT_RESTRICTED: Int
Flag for use with createPackageContext
: a restricted context may disable specific features. For instance, a View associated with a restricted context would ignore particular XML attributes.
Value: 4
CREDENTIAL_SERVICE
static val CREDENTIAL_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.credentials.CredentialManager
to authenticate a user to your app.
Value: "credential"
CROSS_PROFILE_APPS_SERVICE
static val CROSS_PROFILE_APPS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.content.pm.CrossProfileApps
for cross profile operations.
Value: "crossprofileapps"
See Also
DEVICE_ID_DEFAULT
static val DEVICE_ID_DEFAULT: Int
The default device ID, which is the ID of the primary (non-virtual) device.
Value: 0
DEVICE_ID_INVALID
static val DEVICE_ID_INVALID: Int
Invalid device ID.
Value: -1
DEVICE_LOCK_SERVICE
static val DEVICE_LOCK_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.devicelock.DeviceLockManager
.
Value: "device_lock"
See Also
DEVICE_POLICY_SERVICE
static val DEVICE_POLICY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.admin.DevicePolicyManager
for working with global device policy management.
Value: "device_policy"
See Also
DISPLAY_HASH_SERVICE
static val DISPLAY_HASH_SERVICE: String
Use with getSystemService(java.lang.String)
to access android.view.displayhash.DisplayHashManager
to handle display hashes.
Value: "display_hash"
See Also
DISPLAY_SERVICE
static val DISPLAY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.display.DisplayManager
for interacting with display devices.
Value: "display"
DOMAIN_VERIFICATION_SERVICE
static val DOMAIN_VERIFICATION_SERVICE: String
Use with getSystemService(java.lang.String)
to access android.content.pm.verify.domain.DomainVerificationManager
to retrieve approval and user state for declared web domains.
Value: "domain_verification"
DOWNLOAD_SERVICE
static val DOWNLOAD_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.DownloadManager
for requesting HTTP downloads.
Value: "download"
See Also
DROPBOX_SERVICE
static val DROPBOX_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.DropBoxManager
instance for recording diagnostic logs.
Value: "dropbox"
See Also
EUICC_SERVICE
static val EUICC_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.telephony.euicc.EuiccManager
to manage the device eUICC (embedded SIM).
Value: "euicc"
FILE_INTEGRITY_SERVICE
static val FILE_INTEGRITY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve an android.security.FileIntegrityManager
.
Value: "file_integrity"
FINGERPRINT_SERVICE
static val FINGERPRINT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.fingerprint.FingerprintManager
for handling management of fingerprints.
Value: "fingerprint"
GAME_SERVICE
static val GAME_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a GameManager
.
Value: "game"
See Also
GRAMMATICAL_INFLECTION_SERVICE
static val GRAMMATICAL_INFLECTION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a GrammaticalInflectionManager
.
Value: "grammatical_inflection"
See Also
HARDWARE_PROPERTIES_SERVICE
static val HARDWARE_PROPERTIES_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.HardwarePropertiesManager
for accessing the hardware properties service.
Value: "hardware_properties"
See Also
HEALTHCONNECT_SERVICE
static val HEALTHCONNECT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.health.connect.HealthConnectManager
.
Value: "healthconnect"
INPUT_METHOD_SERVICE
static val INPUT_METHOD_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.inputmethod.InputMethodManager
for accessing input methods.
Value: "input_method"
See Also
INPUT_SERVICE
static val INPUT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.hardware.input.InputManager
for interacting with input devices.
Value: "input"
IPSEC_SERVICE
static val IPSEC_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.net.IpSecManager
for encrypting Sockets or Networks with IPSec.
Value: "ipsec"
See Also
JOB_SCHEDULER_SERVICE
static val JOB_SCHEDULER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a instance for managing occasional background tasks.
Value: "jobscheduler"
KEYGUARD_SERVICE
static val KEYGUARD_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.KeyguardManager
for controlling keyguard.
Value: "keyguard"
LAUNCHER_APPS_SERVICE
static val LAUNCHER_APPS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.content.pm.LauncherApps
for querying and monitoring launchable apps across profiles of a user.
Value: "launcherapps"
LAYOUT_INFLATER_SERVICE
static val LAYOUT_INFLATER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.LayoutInflater
for inflating layout resources in this context.
Value: "layout_inflater"
LOCALE_SERVICE
static val LOCALE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.LocaleManager
.
Value: "locale"
See Also
LOCATION_SERVICE
static val LOCATION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for controlling location updates.
Value: "location"
MEDIA_COMMUNICATION_SERVICE
static val MEDIA_COMMUNICATION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.MediaCommunicationManager
for managing android.media.MediaSession2
.
Value: "media_communication"
MEDIA_METRICS_SERVICE
static val MEDIA_METRICS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.metrics.MediaMetricsManager
for interacting with media metrics on the device.
Value: "media_metrics"
MEDIA_PROJECTION_SERVICE
static val MEDIA_PROJECTION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a instance for managing media projection sessions.
Value: "media_projection"
MEDIA_ROUTER_SERVICE
static val MEDIA_ROUTER_SERVICE: String
Use with #getSystemService to retrieve a android.media.MediaRouter
for controlling and managing routing of media.
Value: "media_router"
MEDIA_SESSION_SERVICE
static val MEDIA_SESSION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.session.MediaSessionManager
for managing media Sessions.
Value: "media_session"
MIDI_SERVICE
static val MIDI_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.midi.MidiManager
for accessing the MIDI service.
Value: "midi"
See Also
MODE_APPEND
static val MODE_APPEND: Int
File creation mode: for use with openFileOutput
, if the file already exists then write data to the end of the existing file instead of erasing it.
Value: 32768
See Also
MODE_ENABLE_WRITE_AHEAD_LOGGING
static val MODE_ENABLE_WRITE_AHEAD_LOGGING: Int
Database open flag: when set, the database is opened with write-ahead logging enabled by default.
Value: 8
MODE_MULTI_PROCESS
static valMODE_MULTI_PROCESS: Int
Deprecated: MODE_MULTI_PROCESS does not work reliably in some versions of Android, and furthermore does not provide any mechanism for reconciling concurrent modifications across processes. Applications should not attempt to use it. Instead, they should use an explicit cross-process data management approach such as ContentProvider
.
SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. This behavior is sometimes desired in cases where the application has multiple processes, all writing to the same SharedPreferences file. Generally there are better forms of communication between processes, though.
This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targeting such releases. For applications targeting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.
Value: 4
See Also
MODE_NO_LOCALIZED_COLLATORS
static val MODE_NO_LOCALIZED_COLLATORS: Int
Database open flag: when set, the database is opened without support for localized collators.
Value: 16
MODE_PRIVATE
static val MODE_PRIVATE: Int
File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID).
Value: 0
MODE_WORLD_READABLE
static valMODE_WORLD_READABLE: Int
Deprecated: Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider
, BroadcastReceiver
, and android.app.Service
. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
File creation mode: allow all other applications to have read access to the created file.
Starting from android.os.Build.VERSION_CODES#N
, attempting to use this mode throws a SecurityException
.
Value: 1
MODE_WORLD_WRITEABLE
static valMODE_WORLD_WRITEABLE: Int
Deprecated: Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider
, BroadcastReceiver
, and android.app.Service
. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
File creation mode: allow all other applications to have write access to the created file.
Starting from android.os.Build.VERSION_CODES#N
, attempting to use this mode will throw a SecurityException
.
Value: 2
NETWORK_STATS_SERVICE
static val NETWORK_STATS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for querying network usage stats.
Value: "netstats"
NFC_SERVICE
static val NFC_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.nfc.NfcManager
for using NFC.
Value: "nfc"
See Also
NOTIFICATION_SERVICE
static val NOTIFICATION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.NotificationManager
for informing the user of background events.
Value: "notification"
NSD_SERVICE
static val NSD_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for handling management of network service discovery
Value: "servicediscovery"
OVERLAY_SERVICE
static val OVERLAY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for managing overlay packages.
Value: "overlay"
PEOPLE_SERVICE
static val PEOPLE_SERVICE: String
Use with getSystemService(java.lang.String)
to access a PeopleManager
to interact with your published conversations.
Value: "people"
See Also
PERFORMANCE_HINT_SERVICE
static val PERFORMANCE_HINT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.PerformanceHintManager
for accessing the performance hinting service.
Value: "performance_hint"
See Also
PERSISTENT_DATA_BLOCK_SERVICE
static val PERSISTENT_DATA_BLOCK_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a instance for interacting with a storage device that lives across factory resets.
Value: "persistent_data_block"
POWER_SERVICE
static val POWER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.PowerManager
for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.
Value: "power"
PRINT_SERVICE
static val PRINT_SERVICE: String
android.print.PrintManager
for printing and managing printers and print tasks.
Value: "print"
PROFILING_SERVICE
static val PROFILING_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve an android.os.ProfilingManager
.
Value: "profiling"
See Also
RECEIVER_EXPORTED
static val RECEIVER_EXPORTED: Int
Flag for #registerReceiver: The receiver can receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=true"
Value: 2
RECEIVER_NOT_EXPORTED
static val RECEIVER_NOT_EXPORTED: Int
Flag for #registerReceiver: The receiver cannot receive broadcasts from other Apps. Has the same behavior as marking a statically registered receiver with "exported=false"
Value: 4
RECEIVER_VISIBLE_TO_INSTANT_APPS
static val RECEIVER_VISIBLE_TO_INSTANT_APPS: Int
Flag for #registerReceiver: The receiver can receive broadcasts from Instant Apps.
Value: 1
RESTRICTIONS_SERVICE
static val RESTRICTIONS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.content.RestrictionsManager
for retrieving application restrictions and requesting permissions for restricted operations.
Value: "restrictions"
ROLE_SERVICE
static val ROLE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.role.RoleManager
for managing roles.
Value: "role"
SEARCH_SERVICE
static val SEARCH_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for handling searches.
Configuration#UI_MODE_TYPE_WATCH
does not support android.app.SearchManager
.
Value: "search"
See Also
SECURITY_STATE_SERVICE
static val SECURITY_STATE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.SecurityStateManager
for accessing the security state manager service.
Value: "security_state"
SENSOR_SERVICE
static val SENSOR_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for accessing sensors.
Value: "sensor"
SHORTCUT_SERVICE
static val SHORTCUT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.content.pm.ShortcutManager
for accessing the launcher shortcut service.
Value: "shortcut"
STATUS_BAR_SERVICE
static val STATUS_BAR_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for interacting with the status bar and quick settings.
Value: "statusbar"
STORAGE_SERVICE
static val STORAGE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for accessing system storage functions.
Value: "storage"
STORAGE_STATS_SERVICE
static val STORAGE_STATS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for accessing system storage statistics.
Value: "storagestats"
SYSTEM_HEALTH_SERVICE
static val SYSTEM_HEALTH_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.health.SystemHealthManager
for accessing system health (battery, power, memory, etc) metrics.
Value: "systemhealth"
See Also
TELECOM_SERVICE
static val TELECOM_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.telecom.TelecomManager
to manage telecom-related features of the device.
Value: "telecom"
TELEPHONY_IMS_SERVICE
static val TELEPHONY_IMS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve an android.telephony.ims.ImsManager
.
Value: "telephony_ims"
TELEPHONY_SERVICE
static val TELEPHONY_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.telephony.TelephonyManager
for handling management the telephony features of the device.
Value: "phone"
TELEPHONY_SUBSCRIPTION_SERVICE
static val TELEPHONY_SUBSCRIPTION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.telephony.SubscriptionManager
for handling management the telephony subscriptions of the device.
Value: "telephony_subscription_service"
TEXT_CLASSIFICATION_SERVICE
static val TEXT_CLASSIFICATION_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a TextClassificationManager
for text classification services.
Value: "textclassification"
TEXT_SERVICES_MANAGER_SERVICE
static val TEXT_SERVICES_MANAGER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.textservice.TextServicesManager
for accessing text services.
Value: "textservices"
See Also
TV_INPUT_SERVICE
static val TV_INPUT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.tv.TvInputManager
for interacting with TV inputs on the device.
Value: "tv_input"
TV_INTERACTIVE_APP_SERVICE
static val TV_INTERACTIVE_APP_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.media.tv.interactive.TvInteractiveAppManager
for interacting with TV interactive applications on the device.
Value: "tv_interactive_app"
UI_MODE_SERVICE
static val UI_MODE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.app.UiModeManager
for controlling UI modes.
Value: "uimode"
See Also
USAGE_STATS_SERVICE
static val USAGE_STATS_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for querying device usage stats.
Value: "usagestats"
USB_SERVICE
static val USB_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for access to USB devices (as a USB host) and for controlling this device's behavior as a USB device.
Value: "usb"
USER_SERVICE
static val USER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.UserManager
for managing users on devices that support multiple users.
Value: "user"
VIBRATOR_MANAGER_SERVICE
static val VIBRATOR_MANAGER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.os.VibratorManager
for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
Value: "vibrator_manager"
VIBRATOR_SERVICE
static valVIBRATOR_SERVICE: String
Deprecated: Use android.os.VibratorManager
to retrieve the default system vibrator.
Use with getSystemService(java.lang.String)
to retrieve a android.os.Vibrator
for interacting with the vibration hardware.
Value: "vibrator"
VIRTUAL_DEVICE_SERVICE
static val VIRTUAL_DEVICE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.companion.virtual.VirtualDeviceManager
for managing virtual devices. On devices without PackageManager#FEATURE_COMPANION_DEVICE_SETUP
system feature the getSystemService(java.lang.String)
will return null
.
Value: "virtualdevice"
VPN_MANAGEMENT_SERVICE
static val VPN_MANAGEMENT_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.net.VpnManager
to manage profiles for the platform built-in VPN.
Value: "vpn_management"
See Also
WALLPAPER_SERVICE
static val WALLPAPER_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a com.android.server.WallpaperService for accessing wallpapers.
Value: "wallpaper"
See Also
WIFI_AWARE_SERVICE
static val WIFI_AWARE_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.net.wifi.aware.WifiAwareManager
for handling management of Wi-Fi Aware.
Value: "wifiaware"
WIFI_P2P_SERVICE
static val WIFI_P2P_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for handling management of Wi-Fi peer-to-peer connections.
Value: "wifip2p"
WIFI_RTT_RANGING_SERVICE
static val WIFI_RTT_RANGING_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for ranging devices with wifi.
Value: "wifirtt"
WIFI_SERVICE
static val WIFI_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a for handling management of Wi-Fi access.
Value: "wifi"
WINDOW_SERVICE
static val WINDOW_SERVICE: String
Use with getSystemService(java.lang.String)
to retrieve a android.view.WindowManager
for accessing the system's window manager.
Value: "window"
Public constructors
Context
Context()
Public methods
bindIsolatedService
open fun bindIsolatedService(
service: Intent,
flags: Int,
instanceName: String,
executor: Executor,
conn: ServiceConnection
): Boolean
Variation of #bindService that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. In other words, you can use this to bind to a service that has specified android.R.attr#isolatedProcess
and, in addition to the existing behavior of running in an isolated process, you can also through the arguments here have the system bring up multiple concurrent processes hosting their own instances of that service. The instanceName you provide here identifies the different instances, and you can use updateServiceGroup(android.content.ServiceConnection,int,int)
to tell the system how it should manage each of these instances.
Parameters | |
---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null . |
flags |
Int: Operation options for the binding as per #bindService. |
instanceName |
String: Unique identifier for the service instance. Each unique name here will result in a different service instance being created. Identifiers must only contain ASCII letters, digits, underscores, and periods. This value cannot be null . |
executor |
Executor: Callbacks on ServiceConnection will be called on executor. Must use same instance for the same instance of ServiceConnection. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
Return | |
---|---|
Boolean |
Returns success of binding as per #bindService. |
Exceptions | |
---|---|
java.lang.SecurityException |
If the caller does not have permission to access the service |
java.lang.IllegalArgumentException |
If the instanceName is invalid. |
bindIsolatedService
open fun bindIsolatedService(
service: Intent,
flags: Context.BindServiceFlags,
instanceName: String,
executor: Executor,
conn: ServiceConnection
): Boolean
See bindIsolatedService(android.content.Intent,int,java.lang.String,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 . |
instanceName |
String: This value cannot be null . |
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. |
conn |
ServiceConnection: This value cannot be null . |
bindService
abstract fun bindService(
service: Intent,
conn: ServiceConnection,
flags: Int
): Boolean
Connects to an application service, creating it if needed. This defines a dependency between your application and the service. The given conn will receive the service object when it is created and be told if it dies and restarts. The service will be considered required by the system only for as long as the calling context exists. For example, if this Context is an Activity that is stopped, the service will not be required to continue running until the Activity is resumed.
If the service does not support binding, it may return null
from its onBind()
method. If it does, then the ServiceConnection's onNullBinding()
method will be invoked instead of onServiceConnected()
.
Note: This method cannot be called from a BroadcastReceiver
component. A pattern you can use to communicate from a BroadcastReceiver to a Service is to call startService
with the arguments containing the command to be sent, with the service calling its android.app.Service#stopSelf(int)
method when done executing that command. See the API demo App/Service/Service Start Arguments Controller for an illustration of this. It is okay, however, to use this method from a BroadcastReceiver that has been registered with #registerReceiver, since the lifetime of this BroadcastReceiver is tied to another object (the one that registered it).
This method only accepts a int type flag, to pass in a long type flag, call bindService(android.content.Intent,android.content.ServiceConnection,android.content.Context.BindServiceFlags)
instead.
Parameters | |
---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null . |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
flags |
Int: Operation options for the binding. Can be: |
Return | |
---|---|
Boolean |
true if the system is in the process of bringing up a service that your client has permission to bind to; false if the system couldn't find the service or if your client doesn't have permission to bind to it. Regardless of the return value, you should later call unbindService to release the connection. |
Exceptions | |
---|---|
java.lang.SecurityException |
If the caller does not have permission to access the service or the service cannot be found. Call unbindService to release the connection when this exception is thrown. |
See Also
bindService
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
open fun bindService(
service: Intent,
flags: Int,
executor: Executor,
conn: ServiceConnection
): Boolean
Same as bindService(Intent, ServiceConnection, int)
with executor to control ServiceConnection callbacks.
This method only accepts a 32 bits flag, to pass in a 64 bits flag, call bindService(android.content.Intent,android.content.Context.BindServiceFlags,java.util.concurrent.Executor,android.content.ServiceConnection)
instead.
Return | |
---|---|
Boolean |
The result of the binding as described in bindService(Intent, ServiceConnection, int) . |
bindService
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 . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
conn |
ServiceConnection: This value cannot be null . |
bindServiceAsUser
open fun bindServiceAsUser(
service: Intent,
conn: ServiceConnection,
flags: Int,
user: UserHandle
): Boolean
Binds to a service in the given user
in the same manner as #bindService.
Requires that one of the following conditions are met:
- caller has
android.Manifest.permission.INTERACT_ACROSS_USERS_FULL
- caller has
android.Manifest.permission.INTERACT_ACROSS_USERS
and is the same package as theservice
(determined by its component's package) and the Android version is at leastandroid.os.Build.VERSION_CODES#TIRAMISU
- caller has
android.Manifest.permission.INTERACT_ACROSS_USERS
and is in same profile group as the givenuser
- caller has
android.Manifest.permission.INTERACT_ACROSS_PROFILES
and is in same profile group as the givenuser
and is the same package as theservice
Parameters | |
---|---|
service |
Intent: Identifies the service to connect to. The Intent must specify an explicit component name. This value cannot be null . |
conn |
ServiceConnection: Receives information as the service is started and stopped. This must be a valid ServiceConnection object; it must not be null. |
flags |
Int: Operation options for the binding. May be 0, BIND_AUTO_CREATE , BIND_DEBUG_UNBIND , BIND_NOT_FOREGROUND , BIND_ABOVE_CLIENT , BIND_ALLOW_OOM_MANAGEMENT , BIND_WAIVE_PRIORITY . BIND_IMPORTANT , or BIND_ADJUST_WITH_ACTIVITY . |
user |
UserHandle: This value cannot be null . |
Return | |
---|---|
Boolean |
true if the system is in the process of bringing up a service that your client has permission to bind to; false if the system couldn't find the service. You should call unbindService to release the connection even if this method returned false . |
Exceptions | |
---|---|
java.lang.SecurityException |
if the client does not have the required permission to bind. |
bindServiceAsUser
open fun bindServiceAsUser(
service: Intent,
conn: ServiceConnection,
flags: Context.BindServiceFlags,
user: UserHandle
): Boolean
See bindServiceAsUser(android.content.Intent,android.content.ServiceConnection,int,android.os.UserHandle)
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 . |
user |
UserHandle: This value cannot be null . |
checkCallingOrSelfPermission
abstract fun checkCallingOrSelfPermission(permission: String): Int
Determine whether the calling process of an IPC or you have been granted a particular permission. This is the same as checkCallingPermission
, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
Return | |
---|---|
Int |
PackageManager#PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager#PERMISSION_DENIED if it is not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
checkCallingOrSelfUriPermission
abstract fun checkCallingOrSelfUriPermission(
uri: Uri!,
modeFlags: Int
): Int
Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. This is the same as checkCallingUriPermission
, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of 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 |
See Also
checkCallingOrSelfUriPermissions
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!>: The list of URIs that is being checked. 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 |
Array of permission grants corresponding to each entry in the list of uris. PackageManager#PERMISSION_GRANTED if the given pid/uid is allowed to access that uri, or PackageManager#PERMISSION_DENIED if it is not. This value cannot be null . Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
See Also
checkCallingPermission
abstract fun checkCallingPermission(permission: String): Int
Determine whether the calling process of an IPC you are handling has been granted a particular permission. This is basically the same as calling checkPermission(java.lang.String,int,int)
with the pid and uid returned by android.os.Binder#getCallingPid
and android.os.Binder#getCallingUid
. One important difference is that if you are not currently processing an IPC, this function will always fail. This is done to protect against accidentally leaking permissions; you can use checkCallingOrSelfPermission
to avoid this protection.
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
Return | |
---|---|
Int |
PackageManager#PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager#PERMISSION_DENIED if it is not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
checkCallingUriPermission
abstract fun checkCallingUriPermission(
uri: Uri!,
modeFlags: Int
): Int
Determine whether the calling process and uid has been granted permission to access a specific URI. This is basically the same as calling checkUriPermission(android.net.Uri,int,int,int)
with the pid and uid returned by android.os.Binder#getCallingPid
and android.os.Binder#getCallingUid
. One important difference is that if you are not currently processing an IPC, this function will always fail.
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of 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
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!>: The list of URIs that is being checked. 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 |
Array of permission grants corresponding to each entry in the list of uris. PackageManager#PERMISSION_GRANTED if the given pid/uid is allowed to access that uri, or PackageManager#PERMISSION_DENIED if it is not. This value cannot be null . Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
checkContentUriPermissionFull
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: The content uri that is being checked. 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
abstract fun checkPermission(
permission: String,
pid: Int,
uid: Int
): Int
Determine whether the given permission is allowed for a particular process and user ID running in the system.
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
Return | |
---|---|
Int |
PackageManager#PERMISSION_GRANTED if the given pid/uid is allowed that permission, or PackageManager#PERMISSION_DENIED if it is not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
checkSelfPermission
abstract fun checkSelfPermission(permission: String): Int
Determine whether you have been granted a particular permission.
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
Return | |
---|---|
Int |
PackageManager#PERMISSION_GRANTED if you have the permission, or PackageManager#PERMISSION_DENIED if not. Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
checkUriPermission
abstract fun checkUriPermission(
uri: Uri!,
pid: Int,
uid: Int,
modeFlags: Int
): Int
Determine whether a particular process and uid has been granted permission to access a specific URI. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of 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 |
See Also
checkUriPermission
abstract fun checkUriPermission(
uri: Uri?,
readPermission: String?,
writePermission: String?,
pid: Int,
uid: Int,
modeFlags: Int
): Int
Check both a Uri and normal permission. This allows you to perform both checkPermission
and #checkUriPermission in one call.
Parameters | |
---|---|
uri |
Uri?: The Uri whose permission is to be checked, or null to not do this check. |
readPermission |
String?: The permission that provides overall read access, or null to not do this check. |
writePermission |
String?: The permission that provides overall write access, or null to not do this check. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to check. Value is either 0 or a combination of 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
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!>: The list of URIs that is 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. |
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 |
Array of permission grants corresponding to each entry in the list of uris. PackageManager#PERMISSION_GRANTED if the given pid/uid is allowed to access that uri, or PackageManager#PERMISSION_DENIED if it is not. This value cannot be null . Value is android.content.pm.PackageManager#PERMISSION_GRANTED , or android.content.pm.PackageManager#PERMISSION_DENIED |
See Also
clearWallpaper
abstract funclearWallpaper(): Unit
Deprecated: Use android.app.WallpaperManager#clear instead.
This method requires the caller to hold the permission android.Manifest.permission#SET_WALLPAPER
.
createAttributionContext
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?: The tag or null to create a context for the default. |
Return | |
---|---|
Context |
A Context that is tagged for the new attribution This value cannot be null . |
See Also
createConfigurationContext
abstract fun createConfigurationContext(overrideConfiguration: Configuration): Context!
Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
Parameters | |
---|---|
overrideConfiguration |
Configuration: A Configuration specifying what values to modify in the base Configuration of the original Context's resources. If the base configuration changes (such as due to an orientation change), the resources of this context will also change except for those that have been explicitly overridden with a value here. This value cannot be null . |
Return | |
---|---|
Context! |
A Context with the given configuration override. |
createContext
open fun createContext(contextParams: ContextParams): Context
Creates a context with specific properties and behaviors.
Parameters | |
---|---|
contextParams |
ContextParams: Parameters for how the new context should behave. This value cannot be null . |
Return | |
---|---|
Context |
A context with the specified behaviors. This value cannot be null . |
See Also
createContextForSplit
abstract fun createContextForSplit(splitName: String!): Context!
Return a new Context object for the given split name. The new Context has a ClassLoader and Resources object that can access the split's and all of its dependencies' code/resources. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same split) may be so the Context itself can be fairly lightweight.
Parameters | |
---|---|
splitName |
String!: The name of the split to include, as declared in the split's AndroidManifest.xml . |
Return | |
---|---|
Context! |
A Context with the given split's code and/or resources loaded. |
createDeviceContext
open fun createDeviceContext(deviceId: Int): Context
Returns a new Context
object from the current context but with device association given by the deviceId
. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader
and other resources for the same configuration) can be shared, so the Context
itself is lightweight.
Applications that run on virtual devices may use this method to access the default device capabilities and functionality (by passing Context#DEVICE_ID_DEFAULT
. Similarly, applications running on the default device may access the functionality of virtual devices.
Note that the newly created instance will be associated with the same display as the parent Context, regardless of the device ID passed here.
Parameters | |
---|---|
deviceId |
Int: The ID of the device to associate with this context. |
Return | |
---|---|
Context |
A context associated with the given device ID. 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
abstract fun createDeviceProtectedStorageContext(): Context!
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).
Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.
If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.
Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
See Also
createDisplayContext
abstract fun createDisplayContext(display: Display): Context!
Returns a new Context
object from the current context but with resources adjusted to match the metrics of display
. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader
and other resources for the same configuration) can be shared, so the Context
itself is lightweight.
Note: This Context
is not expected to be updated with new configuration if the underlying display configuration changes and the cached Resources
it returns could be stale. It is suggested to use android.hardware.display.DisplayManager.DisplayListener
to listen for changes and re-create an instance if necessary.
This Context
is not a UI context, do not use it to access UI components or obtain a WindowManager
instance.
To obtain an instance of WindowManager
configured to show windows on the given display, call createWindowContext(int,android.os.Bundle)
on the returned display context, then call getSystemService(java.lang.String)
or getSystemService(java.lang.Class)
on the returned window context.
Parameters | |
---|---|
display |
Display: The display to which the current context's resources are adjusted. This value cannot be null . |
Return | |
---|---|
Context! |
A context for the display. |
createPackageContext
abstract fun createPackageContext(
packageName: String!,
flags: Int
): Context!
Return a new Context object for the given application name. This Context is the same as what the named application gets when it is launched, containing the same resources and class loader. Each call to this method returns a new instance of a Context object; Context objects are not shared, however they share common state (Resources, ClassLoader, etc) so the Context instance itself is fairly lightweight.
Throws android.content.pm.PackageManager.NameNotFoundException
if there is no application with the given package name.
Throws java.lang.SecurityException
if the Context requested can not be loaded into the caller's process for security reasons (see CONTEXT_INCLUDE_CODE
for more information}.
Parameters | |
---|---|
packageName |
String!: Name of the application's package. |
flags |
Int: Option flags. Value is either 0 or a combination of 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
open fun createWindowContext(
type: Int,
options: Bundle?
): Context
Creates a Context for a non-activity window.
A window context is a context that can be used to add non-activity windows, such as android.view.WindowManager.LayoutParams#TYPE_APPLICATION_OVERLAY
. A window context must be created from a context that has an associated Display
, such as Activity
or a context created with createDisplayContext(android.view.Display)
.
The window context is created with the appropriate Configuration
for the area of the display that the windows created with it can occupy; it must be used when inflating
views, such that they can be inflated with proper Resources
. Below is a sample code to add an application overlay window on the primary display:
... final DisplayManager dm = anyContext.getSystemService(DisplayManager.class); final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY); final Context windowContext = anyContext.createDisplayContext(primaryDisplay) .createWindowContext(TYPE_APPLICATION_OVERLAY, null); final View overlayView = Inflater.from(windowContext).inflate(someLayoutXml, null); // WindowManager.LayoutParams initialization ... // The types used in addView and createWindowContext must match. mParams.type = TYPE_APPLICATION_OVERLAY; ... windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
This context's configuration and resources are adjusted to an area of the display where the windows with provided type will be added. Note that all windows associated with the same context will have an affinity and can only be moved together between different displays or areas on a display. If there is a need to add different window types, or non-associated windows, separate Contexts should be used.
Creating a window context is an expensive operation. Misuse of this API may lead to a huge performance drop. The best practice is to use the same window context when possible. An approach is to create one window context with specific window type and display and use it everywhere it's needed.
After Build.VERSION_CODES#S
, window context provides the capability to receive configuration changes for existing token by overriding the token
of the android.view.WindowManager.LayoutParams
passed in WindowManager#addView(View, LayoutParams)
. This is useful when an application needs to attach its window to an existing activity for window token sharing use-case.
Note that the window context in Build.VERSION_CODES#R
didn't have this capability. This is a no-op for the window context in Build.VERSION_CODES#R
.
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class); final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY); final Context windowContext = anyContext.createWindowContext(primaryDisplay, TYPE_APPLICATION, null); // Get an existing token. final IBinder existingToken = activity.getWindow().getAttributes().token; // The types used in addView() and createWindowContext() must match. final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION); params.token = existingToken; // After WindowManager#addView(), the server side will extract the provided token from // LayoutParams#token (existingToken in the sample code), and switch to propagate // configuration changes from the node associated with the provided token. windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
After Build.VERSION_CODES#S
, window context provides the capability to listen to its Configuration
changes by calling registerComponentCallbacks(android.content.ComponentCallbacks)
, while other kinds of Context
will register the ComponentCallbacks
to its
. Note that window context only propagate ComponentCallbacks#onConfigurationChanged(Configuration)
callback. ComponentCallbacks#onLowMemory()
or other callbacks in ComponentCallbacks2
won't be invoked.
Note that using android.app.Application
or android.app.Service
context for UI-related queries may result in layout or continuity issues on devices with variable screen sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect the Configuration
changes for the visual container.
Parameters | |
---|---|
type |
Int: Window type in WindowManager.LayoutParams 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?: A bundle used to pass window-related options This value may be null . |
Return | |
---|---|
Context |
A Context that can be used to create non-activity windows. |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if this Context does not attach to a display, such as Application or Service . |
createWindowContext
open fun createWindowContext(
display: Display,
type: Int,
options: Bundle?
): Context
Creates a Context
for a non-activity
window on the given Display
.
Similar to createWindowContext(int,android.os.Bundle)
, but the display
is passed in, instead of implicitly using the original Context's Display
.
Parameters | |
---|---|
display |
Display: The Display to associate with This value cannot be null . |
type |
Int: Window type in WindowManager.LayoutParams 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?: A bundle used to pass window-related options. This value may be null . |
Return | |
---|---|
Context |
A Context that can be used to create non-activity windows. This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the Display is null . |
databaseList
abstract fun databaseList(): Array<String!>!
Returns an array of strings naming the private databases associated with this Context's application package.
Return | |
---|---|
Array<String!>! |
Array of strings naming the private databases. |
See Also
deleteDatabase
abstract fun deleteDatabase(name: String!): Boolean
Delete an existing private SQLiteDatabase associated with this Context's application package.
Parameters | |
---|---|
name |
String!: The name (unique in the application package) of the database. |
Return | |
---|---|
Boolean |
true if the database was successfully deleted; else false . |
See Also
deleteFile
abstract fun deleteFile(name: String!): Boolean
Delete the given private file associated with this Context's application package.
Parameters | |
---|---|
name |
String!: The name of the file to delete; can not contain path separators. |
Return | |
---|---|
Boolean |
true if the file was successfully deleted; else false . |
deleteSharedPreferences
abstract fun deleteSharedPreferences(: String!): Boolean
Delete an existing shared preferences file.
Parameters | |
---|---|
name |
String!: The name (unique in the application package) of the shared preferences file. |
Return | |
---|---|
Boolean |
true if the shared preferences file was successfully deleted; else false . |
See Also
enforceCallingOrSelfPermission
abstract fun enforceCallingOrSelfPermission(
permission: String,
message: String?
): Unit
If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException
. This is the same as enforceCallingPermission
, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
message |
String?: A message to include in the exception if it is thrown. This value may be null . |
enforceCallingOrSelfUriPermission
abstract fun enforceCallingOrSelfUriPermission(
uri: Uri!,
modeFlags: Int,
message: String!
): Unit
If the calling process of an IPC or you has not been granted permission to access a specific URI, throw SecurityException
. This is the same as enforceCallingUriPermission
, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of 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
abstract fun enforceCallingPermission(
permission: String,
message: String?
): Unit
If the calling process of an IPC you are handling has not been granted a particular permission, throw a SecurityException
. This is basically the same as calling enforcePermission(java.lang.String,int,int,java.lang.String)
with the pid and uid returned by android.os.Binder#getCallingPid
and android.os.Binder#getCallingUid
. One important difference is that if you are not currently processing an IPC, this function will always throw the SecurityException. This is done to protect against accidentally leaking permissions; you can use enforceCallingOrSelfPermission
to avoid this protection.
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
message |
String?: A message to include in the exception if it is thrown. This value may be null . |
See Also
enforceCallingUriPermission
abstract fun enforceCallingUriPermission(
uri: Uri!,
modeFlags: Int,
message: String!
): Unit
If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException
. This is basically the same as calling enforceUriPermission(android.net.Uri,int,int,int,java.lang.String)
with the pid and uid returned by android.os.Binder#getCallingPid
and android.os.Binder#getCallingUid
. One important difference is that if you are not currently processing an IPC, this function will always throw a SecurityException.
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of 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. |
See Also
enforcePermission
abstract fun enforcePermission(
permission: String,
pid: Int,
uid: Int,
message: String?
): Unit
If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException
.
Parameters | |
---|---|
permission |
String: The name of the permission being checked. This value cannot be null . |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
message |
String?: A message to include in the exception if it is thrown. This value may be null . |
See Also
enforceUriPermission
abstract fun enforceUriPermission(
uri: Uri!,
pid: Int,
uid: Int,
modeFlags: Int,
message: String!
): Unit
If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException
. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.
Parameters | |
---|---|
uri |
Uri!: The uri that is being checked. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of 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
abstract fun enforceUriPermission(
uri: Uri?,
readPermission: String?,
writePermission: String?,
pid: Int,
uid: Int,
modeFlags: Int,
message: String?
): Unit
Enforce both a Uri and normal permission. This allows you to perform both enforcePermission
and #enforceUriPermission in one call.
Parameters | |
---|---|
uri |
Uri?: The Uri whose permission is to be checked, or null to not do this check. |
readPermission |
String?: The permission that provides overall read access, or null to not do this check. |
writePermission |
String?: The permission that provides overall write access, or null to not do this check. |
pid |
Int: The process ID being checked against. Must be > 0. |
uid |
Int: The UID being checked against. A uid of 0 is the root user, which will pass every permission check. |
modeFlags |
Int: The access modes to enforce. Value is either 0 or a combination of 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. This value may be null . |
fileList
abstract fun fileList(): Array<String!>!
Returns an array of strings naming the private files associated with this Context's application package.
Return | |
---|---|
Array<String!>! |
Array of strings naming the private files. |
See Also
getApplicationContext
abstract fun getApplicationContext(): Context!
Return the context of the single, global Application object of the current process. This generally should only be used if you need a Context whose lifecycle is separate from the current context, that is tied to the lifetime of the process rather than the current component.
Consider for example how this interacts with registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter)
:
-
If used from an Activity context, the receiver is being registered within that activity. This means that you are expected to unregister before the activity is done being destroyed; in fact if you do not do so, the framework will clean up your leaked registration as it removes the activity and log an error. Thus, if you use the Activity context to register a receiver that is static (global to the process, not associated with an Activity instance) then that registration will be removed on you at whatever point the activity you used is destroyed.
-
If used from the Context returned here, the receiver is being registered with the global state associated with your application. Thus it will never be unregistered for you. This is necessary if the receiver is associated with static data, not a particular component. However using the ApplicationContext elsewhere can easily lead to serious leaks if you forget to unregister, unbind, etc.
getApplicationInfo
abstract fun getApplicationInfo(): ApplicationInfo!
Return the full application info for this context's package.
getAssets
abstract fun getAssets(): AssetManager!
Returns an AssetManager instance for the application's package.
Note: Implementations of this method should return an AssetManager instance that is consistent with the Resources instance returned by getResources()
. For example, they should share the same Configuration
object.
Return | |
---|---|
AssetManager! |
an AssetManager instance for the application's package |
See Also
getAttributionSource
open fun getAttributionSource(): AttributionSource
Return | |
---|---|
AttributionSource |
The identity of this context for permission purposes. This value cannot be null . |
See Also
getAttributionTag
open fun getAttributionTag(): String?
Attribution can be used in complex apps to logically separate parts of the app. E.g. a blogging app might also have a instant messaging app built in. In this case two separate tags can for used each sub-feature.
Return | |
---|---|
String? |
the attribution tag this context is for or null if this is the default. |
getCacheDir
abstract fun getCacheDir(): File!
Returns the absolute path to the application specific cache directory on the filesystem.
The system will automatically delete files in this directory as disk space is needed elsewhere on the device. The system will always delete older files first, as reported by File#lastModified()
. If desired, you can exert more control over how files are deleted using StorageManager#setCacheBehaviorGroup(File, boolean)
and StorageManager#setCacheBehaviorTombstone(File, boolean)
.
Apps are strongly encouraged to keep their usage of cache space below the quota returned by StorageManager#getCacheQuotaBytes(java.util.UUID)
. If your app goes above this quota, your cached files will be some of the first to be deleted when additional disk space is needed. Conversely, if your app stays under this quota, your cached files will be some of the last to be deleted when additional disk space is needed.
Note that your cache quota will change over time depending on how frequently the user interacts with your app, and depending on how much system-wide disk space is used.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
Return | |
---|---|
File! |
The path of the directory holding application cache files. |
getClassLoader
abstract fun getClassLoader(): ClassLoader!
Return a class loader you can use to retrieve classes in this package.
getCodeCacheDir
abstract fun getCodeCacheDir(): File!
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
The system will delete any files stored in this location both when your specific application is upgraded, and when the entire platform is upgraded.
This location is optimal for storing compiled or optimized code generated by your application at runtime.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
Return | |
---|---|
File! |
The path of the directory holding application code cache files. |
getColor
fun getColor(id: Int): Int
Returns a color associated with a particular resource ID and styled for the current theme.
Parameters | |
---|---|
id |
Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier. |
Return | |
---|---|
Int |
A single color value in the form 0xAARRGGBB. |
Exceptions | |
---|---|
android.content.res.Resources.NotFoundException |
if the given ID does not exist. |
getColorStateList
fun getColorStateList(id: Int): ColorStateList
Returns a color state list associated with a particular resource ID and styled for the current theme.
Parameters | |
---|---|
id |
Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier. |
Return | |
---|---|
ColorStateList |
A color state list. This value cannot be null . |
Exceptions | |
---|---|
android.content.res.Resources.NotFoundException |
if the given ID does not exist. |
getContentResolver
abstract fun getContentResolver(): ContentResolver!
Return a ContentResolver instance for your application's package.
getDataDir
abstract fun getDataDir(): File!
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. Apps should not use this path directly; they should instead use getFilesDir()
, getCacheDir()
, getDir(java.lang.String,int)
, or other storage APIs on this class.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
getDatabasePath
abstract fun getDatabasePath(name: String!): File!
Returns the absolute path on the filesystem where a database created with #openOrCreateDatabase is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Parameters | |
---|---|
name |
String!: The name of the database for which you would like to get its path. |
Return | |
---|---|
File! |
An absolute path to the given database. |
See Also
getDeviceId
open fun getDeviceId(): Int
Gets the device ID this context is associated with. Applications can use this method to determine whether they are running on a virtual device and identify that device. The device ID of the host device is Context#DEVICE_ID_DEFAULT
If the underlying device ID is changed by the system, for example, when an Activity
is moved to a different virtual device, applications can register to listen to changes by calling Context#registerDeviceIdChangeListener(Executor, IntConsumer)
.
This method will only return a reliable value for this instance if it was created with Context#createDeviceContext(int)
, or if this instance is a UI or Display Context. Contexts created with Context#createDeviceContext(int)
will have an explicit device association, which will never change, even if the underlying device is closed or is removed. UI Contexts and Display Contexts are already associated with a display, so if the device association is not explicitly given, Context#getDeviceId()
will return the ID of the device associated with the associated display. The system can assign an arbitrary device id value for Contexts not logically associated with a device.
Return | |
---|---|
Int |
the ID of the device this context is associated with. |
getDir
abstract fun getDir(
name: String!,
mode: Int
): File!
Retrieve, creating if needed, a new directory in which the application can place its own custom data files. You can use the returned File object to create and access files in this directory. Note that files created through a File object will only be accessible by your own application; you can only set the mode of the entire directory, not of individual files.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
Parameters | |
---|---|
name |
String!: Name of the directory to retrieve. This is a directory that is created as part of your application data. |
mode |
Int: Operating mode. Value is either 0 or a combination of 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. |
See Also
getDisplay
open fun getDisplay(): Display
Get the display this context is associated with. Applications should use this method with android.app.Activity
or a context associated with a Display
via createDisplayContext(android.view.Display)
to get a display object associated with a Context, or android.hardware.display.DisplayManager#getDisplay
to get a display object by id.
Return | |
---|---|
Display |
Returns the Display object this context is associated with. This value cannot be null . |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
if the method is called on an instance that is not associated with any display. |
getDrawable
fun getDrawable(id: Int): Drawable?
Returns a drawable object associated with a particular resource ID and styled for the current theme.
Parameters | |
---|---|
id |
Int: The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier. |
Return | |
---|---|
Drawable? |
An object that can be used to draw this resource. This value may be null . |
Exceptions | |
---|---|
android.content.res.Resources.NotFoundException |
if the given ID does not exist. |
getExternalCacheDir
abstract fun getExternalCacheDir(): File?
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- The platform does not always monitor the space available in shared storage, and thus may not automatically delete these files. Apps should always manage the maximum space used in this location. Currently the only time files here will be deleted by the platform is when running on
android.os.Build.VERSION_CODES#JELLY_BEAN_MR1
or later andEnvironment#isExternalStorageEmulated(File)
returns true. - Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File)
), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir()
.
Starting in android.os.Build.VERSION_CODES#KITKAT
, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE
and/or android.Manifest.permission#READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Return | |
---|---|
File? |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getExternalCacheDirs
abstract fun getExternalCacheDirs(): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- The platform does not always monitor the space available in shared storage, and thus may not automatically delete these files. Apps should always manage the maximum space used in this location. Currently the only time files here will be deleted by the platform is when running on
android.os.Build.VERSION_CODES#JELLY_BEAN_MR1
or later andEnvironment#isExternalStorageEmulated(File)
returns true. - Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File)
), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directory returned by getCacheDir()
.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Return | |
---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getExternalCacheDir() . |
getExternalFilesDir
abstract fun getExternalFilesDir(type: String?): File?
Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media.
This is like getFilesDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File)
), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir()
, etc.
Starting in android.os.Build.VERSION_CODES#KITKAT
, no permissions are required to read or write to the returned path; it's always accessible to the calling app. This only applies to paths generated for package name of the calling application. To access paths belonging to other packages, android.Manifest.permission#WRITE_EXTERNAL_STORAGE
and/or android.Manifest.permission#READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
), each user has their own isolated shared storage. Applications only have access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Here is an example of typical code to manipulate a file in an application's shared storage:
If you supply a non-null type to this function, the returned file will be a path to a sub-directory of the given type. Though these files are not automatically scanned by the media scanner, you can explicitly add them to the media database with MediaScannerConnection.scanFile
. Note that this is not the same as Environment.getExternalStoragePublicDirectory()
, which provides directories of media shared by all applications. The directories returned here are owned by the application, and their contents will be removed when the application is uninstalled. Unlike Environment.getExternalStoragePublicDirectory()
, the directory returned here will be automatically created for you.
Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:
Parameters | |
---|---|
type |
String?: The type of files directory to return. May be null for the root of the files directory or one of the following constants for a subdirectory: android.os.Environment#DIRECTORY_MUSIC , android.os.Environment#DIRECTORY_PODCASTS , android.os.Environment#DIRECTORY_RINGTONES , android.os.Environment#DIRECTORY_ALARMS , android.os.Environment#DIRECTORY_NOTIFICATIONS , android.os.Environment#DIRECTORY_PICTURES , or android.os.Environment#DIRECTORY_MOVIES . |
Return | |
---|---|
File? |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getExternalFilesDirs
abstract fun getExternalFilesDirs(type: String!): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.
This is like getFilesDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by Environment#isExternalStorageEmulated(File)
), its contents are backed by a private user data partition, which means there is little benefit to storing data here instead of the private directories returned by getFilesDir()
, etc.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Parameters | |
---|---|
type |
String!: The type of files directory to return. May be null for the root of the files directory or one of the following constants for a subdirectory: android.os.Environment#DIRECTORY_MUSIC , android.os.Environment#DIRECTORY_PODCASTS , android.os.Environment#DIRECTORY_RINGTONES , android.os.Environment#DIRECTORY_ALARMS , android.os.Environment#DIRECTORY_NOTIFICATIONS , android.os.Environment#DIRECTORY_PICTURES , or android.os.Environment#DIRECTORY_MOVIES . |
Return | |
---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getExternalFilesDir(java.lang.String) . |
getExternalMediaDirs
abstract fungetExternalMediaDirs(): Array<File!>!
Deprecated: These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore
collection directly, as any app can contribute new media to MediaStore
with no permissions required, starting in android.os.Build.VERSION_CODES#Q
.
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files. These files are scanned and made available to other apps through MediaStore
.
This is like getExternalFilesDirs
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Return | |
---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. |
getFileStreamPath
abstract fun getFileStreamPath(name: String!): File!
Returns the absolute path on the filesystem where a file created with openFileOutput
is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Parameters | |
---|---|
name |
String!: The name of the file for which you would like to get its path. |
Return | |
---|---|
File! |
An absolute path to the given file. |
See Also
getFilesDir
abstract fun getFilesDir(): File!
Returns the absolute path to the directory on the filesystem where files created with openFileOutput
are stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
Return | |
---|---|
File! |
The path of the directory holding application files. |
See Also
getMainExecutor
open fun getMainExecutor(): Executor!
Return an Executor
that will run enqueued tasks on the main thread associated with this context. This is the thread used to dispatch calls to application components (activities, services, etc).
getMainLooper
abstract fun getMainLooper(): Looper!
Return the Looper for the main thread of the current process. This is the thread used to dispatch calls to application components (activities, services, etc).
By definition, this method returns the same result as would be obtained by calling Looper.getMainLooper()
.
Return | |
---|---|
Looper! |
The main looper. |
getNoBackupFilesDir
abstract fun getNoBackupFilesDir(): File!
Returns the absolute path to the directory on the filesystem similar to getFilesDir()
. The difference is that files placed under this directory will be excluded from automatic backup to remote storage. See BackupAgent
for a full discussion of the automatic backup mechanism in Android.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
Return | |
---|---|
File! |
The path of the directory holding application files that will not be automatically backed up to remote storage. |
getObbDir
abstract fun getObbDir(): File!
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. Note if the application does not have any OBB files, this directory may not exist.
This is like getFilesDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
Starting in android.os.Build.VERSION_CODES#KITKAT
, no permissions are required to read or write to the path that this method returns. However, starting from android.os.Build.VERSION_CODES#M
, to read the OBB expansion files, you must declare the android.Manifest.permission#READ_EXTERNAL_STORAGE
permission in the app manifest and ask for permission at runtime as follows:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="23" />
Starting from android.os.Build.VERSION_CODES#N
, android.Manifest.permission#READ_EXTERNAL_STORAGE
permission is not required, so don’t ask for this permission at runtime. To handle both cases, your app must first try to read the OBB file, and if it fails, you must request android.Manifest.permission#READ_EXTERNAL_STORAGE
permission at runtime.
The following code snippet shows how to do this:
File obb = new File(obb_filename); boolean open_failed = false; try { BufferedReader br = new BufferedReader(new FileReader(obb)); open_failed = false; ReadObbFile(br); } catch (IOException e) { open_failed = true; } if (open_failed) { // request READ_EXTERNAL_STORAGE permission before reading OBB file ReadObbFileWithPermission(); }On devices with multiple users (as described by
UserManager
), multiple users may share the same OBB storage location. Applications should ensure that multiple instances running under different users don't interfere with each other.
Return | |
---|---|
File! |
the absolute path to application-specific directory. May return null if shared storage is not currently available. |
getObbDirs
abstract fun getObbDirs(): Array<File!>!
Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found. Note if the application does not have any OBB files, these directories may not exist.
This is like getFilesDir()
in that these files will be deleted when the application is uninstalled, however there are some important differences:
- Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any application holding
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For example, an app may choose to store large files on the device with the most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
Return | |
---|---|
Array<File!>! |
the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available. The first path returned is the same as getObbDir() |
getOpPackageName
open fun getOpPackageName(): String
Return the package name that should be used for android.app.AppOpsManager
calls from this context, so that app ops manager's uid verification will work with the name.
This is not generally intended for third party application developers.
Return | |
---|---|
String |
This value cannot be null . |
getPackageCodePath
abstract fun getPackageCodePath(): String!
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains application's primary code and assets.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
Return | |
---|---|
String! |
String Path to the code and assets. |
getPackageManager
abstract fun getPackageManager(): PackageManager!
Return PackageManager instance to find global package information.
getPackageName
abstract fun getPackageName(): String!
Return the name of this application's package.
getPackageResourcePath
abstract fun getPackageResourcePath(): String!
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains the application's primary resources.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
Return | |
---|---|
String! |
String Path to the resources. |
getParams
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
abstract fun getResources(): Resources!
Returns a Resources instance for the application's package.
Note: Implementations of this method should return a Resources instance that is consistent with the AssetManager instance returned by getAssets()
. For example, they should share the same Configuration
object.
Return | |
---|---|
Resources! |
a Resources instance for the application's package |
See Also
getSharedPreferences
abstract fun getSharedPreferences(
: String!,
: Int
): SharedPreferences!
Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. Only one instance of the SharedPreferences object is returned to any callers for the same name, meaning they will see each other's edits as soon as they are made.
This method is thread-safe.
If the preferences directory does not already exist, it will be created when this method is called.
If a preferences file by this name does not exist, it will be created when you retrieve an editor (SharedPreferences#edit()
) and then commit changes (android.content.SharedPreferences.Editor#commit()
or SharedPreferences.Editor#apply()
).
Parameters | |
---|---|
name |
String!: Desired preferences file. |
mode |
Int: Operating mode. Value is either 0 or a combination of 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. |
See Also
getString
fun getString(resId: Int): String
Returns a localized string from the application's package's default string table.
Parameters | |
---|---|
resId |
Int: Resource id for the string |
Return | |
---|---|
String |
The string data associated with the resource, stripped of styled text information. This value cannot be null . |
getString
fun getString(
resId: Int,
vararg formatArgs: Any!
): String
Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter
and java.lang.String#format.
Parameters | |
---|---|
resId |
Int: Resource id for the format string |
formatArgs |
Any!: The format arguments that will be used for substitution. |
Return | |
---|---|
String |
The string data associated with the resource, formatted and stripped of styled text information. This value cannot be null . |
getSystemService
abstract fun getSystemService(name: String): Any!
Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:
-
WINDOW_SERVICE
("window") - The top-level window manager in which you can place custom windows. The returned object is a
android.view.WindowManager
. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle)
, which are adjusted to the configuration and visual bounds of an area on screen. -
LAYOUT_INFLATER_SERVICE
("layout_inflater") - A
android.view.LayoutInflater
for inflating layout resources in this context. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle)
, which are adjusted to the configuration and visual bounds of an area on screen. -
ACTIVITY_SERVICE
("activity") - A
android.app.ActivityManager
for interacting with the global activity state of the system. -
WALLPAPER_SERVICE
("wallpaper") - A
android.service.wallpaper.WallpaperService
for accessing wallpapers in this context. Must only be obtained from a visual context such as Activity or a Context created withcreateWindowContext(int,android.os.Bundle)
, which are adjusted to the configuration and visual bounds of an area on screen. -
POWER_SERVICE
("power") - A
android.os.PowerManager
for controlling power management. -
ALARM_SERVICE
("alarm") - A
android.app.AlarmManager
for receiving intents at the time of your choosing. -
NOTIFICATION_SERVICE
("notification") - A
android.app.NotificationManager
for informing the user of background events. -
KEYGUARD_SERVICE
("keyguard") - A
android.app.KeyguardManager
for controlling keyguard. -
LOCATION_SERVICE
("location") - A
android.location.LocationManager
for controlling location (e.g., GPS) updates. -
SEARCH_SERVICE
("search") - A
android.app.SearchManager
for handling search. -
VIBRATOR_MANAGER_SERVICE
("vibrator_manager") - A
android.os.VibratorManager
for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators. -
VIBRATOR_SERVICE
("vibrator") - A
android.os.Vibrator
for interacting with the vibrator hardware. -
CONNECTIVITY_SERVICE
("connectivity") - A
ConnectivityManager
for handling management of network connections. -
IPSEC_SERVICE
("ipsec") - A
IpSecManager
for managing IPSec on sockets and networks. -
WIFI_SERVICE
("wifi") - A
WifiManager
for management of Wi-Fi connectivity. On releases before Android 7, it should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process. -
WIFI_AWARE_SERVICE
("wifiaware") - A
WifiAwareManager
for management of Wi-Fi Aware discovery and connectivity. -
WIFI_P2P_SERVICE
("wifip2p") - A
WifiP2pManager
for management of Wi-Fi Direct connectivity. -
INPUT_METHOD_SERVICE
("input_method") - An
InputMethodManager
for management of input methods. -
UI_MODE_SERVICE
("uimode") - An
android.app.UiModeManager
for controlling UI modes. -
DOWNLOAD_SERVICE
("download") - A
android.app.DownloadManager
for requesting HTTP downloads -
BATTERY_SERVICE
("batterymanager") - A
android.os.BatteryManager
for managing battery state -
JOB_SCHEDULER_SERVICE
("taskmanager") - A
android.app.job.JobScheduler
for managing scheduled tasks -
NETWORK_STATS_SERVICE
("netstats") - A
NetworkStatsManager
for querying network usage statistics. -
HARDWARE_PROPERTIES_SERVICE
("hardware_properties") - A
android.os.HardwarePropertiesManager
for accessing hardware properties. -
DOMAIN_VERIFICATION_SERVICE
("domain_verification") - A
android.content.pm.verify.domain.DomainVerificationManager
for accessing web domain approval state. -
DISPLAY_HASH_SERVICE
("display_hash") - A
android.view.displayhash.DisplayHashManager
for management of display hashes.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp()
returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE
, FINGERPRINT_SERVICE
, KEYGUARD_SERVICE
, SHORTCUT_SERVICE
, USB_SERVICE
, WALLPAPER_SERVICE
, WIFI_P2P_SERVICE
, WIFI_SERVICE
, WIFI_AWARE_SERVICE
. For these services this method will return null
. Generally, if you are running as an instant app you should always check whether the result of this method is null
.
Note: When implementing this method, keep in mind that new services can be added on newer Android releases, so if you're looking for just the explicit names mentioned above, make sure to return null
when you don't recognize the name — if you throw a RuntimeException
exception instead, your app might break on new Android releases.
Return | |
---|---|
Any! |
The service or null if the name does not exist. |
See Also
#WINDOW_SERVICE
android.view.WindowManager
#LAYOUT_INFLATER_SERVICE
android.view.LayoutInflater
#ACTIVITY_SERVICE
android.app.ActivityManager
#POWER_SERVICE
android.os.PowerManager
#ALARM_SERVICE
android.app.AlarmManager
#NOTIFICATION_SERVICE
android.app.NotificationManager
#KEYGUARD_SERVICE
android.app.KeyguardManager
#LOCATION_SERVICE
android.location.LocationManager
#SEARCH_SERVICE
android.app.SearchManager
#SENSOR_SERVICE
android.hardware.SensorManager
#STORAGE_SERVICE
android.os.storage.StorageManager
#VIBRATOR_MANAGER_SERVICE
android.os.VibratorManager
#VIBRATOR_SERVICE
android.os.Vibrator
#CONNECTIVITY_SERVICE
android.net.ConnectivityManager
#WIFI_SERVICE
android.net.wifi.WifiManager
#AUDIO_SERVICE
android.media.AudioManager
#MEDIA_ROUTER_SERVICE
android.media.MediaRouter
#TELEPHONY_SERVICE
android.telephony.TelephonyManager
#TELEPHONY_SUBSCRIPTION_SERVICE
android.telephony.SubscriptionManager
#CARRIER_CONFIG_SERVICE
android.telephony.CarrierConfigManager
#EUICC_SERVICE
android.telephony.euicc.EuiccManager
#INPUT_METHOD_SERVICE
android.view.inputmethod.InputMethodManager
#UI_MODE_SERVICE
android.app.UiModeManager
#DOWNLOAD_SERVICE
android.app.DownloadManager
#BATTERY_SERVICE
android.os.BatteryManager
#JOB_SCHEDULER_SERVICE
android.app.job.JobScheduler
#NETWORK_STATS_SERVICE
android.app.usage.NetworkStatsManager
android.os.HardwarePropertiesManager
#HARDWARE_PROPERTIES_SERVICE
#DOMAIN_VERIFICATION_SERVICE
android.content.pm.verify.domain.DomainVerificationManager
#DISPLAY_HASH_SERVICE
android.view.displayhash.DisplayHashManager
getSystemService
fun <T : Any!> getSystemService(serviceClass: Class<T>): T
Return the handle to a system-level service by class.
Currently available classes are: android.view.WindowManager
, android.view.LayoutInflater
, android.app.ActivityManager
, android.os.PowerManager
, android.app.AlarmManager
, android.app.NotificationManager
, android.app.KeyguardManager
, android.location.LocationManager
, android.app.SearchManager
, android.os.Vibrator
, android.net.ConnectivityManager
, android.net.wifi.WifiManager
, android.media.AudioManager
, android.media.MediaRouter
, android.telephony.TelephonyManager
, android.telephony.SubscriptionManager
, android.view.inputmethod.InputMethodManager
, android.app.UiModeManager
, android.app.DownloadManager
, android.os.BatteryManager
, android.app.job.JobScheduler
, android.app.usage.NetworkStatsManager
, android.content.pm.verify.domain.DomainVerificationManager
, android.view.displayhash.DisplayHashManager
.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp()
returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE
, FINGERPRINT_SERVICE
, KEYGUARD_SERVICE
, SHORTCUT_SERVICE
, USB_SERVICE
, WALLPAPER_SERVICE
, WIFI_P2P_SERVICE
, WIFI_SERVICE
, WIFI_AWARE_SERVICE
. For these services this method will return null
. Generally, if you are running as an instant app you should always check whether the result of this method is null
.
Parameters | |
---|---|
serviceClass |
Class<T>: The class of the desired service. This value cannot be null . |
Return | |
---|---|
T |
The service or null if the class is not a supported system service. Note: never throw a RuntimeException if the name is not supported. |
getSystemServiceName
abstract fun getSystemServiceName(serviceClass: Class<*>): String?
Gets the name of the system-level service that is represented by the specified class.
Parameters | |
---|---|
serviceClass |
Class<*>: The class of the desired service. This value cannot be null . |
Return | |
---|---|
String? |
The service name or null if the class is not a supported system service. |
getText
fun getText(resId: Int): CharSequence
Return a localized, styled CharSequence from the application's package's default string table.
Parameters | |
---|---|
resId |
Int: Resource id for the CharSequence text |
Return | |
---|---|
CharSequence |
This value cannot be null . |
getTheme
abstract fun getTheme(): Resources.Theme!
Return the Theme object associated with this Context.
getWallpaper
abstract fungetWallpaper(): Drawable!
Deprecated: Use android.app.WallpaperManager#getDrawable instead.
getWallpaperDesiredMinimumHeight
abstract fungetWallpaperDesiredMinimumHeight(): Int
Deprecated: Use WallpaperManager.getDesiredMinimumHeight()
instead.
getWallpaperDesiredMinimumWidth
abstract fungetWallpaperDesiredMinimumWidth(): Int
Deprecated: Use WallpaperManager.getDesiredMinimumWidth()
instead.
grantUriPermission
abstract fun grantUriPermission(
toPackage: String!,
uri: Uri!,
modeFlags: Int
): Unit
Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. This can be used to grant specific, temporary permissions, typically in response to user interaction (such as the user opening an attachment that you would like someone else to display).
Normally you should use Intent.FLAG_GRANT_READ_URI_PERMISSION
or Intent.FLAG_GRANT_WRITE_URI_PERMISSION
with the Intent being used to start an activity instead of this function directly. If you use this function directly, you should be sure to call #revokeUriPermission when the target should no longer be allowed to access it.
To succeed, the content provider owning the Uri must have set the grantUriPermissions
attribute in its manifest or included the <grant-uri-permissions>
tag.
Parameters | |
---|---|
toPackage |
String!: The package you would like to allow to access the Uri. |
uri |
Uri!: The Uri you would like to grant access to. |
modeFlags |
Int: The desired access modes. Value is either 0 or a combination of 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 |
See Also
isDeviceProtectedStorage
abstract fun isDeviceProtectedStorage(): Boolean
Indicates if the storage APIs of this Context are backed by device-protected storage.
isRestricted
open fun isRestricted(): Boolean
Indicates whether this Context is restricted.
Return | |
---|---|
Boolean |
true if this Context is restricted, false otherwise. |
See Also
isUiContext
open fun isUiContext(): Boolean
Returns true
if the context is a UI context which can access UI components such as WindowManager
, LayoutInflater
or WallpaperManager
. Accessing UI components from non-UI contexts throws android.os.strictmode.Violation
if android.os.StrictMode.VmPolicy.Builder#detectIncorrectContextUse()
is enabled.
Examples of UI contexts are an Activity
, a context created from createWindowContext(int,android.os.Bundle)
or InputMethodService
Note that even if it is allowed programmatically, it is not suggested to override this method to bypass android.os.strictmode.IncorrectContextUseViolation
verification.
moveDatabaseFrom
abstract fun moveDatabaseFrom(
sourceContext: Context!,
name: String!
): Boolean
Move an existing database file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as migrating to device protected storage.
The database must be closed before being moved.
Parameters | |
---|---|
sourceContext |
Context!: The source context which contains the existing database to move. |
name |
String!: The name of the database file. |
Return | |
---|---|
Boolean |
true if the move was successful or if the database didn't exist in the source context, otherwise false . |
moveSharedPreferencesFrom
abstract fun moveSharedPreferencesFrom(
: Context!,
: String!
): Boolean
Move an existing shared preferences file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as moving to device protected storage.
Parameters | |
---|---|
sourceContext |
Context!: The source context which contains the existing shared preferences to move. |
name |
String!: The name of the shared preferences file. |
Return | |
---|---|
Boolean |
true if the move was successful or if the shared preferences didn't exist in the source context, otherwise false . |
obtainStyledAttributes
fun obtainStyledAttributes(attrs: IntArray): TypedArray
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int[])
for more information.
Parameters | |
---|---|
attrs |
IntArray: This value cannot be null . |
Return | |
---|---|
TypedArray |
This value cannot be null . |
obtainStyledAttributes
fun obtainStyledAttributes(
resid: Int,
attrs: IntArray
): TypedArray
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(int, int[])
for more information.
Parameters | |
---|---|
attrs |
IntArray: This value cannot be null . |
Return | |
---|---|
TypedArray |
This value cannot be null . |
obtainStyledAttributes
fun obtainStyledAttributes(
set: AttributeSet?,
attrs: IntArray
): TypedArray
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.
Parameters | |
---|---|
set |
AttributeSet?: This value may be null . |
attrs |
IntArray: This value cannot be null . |
Return | |
---|---|
TypedArray |
This value cannot be null . |
obtainStyledAttributes
fun obtainStyledAttributes(
set: AttributeSet?,
attrs: IntArray,
defStyleAttr: Int,
defStyleRes: Int
): TypedArray
Retrieve styled attribute information in this Context's theme. See android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.
Parameters | |
---|---|
set |
AttributeSet?: This value may be null . |
attrs |
IntArray: This value cannot be null . |
Return | |
---|---|
TypedArray |
This value cannot be null . |
openFileInput
abstract fun openFileInput(name: String!): FileInputStream!
Open a private file associated with this Context's application package for reading.
Parameters | |
---|---|
name |
String!: The name of the file to open; can not contain path separators. |
Return | |
---|---|
FileInputStream! |
The resulting FileInputStream . |
openFileOutput
abstract fun openFileOutput(
name: String!,
mode: Int
): FileOutputStream!
Open a private file associated with this Context's application package for writing. Creates the file if it doesn't already exist.
No additional permissions are required for the calling app to read or write the returned file.
Parameters | |
---|---|
name |
String!: The name of the file to open; can not contain path separators. |
mode |
Int: Operating mode. Value is either 0 or a combination of 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
abstract fun openOrCreateDatabase(
name: String!,
mode: Int,
factory: SQLiteDatabase.CursorFactory!
): SQLiteDatabase!
Open a new private SQLiteDatabase associated with this Context's application package. Create the database file if it doesn't exist.
Parameters | |
---|---|
name |
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
abstract 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?: the DatabaseErrorHandler to be used when sqlite reports database corruption. if null, android.database.DefaultDatabaseErrorHandler is assumed. |
Return | |
---|---|
SQLiteDatabase! |
The contents of a newly created database with the given name. |
Exceptions | |
---|---|
android.database.sqlite.SQLiteException |
if the database file could not be opened. |
peekWallpaper
abstract funpeekWallpaper(): Drawable!
Deprecated: Use android.app.WallpaperManager#peekDrawable instead.
registerComponentCallbacks
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#S
, registering the ComponentCallbacks to Context created via createWindowContext(int,android.os.Bundle)
or createWindowContext(android.view.Display,int,android.os.Bundle)
will receive ComponentCallbacks#onConfigurationChanged(Configuration)
from Window Context rather than its base application. It is helpful if you want to handle UI components that associated with the Window Context when the Window Context has configuration changes.
After Build.VERSION_CODES#TIRAMISU
, registering the ComponentCallbacks to Activity
context will receive ComponentCallbacks#onConfigurationChanged(Configuration)
from Activity#onConfigurationChanged(Configuration)
rather than its base application.
After Build.VERSION_CODES#UPSIDE_DOWN_CAKE
, registering the ComponentCallbacks to android.inputmethodservice.InputMethodService
will receive ComponentCallbacks#onConfigurationChanged(Configuration)
from InputmethodService rather than its base application. It is helpful if you want to handle UI components when the IME has configuration changes.
Parameters | |
---|---|
callback |
ComponentCallbacks!: The interface to call. This can be either a ComponentCallbacks or ComponentCallbacks2 interface. |
registerDeviceIdChangeListener
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: The Executor on whose thread to execute the callbacks of the listener object. 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: The listener IntConsumer to call which will receive the updated device ID. This value cannot be null . |
registerReceiver
abstract 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?: The BroadcastReceiver to handle the broadcast. This value may be null . |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
Return | |
---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
abstract fun registerReceiver(
receiver: BroadcastReceiver?,
filter: IntentFilter!,
flags: Int
): Intent?
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter)
for more information. By default Instant Apps cannot interact with receivers in other applications, this allows you to expose a receiver that Instant Apps can interact with.
See BroadcastReceiver
for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE
, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH
, receivers registered with this method will correctly respect the Intent#setPackage(String)
specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
Parameters | |
---|---|
receiver |
BroadcastReceiver?: The BroadcastReceiver to handle the broadcast. This value may be null . |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
flags |
Int: Additional options for the receiver. For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered for system broadcasts or a SecurityException will be thrown. If RECEIVER_EXPORTED is specified, a receiver may additionally specify RECEIVER_VISIBLE_TO_INSTANT_APPS . For a complete list of system broadcast actions, see the BROADCAST_ACTIONS.TXT file in the Android SDK. If both RECEIVER_EXPORTED and RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown. Value is either 0 or a combination of 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
abstract fun registerReceiver(
receiver: BroadcastReceiver!,
filter: IntentFilter!,
broadcastPermission: String?,
scheduler: Handler?
): Intent?
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter)
for more information. This allows you to enforce permissions on who can broadcast intents to your receiver, or have the receiver run in a different thread than the main application thread.
See BroadcastReceiver
for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE
, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH
, receivers registered with this method will correctly respect the Intent#setPackage(String)
specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE
, either RECEIVER_EXPORTED
or RECEIVER_NOT_EXPORTED
must be specified if the receiver is not being registered for system broadcasts or a SecurityException
will be thrown. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler,int)
to register a receiver with flags.
Parameters | |
---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to handle the broadcast. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
broadcastPermission |
String?: String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required. |
scheduler |
Handler?: Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used. |
Return | |
---|---|
Intent? |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
abstract fun registerReceiver(
receiver: BroadcastReceiver!,
filter: IntentFilter!,
broadcastPermission: String?,
scheduler: Handler?,
flags: Int
): Intent?
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,int)
and registerReceiver(android.content.BroadcastReceiver,android.content.IntentFilter,java.lang.String,android.os.Handler)
for more information.
See BroadcastReceiver
for more information on Intent broadcasts.
As of android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE
, the system can place context-registered broadcasts in a queue while the app is in the cached state. When the app leaves the cached state, such as returning to the foreground, the system delivers any queued broadcasts. Multiple instances of certain broadcasts might be merged into one broadcast.
As of android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH
, receivers registered with this method will correctly respect the Intent#setPackage(String)
specified for an Intent being broadcast. Prior to that, it would be ignored and delivered to all matching registered receivers. Be careful if using this for security.
Parameters | |
---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to handle the broadcast. |
filter |
IntentFilter!: Selects the Intent broadcasts to be received. |
broadcastPermission |
String?: String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required. |
scheduler |
Handler?: Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used. |
flags |
Int: Additional options for the receiver. For apps targeting android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE either RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered for system broadcasts or a SecurityException will be thrown. If RECEIVER_EXPORTED is specified, a receiver may additionally specify RECEIVER_VISIBLE_TO_INSTANT_APPS . For a complete list of system broadcast actions, see the BROADCAST_ACTIONS.TXT file in the Android SDK. If both RECEIVER_EXPORTED and RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown. Value is either 0 or a combination of 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
abstract funremoveStickyBroadcast(intent: Intent!): 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.
Remove the data previously sent with #sendStickyBroadcast, so that it is as if the sticky broadcast had never happened.
Requires android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent that was previously broadcast. |
See Also
removeStickyBroadcastAsUser
abstract funremoveStickyBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): 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.
Version of removeStickyBroadcast(android.content.Intent)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
You must hold the android.Manifest.permission#BROADCAST_STICKY
permission in order to use this API. If you do not hold that permission, SecurityException
will be thrown.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent that was previously broadcast. |
user |
UserHandle!: UserHandle to remove the sticky broadcast from. |
See Also
revokeSelfPermissionOnKill
open fun revokeSelfPermissionOnKill(permName: String): Unit
Triggers the asynchronous revocation of a runtime permission. If the permission is not currently granted, nothing happens (even if later granted by the user).
Parameters | |
---|---|
permName |
String: The name of the permission to be revoked. This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the permission is not a runtime permission |
revokeSelfPermissionsOnKill
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!>: Collection of permissions to be revoked. This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if any of the permissions is not a runtime permission |
revokeUriPermission
abstract fun revokeUriPermission(
uri: Uri!,
modeFlags: Int
): Unit
Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission
or any other mechanism. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.
Prior to android.os.Build.VERSION_CODES#LOLLIPOP
, if you did not have regular permission access to a Uri, but had received access to it through a specific Uri permission grant, you could not revoke that grant with this function and a SecurityException
would be thrown. As of android.os.Build.VERSION_CODES#LOLLIPOP
, this function will not throw a security exception, but will remove whatever permission grants to the Uri had been given to the app (or none).
Unlike revokeUriPermission(java.lang.String,android.net.Uri,int)
, this method impacts all permission grants matching the given Uri, for any package they had been granted to, through any mechanism this had happened (such as indirectly through the clipboard, activity launch, service start, etc). That means this can be potentially dangerous to use, as it can revoke grants that another app could be strongly expecting to stick around.
Parameters | |
---|---|
uri |
Uri!: The Uri you would like to revoke access to. |
modeFlags |
Int: The access modes to revoke. Value is either 0 or a combination of android.content.Intent#FLAG_GRANT_READ_URI_PERMISSION , and android.content.Intent#FLAG_GRANT_WRITE_URI_PERMISSION |
See Also
revokeUriPermission
abstract fun revokeUriPermission(
toPackage: String!,
uri: Uri!,
modeFlags: Int
): Unit
Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission
for a specific target package. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.
Unlike revokeUriPermission(android.net.Uri,int)
, this method will only revoke permissions that had been explicitly granted through grantUriPermission
and only for the package specified. Any matching grants that have happened through other mechanisms (clipboard, activity launching, service starting, etc) will not be removed.
Parameters | |
---|---|
toPackage |
String!: 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 |
See Also
sendBroadcast
abstract fun sendBroadcast(intent: Intent!): Unit
Broadcast the given intent to all interested BroadcastReceivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
sendBroadcast
abstract fun sendBroadcast(
intent: Intent!,
receiverPermission: String?
): Unit
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(android.content.Intent,java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
sendBroadcast
open fun sendBroadcast(
intent: Intent,
receiverPermission: String?,
options: Bundle?
): Unit
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. This value cannot be null . |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions . This value may be null . |
sendBroadcastAsUser
abstract fun sendBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): Unit
Version of sendBroadcast(android.content.Intent)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent!: The intent to broadcast |
user |
UserHandle!: UserHandle to send the intent to. |
See Also
sendBroadcastAsUser
abstract fun sendBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
receiverPermission: String?
): Unit
Version of sendBroadcast(android.content.Intent,java.lang.String)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
receiverPermission |
String?: (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
See Also
sendBroadcastWithMultiplePermissions
open fun sendBroadcastWithMultiplePermissions(
intent: Intent,
receiverPermissions: Array<String!>
): Unit
Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions 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. This value cannot be null . |
receiverPermissions |
Array<String!>: Array of names of permissions that a receiver must hold in order to receive your broadcast. If empty, no permissions are required. This value cannot be null . |
sendOrderedBroadcast
abstract fun sendOrderedBroadcast(
intent: Intent!,
receiverPermission: String?
): Unit
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
receiverPermission |
String?: (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
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: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null . |
receiverPermission |
String?: (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions . This value may be null . |
sendOrderedBroadcast
abstract fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendBroadcast(android.content.Intent)
that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive
method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is asynchronous; it will return before resultReceiver.onReceive() is called.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null . |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null . |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
options: Bundle?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendBroadcast(android.content.Intent)
that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive
method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is asynchronous; it will return before resultReceiver.onReceive() is called.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null . |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions . This value may be null . |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null . |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcast
open fun sendOrderedBroadcast(
intent: Intent,
receiverPermission: String?,
receiverAppOp: String?,
resultReceiver: BroadcastReceiver?,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle)
that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. This value cannot be null . |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
receiverAppOp |
String?: The app op associated with the broadcast. If null, no appOp is required. If both receiverAppOp and receiverPermission are non-null, a receiver must have both of them to receive the broadcast |
resultReceiver |
BroadcastReceiver?: Your own BroadcastReceiver to treat as the final receiver of the broadcast. This value may be null . |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendOrderedBroadcastAsUser
abstract fun sendOrderedBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
receiverPermission: String?,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: Bundle?
): Unit
Version of sendOrderedBroadcast(android.content.Intent,java.lang.String,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
receiverPermission |
String?: String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendStickyBroadcast
abstract funsendStickyBroadcast(intent: Intent!): 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)
.
Requires android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. |
sendStickyBroadcast
open funsendStickyBroadcast(
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)
.
Requires android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. This value cannot be null . |
options |
Bundle?: (optional) Additional sending options, generated from a android.app.BroadcastOptions . This value may be null . |
sendStickyBroadcastAsUser
abstract funsendStickyBroadcastAsUser(
intent: Intent!,
user: UserHandle!
): 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.
Version of sendStickyBroadcast(android.content.Intent)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast, and the Intent will be held to be re-broadcast to future receivers. |
user |
UserHandle!: UserHandle to send the intent to. |
See Also
sendStickyOrderedBroadcast
abstract funsendStickyOrderedBroadcast(
intent: Intent!,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: 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.
Version of #sendStickyBroadcast that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver#onReceive
method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(android.content.Intent,java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is asynchronous; it will return before resultReceiver.onReceive() is called. Note that the sticky data stored is only the data you initially supply to the broadcast, not the result of any changes made by the receivers.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
sendStickyOrderedBroadcastAsUser
abstract funsendStickyOrderedBroadcastAsUser(
intent: Intent!,
user: UserHandle!,
resultReceiver: BroadcastReceiver!,
scheduler: Handler?,
initialCode: Int,
initialData: String?,
initialExtras: 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.
Version of sendStickyOrderedBroadcast(android.content.Intent,android.content.BroadcastReceiver,android.os.Handler,int,java.lang.String,android.os.Bundle)
that allows you to specify the user the broadcast will be sent to. This is not available to applications that are not pre-installed on the system image.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and android.Manifest.permission#BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent!: The Intent to broadcast; all receivers matching this Intent will receive the broadcast. |
user |
UserHandle!: UserHandle to send the intent to. |
resultReceiver |
BroadcastReceiver!: Your own BroadcastReceiver to treat as the final receiver of the broadcast. |
scheduler |
Handler?: A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread. |
initialCode |
Int: An initial value for the result code. Often Activity.RESULT_OK. |
initialData |
String?: An initial value for the result data. Often null. |
initialExtras |
Bundle?: An initial value for the result extras. Often null. |
setTheme
abstract fun setTheme(resid: Int): Unit
Set the base theme for this context. Note that this should be called before any views are instantiated in the Context (for example before calling android.app.Activity#setContentView or android.view.LayoutInflater#inflate).
Parameters | |
---|---|
resid |
Int: The style resource describing the theme. |
setWallpaper
abstract funsetWallpaper(bitmap: Bitmap!): Unit
Deprecated: Use This method requires the caller to hold the permission WallpaperManager.set()
instead.
android.Manifest.permission#SET_WALLPAPER
.
setWallpaper
abstract funsetWallpaper(data: InputStream!): Unit
Deprecated: Use This method requires the caller to hold the permission WallpaperManager.set()
instead.
android.Manifest.permission#SET_WALLPAPER
.
startActivities
abstract fun startActivities(intents: Array<Intent!>!): Unit
Same as startActivities(android.content.Intent[],android.os.Bundle)
with no options specified.
Parameters | |
---|---|
intents |
Array<Intent!>!: An array of Intents to be started. |
Exceptions | |
---|---|
android.content.ActivityNotFoundException |
See Also
startActivities
abstract fun startActivities(
intents: Array<Intent!>!,
options: Bundle!
): Unit
Launch multiple new activities. This is generally the same as calling startActivity(android.content.Intent)
for the first Intent in the array, that activity during its creation calling startActivity(android.content.Intent)
for the second entry, etc. Note that unlike that approach, generally none of the activities except the last in the array will be created at this point, but rather will be created when the user first visits them (due to pressing back from the activity on top).
This method throws ActivityNotFoundException
if there was no Activity found for any given Intent. In this case the state of the activity stack is undefined (some Intents in the list may be on it, some not), so you probably want to avoid such situations.
Parameters | |
---|---|
intents |
Array<Intent!>!: An array of Intents to be started. |
options |
Bundle!: Additional options for how the Activity should be started. See android.content.Context#startActivity(Intent, Bundle) Context.startActivity(Intent, Bundle)} for more details. |
Exceptions | |
---|---|
android.content.ActivityNotFoundException |
See Also
startActivity
abstract fun startActivity(intent: Intent!): Unit
Same as startActivity(android.content.Intent,android.os.Bundle)
with no options specified.
Parameters | |
---|---|
intent |
Intent!: The description of the activity to start. |
Exceptions | |
---|---|
android.content.ActivityNotFoundException |
` |
See Also
startActivity
abstract fun startActivity(
intent: Intent!,
options: Bundle?
): Unit
Launch a new activity. You will not receive any information about when the activity exits.
Note that if this method is being called from outside of an android.app.Activity
Context, then the Intent must include the Intent#FLAG_ACTIVITY_NEW_TASK
launch flag. This is because, without being started from an existing Activity, there is no existing task in which to place the new activity and thus it needs to be placed in its own separate task.
This method throws ActivityNotFoundException
if there was no Activity found to run the given Intent.
Parameters | |
---|---|
intent |
Intent!: The description of the activity to start. |
options |
Bundle?: Additional options for how the Activity should be started. May be null if there are no options. See android.app.ActivityOptions for how to build the Bundle supplied here; there are no supported definitions for building it manually. |
Exceptions | |
---|---|
android.content.ActivityNotFoundException |
See Also
startForegroundService
abstract fun startForegroundService(service: Intent!): ComponentName?
Similar to startService(android.content.Intent)
, but with an implicit promise that the Service will call startForeground(int, android.app.Notification)
once it begins running. The service is given an amount of time comparable to the ANR interval to do this, otherwise the system will automatically crash the process, in which case an internal exception ForegroundServiceDidNotStartInTimeException
is logged on logcat on devices running SDK Version android.os.Build.VERSION_CODES#S
or later. On older Android versions, an internal exception RemoteServiceException
is logged instead, with a corresponding message.
Unlike the ordinary startService(android.content.Intent)
, this method can be used at any time, regardless of whether the app hosting the service is in a foreground state.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S
, apps targeting SDK Version android.os.Build.VERSION_CODES#S
or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
Parameters | |
---|---|
service |
Intent!: Identifies the service to be started. The Intent must be fully explicit (supplying a component name). Additional values may be included in the Intent extras to supply arguments along with this specific start call. |
Return | |
---|---|
ComponentName? |
If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned. |
Exceptions | |
---|---|
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
abstract fun startInstrumentation(
className: ComponentName,
profileFile: String?,
arguments: Bundle?
): Boolean
Start executing an android.app.Instrumentation
class. The given Instrumentation component will be run by killing its target application (if currently running), starting the target process, instantiating the instrumentation component, and then letting it drive the application.
This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.
Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).
Parameters | |
---|---|
className |
ComponentName: Name of the Instrumentation component to be run. This value cannot be null . |
profileFile |
String?: Optional path to write profiling data as the instrumentation runs, or null for no profiling. |
arguments |
Bundle?: Additional optional arguments to pass to the instrumentation, or null. |
Return | |
---|---|
Boolean |
true if the instrumentation was successfully started, else false if it could not be found. |
startIntentSender
abstract fun startIntentSender(
intent: IntentSender!,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int
): Unit
Same as startIntentSender(android.content.IntentSender,android.content.Intent,int,int,int,android.os.Bundle)
with no options specified.
startIntentSender
abstract fun startIntentSender(
intent: IntentSender!,
fillInIntent: Intent?,
flagsMask: Int,
flagsValues: Int,
extraFlags: Int,
options: Bundle?
): Unit
Like startActivity(android.content.Intent,android.os.Bundle)
, but taking a IntentSender to start. If the IntentSender is for an activity, that activity will be started as if you had called the regular startActivity(android.content.Intent)
here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called android.content.IntentSender#sendIntent on it.
startService
abstract fun startService(service: Intent!): ComponentName?
Request that a given application service be started. The Intent should either contain the complete class name of a specific service implementation to start, or a specific package name to target. If the Intent is less specified, it logs a warning about this. In this case any of the multiple matching services may be used. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.
Every call to this method will result in a corresponding call to the target service's android.app.Service#onStartCommand
method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.
Using startService() overrides the default service lifetime that is managed by #bindService: it requires the service to remain running until stopService
is called, regardless of whether any clients are connected to it. Note that calls to startService() do not nest: no matter how many times you call startService(), a single call to stopService
will stop it.
The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.
This function will throw SecurityException
if you do not have permission to start the given service.
Note: Each call to startService() results in significant work done by the system to manage service lifecycle surrounding the processing of the intent, which can take multiple milliseconds of CPU time. Due to this cost, startService() should not be used for frequent intent delivery to a service, and only for scheduling significant work. Use #bindService for high frequency calls.
Beginning with SDK Versionandroid.os.Build.VERSION_CODES#O
, apps targeting SDK Version android.os.Build.VERSION_CODES#O
or higher are not allowed to start background services from the background. See Background Execution Limits for more details.
Note: Beginning with SDK Version android.os.Build.VERSION_CODES#S
, apps targeting SDK Version android.os.Build.VERSION_CODES#S
or higher are not allowed to start foreground services from the background. See Behavior changes: Apps targeting Android 12 for more details.
Parameters | |
---|---|
service |
Intent!: Identifies the service to be started. The Intent must be fully explicit (supplying a component name). Additional values may be included in the Intent extras to supply arguments along with this specific start call. |
Return | |
---|---|
ComponentName? |
If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned. |
Exceptions | |
---|---|
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
abstract fun stopService(service: Intent!): Boolean
Request that a given application service be stopped. If the service is not running, nothing happens. Otherwise it is stopped. Note that calls to startService() are not counted -- this stops the service no matter how many times it was started.
If the service is running as a foreground service when it is stopped, its associated notification will be removed. To avoid this, apps can use stopForeground(STOP_FOREGROUND_DETACH)
to decouple the notification from the service's lifecycle before stopping it.
Note that if a stopped service still has ServiceConnection
objects bound to it with the BIND_AUTO_CREATE
set, it will not be destroyed until all of these bindings are removed. See the android.app.Service
documentation for more details on a service's lifecycle.
This function will throw SecurityException
if you do not have permission to stop the given service.
Parameters | |
---|---|
service |
Intent!: Description of the service to be stopped. The Intent must be either fully explicit (supplying a component name) or specify a specific package name it is targeted to. |
Return | |
---|---|
Boolean |
If there is a service matching the given Intent that is already running, then it is stopped and true is returned; else false is returned. |
Exceptions | |
---|---|
java.lang.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). |
See Also
unbindService
abstract fun unbindService(conn: ServiceConnection): Unit
Disconnect from an application service. You will no longer receive calls as the service is restarted, and the service is now allowed to stop at any time.
Parameters | |
---|---|
conn |
ServiceConnection: The connection interface previously supplied to bindService(). This parameter must not be null. |
See Also
unregisterComponentCallbacks
open fun unregisterComponentCallbacks(callback: ComponentCallbacks!): Unit
Remove a ComponentCallbacks
object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks)
.
unregisterDeviceIdChangeListener
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: The Consumer to remove. This value cannot be null . |
unregisterReceiver
abstract fun unregisterReceiver(receiver: BroadcastReceiver!): Unit
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
Parameters | |
---|---|
receiver |
BroadcastReceiver!: The BroadcastReceiver to unregister. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if the receiver was not previously registered or already unregistered. |
See Also
updateServiceGroup
open fun updateServiceGroup(
conn: ServiceConnection,
group: Int,
importance: Int
): Unit
For a service previously bound with #bindService or a related method, change how the system manages that service's process in relation to other processes. This doesn't modify the original bind flags that were passed in when binding, but adjusts how the process will be managed in some cases based on those flags. Currently only works on isolated processes (will be ignored for non-isolated processes).
Note that this call does not take immediate effect, but will be applied the next time the impacted process is adjusted for some other reason. Typically you would call this before then calling a new #bindIsolatedService on the service of interest, with that binding causing the process to be shuffled accordingly.
Parameters | |
---|---|
conn |
ServiceConnection: The connection interface previously supplied to bindService(). This parameter must not be null. |
group |
Int: A group to put this connection's process in. Upon calling here, this will override any previous group that was set for that process. The group tells the system about processes that are logically grouped together, so should be managed as one unit of importance (such as when being considered a recently used app). All processes in the same app with the same group are considered to be related. Supplying 0 reverts to the default behavior of not grouping. |
importance |
Int: Additional importance of the processes within a group. Upon calling here, this will override any previous importance that was set for that process. The most important process is 0, and higher values are successively less important. You can view this as describing how to order the processes in an array, with the processes at the end of the array being the least important. This value has no meaning besides indicating how processes should be ordered in that array one after the other. This provides a way to fine-tune the system's process killing, guiding it to kill processes at the end of the array first. |
See Also