ContextWrapper
public
class
ContextWrapper
extends Context
java.lang.Object | ||
↳ | android.content.Context | |
↳ | android.content.ContextWrapper |
Proxying implementation of Context that simply delegates all of its calls to another Context. Can be subclassed to modify behavior without changing the original Context.
Summary
Inherited constants |
---|
Public constructors | |
---|---|
ContextWrapper(Context base)
|
Public methods | |
---|---|
boolean
|
bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)
Variation of |
boolean
|
bindService(Intent service, int flags, Executor executor, ServiceConnection conn)
Same as |
boolean
|
bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)
See |
boolean
|
bindService(Intent service, ServiceConnection conn, int flags)
Connects to an application service, creating it if needed. |
boolean
|
bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)
See |
int
|
checkCallingOrSelfPermission(String permission)
Determine whether the calling process of an IPC or you have been granted a particular permission. |
int
|
checkCallingOrSelfUriPermission(Uri uri, int modeFlags)
Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. |
int[]
|
checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)
Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. |
int
|
checkCallingPermission(String permission)
Determine whether the calling process of an IPC you are handling has been granted a particular permission. |
int
|
checkCallingUriPermission(Uri uri, int modeFlags)
Determine whether the calling process and uid has been granted permission to access a specific URI. |
int[]
|
checkCallingUriPermissions(List<Uri> uris, int modeFlags)
Determine whether the calling process and uid has been granted permission to access a list of URIs. |
int
|
checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted permission to access a specific content URI. |
int
|
checkPermission(String permission, int pid, int uid)
Determine whether the given permission is allowed for a particular process and user ID running in the system. |
int
|
checkSelfPermission(String permission)
Determine whether you have been granted a particular permission. |
int
|
checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
Check both a Uri and normal permission. |
int
|
checkUriPermission(Uri uri, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted permission to access a specific URI. |
int[]
|
checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted permission to access a list of URIs. |
void
|
clearWallpaper()
This method is deprecated.
Use This method requires the caller to hold the permission
|
Context
|
createAttributionContext(String attributionTag)
Return a new Context object for the current Context but attribute to a different tag. |
Context
|
createConfigurationContext(Configuration overrideConfiguration)
Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. |
Context
|
createContext(ContextParams contextParams)
Creates a context with specific properties and behaviors. |
Context
|
createDeviceContext(int deviceId)
Returns a new |
Context
|
createDeviceProtectedStorageContext()
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage. |
Context
|
createDisplayContext(Display display)
Returns a new |
Context
|
createPackageContext(String packageName, int flags)
Return a new Context object for the given application name. |
Context
|
createWindowContext(int type, Bundle options)
Creates a Context for a non-activity window. |
Context
|
createWindowContext(Display display, int type, Bundle options)
Creates a |
String[]
|
databaseList()
Returns an array of strings naming the private databases associated with this Context's application package. |
boolean
|
deleteDatabase(String name)
Delete an existing private SQLiteDatabase associated with this Context's application package. |
boolean
|
deleteFile(String name)
Delete the given private file associated with this Context's application package. |
boolean
|
deleteSharedPreferences(String name)
Delete an existing shared preferences file. |
void
|
enforceCallingOrSelfPermission(String permission, String message)
If neither you nor the calling process of an IPC you are
handling has been granted a particular permission, throw a
|
void
|
enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)
If the calling process of an IPC or you has not been
granted permission to access a specific URI, throw |
void
|
enforceCallingPermission(String permission, String message)
If the calling process of an IPC you are handling has not been
granted a particular permission, throw a |
void
|
enforceCallingUriPermission(Uri uri, int modeFlags, String message)
If the calling process and uid has not been granted
permission to access a specific URI, throw |
void
|
enforcePermission(String permission, int pid, int uid, String message)
If the given permission is not allowed for a particular process
and user ID running in the system, throw a |
void
|
enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
Enforce both a Uri and normal permission. |
void
|
enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)
If a particular process and uid has not been granted
permission to access a specific URI, throw |
String[]
|
fileList()
Returns an array of strings naming the private files associated with this Context's application package. |
Context
|
getApplicationContext()
Return the context of the single, global Application object of the current process. |
ApplicationInfo
|
getApplicationInfo()
Return the full application info for this context's package. |
AssetManager
|
getAssets()
Returns an AssetManager instance for the application's package. |
AttributionSource
|
getAttributionSource()
|
Context
|
getBaseContext()
|
File
|
getCacheDir()
Returns the absolute path to the application specific cache directory on the filesystem. |
ClassLoader
|
getClassLoader()
Return a class loader you can use to retrieve classes in this package. |
File
|
getCodeCacheDir()
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code. |
ContentResolver
|
getContentResolver()
Return a ContentResolver instance for your application's package. |
File
|
getDataDir()
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. |
File
|
getDatabasePath(String name)
Returns the absolute path on the filesystem where a database created with
|
int
|
getDeviceId()
Gets the device ID this context is associated with. |
File
|
getDir(String name, int mode)
Retrieve, creating if needed, a new directory in which the application can place its own custom data files. |
Display
|
getDisplay()
Get the display this context is associated with. |
File
|
getExternalCacheDir()
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. |
File[]
|
getExternalCacheDirs()
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. |
File
|
getExternalFilesDir(String type)
Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. |
File[]
|
getExternalFilesDirs(String type)
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. |
File[]
|
getExternalMediaDirs()
This method is deprecated.
These directories still exist and are scanned, but developers
are encouraged to migrate to inserting content into a
|
File
|
getFileStreamPath(String name)
Returns the absolute path on the filesystem where a file created with
|
File
|
getFilesDir()
Returns the absolute path to the directory on the filesystem where files
created with |
Executor
|
getMainExecutor()
Return an |
Looper
|
getMainLooper()
Return the Looper for the main thread of the current process. |
File
|
getNoBackupFilesDir()
Returns the absolute path to the directory on the filesystem similar to
|
File
|
getObbDir()
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. |
File[]
|
getObbDirs()
Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found. |
String
|
getPackageCodePath()
Return the full path to this context's primary Android package. |
PackageManager
|
getPackageManager()
Return PackageManager instance to find global package information. |
String
|
getPackageName()
Return the name of this application's package. |
String
|
getPackageResourcePath()
Return the full path to this context's primary Android package. |
ContextParams
|
getParams()
Return the set of parameters which this Context was created with, if it
was created via |
Resources
|
getResources()
Returns a Resources instance for the application's package. |
SharedPreferences
|
getSharedPreferences(String name, int mode)
Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. |
Object
|
getSystemService(String name)
Return the handle to a system-level service by name. |
String
|
getSystemServiceName(Class<?> serviceClass)
Gets the name of the system-level service that is represented by the specified class. |
Resources.Theme
|
getTheme()
Return the Theme object associated with this Context. |
Drawable
|
getWallpaper()
This method is deprecated.
Use |
int
|
getWallpaperDesiredMinimumHeight()
This method is deprecated.
Use |
int
|
getWallpaperDesiredMinimumWidth()
This method is deprecated.
Use |
void
|
grantUriPermission(String toPackage, Uri uri, int modeFlags)
Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. |
boolean
|
isDeviceProtectedStorage()
Indicates if the storage APIs of this Context are backed by device-protected storage. |
boolean
|
isRestricted()
Indicates whether this Context is restricted. |
boolean
|
moveDatabaseFrom(Context sourceContext, String name)
Move an existing database file from the given source storage context to this context. |
boolean
|
moveSharedPreferencesFrom(Context sourceContext, String name)
Move an existing shared preferences file from the given source storage context to this context. |
FileInputStream
|
openFileInput(String name)
Open a private file associated with this Context's application package for reading. |
FileOutputStream
|
openFileOutput(String name, int mode)
Open a private file associated with this Context's application package for writing. |
SQLiteDatabase
|
openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)
Open a new private SQLiteDatabase associated with this Context's application package. |
SQLiteDatabase
|
openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)
Open a new private SQLiteDatabase associated with this Context's application package. |
Drawable
|
peekWallpaper()
This method is deprecated.
Use |
void
|
registerComponentCallbacks(ComponentCallbacks callback)
Add a new |
void
|
registerDeviceIdChangeListener(Executor executor, IntConsumer listener)
Adds a new device ID changed listener to the |
Intent
|
registerReceiver(BroadcastReceiver receiver, IntentFilter filter)
Register a BroadcastReceiver to be run in the main activity thread. |
Intent
|
registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. |
Intent
|
registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)
Register to receive intent broadcasts, to run in the context of scheduler. |
Intent
|
registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
Register to receive intent broadcasts, to run in the context of scheduler. |
void
|
removeStickyBroadcast(Intent intent)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
removeStickyBroadcastAsUser(Intent intent, UserHandle user)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
revokeSelfPermissionsOnKill(Collection<String> permissions)
Triggers the revocation of one or more permissions for the calling package. |
void
|
revokeUriPermission(Uri uri, int modeFlags)
Remove all permissions to access a particular content provider Uri
that were previously added with |
void
|
revokeUriPermission(String targetPackage, Uri uri, int modeFlags)
Remove permissions to access a particular content provider Uri
that were previously added with |
void
|
sendBroadcast(Intent intent, String receiverPermission, Bundle options)
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. |
void
|
sendBroadcast(Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. |
void
|
sendBroadcast(Intent intent)
Broadcast the given intent to all interested BroadcastReceivers. |
void
|
sendBroadcastAsUser(Intent intent, UserHandle user)
Version of |
void
|
sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)
Version of |
void
|
sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
|
void
|
sendOrderedBroadcast(Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options)
|
void
|
sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of |
void
|
sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. |
void
|
sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of |
void
|
sendOrderedBroadcast(Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. |
void
|
sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
|
void
|
sendStickyBroadcast(Intent intent)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
sendStickyBroadcast(Intent intent, Bundle options)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
sendStickyBroadcastAsUser(Intent intent, UserHandle user)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. |
void
|
setTheme(int resid)
Set the base theme for this context. |
void
|
setWallpaper(Bitmap bitmap)
This method is deprecated.
Use This method requires the caller to hold the permission
|
void
|
setWallpaper(InputStream data)
This method is deprecated.
Use This method requires the caller to hold the permission
|
void
|
startActivities(Intent[] intents, Bundle options)
Launch multiple new activities. |
void
|
startActivities(Intent[] intents)
Same as |
void
|
startActivity(Intent intent)
Same as |
void
|
startActivity(Intent intent, Bundle options)
Launch a new activity. |
ComponentName
|
startForegroundService(Intent service)
Similar to |
boolean
|
startInstrumentation(ComponentName className, String profileFile, Bundle arguments)
Start executing an |
void
|
startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
Same as |
void
|
startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
Like |
ComponentName
|
startService(Intent service)
Request that a given application service be started. |
boolean
|
stopService(Intent name)
Request that a given application service be stopped. |
void
|
unbindService(ServiceConnection conn)
Disconnect from an application service. |
void
|
unregisterComponentCallbacks(ComponentCallbacks callback)
Remove a |
void
|
unregisterDeviceIdChangeListener(IntConsumer listener)
Removes a device ID changed listener from the Context. |
void
|
unregisterReceiver(BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver. |
void
|
updateServiceGroup(ServiceConnection conn, int group, int importance)
For a service previously bound with |
Protected methods | |
---|---|
void
|
attachBaseContext(Context base)
Set the base context for this ContextWrapper. |
Inherited methods | |
---|---|
Public constructors
Public methods
bindIsolatedService
public boolean bindIsolatedService (Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)
Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection)
that, in the specific case of isolated
services, allows the caller to generate multiple instances of a service
from a single component declaration. In other words, you can use this to bind
to a service that has specified 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(Intent, BindServiceFlags, Executor, ServiceConnection) . |
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. |
Returns | |
---|---|
boolean |
Returns success of binding as per bindService(Intent, BindServiceFlags, Executor, ServiceConnection) . |
bindService
public boolean bindService (Intent service, int flags, Executor executor, ServiceConnection conn)
Same as bindService(Intent, ServiceConnection, int)
with executor to control ServiceConnection
callbacks.
This method only accepts a 32 bits flag, to pass in a 64 bits flag, call
bindService(android.content.Intent, android.content.Context.BindServiceFlags, java.util.concurrent.Executor, android.content.ServiceConnection)
instead.
Parameters | |
---|---|
service |
Intent : This value cannot be null . |
flags |
int : Value is either 0 or a combination of Context.BIND_AUTO_CREATE , Context.BIND_DEBUG_UNBIND , Context.BIND_NOT_FOREGROUND , Context.BIND_ABOVE_CLIENT , Context.BIND_ALLOW_OOM_MANAGEMENT , Context.BIND_WAIVE_PRIORITY , Context.BIND_IMPORTANT , Context.BIND_ADJUST_WITH_ACTIVITY , Context.BIND_NOT_PERCEPTIBLE , Context.BIND_ALLOW_ACTIVITY_STARTS , Context.BIND_INCLUDE_CAPABILITIES , Context.BIND_SHARED_ISOLATED_PROCESS , Context.BIND_PACKAGE_ISOLATED_PROCESS , and Context.BIND_EXTERNAL_SERVICE |
executor |
Executor : Callbacks on ServiceConnection will be called on executor. Must use same
instance for the same instance of ServiceConnection.
This value cannot be null .
Callback and listener events are dispatched through this
Executor , providing an easy way to control which thread is
used. To dispatch events through the main thread of your
application, you can use
Context.getMainExecutor() .
Otherwise, provide an Executor that dispatches to an appropriate thread. |
conn |
ServiceConnection : This value cannot be null . |
Returns | |
---|---|
boolean |
The result of the binding as described in
bindService(Intent, ServiceConnection, int) . |
bindService
public boolean bindService (Intent service, ServiceConnection conn, Context.BindServiceFlags flags)
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 . |
Returns | |
---|---|
boolean |
bindService
public boolean bindService (Intent service, ServiceConnection conn, int flags)
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(Intent)
with the arguments containing the command to be
sent, with the service calling its
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(BroadcastReceiver, IntentFilter)
, 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:
|
Returns | |
---|---|
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(ServiceConnection) to release the connection. |
bindService
public boolean bindService (Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)
See bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection)
Call BindServiceFlags#of(long)
to obtain a BindServiceFlags object.
Parameters | |
---|---|
service |
Intent : This value cannot be null . |
flags |
Context.BindServiceFlags : This value cannot be null . |
executor |
Executor : This value cannot be null . |
conn |
ServiceConnection : This value cannot be null . |
Returns | |
---|---|
boolean |
checkCallingOrSelfPermission
public int checkCallingOrSelfPermission (String permission)
Determine whether the calling process of an IPC or you have been
granted a particular permission. This is the same as
checkCallingPermission(String)
, 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 . |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if the calling
pid/uid is allowed that permission, or
PackageManager#PERMISSION_DENIED if it is not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkCallingOrSelfUriPermission
public int checkCallingOrSelfUriPermission (Uri uri, int modeFlags)
Determine whether the calling process of an IPC or you has been granted
permission to access a specific URI. This is the same as
checkCallingUriPermission(Uri, int)
, 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if the caller
is allowed to access that uri, or
PackageManager#PERMISSION_DENIED if it is not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkCallingOrSelfUriPermissions
public int[] checkCallingOrSelfUriPermissions (List<Uri> uris, int modeFlags)
Determine whether the calling process of an IPC or you has been granted
permission to access a list of URIs. This is the same as
checkCallingUriPermission(Uri, int)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!
Parameters | |
---|---|
uris |
List : This value cannot be null . |
modeFlags |
int : The access modes to check.
Value is either 0 or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
int[] |
This value cannot be null . |
checkCallingPermission
public int checkCallingPermission (String permission)
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 Binder.getCallingPid()
and
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(String)
to avoid this protection.
Parameters | |
---|---|
permission |
String : The name of the permission being checked.
This value cannot be null . |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if the calling
pid/uid is allowed that permission, or
PackageManager#PERMISSION_DENIED if it is not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkCallingUriPermission
public int checkCallingUriPermission (Uri uri, int modeFlags)
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 Binder.getCallingPid()
and 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if the caller
is allowed to access that uri, or
PackageManager#PERMISSION_DENIED if it is not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkCallingUriPermissions
public int[] checkCallingUriPermissions (List<Uri> uris, int modeFlags)
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 Binder.getCallingPid()
and Binder.getCallingUid()
. One important difference is
that if you are not currently processing an IPC, this function
will always fail.
Parameters | |
---|---|
uris |
List : This value cannot be null . |
modeFlags |
int : The access modes to check.
Value is either 0 or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
int[] |
This value cannot be null . |
checkContentUriPermissionFull
public int checkContentUriPermissionFull (Uri uri, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted permission to access a specific content URI.
Unlike checkUriPermission(android.net.Uri, int, int, int)
, this method
checks for general access to the URI's content provider, as well as
explicitly granted permissions.
Note, this check will throw an IllegalArgumentException
for non-content URIs.
Parameters | |
---|---|
uri |
Uri : This value cannot be null . |
pid |
int : (Optional) The process ID being checked against. If the
pid is unknown, pass -1. |
uid |
int : The UID being checked against. A uid of 0 is the root
user, which will pass every permission check. |
modeFlags |
int : The access modes to check.
Value is either 0 or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
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 PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkPermission
public int checkPermission (String permission, int pid, int uid)
Determine whether the given permission is allowed for a particular process and user ID running in the system.
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. |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if the given
pid/uid is allowed that permission, or
PackageManager#PERMISSION_DENIED if it is not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkSelfPermission
public int checkSelfPermission (String permission)
Determine whether you have been granted a particular permission.
Parameters | |
---|---|
permission |
String : The name of the permission being checked.
This value cannot be null . |
Returns | |
---|---|
int |
PackageManager#PERMISSION_GRANTED if you have the
permission, or PackageManager#PERMISSION_DENIED if not.
Value is PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkUriPermission
public int checkUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
Check both a Uri and normal permission. This allows you to perform
both checkPermission(String, int, int)
and checkUriPermission(Uri, int, int, int)
in one
call.
Parameters | |
---|---|
uri |
Uri : This value may be null . |
readPermission |
String : This value may be null . |
writePermission |
String : This value may be null . |
pid |
int : The process ID being checked against. Must be > 0. |
uid |
int : The UID being checked against. A uid of 0 is the root
user, which will pass every permission check. |
modeFlags |
int : The access modes to check.
Value is either 0 or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
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 PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkUriPermission
public int checkUriPermission (Uri uri, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted permission to access a specific URI. 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
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 PackageManager.PERMISSION_GRANTED , or PackageManager.PERMISSION_DENIED |
checkUriPermissions
public int[] checkUriPermissions (List<Uri> uris, int pid, int uid, int modeFlags)
Determine whether a particular process and uid has been granted
permission to access a list of URIs. 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 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 |
List : 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
Returns | |
---|---|
int[] |
This value cannot be null . |
clearWallpaper
public void clearWallpaper ()
This method is deprecated.
Use WallpaperManager.clear()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
Throws | |
---|---|
IOException |
createAttributionContext
public Context createAttributionContext (String attributionTag)
Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.
Parameters | |
---|---|
attributionTag |
String : This value may be null . |
Returns | |
---|---|
Context |
This value cannot be null . |
createConfigurationContext
public Context createConfigurationContext (Configuration overrideConfiguration)
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 . |
Returns | |
---|---|
Context |
A Context with the given configuration override. |
createContext
public Context createContext (ContextParams contextParams)
Creates a context with specific properties and behaviors.
Parameters | |
---|---|
contextParams |
ContextParams : This value cannot be null . |
Returns | |
---|---|
Context |
This value cannot be null . |
createDeviceContext
public Context createDeviceContext (int deviceId)
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. |
Returns | |
---|---|
Context |
This value cannot be null . |
createDeviceProtectedStorageContext
public Context createDeviceProtectedStorageContext ()
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.
Returns | |
---|---|
Context |
createDisplayContext
public Context createDisplayContext (Display display)
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
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 . |
Returns | |
---|---|
Context |
A context for the display. |
createPackageContext
public Context createPackageContext (String packageName, int flags)
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 PackageManager.NameNotFoundException
if there is no
application with the given package name.
Throws 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 Context.CONTEXT_INCLUDE_CODE , Context.CONTEXT_IGNORE_SECURITY , Context.CONTEXT_RESTRICTED , android.content.Context.CONTEXT_DEVICE_PROTECTED_STORAGE, android.content.Context.CONTEXT_CREDENTIAL_PROTECTED_STORAGE, and android.content.Context.CONTEXT_REGISTER_PACKAGE |
Returns | |
---|---|
Context |
A Context for the application. |
Throws | |
---|---|
PackageManager.NameNotFoundException |
createWindowContext
public Context createWindowContext (int type, Bundle options)
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
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
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
Application context
. Note that window context only propagate
ComponentCallbacks#onConfigurationChanged(Configuration)
callback.
ComponentCallbacks#onLowMemory()
or other callbacks in ComponentCallbacks2
won't be invoked.
Note that using Application
or Service
context for
UI-related queries may result in layout or continuity issues on devices with variable screen
sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect
the Configuration
changes for the visual container.
Parameters | |
---|---|
type |
int : Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION_STARTING , WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION_PANEL , WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA , WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL , WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG , android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR , WindowManager.LayoutParams.TYPE_SEARCH_BAR , WindowManager.LayoutParams.TYPE_PHONE , WindowManager.LayoutParams.TYPE_SYSTEM_ALERT , android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST , WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY , WindowManager.LayoutParams.TYPE_PRIORITY_PHONE , WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG , WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG , WindowManager.LayoutParams.TYPE_SYSTEM_ERROR , WindowManager.LayoutParams.TYPE_INPUT_METHOD , WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG , 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, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION , android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, 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, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY , android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL |
options |
Bundle : This value may be null . |
Returns | |
---|---|
Context |
This value cannot be null . |
createWindowContext
public Context createWindowContext (Display display, int type, Bundle options)
Creates a Context
for a non-activity
window on the given
Display
.
Similar to createWindowContext(int, android.os.Bundle)
, but the display
is passed in,
instead of implicitly using the original Context's Display
.
Parameters | |
---|---|
display |
Display : This value cannot be null . |
type |
int : Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION_STARTING , WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION , WindowManager.LayoutParams.TYPE_APPLICATION_PANEL , WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA , WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL , WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG , android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR , WindowManager.LayoutParams.TYPE_SEARCH_BAR , WindowManager.LayoutParams.TYPE_PHONE , WindowManager.LayoutParams.TYPE_SYSTEM_ALERT , android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST , WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY , WindowManager.LayoutParams.TYPE_PRIORITY_PHONE , WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG , WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG , WindowManager.LayoutParams.TYPE_SYSTEM_ERROR , WindowManager.LayoutParams.TYPE_INPUT_METHOD , WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG , 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, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION , android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, 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, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY , android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL |
options |
Bundle : This value may be null . |
Returns | |
---|---|
Context |
This value cannot be null . |
databaseList
public String[] databaseList ()
Returns an array of strings naming the private databases associated with this Context's application package.
Returns | |
---|---|
String[] |
Array of strings naming the private databases. |
deleteDatabase
public boolean deleteDatabase (String name)
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. |
Returns | |
---|---|
boolean |
true if the database was successfully deleted; else false . |
deleteFile
public boolean deleteFile (String name)
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. |
Returns | |
---|---|
boolean |
true if the file was successfully deleted; else
false . |
deleteSharedPreferences
public boolean deleteSharedPreferences (String name)
Delete an existing shared preferences file.
Parameters | |
---|---|
name |
String : The name (unique in the application package) of the shared
preferences file. |
Returns | |
---|---|
boolean |
true if the shared preferences file was successfully
deleted; else false . |
enforceCallingOrSelfPermission
public void enforceCallingOrSelfPermission (String permission, String message)
If neither you nor the calling process of an IPC you are
handling has been granted a particular permission, throw a
SecurityException
. This is the same as enforceCallingPermission(String, String)
, except it grants your own
permissions if you are not currently processing an IPC. Use
with care!
Parameters | |
---|---|
permission |
String : The name of the permission being checked.
This value cannot be null . |
message |
String : This value may be null . |
enforceCallingOrSelfUriPermission
public void enforceCallingOrSelfUriPermission (Uri uri, int modeFlags, String message)
If the calling process of an IPC or you has not been
granted permission to access a specific URI, throw SecurityException
. This is the same as enforceCallingUriPermission(Uri, int, String)
, 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
message |
String : A message to include in the exception if it is thrown. |
enforceCallingPermission
public void enforceCallingPermission (String permission, String message)
If the calling process of an IPC you are handling has not been
granted a particular permission, throw a SecurityException
. This is basically the same as calling
enforcePermission(java.lang.String, int, int, java.lang.String)
with the
pid and uid returned by Binder.getCallingPid()
and 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(String, String)
to avoid this
protection.
Parameters | |
---|---|
permission |
String : The name of the permission being checked.
This value cannot be null . |
message |
String : This value may be null . |
enforceCallingUriPermission
public void enforceCallingUriPermission (Uri uri, int modeFlags, String message)
If the calling process and uid has not been granted
permission to access a specific URI, throw SecurityException
. This is basically the same as calling
enforceUriPermission(android.net.Uri, int, int, int, java.lang.String)
with
the pid and uid returned by Binder.getCallingPid()
and 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
message |
String : A message to include in the exception if it is thrown. |
enforcePermission
public void enforcePermission (String permission, int pid, int uid, String message)
If the given permission is not allowed for a particular process
and user ID running in the system, throw a SecurityException
.
Parameters | |
---|---|
permission |
String : The name of the permission being checked.
This value cannot be null . |
pid |
int : The process ID being checked against. Must be > 0. |
uid |
int : The UID being checked against. A uid of 0 is the root
user, which will pass every permission check. |
message |
String : This value may be null . |
enforceUriPermission
public void enforceUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
Enforce both a Uri and normal permission. This allows you to perform
both enforcePermission(String, int, int, String)
and enforceUriPermission(Uri, int, int, int, String)
in one
call.
Parameters | |
---|---|
uri |
Uri : This value may be null . |
readPermission |
String : This value may be null . |
writePermission |
String : This value may be null . |
pid |
int : The process ID being checked against. Must be > 0. |
uid |
int : The UID being checked against. A uid of 0 is the root
user, which will pass every permission check. |
modeFlags |
int : The access modes to enforce.
Value is either 0 or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
message |
String : This value may be null . |
enforceUriPermission
public void enforceUriPermission (Uri uri, int pid, int uid, int modeFlags, String message)
If a particular process and uid has not been granted
permission to access a specific URI, throw SecurityException
. 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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
message |
String : A message to include in the exception if it is thrown. |
fileList
public String[] fileList ()
Returns an array of strings naming the private files associated with this Context's application package.
Returns | |
---|---|
String[] |
Array of strings naming the private files. |
getApplicationContext
public Context getApplicationContext ()
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.
Returns | |
---|---|
Context |
getApplicationInfo
public ApplicationInfo getApplicationInfo ()
Return the full application info for this context's package.
Returns | |
---|---|
ApplicationInfo |
getAssets
public AssetManager getAssets ()
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.
Returns | |
---|---|
AssetManager |
an AssetManager instance for the application's package |
getAttributionSource
public AttributionSource getAttributionSource ()
Returns | |
---|---|
AttributionSource |
This value cannot be null . |
getBaseContext
public Context getBaseContext ()
Returns | |
---|---|
Context |
the base context as set by the constructor or setBaseContext |
getCacheDir
public File getCacheDir ()
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.
Returns | |
---|---|
File |
The path of the directory holding application cache files. |
getClassLoader
public ClassLoader getClassLoader ()
Return a class loader you can use to retrieve classes in this package.
Returns | |
---|---|
ClassLoader |
getCodeCacheDir
public File getCodeCacheDir ()
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.
Returns | |
---|---|
File |
The path of the directory holding application code cache files. |
getContentResolver
public ContentResolver getContentResolver ()
Return a ContentResolver instance for your application's package.
Returns | |
---|---|
ContentResolver |
getDataDir
public File getDataDir ()
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.
Returns | |
---|---|
File |
getDatabasePath
public File getDatabasePath (String name)
Returns the absolute path on the filesystem where a database created with
openOrCreateDatabase(String, int, CursorFactory)
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. |
Returns | |
---|---|
File |
An absolute path to the given database. |
getDeviceId
public int getDeviceId ()
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.
Returns | |
---|---|
int |
the ID of the device this context is associated with. |
getDir
public File getDir (String name, int mode)
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 Context.MODE_PRIVATE , Context.MODE_WORLD_READABLE , Context.MODE_WORLD_WRITEABLE , and Context.MODE_APPEND |
Returns | |
---|---|
File |
A File object for the requested directory. The directory
will have been created if it does not already exist. |
getDisplay
public Display getDisplay ()
Get the display this context is associated with. Applications should use this method with
Activity
or a context associated with a Display
via
createDisplayContext(android.view.Display)
to get a display object associated with a Context, or
DisplayManager.getDisplay(int)
to get a display object by id.
Returns | |
---|---|
Display |
This value may be null . |
getExternalCacheDir
public File getExternalCacheDir ()
Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. 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
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
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 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,
Manifest.permission.WRITE_EXTERNAL_STORAGE
and/or
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.
Returns | |
---|---|
File |
This value may be null . |
getExternalCacheDirs
public File[] getExternalCacheDirs ()
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
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
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.
Returns | |
---|---|
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
public File getExternalFilesDir (String type)
Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. 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
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 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,
Manifest.permission.WRITE_EXTERNAL_STORAGE
and/or
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:
void createExternalStoragePrivateFile() { // Create a path where we will place our private file on external // storage. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); try { // Very simple code to copy a picture from the application's // resource into the external file. Note that this code does // no error checking, and assumes the picture is small (does not // try to copy it in chunks). Note that if external storage is // not currently mounted this will silently fail. InputStream is = getResources().openRawResource(R.drawable.balloons); OutputStream os = new FileOutputStream(file); byte[] data = new byte[is.available()]; is.read(data); os.write(data); is.close(); os.close(); } catch (IOException e) { // Unable to create file, likely because external storage is // not currently mounted. Log.w("ExternalStorage", "Error writing " + file, e); } } void deleteExternalStoragePrivateFile() { // Get path for the file on external storage. If external // storage is not currently mounted this will fail. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); file.delete(); } boolean hasExternalStoragePrivateFile() { // Get path for the file on external storage. If external // storage is not currently mounted this will fail. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); return file.exists(); }
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:
void createExternalStoragePrivatePicture() { // Create a path where we will place our picture in our own private // pictures directory. Note that we don't really need to place a // picture in DIRECTORY_PICTURES, since the media scanner will see // all media in these directories; this may be useful with other // media types such as DIRECTORY_MUSIC however to help it classify // your media for display to the user. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); File file = new File(path, "DemoPicture.jpg"); try { // Very simple code to copy a picture from the application's // resource into the external file. Note that this code does // no error checking, and assumes the picture is small (does not // try to copy it in chunks). Note that if external storage is // not currently mounted this will silently fail. InputStream is = getResources().openRawResource(R.drawable.balloons); OutputStream os = new FileOutputStream(file); byte[] data = new byte[is.available()]; is.read(data); os.write(data); is.close(); os.close(); // Tell the media scanner about the new file so that it is // immediately available to the user. MediaScannerConnection.scanFile(this, new String[] { file.toString() }, null, new MediaScannerConnection.OnScanCompletedListener() { public void onScanCompleted(String path, Uri uri) { Log.i("ExternalStorage", "Scanned " + path + ":"); Log.i("ExternalStorage", "-> uri=" + uri); } }); } catch (IOException e) { // Unable to create file, likely because external storage is // not currently mounted. Log.w("ExternalStorage", "Error writing " + file, e); } } void deleteExternalStoragePrivatePicture() { // Create a path where we will place our picture in the user's // public pictures directory and delete the file. If external // storage is not currently mounted this will fail. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); if (path != null) { File file = new File(path, "DemoPicture.jpg"); file.delete(); } } boolean hasExternalStoragePrivatePicture() { // Create a path where we will place our picture in the user's // public pictures directory and check if the file exists. If // external storage is not currently mounted this will think the // picture doesn't exist. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); if (path != null) { File file = new File(path, "DemoPicture.jpg"); return file.exists(); } return false; }
Parameters | |
---|---|
type |
String : This value may be null . |
Returns | |
---|---|
File |
This value may be null . |
getExternalFilesDirs
public File[] getExternalFilesDirs (String type)
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. 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
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:
Environment.DIRECTORY_MUSIC ,
Environment.DIRECTORY_PODCASTS ,
Environment.DIRECTORY_RINGTONES ,
Environment.DIRECTORY_ALARMS ,
Environment.DIRECTORY_NOTIFICATIONS ,
Environment.DIRECTORY_PICTURES , or
Environment.DIRECTORY_MOVIES . |
Returns | |
---|---|
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
public File[] getExternalMediaDirs ()
This method is deprecated.
These directories still exist and are scanned, but developers
are encouraged to migrate to inserting content into a
MediaStore
collection directly, as any app can
contribute new media to MediaStore
with no
permissions required, starting in
Build.VERSION_CODES.Q
.
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(String)
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
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.
Returns | |
---|---|
File[] |
the absolute paths to application-specific directories. Some
individual paths may be null if that shared storage is
not currently available. |
getFileStreamPath
public File getFileStreamPath (String name)
Returns the absolute path on the filesystem where a file created with
openFileOutput(String, int)
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. |
Returns | |
---|---|
File |
An absolute path to the given file. |
getFilesDir
public File getFilesDir ()
Returns the absolute path to the directory on the filesystem where files
created with openFileOutput(String, int)
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.
Returns | |
---|---|
File |
The path of the directory holding application files. |
getMainExecutor
public Executor getMainExecutor ()
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).
Returns | |
---|---|
Executor |
getMainLooper
public Looper getMainLooper ()
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()
.
Returns | |
---|---|
Looper |
The main looper. |
getNoBackupFilesDir
public File getNoBackupFilesDir ()
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.
Returns | |
---|---|
File |
The path of the directory holding application files that will not be automatically backed up to remote storage. |
getObbDir
public File getObbDir ()
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
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
Starting in Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the path that this method returns.
However, starting from Build.VERSION_CODES.M
,
to read the OBB expansion files, you must declare the
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 Build.VERSION_CODES.N
,
Manifest.permission.READ_EXTERNAL_STORAGE
permission is not required, so don\u2019t 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
Manifest.permission.READ_EXTERNAL_STORAGE
permission at runtime.
The following code snippet shows how to do this:
File obb = new File(obb_filename); boolean open_failed = false; try { BufferedReader br = new BufferedReader(new FileReader(obb)); open_failed = false; ReadObbFile(br); } catch (IOException e) { open_failed = true; } if (open_failed) { // request READ_EXTERNAL_STORAGE permission before reading OBB file ReadObbFileWithPermission(); }
UserManager
),
multiple users may share the same OBB storage location. Applications
should ensure that multiple instances running under different users don't
interfere with each other.
Returns | |
---|---|
File |
the absolute path to application-specific directory. May return
null if shared storage is not currently available. |
getObbDirs
public File[] getObbDirs ()
Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found. 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
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.
Returns | |
---|---|
File[] |
the absolute paths to application-specific directories. Some
individual paths may be null if that shared storage is
not currently available. The first path returned is the same as
getObbDir() |
getPackageCodePath
public String getPackageCodePath ()
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.
Returns | |
---|---|
String |
String Path to the code and assets. |
getPackageManager
public PackageManager getPackageManager ()
Return PackageManager instance to find global package information.
Returns | |
---|---|
PackageManager |
getPackageName
public String getPackageName ()
Return the name of this application's package.
Returns | |
---|---|
String |
getPackageResourcePath
public String getPackageResourcePath ()
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.
Returns | |
---|---|
String |
String Path to the resources. |
getParams
public ContextParams getParams ()
Return the set of parameters which this Context was created with, if it
was created via createContext(android.content.ContextParams)
.
Returns | |
---|---|
ContextParams |
This value may be null . |
getResources
public Resources getResources ()
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.
Returns | |
---|---|
Resources |
a Resources instance for the application's package |
getSharedPreferences
public SharedPreferences getSharedPreferences (String name, int mode)
Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. Only one instance of the SharedPreferences object is returned to any callers for the same name, meaning they will see each other's edits as soon as they are made.
This method is thread-safe.
If the preferences directory does not already exist, it will be created when this method is called.
If a preferences file by this name does not exist, it will be created when you retrieve an
editor (SharedPreferences#edit()
) and then commit changes (SharedPreferences.Editor.commit()
or SharedPreferences.Editor#apply()
).
Parameters | |
---|---|
name |
String : Desired preferences file. |
mode |
int : Operating mode.
Value is either 0 or a combination of Context.MODE_PRIVATE , Context.MODE_WORLD_READABLE , Context.MODE_WORLD_WRITEABLE , and Context.MODE_MULTI_PROCESS |
Returns | |
---|---|
SharedPreferences |
The single SharedPreferences instance that can be used
to retrieve and modify the preference values. |
getSystemService
public Object getSystemService (String name)
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
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
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
ActivityManager
for interacting with the global activity state of the system. -
WALLPAPER_SERVICE
("wallpaper") - A
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
PowerManager
for controlling power management. -
ALARM_SERVICE
("alarm") - A
AlarmManager
for receiving intents at the time of your choosing. -
NOTIFICATION_SERVICE
("notification") - A
NotificationManager
for informing the user of background events. -
KEYGUARD_SERVICE
("keyguard") - A
KeyguardManager
for controlling keyguard. -
LOCATION_SERVICE
("location") - A
LocationManager
for controlling location (e.g., GPS) updates. -
SEARCH_SERVICE
("search") - A
SearchManager
for handling search. -
VIBRATOR_MANAGER_SERVICE
("vibrator_manager") - A
VibratorManager
for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators. -
VIBRATOR_SERVICE
("vibrator") - A
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
UiModeManager
for controlling UI modes. -
DOWNLOAD_SERVICE
("download") - A
DownloadManager
for requesting HTTP downloads -
BATTERY_SERVICE
("batterymanager") - A
BatteryManager
for managing battery state -
JOB_SCHEDULER_SERVICE
("taskmanager") - A
JobScheduler
for managing scheduled tasks -
NETWORK_STATS_SERVICE
("netstats") - A
NetworkStatsManager
for querying network usage statistics. -
HARDWARE_PROPERTIES_SERVICE
("hardware_properties") - A
HardwarePropertiesManager
for accessing hardware properties. -
DOMAIN_VERIFICATION_SERVICE
("domain_verification") - A
DomainVerificationManager
for accessing web domain approval state. -
DISPLAY_HASH_SERVICE
("display_hash") - A
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.
Returns | |
---|---|
Object |
The service or null if the name does not exist. |
getSystemServiceName
public String getSystemServiceName (Class<?> serviceClass)
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 . |
Returns | |
---|---|
String |
The service name or null if the class is not a supported system service. |
getTheme
public Resources.Theme getTheme ()
Return the Theme object associated with this Context.
Returns | |
---|---|
Resources.Theme |
getWallpaper
public Drawable getWallpaper ()
This method is deprecated.
Use WallpaperManager.get()
instead.
Returns | |
---|---|
Drawable |
getWallpaperDesiredMinimumHeight
public int getWallpaperDesiredMinimumHeight ()
This method is deprecated.
Use WallpaperManager.getDesiredMinimumHeight()
instead.
Returns | |
---|---|
int |
getWallpaperDesiredMinimumWidth
public int getWallpaperDesiredMinimumWidth ()
This method is deprecated.
Use WallpaperManager.getDesiredMinimumWidth()
instead.
Returns | |
---|---|
int |
grantUriPermission
public void grantUriPermission (String toPackage, Uri uri, int modeFlags)
Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. 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(Uri, int)
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 Intent.FLAG_GRANT_READ_URI_PERMISSION , Intent.FLAG_GRANT_WRITE_URI_PERMISSION , Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION , and Intent.FLAG_GRANT_PREFIX_URI_PERMISSION |
isDeviceProtectedStorage
public boolean isDeviceProtectedStorage ()
Indicates if the storage APIs of this Context are backed by device-protected storage.
Returns | |
---|---|
boolean |
isRestricted
public boolean isRestricted ()
Indicates whether this Context is restricted.
Returns | |
---|---|
boolean |
true if this Context is restricted, false otherwise. |
moveDatabaseFrom
public boolean moveDatabaseFrom (Context sourceContext, String name)
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. |
Returns | |
---|---|
boolean |
true if the move was successful or if the database didn't
exist in the source context, otherwise false . |
moveSharedPreferencesFrom
public boolean moveSharedPreferencesFrom (Context sourceContext, String name)
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. |
Returns | |
---|---|
boolean |
true if the move was successful or if the shared
preferences didn't exist in the source context, otherwise
false . |
openFileInput
public FileInputStream openFileInput (String name)
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. |
Returns | |
---|---|
FileInputStream |
The resulting FileInputStream . |
Throws | |
---|---|
FileNotFoundException |
openFileOutput
public FileOutputStream openFileOutput (String name, int mode)
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 Context.MODE_PRIVATE , Context.MODE_WORLD_READABLE , Context.MODE_WORLD_WRITEABLE , and Context.MODE_APPEND |
Returns | |
---|---|
FileOutputStream |
The resulting FileOutputStream . |
Throws | |
---|---|
FileNotFoundException |
openOrCreateDatabase
public SQLiteDatabase openOrCreateDatabase (String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)
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 Context.MODE_PRIVATE , Context.MODE_WORLD_READABLE , Context.MODE_WORLD_WRITEABLE , Context.MODE_ENABLE_WRITE_AHEAD_LOGGING , and Context.MODE_NO_LOCALIZED_COLLATORS |
factory |
SQLiteDatabase.CursorFactory : An optional factory class that is called to instantiate a
cursor when query is called. |
errorHandler |
DatabaseErrorHandler : This value may be null . |
Returns | |
---|---|
SQLiteDatabase |
The contents of a newly created database with the given name. |
openOrCreateDatabase
public SQLiteDatabase openOrCreateDatabase (String name, int mode, SQLiteDatabase.CursorFactory factory)
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 Context.MODE_PRIVATE , Context.MODE_WORLD_READABLE , Context.MODE_WORLD_WRITEABLE , Context.MODE_ENABLE_WRITE_AHEAD_LOGGING , and Context.MODE_NO_LOCALIZED_COLLATORS |
factory |
SQLiteDatabase.CursorFactory : An optional factory class that is called to instantiate a
cursor when query is called. |
Returns | |
---|---|
SQLiteDatabase |
The contents of a newly created database with the given name. |
peekWallpaper
public Drawable peekWallpaper ()
This method is deprecated.
Use WallpaperManager.peek()
instead.
Returns | |
---|---|
Drawable |
registerComponentCallbacks
public void registerComponentCallbacks (ComponentCallbacks callback)
Add a new ComponentCallbacks
to the base application of the
Context, which will be called at the same times as the ComponentCallbacks
methods of activities and other components are called. Note that you
must be sure to use unregisterComponentCallbacks(ComponentCallbacks)
when
appropriate in the future; this will not be removed for you.
After Build.VERSION_CODES#TIRAMISU
, the ComponentCallbacks
will be registered
to the base Context
, and can be only used after
attachBaseContext(android.content.Context)
. Users can still call to
getApplicationContext().registerComponentCallbacks(ComponentCallbacks)
to add
ComponentCallbacks
to the base application.
Parameters | |
---|---|
callback |
ComponentCallbacks : The interface to call. This can be either a
ComponentCallbacks or ComponentCallbacks2 interface. |
Throws | |
---|---|
IllegalStateException |
if this method calls before attachBaseContext(android.content.Context) |
registerDeviceIdChangeListener
public void registerDeviceIdChangeListener (Executor executor, IntConsumer listener)
Adds a new device ID changed listener to the Context
, which will be called when
the device association is changed by the system.
The callback can be called when an app is moved to a different device and the Context
is not explicitly associated with a specific device.
When an application receives a device id update callback, this Context is guaranteed to
also have an updated display ID(if any) and Configuration
.
Parameters | |
---|---|
executor |
Executor : This value cannot be null .
Callback and listener events are dispatched through this
Executor , providing an easy way to control which thread is
used. To dispatch events through the main thread of your
application, you can use
Context.getMainExecutor() .
Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
IntConsumer : This value cannot be null . |
registerReceiver
public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter)
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 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 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 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(BroadcastReceiver, IntentFilter)
, since the lifetime of such a
registered BroadcastReceiver is tied to the object that registered it.
Parameters | |
---|---|
receiver |
BroadcastReceiver : This value may be null . |
filter |
IntentFilter : Selects the Intent broadcasts to be received. |
Returns | |
---|---|
Intent |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, int flags)
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 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 Build.VERSION_CODES.ICE_CREAM_SANDWICH
, receivers
registered with this method will correctly respect the
Intent#setPackage(String)
specified for an Intent being broadcast.
Prior to that, it would be ignored and delivered to all matching registered
receivers. Be careful if using this for security.
Parameters | |
---|---|
receiver |
BroadcastReceiver : This value may be null . |
filter |
IntentFilter : Selects the Intent broadcasts to be received. |
flags |
int : Additional options for the receiver. For apps targeting Build.VERSION_CODES.UPSIDE_DOWN_CAKE either Context.RECEIVER_EXPORTED or
Context.RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered
for system
broadcasts or a SecurityException will be thrown. If Context.RECEIVER_EXPORTED is specified, a receiver may additionally specify Context.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 Context.RECEIVER_EXPORTED and Context.RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown.
Value is either 0 or a combination of Context.RECEIVER_VISIBLE_TO_INSTANT_APPS , Context.RECEIVER_EXPORTED , Context.RECEIVER_NOT_EXPORTED , and android.content.Context.RECEIVER_EXPORTED_UNAUDITED |
Returns | |
---|---|
Intent |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)
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 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 Build.VERSION_CODES.ICE_CREAM_SANDWICH
, receivers
registered with this method will correctly respect the
Intent#setPackage(String)
specified for an Intent being broadcast.
Prior to that, it would be ignored and delivered to all matching registered
receivers. Be careful if using this for security.
Parameters | |
---|---|
receiver |
BroadcastReceiver : This value may be null . |
filter |
IntentFilter : Selects the Intent broadcasts to be received. |
broadcastPermission |
String : This value may be null . |
scheduler |
Handler : This value may be null . |
flags |
int : Additional options for the receiver. For apps targeting Build.VERSION_CODES.UPSIDE_DOWN_CAKE either Context.RECEIVER_EXPORTED or
Context.RECEIVER_NOT_EXPORTED must be specified if the receiver isn't being registered
for system
broadcasts or a SecurityException will be thrown. If Context.RECEIVER_EXPORTED is specified, a receiver may additionally specify Context.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 Context.RECEIVER_EXPORTED and Context.RECEIVER_NOT_EXPORTED are specified, an IllegalArgumentException will be thrown.
Value is either 0 or a combination of Context.RECEIVER_VISIBLE_TO_INSTANT_APPS , Context.RECEIVER_EXPORTED , Context.RECEIVER_NOT_EXPORTED , and android.content.Context.RECEIVER_EXPORTED_UNAUDITED |
Returns | |
---|---|
Intent |
The first sticky intent found that matches filter, or null if there are none. |
registerReceiver
public Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
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 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 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 Build.VERSION_CODES.UPSIDE_DOWN_CAKE
,
either RECEIVER_EXPORTED
or RECEIVER_NOT_EXPORTED
must be
specified if the receiver is not being registered for system broadcasts
or a SecurityException
will be thrown. See registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter, java.lang.String, android.os.Handler, int)
to register a
receiver with flags.
Parameters | |
---|---|
receiver |
BroadcastReceiver : This value may be null . |
filter |
IntentFilter : Selects the Intent broadcasts to be received. |
broadcastPermission |
String : This value may be null . |
scheduler |
Handler : This value may be null . |
Returns | |
---|---|
Intent |
The first sticky intent found that matches filter, or null if there are none. |
removeStickyBroadcast
public void removeStickyBroadcast (Intent intent)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Remove the data previously sent with sendStickyBroadcast(Intent)
,
so that it is as if the sticky broadcast had never happened.
Requires Manifest.permission.BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent : The Intent that was previously broadcast. |
removeStickyBroadcastAsUser
public void removeStickyBroadcastAsUser (Intent intent, UserHandle user)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
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 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 Manifest.permission.BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent : The Intent that was previously broadcast. |
user |
UserHandle : UserHandle to remove the sticky broadcast from. |
revokeSelfPermissionsOnKill
public void revokeSelfPermissionsOnKill (Collection<String> permissions)
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 |
Collection : This value cannot be null . |
revokeUriPermission
public void revokeUriPermission (Uri uri, int modeFlags)
Remove all permissions to access a particular content provider Uri
that were previously added with grantUriPermission(String, Uri, int)
or any other mechanism.
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 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
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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
revokeUriPermission
public void revokeUriPermission (String targetPackage, Uri uri, int modeFlags)
Remove permissions to access a particular content provider Uri
that were previously added with grantUriPermission(String, Uri, int)
for a specific target
package. 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(String, Uri, int)
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 | |
---|---|
targetPackage |
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 Intent.FLAG_GRANT_READ_URI_PERMISSION , and Intent.FLAG_GRANT_WRITE_URI_PERMISSION |
sendBroadcast
public void sendBroadcast (Intent intent, String receiverPermission, Bundle options)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an optional required permission to be enforced. This
call is asynchronous; it returns immediately, and you will continue
executing while the receivers are run. No results are propagated from
receivers and receivers can not abort the broadcast. If you want
to allow receivers to propagate results or abort the broadcast, you must
send an ordered broadcast using
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : This value cannot be null . |
receiverPermission |
String : This value may be null . |
options |
Bundle : This value may be null . |
sendBroadcast
public void sendBroadcast (Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an optional required permission to be enforced. This
call is asynchronous; it returns immediately, and you will continue
executing while the receivers are run. No results are propagated from
receivers and receivers can not abort the broadcast. If you want
to allow receivers to propagate results or abort the broadcast, you must
send an ordered broadcast using
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
receiverPermission |
String : This value may be null . |
sendBroadcast
public void sendBroadcast (Intent intent)
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. |
sendBroadcastAsUser
public void sendBroadcastAsUser (Intent intent, UserHandle user)
Version of sendBroadcast(android.content.Intent)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent : The intent to broadcast |
user |
UserHandle : UserHandle to send the intent to. |
sendBroadcastAsUser
public void sendBroadcastAsUser (Intent intent, UserHandle user, String receiverPermission)
Version of sendBroadcast(android.content.Intent, java.lang.String)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
user |
UserHandle : UserHandle to send the intent to. |
receiverPermission |
String : (optional) String naming a permission that
a receiver must hold in order to receive your broadcast.
If null, no permission is required. |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the App Op to enforce restrictions on which receivers
the broadcast will be sent to.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : This value cannot be null . |
receiverPermission |
String : This value may be null . |
receiverAppOp |
String : This value may be null . |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options)
Parameters | |
---|---|
intent |
Intent : This value cannot be null . |
initialCode |
int |
receiverPermission |
String : This value may be null . |
receiverAppOp |
String : This value may be null . |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
options |
Bundle : This value may be null . |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendBroadcast(android.content.Intent)
that allows you to
receive data back from the broadcast. This is accomplished by
supplying your own BroadcastReceiver when calling, which will be
treated as a final receiver at the end of the broadcast -- its
BroadcastReceiver#onReceive
method will be called with
the result values collected from the other receivers. The broadcast will
be serialized in the same way as calling
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is
asynchronous; it will return before
resultReceiver.onReceive() is called.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
This value cannot be null . |
receiverPermission |
String : This value may be null . |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission, Bundle options)
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : This value cannot be null . |
receiverPermission |
String : This value may be null . |
options |
Bundle : This value may be null . |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendBroadcast(android.content.Intent)
that allows you to
receive data back from the broadcast. This is accomplished by
supplying your own BroadcastReceiver when calling, which will be
treated as a final receiver at the end of the broadcast -- its
BroadcastReceiver#onReceive
method will be called with
the result values collected from the other receivers. The broadcast will
be serialized in the same way as calling
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is
asynchronous; it will return before
resultReceiver.onReceive() is called.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : This value cannot be null . |
receiverPermission |
String : This value may be null . |
options |
Bundle : This value may be null . |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver
for more information on Intent broadcasts.
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
receiverPermission |
String : This value may be null . |
sendOrderedBroadcastAsUser
public void sendOrderedBroadcastAsUser (Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
user |
UserHandle : UserHandle to send the intent to. |
receiverPermission |
String : This value may be null . |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
sendStickyBroadcast
public void sendStickyBroadcast (Intent intent)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
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 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
public void sendStickyBroadcast (Intent intent, Bundle options)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Perform a sendBroadcast(android.content.Intent)
that is "sticky," meaning the
Intent you are sending stays around after the broadcast is complete,
so that others can quickly retrieve that data through the return
value of registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
. In
all other ways, this behaves the same as
sendBroadcast(android.content.Intent)
.
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast, and the Intent will be held to
be re-broadcast to future receivers.
This value cannot be null . |
options |
Bundle : (optional) Additional sending options, generated from a
BroadcastOptions .
This value may be null . |
sendStickyBroadcastAsUser
public void sendStickyBroadcastAsUser (Intent intent, UserHandle user)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
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 Manifest.permission.BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast, and the Intent will be held to
be re-broadcast to future receivers. |
user |
UserHandle : UserHandle to send the intent to. |
sendStickyOrderedBroadcast
public void sendStickyOrderedBroadcast (Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Version of sendStickyBroadcast(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. 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 Manifest.permission.BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
sendStickyOrderedBroadcastAsUser
public void sendStickyOrderedBroadcastAsUser (Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method is deprecated.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
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 Manifest.permission.BROADCAST_STICKY
Parameters | |
---|---|
intent |
Intent : The Intent to broadcast; all receivers matching this
Intent will receive the broadcast. |
user |
UserHandle : UserHandle to send the intent to. |
resultReceiver |
BroadcastReceiver : This value may be null . |
scheduler |
Handler : This value may be null . |
initialCode |
int : An initial value for the result code. Often
Activity.RESULT_OK. |
initialData |
String : This value may be null . |
initialExtras |
Bundle : This value may be null . |
setTheme
public void setTheme (int resid)
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 Activity.setContentView(View)
or
LayoutInflater.inflate(int, ViewGroup)
).
Parameters | |
---|---|
resid |
int : The style resource describing the theme. |
setWallpaper
public void setWallpaper (Bitmap bitmap)
This method is deprecated.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
Parameters | |
---|---|
bitmap |
Bitmap |
Throws | |
---|---|
IOException |
setWallpaper
public void setWallpaper (InputStream data)
This method is deprecated.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
Parameters | |
---|---|
data |
InputStream |
Throws | |
---|---|
IOException |
startActivities
public void startActivities (Intent[] intents, Bundle options)
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 |
Intent : An array of Intents to be started. |
options |
Bundle : This value may be null . |
startActivities
public void startActivities (Intent[] intents)
Same as startActivities(android.content.Intent[], android.os.Bundle)
with no options
specified.
Parameters | |
---|---|
intents |
Intent : An array of Intents to be started. |
startActivity
public void startActivity (Intent intent)
Same as startActivity(android.content.Intent, android.os.Bundle)
with no options
specified.
Parameters | |
---|---|
intent |
Intent : The description of the activity to start. |
startActivity
public void startActivity (Intent intent, Bundle options)
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
Activity
Context, then the Intent must include
the Intent#FLAG_ACTIVITY_NEW_TASK
launch flag. This is because,
without being started from an existing Activity, there is no existing
task in which to place the new activity and thus it needs to be placed
in its own separate task.
This method throws ActivityNotFoundException
if there was no Activity found to run the given Intent.
Parameters | |
---|---|
intent |
Intent : The description of the activity to start. |
options |
Bundle : This value may be null . |
startForegroundService
public ComponentName startForegroundService (Intent service)
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 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 Build.VERSION_CODES.S
,
apps targeting SDK Version 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. |
Returns | |
---|---|
ComponentName |
This value may be null . |
startInstrumentation
public boolean startInstrumentation (ComponentName className, String profileFile, Bundle arguments)
Start executing an Instrumentation
class. The given
Instrumentation component will be run by killing its target application
(if currently running), starting the target process, instantiating the
instrumentation component, and then letting it drive the application.
This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.
Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).
Parameters | |
---|---|
className |
ComponentName : Name of the Instrumentation component to be run.
This value cannot be null . |
profileFile |
String : This value may be null . |
arguments |
Bundle : This value may be null . |
Returns | |
---|---|
boolean |
true if the instrumentation was successfully started,
else false if it could not be found. |
startIntentSender
public void startIntentSender (IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
Same as startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle)
with no options specified.
Throws | |
---|---|
IntentSender.SendIntentException |
startIntentSender
public void startIntentSender (IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
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
IntentSender.sendIntent
on it.
Throws | |
---|---|
IntentSender.SendIntentException |
startService
public ComponentName startService (Intent service)
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 Service.onStartCommand(Intent, int, int)
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(Intent, BindServiceFlags, Executor, ServiceConnection)
: it requires the service to remain
running until stopService(Intent)
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(Intent)
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 bound services
for high frequency calls.
Build.VERSION_CODES.O
,
apps targeting SDK Version 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 Build.VERSION_CODES.S
,
apps targeting SDK Version 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. |
Returns | |
---|---|
ComponentName |
This value may be null . |
stopService
public boolean stopService (Intent name)
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 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 | |
---|---|
name |
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. |
Returns | |
---|---|
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. |
unbindService
public void unbindService (ServiceConnection conn)
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. |
unregisterComponentCallbacks
public void unregisterComponentCallbacks (ComponentCallbacks callback)
Remove a ComponentCallbacks
object that was previously registered
with registerComponentCallbacks(android.content.ComponentCallbacks)
.
After Build.VERSION_CODES#TIRAMISU
, the ComponentCallbacks
will be
unregistered to the base Context
, and can be only used after
attachBaseContext(android.content.Context)
Parameters | |
---|---|
callback |
ComponentCallbacks : The interface to call. This can be either a
ComponentCallbacks or ComponentCallbacks2 interface. |
Throws | |
---|---|
IllegalStateException |
if this method calls before attachBaseContext(android.content.Context) |
unregisterDeviceIdChangeListener
public void unregisterDeviceIdChangeListener (IntConsumer listener)
Removes a device ID changed listener from the Context. It's a no-op if the listener is not already registered.
Parameters | |
---|---|
listener |
IntConsumer : This value cannot be null . |
unregisterReceiver
public void unregisterReceiver (BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
Parameters | |
---|---|
receiver |
BroadcastReceiver : The BroadcastReceiver to unregister. |
updateServiceGroup
public void updateServiceGroup (ServiceConnection conn, int group, int importance)
For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection)
or a related method, change
how the system manages that service's process in relation to other processes. 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(Intent, BindServiceFlags, String, Executor, ServiceConnection)
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. |
Protected methods
attachBaseContext
protected void attachBaseContext (Context base)
Set the base context for this ContextWrapper. All calls will then be delegated to the base context. Throws IllegalStateException if a base context has already been set.
Parameters | |
---|---|
base |
Context : The new base context for this wrapper. |