/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.content;

import android.annotation.AttrRes;
import android.annotation.CheckResult;
import android.annotation.ColorInt;
import android.annotation.ColorRes;
import android.annotation.DrawableRes;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.StringDef;
import android.annotation.StringRes;
import android.annotation.StyleRes;
import android.annotation.StyleableRes;
import android.annotation.SystemApi;
import android.annotation.TestApi;
import android.annotation.UserIdInt;
import android.app.ActivityManager;
import android.app.IApplicationThread;
import android.app.IServiceConnection;
import android.app.VrManager;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager;
import android.content.res.AssetManager;
import android.content.res.ColorStateList;
import android.content.res.Configuration;
import android.content.res.Resources;
import android.content.res.TypedArray;
import android.database.DatabaseErrorHandler;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteDatabase.CursorFactory;
import android.graphics.Bitmap;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.os.Build;
import android.os.Bundle;
import android.os.Environment;
import android.os.Handler;
import android.os.HandlerExecutor;
import android.os.IBinder;
import android.os.Looper;
import android.os.StatFs;
import android.os.UserHandle;
import android.os.UserManager;
import android.os.storage.StorageManager;
import android.provider.MediaStore;
import android.util.AttributeSet;
import android.view.Display;
import android.view.DisplayAdjustments;
import android.view.View;
import android.view.ViewDebug;
import android.view.WindowManager;
import android.view.autofill.AutofillManager.AutofillClient;
import android.view.textclassifier.TextClassificationManager;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.concurrent.Executor;

Interface to global information about an application environment. This is an abstract class whose implementation is provided by the Android system. It allows access to application-specific resources and classes, as well as up-calls for application-level operations such as launching activities, broadcasting and receiving intents, etc.
/** * Interface to global information about an application environment. This is * an abstract class whose implementation is provided by * the Android system. It * allows access to application-specific resources and classes, as well as * up-calls for application-level operations such as launching activities, * broadcasting and receiving intents, etc. */
public abstract class Context {
@hide
/** @hide */
@IntDef(flag = true, prefix = { "MODE_" }, value = { MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, MODE_APPEND, }) @Retention(RetentionPolicy.SOURCE) public @interface FileMode {}
@hide
/** @hide */
@IntDef(flag = true, prefix = { "MODE_" }, value = { MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, MODE_MULTI_PROCESS, }) @Retention(RetentionPolicy.SOURCE) public @interface PreferencesMode {}
@hide
/** @hide */
@IntDef(flag = true, prefix = { "MODE_" }, value = { MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_NO_LOCALIZED_COLLATORS, }) @Retention(RetentionPolicy.SOURCE) public @interface DatabaseMode {}
File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID).
/** * File creation mode: the default mode, where the created file can only * be accessed by the calling application (or all applications sharing the * same user ID). */
public static final int MODE_PRIVATE = 0x0000;
File creation mode: allow all other applications to have read access to the created file.

Starting from VERSION_CODES.N, attempting to use this mode throws a SecurityException.

See Also:
Deprecated:Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
/** * File creation mode: allow all other applications to have read access to * the created file. * <p> * Starting from {@link android.os.Build.VERSION_CODES#N}, attempting to use this * mode throws a {@link SecurityException}. * * @deprecated Creating world-readable files is very dangerous, and likely * to cause security holes in applications. It is strongly * discouraged; instead, applications should use more formal * mechanism for interactions such as {@link ContentProvider}, * {@link BroadcastReceiver}, and {@link android.app.Service}. * There are no guarantees that this access mode will remain on * a file, such as when it goes through a backup and restore. * @see android.support.v4.content.FileProvider * @see Intent#FLAG_GRANT_WRITE_URI_PERMISSION */
@Deprecated public static final int MODE_WORLD_READABLE = 0x0001;
File creation mode: allow all other applications to have write access to the created file.

Starting from VERSION_CODES.N, attempting to use this mode will throw a SecurityException.

See Also:
Deprecated:Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as ContentProvider, BroadcastReceiver, and Service. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
/** * File creation mode: allow all other applications to have write access to * the created file. * <p> * Starting from {@link android.os.Build.VERSION_CODES#N}, attempting to use this * mode will throw a {@link SecurityException}. * * @deprecated Creating world-writable files is very dangerous, and likely * to cause security holes in applications. It is strongly * discouraged; instead, applications should use more formal * mechanism for interactions such as {@link ContentProvider}, * {@link BroadcastReceiver}, and {@link android.app.Service}. * There are no guarantees that this access mode will remain on * a file, such as when it goes through a backup and restore. * @see android.support.v4.content.FileProvider * @see Intent#FLAG_GRANT_WRITE_URI_PERMISSION */
@Deprecated public static final int MODE_WORLD_WRITEABLE = 0x0002;
File creation mode: for use with openFileOutput, if the file already exists then write data to the end of the existing file instead of erasing it.
See Also:
/** * File creation mode: for use with {@link #openFileOutput}, if the file * already exists then write data to the end of the existing file * instead of erasing it. * @see #openFileOutput */
public static final int MODE_APPEND = 0x8000;
SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. This behavior is sometimes desired in cases where the application has multiple processes, all writing to the same SharedPreferences file. Generally there are better forms of communication between processes, though.

This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targeting such releases. For applications targeting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.

See Also:
  • getSharedPreferences
Deprecated:MODE_MULTI_PROCESS does not work reliably in some versions of Android, and furthermore does not provide any mechanism for reconciling concurrent modifications across processes. Applications should not attempt to use it. Instead, they should use an explicit cross-process data management approach such as ContentProvider.
/** * SharedPreference loading flag: when set, the file on disk will * be checked for modification even if the shared preferences * instance is already loaded in this process. This behavior is * sometimes desired in cases where the application has multiple * processes, all writing to the same SharedPreferences file. * Generally there are better forms of communication between * processes, though. * * <p>This was the legacy (but undocumented) behavior in and * before Gingerbread (Android 2.3) and this flag is implied when * targeting such releases. For applications targeting SDK * versions <em>greater than</em> Android 2.3, this flag must be * explicitly set if desired. * * @see #getSharedPreferences * * @deprecated MODE_MULTI_PROCESS does not work reliably in * some versions of Android, and furthermore does not provide any * mechanism for reconciling concurrent modifications across * processes. Applications should not attempt to use it. Instead, * they should use an explicit cross-process data management * approach such as {@link android.content.ContentProvider ContentProvider}. */
@Deprecated public static final int MODE_MULTI_PROCESS = 0x0004;
Database open flag: when set, the database is opened with write-ahead logging enabled by default.
See Also:
/** * Database open flag: when set, the database is opened with write-ahead * logging enabled by default. * * @see #openOrCreateDatabase(String, int, CursorFactory) * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler) * @see SQLiteDatabase#enableWriteAheadLogging */
public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING = 0x0008;
Database open flag: when set, the database is opened without support for localized collators.
See Also:
/** * Database open flag: when set, the database is opened without support for * localized collators. * * @see #openOrCreateDatabase(String, int, CursorFactory) * @see #openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler) * @see SQLiteDatabase#NO_LOCALIZED_COLLATORS */
public static final int MODE_NO_LOCALIZED_COLLATORS = 0x0010;
@hide
/** @hide */
@IntDef(flag = true, prefix = { "BIND_" }, value = { BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_NOT_FOREGROUND, BIND_ABOVE_CLIENT, BIND_ALLOW_OOM_MANAGEMENT, BIND_WAIVE_PRIORITY, BIND_IMPORTANT, BIND_ADJUST_WITH_ACTIVITY }) @Retention(RetentionPolicy.SOURCE) public @interface BindServiceFlags {}
Flag for bindService: automatically create the service as long as the binding exists. Note that while this will create the service, its Service.onStartCommand method will still only be called due to an explicit call to startService. Even without that, though, this still provides you with access to the service object while the service is created.

Note that prior to VERSION_CODES.ICE_CREAM_SANDWICH, not supplying this flag would also impact how important the system consider's the target service's process to be. When set, the only way for it to be raised was by binding from a service in which case it will only be important when that activity is in the foreground. Now to achieve this behavior you must explicitly supply the new flag BIND_ADJUST_WITH_ACTIVITY. For compatibility, old applications that don't specify BIND_AUTO_CREATE will automatically have the flags BIND_WAIVE_PRIORITY and BIND_ADJUST_WITH_ACTIVITY set for them in order to achieve the same result.

/** * Flag for {@link #bindService}: automatically create the service as long * as the binding exists. Note that while this will create the service, * its {@link android.app.Service#onStartCommand} * method will still only be called due to an * explicit call to {@link #startService}. Even without that, though, * this still provides you with access to the service object while the * service is created. * * <p>Note that prior to {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, * not supplying this flag would also impact how important the system * consider's the target service's process to be. When set, the only way * for it to be raised was by binding from a service in which case it will * only be important when that activity is in the foreground. Now to * achieve this behavior you must explicitly supply the new flag * {@link #BIND_ADJUST_WITH_ACTIVITY}. For compatibility, old applications * that don't specify {@link #BIND_AUTO_CREATE} will automatically have * the flags {@link #BIND_WAIVE_PRIORITY} and * {@link #BIND_ADJUST_WITH_ACTIVITY} set for them in order to achieve * the same result. */
public static final int BIND_AUTO_CREATE = 0x0001;
Flag for bindService: include debugging help for mismatched calls to unbind. When this flag is set, the callstack of the following unbindService call is retained, to be printed if a later incorrect unbind call is made. Note that doing this requires retaining information about the binding that was made for the lifetime of the app, resulting in a leak -- this should only be used for debugging.
/** * Flag for {@link #bindService}: include debugging help for mismatched * calls to unbind. When this flag is set, the callstack of the following * {@link #unbindService} call is retained, to be printed if a later * incorrect unbind call is made. Note that doing this requires retaining * information about the binding that was made for the lifetime of the app, * resulting in a leak -- this should only be used for debugging. */
public static final int BIND_DEBUG_UNBIND = 0x0002;
Flag for bindService: don't allow this binding to raise the target service's process to the foreground scheduling priority. It will still be raised to at least the same memory priority as the client (so that its process will not be killable in any situation where the client is not killable), but for CPU scheduling purposes it may be left in the background. This only has an impact in the situation where the binding client is a foreground process and the target service is in a background process.
/** * Flag for {@link #bindService}: don't allow this binding to raise * the target service's process to the foreground scheduling priority. * It will still be raised to at least the same memory priority * as the client (so that its process will not be killable in any * situation where the client is not killable), but for CPU scheduling * purposes it may be left in the background. This only has an impact * in the situation where the binding client is a foreground process * and the target service is in a background process. */
public static final int BIND_NOT_FOREGROUND = 0x0004;
Flag for bindService: indicates that the client application binding to this service considers the service to be more important than the app itself. When set, the platform will try to have the out of memory killer kill the app before it kills the service it is bound to, though this is not guaranteed to be the case.
/** * Flag for {@link #bindService}: indicates that the client application * binding to this service considers the service to be more important than * the app itself. When set, the platform will try to have the out of * memory killer kill the app before it kills the service it is bound to, though * this is not guaranteed to be the case. */
public static final int BIND_ABOVE_CLIENT = 0x0008;
Flag for bindService: allow the process hosting the bound service to go through its normal memory management. It will be treated more like a running service, allowing the system to (temporarily) expunge the process if low on memory or for some other whim it may have, and being more aggressive about making it a candidate to be killed (and restarted) if running for a long time.
/** * Flag for {@link #bindService}: allow the process hosting the bound * service to go through its normal memory management. It will be * treated more like a running service, allowing the system to * (temporarily) expunge the process if low on memory or for some other * whim it may have, and being more aggressive about making it a candidate * to be killed (and restarted) if running for a long time. */
public static final int BIND_ALLOW_OOM_MANAGEMENT = 0x0010;
Flag for bindService: don't impact the scheduling or memory management priority of the target service's hosting process. Allows the service's process to be managed on the background LRU list just like a regular application process in the background.
/** * Flag for {@link #bindService}: don't impact the scheduling or * memory management priority of the target service's hosting process. * Allows the service's process to be managed on the background LRU list * just like a regular application process in the background. */
public static final int BIND_WAIVE_PRIORITY = 0x0020;
Flag for bindService: this service is very important to the client, so should be brought to the foreground process level when the client is. Normally a process can only be raised to the visibility level by a client, even if that client is in the foreground.
/** * Flag for {@link #bindService}: this service is very important to * the client, so should be brought to the foreground process level * when the client is. Normally a process can only be raised to the * visibility level by a client, even if that client is in the foreground. */
public static final int BIND_IMPORTANT = 0x0040;
Flag for bindService: If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it.
/** * Flag for {@link #bindService}: If binding from an activity, allow the * target service's process importance to be raised based on whether the * activity is visible to the user, regardless whether another flag is * used to reduce the amount that the client process's overall importance * is used to impact it. */
public static final int BIND_ADJUST_WITH_ACTIVITY = 0x0080;
Flag for bindService: If binding from something better than perceptible, still set the adjust below perceptible. This would be used for bound services that can afford to be evicted when under extreme memory pressure, but should be restarted as soon as possible.
@hide
/** * Flag for {@link #bindService}: If binding from something better than perceptible, * still set the adjust below perceptible. This would be used for bound services that can * afford to be evicted when under extreme memory pressure, but should be restarted as soon * as possible. * @hide */
public static final int BIND_ADJUST_BELOW_PERCEPTIBLE = 0x0100;
@hideFlag for bindService: allows binding to a service provided by an instant app. Note that the caller may not have access to the instant app providing the service which is a violation of the instant app sandbox. This flag is intended ONLY for development/testing and should be used with great care. Only the system is allowed to use this flag.
/** * @hide Flag for {@link #bindService}: allows binding to a service provided * by an instant app. Note that the caller may not have access to the instant * app providing the service which is a violation of the instant app sandbox. * This flag is intended ONLY for development/testing and should be used with * great care. Only the system is allowed to use this flag. */
public static final int BIND_ALLOW_INSTANT = 0x00400000;
@hideFlag for bindService: like BIND_NOT_FOREGROUND, but puts it up in to the important background state (instead of transient).
/** * @hide Flag for {@link #bindService}: like {@link #BIND_NOT_FOREGROUND}, but puts it * up in to the important background state (instead of transient). */
public static final int BIND_IMPORTANT_BACKGROUND = 0x00800000;
@hideFlag for bindService: allows application hosting service to manage whitelists such as temporary allowing a PendingIntent to bypass Power Save mode.
/** * @hide Flag for {@link #bindService}: allows application hosting service to manage whitelists * such as temporary allowing a {@code PendingIntent} to bypass Power Save mode. */
public static final int BIND_ALLOW_WHITELIST_MANAGEMENT = 0x01000000;
@hideFlag for bindService: Like BIND_FOREGROUND_SERVICE, but only applies while the device is awake.
/** * @hide Flag for {@link #bindService}: Like {@link #BIND_FOREGROUND_SERVICE}, * but only applies while the device is awake. */
public static final int BIND_FOREGROUND_SERVICE_WHILE_AWAKE = 0x02000000;
@hideFlag for bindService: For only the case where the binding is coming from the system, set the process state to FOREGROUND_SERVICE instead of the normal maximum of IMPORTANT_FOREGROUND. That is, this is saying that the process shouldn't participate in the normal power reduction modes (removing network access etc).
/** * @hide Flag for {@link #bindService}: For only the case where the binding * is coming from the system, set the process state to FOREGROUND_SERVICE * instead of the normal maximum of IMPORTANT_FOREGROUND. That is, this is * saying that the process shouldn't participate in the normal power reduction * modes (removing network access etc). */
public static final int BIND_FOREGROUND_SERVICE = 0x04000000;
@hideFlag for bindService: Treat the binding as hosting an activity, an unbinding as the activity going in the background. That is, when unbinding, the process when empty will go on the activity LRU list instead of the regular one, keeping it around more aggressively than it otherwise would be. This is intended for use with IMEs to try to keep IME processes around for faster keyboard switching.
/** * @hide Flag for {@link #bindService}: Treat the binding as hosting * an activity, an unbinding as the activity going in the background. * That is, when unbinding, the process when empty will go on the activity * LRU list instead of the regular one, keeping it around more aggressively * than it otherwise would be. This is intended for use with IMEs to try * to keep IME processes around for faster keyboard switching. */
public static final int BIND_TREAT_LIKE_ACTIVITY = 0x08000000;
@hideAn idea that is not yet implemented. Flag for bindService: If binding from an activity, consider this service to be visible like the binding activity is. That is, it will be treated as something more important to keep around than invisible background activities. This will impact the number of recent activities the user can switch between without having them restart. There is no guarantee this will be respected, as the system tries to balance such requests from one app vs. the importantance of keeping other apps around.
/** * @hide An idea that is not yet implemented. * Flag for {@link #bindService}: If binding from an activity, consider * this service to be visible like the binding activity is. That is, * it will be treated as something more important to keep around than * invisible background activities. This will impact the number of * recent activities the user can switch between without having them * restart. There is no guarantee this will be respected, as the system * tries to balance such requests from one app vs. the importantance of * keeping other apps around. */
public static final int BIND_VISIBLE = 0x10000000;
@hide Flag for bindService: Consider this binding to be causing the target process to be showing UI, so it will be do a UI_HIDDEN memory trim when it goes away.
/** * @hide * Flag for {@link #bindService}: Consider this binding to be causing the target * process to be showing UI, so it will be do a UI_HIDDEN memory trim when it goes * away. */
public static final int BIND_SHOWING_UI = 0x20000000;
Flag for bindService: Don't consider the bound service to be visible, even if the caller is visible.
@hide
/** * Flag for {@link #bindService}: Don't consider the bound service to be * visible, even if the caller is visible. * @hide */
public static final int BIND_NOT_VISIBLE = 0x40000000;
Flag for bindService: The service being bound is an isolated, external service. This binds the service into the calling application's package, rather than the package in which the service is declared.

When using this flag, the code for the service being bound will execute under the calling application's package name and user ID. Because the service must be an isolated process, it will not have direct access to the application's data, though. The purpose of this flag is to allow applications to provide services that are attributed to the app using the service, rather than the application providing the service.

/** * Flag for {@link #bindService}: The service being bound is an * {@link android.R.attr#isolatedProcess isolated}, * {@link android.R.attr#externalService external} service. This binds the service into the * calling application's package, rather than the package in which the service is declared. * <p> * When using this flag, the code for the service being bound will execute under the calling * application's package name and user ID. Because the service must be an isolated process, * it will not have direct access to the application's data, though. * * The purpose of this flag is to allow applications to provide services that are attributed * to the app using the service, rather than the application providing the service. * </p> */
public static final int BIND_EXTERNAL_SERVICE = 0x80000000;
@hide
/** @hide */
@IntDef(flag = true, prefix = { "RECEIVER_VISIBLE_" }, value = { RECEIVER_VISIBLE_TO_INSTANT_APPS }) @Retention(RetentionPolicy.SOURCE) public @interface RegisterReceiverFlags {}
Flag for registerReceiver: The receiver can receive broadcasts from Instant Apps.
/** * Flag for {@link #registerReceiver}: The receiver can receive broadcasts from Instant Apps. */
public static final int RECEIVER_VISIBLE_TO_INSTANT_APPS = 0x1;
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.

See Also:
Returns:an AssetManager instance for the application's package
/** * Returns an AssetManager instance for the application's package. * <p> * <strong>Note:</strong> Implementations of this method should return * an AssetManager instance that is consistent with the Resources instance * returned by {@link #getResources()}. For example, they should share the * same {@link Configuration} object. * * @return an AssetManager instance for the application's package * @see #getResources() */
public abstract AssetManager getAssets();
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.

See Also:
Returns:a Resources instance for the application's package
/** * Returns a Resources instance for the application's package. * <p> * <strong>Note:</strong> Implementations of this method should return * a Resources instance that is consistent with the AssetManager instance * returned by {@link #getAssets()}. For example, they should share the * same {@link Configuration} object. * * @return a Resources instance for the application's package * @see #getAssets() */
public abstract Resources getResources();
Return PackageManager instance to find global package information.
/** Return PackageManager instance to find global package information. */
public abstract PackageManager getPackageManager();
Return a ContentResolver instance for your application's package.
/** Return a ContentResolver instance for your application's package. */
public abstract ContentResolver getContentResolver();
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:The main looper.
/** * Return the Looper for the main thread of the current process. This is * the thread used to dispatch calls to application components (activities, * services, etc). * <p> * By definition, this method returns the same result as would be obtained * by calling {@link Looper#getMainLooper() Looper.getMainLooper()}. * </p> * * @return The main looper. */
public abstract Looper getMainLooper();
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).
/** * Return an {@link 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). */
public Executor getMainExecutor() { // This is pretty inefficient, which is why ContextImpl overrides it return new HandlerExecutor(new Handler(getMainLooper())); }
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(BroadcastReceiver, 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.

/** * 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. * * <p>Consider for example how this interacts with * {@link #registerReceiver(BroadcastReceiver, IntentFilter)}: * <ul> * <li> <p>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. * <li> <p>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. * </ul> */
public abstract Context getApplicationContext();
Non-activity related autofill ids are unique in the app
/** Non-activity related autofill ids are unique in the app */
private static int sLastAutofillId = View.NO_ID;
Gets the next autofill ID.

All IDs will be smaller or the same as View.LAST_APP_AUTOFILL_ID. All IDs returned will be unique.

Returns:A ID that is unique in the process {@hide}
/** * Gets the next autofill ID. * * <p>All IDs will be smaller or the same as {@link View#LAST_APP_AUTOFILL_ID}. All IDs * returned will be unique. * * @return A ID that is unique in the process * * {@hide} */
public int getNextAutofillId() { if (sLastAutofillId == View.LAST_APP_AUTOFILL_ID - 1) { sLastAutofillId = View.NO_ID; } sLastAutofillId++; return sLastAutofillId; }
Add a new ComponentCallbacks to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called. Note that you must be sure to use unregisterComponentCallbacks when appropriate in the future; this will not be removed for you.
Params:
/** * Add a new {@link 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 * <em>must</em> be sure to use {@link #unregisterComponentCallbacks} when * appropriate in the future; this will not be removed for you. * * @param callback The interface to call. This can be either a * {@link ComponentCallbacks} or {@link ComponentCallbacks2} interface. */
public void registerComponentCallbacks(ComponentCallbacks callback) { getApplicationContext().registerComponentCallbacks(callback); }
Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(ComponentCallbacks).
/** * Remove a {@link ComponentCallbacks} object that was previously registered * with {@link #registerComponentCallbacks(ComponentCallbacks)}. */
public void unregisterComponentCallbacks(ComponentCallbacks callback) { getApplicationContext().unregisterComponentCallbacks(callback); }
Return a localized, styled CharSequence from the application's package's default string table.
Params:
  • resId – Resource id for the CharSequence text
/** * Return a localized, styled CharSequence from the application's package's * default string table. * * @param resId Resource id for the CharSequence text */
@NonNull public final CharSequence getText(@StringRes int resId) { return getResources().getText(resId); }
Returns a localized string from the application's package's default string table.
Params:
  • resId – Resource id for the string
Returns:The string data associated with the resource, stripped of styled text information.
/** * Returns a localized string from the application's package's * default string table. * * @param resId Resource id for the string * @return The string data associated with the resource, stripped of styled * text information. */
@NonNull public final String getString(@StringRes int resId) { return getResources().getString(resId); }
Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in Formatter and String.format.
Params:
  • resId – Resource id for the format string
  • formatArgs – The format arguments that will be used for substitution.
Returns:The string data associated with the resource, formatted and stripped of styled text information.
/** * Returns a localized formatted string from the application's package's * default string table, substituting the format arguments as defined in * {@link java.util.Formatter} and {@link java.lang.String#format}. * * @param resId Resource id for the format string * @param formatArgs The format arguments that will be used for * substitution. * @return The string data associated with the resource, formatted and * stripped of styled text information. */
@NonNull public final String getString(@StringRes int resId, Object... formatArgs) { return getResources().getString(resId, formatArgs); }
Returns a color associated with a particular resource ID and styled for the current theme.
Params:
  • id – The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Throws:
Returns:A single color value in the form 0xAARRGGBB.
/** * Returns a color associated with a particular resource ID and styled for * the current theme. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @return A single color value in the form 0xAARRGGBB. * @throws android.content.res.Resources.NotFoundException if the given ID * does not exist. */
@ColorInt public final int getColor(@ColorRes int id) { return getResources().getColor(id, getTheme()); }
Returns a drawable object associated with a particular resource ID and styled for the current theme.
Params:
  • id – The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Throws:
Returns:An object that can be used to draw this resource.
/** * Returns a drawable object associated with a particular resource ID and * styled for the current theme. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @return An object that can be used to draw this resource. * @throws android.content.res.Resources.NotFoundException if the given ID * does not exist. */
@Nullable public final Drawable getDrawable(@DrawableRes int id) { return getResources().getDrawable(id, getTheme()); }
Returns a color state list associated with a particular resource ID and styled for the current theme.
Params:
  • id – The desired resource identifier, as generated by the aapt tool. This integer encodes the package, type, and resource entry. The value 0 is an invalid identifier.
Throws:
Returns:A color state list.
/** * Returns a color state list associated with a particular resource ID and * styled for the current theme. * * @param id The desired resource identifier, as generated by the aapt * tool. This integer encodes the package, type, and resource * entry. The value 0 is an invalid identifier. * @return A color state list. * @throws android.content.res.Resources.NotFoundException if the given ID * does not exist. */
@NonNull public final ColorStateList getColorStateList(@ColorRes int id) { return getResources().getColorStateList(id, getTheme()); }
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 or LayoutInflater.inflate).
Params:
  • resid – The style resource describing the theme.
/** * 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 {@link android.app.Activity#setContentView} or * {@link android.view.LayoutInflater#inflate}). * * @param resid The style resource describing the theme. */
public abstract void setTheme(@StyleRes int resid);
@hideNeeded for some internal implementation... not public because you can't assume this actually means anything.
/** @hide Needed for some internal implementation... not public because * you can't assume this actually means anything. */
public int getThemeResId() { return 0; }
Return the Theme object associated with this Context.
/** * Return the Theme object associated with this Context. */
@ViewDebug.ExportedProperty(deepExport = true) public abstract Resources.Theme getTheme();
Retrieve styled attribute information in this Context's theme. See Theme.obtainStyledAttributes(int[]) for more information.
See Also:
/** * Retrieve styled attribute information in this Context's theme. See * {@link android.content.res.Resources.Theme#obtainStyledAttributes(int[])} * for more information. * * @see android.content.res.Resources.Theme#obtainStyledAttributes(int[]) */
public final TypedArray obtainStyledAttributes(@StyleableRes int[] attrs) { return getTheme().obtainStyledAttributes(attrs); }
Retrieve styled attribute information in this Context's theme. See Theme.obtainStyledAttributes(int, int[]) for more information.
See Also:
/** * Retrieve styled attribute information in this Context's theme. See * {@link android.content.res.Resources.Theme#obtainStyledAttributes(int, int[])} * for more information. * * @see android.content.res.Resources.Theme#obtainStyledAttributes(int, int[]) */
public final TypedArray obtainStyledAttributes( @StyleRes int resid, @StyleableRes int[] attrs) throws Resources.NotFoundException { return getTheme().obtainStyledAttributes(resid, attrs); }
Retrieve styled attribute information in this Context's theme. See Theme.obtainStyledAttributes(AttributeSet, int[], int, int) for more information.
See Also:
/** * Retrieve styled attribute information in this Context's theme. See * {@link android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} * for more information. * * @see android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) */
public final TypedArray obtainStyledAttributes( AttributeSet set, @StyleableRes int[] attrs) { return getTheme().obtainStyledAttributes(set, attrs, 0, 0); }
Retrieve styled attribute information in this Context's theme. See Theme.obtainStyledAttributes(AttributeSet, int[], int, int) for more information.
See Also:
/** * Retrieve styled attribute information in this Context's theme. See * {@link android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int)} * for more information. * * @see android.content.res.Resources.Theme#obtainStyledAttributes(AttributeSet, int[], int, int) */
public final TypedArray obtainStyledAttributes( AttributeSet set, @StyleableRes int[] attrs, @AttrRes int defStyleAttr, @StyleRes int defStyleRes) { return getTheme().obtainStyledAttributes( set, attrs, defStyleAttr, defStyleRes); }
Return a class loader you can use to retrieve classes in this package.
/** * Return a class loader you can use to retrieve classes in this package. */
public abstract ClassLoader getClassLoader();
Return the name of this application's package.
/** Return the name of this application's package. */
public abstract String getPackageName();
@hideReturn the name of the base context this context is derived from.
/** @hide Return the name of the base context this context is derived from. */
public abstract String getBasePackageName();
@hideReturn the package name that should be used for app ops calls from this context. This is the same as getBasePackageName() except in cases where system components are loaded into other app processes, in which case this will be the name of the primary package in that process (so that app ops uid verification will work with the name).
/** @hide Return the package name that should be used for app ops calls from * this context. This is the same as {@link #getBasePackageName()} except in * cases where system components are loaded into other app processes, in which * case this will be the name of the primary package in that process (so that app * ops uid verification will work with the name). */
public abstract String getOpPackageName();
Return the full application info for this context's package.
/** Return the full application info for this context's package. */
public abstract ApplicationInfo getApplicationInfo();
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 Path to the resources.
/** * 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. * * <p>Note: this is not generally useful for applications, since they should * not be directly accessing the file system. * * @return String Path to the resources. */
public abstract String getPackageResourcePath();
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 Path to the code and assets.
/** * 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. * * <p>Note: this is not generally useful for applications, since they should * not be directly accessing the file system. * * @return String Path to the code and assets. */
public abstract String getPackageCodePath();
@hide
Deprecated:use getSharedPreferencesPath(String)
/** * @hide * @deprecated use {@link #getSharedPreferencesPath(String)} */
@Deprecated public File getSharedPrefsFile(String name) { return getSharedPreferencesPath(name); }
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 thead-safe.
Params:
  • name – Desired preferences file. 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 (Editor.commit()).
  • mode – Operating mode.
See Also:
Returns:The single SharedPreferences instance that can be used to retrieve and modify the preference values.
/** * 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 thead-safe. * * @param name Desired preferences file. 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 (Editor.commit()). * @param mode Operating mode. * * @return The single {@link SharedPreferences} instance that can be used * to retrieve and modify the preference values. * * @see #MODE_PRIVATE */
public abstract SharedPreferences getSharedPreferences(String name, @PreferencesMode int mode);
Retrieve and hold the contents of the preferences file, 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.
Params:
  • file – Desired preferences file. 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 (Editor.commit()).
  • mode – Operating mode.
See Also:
Returns:The single SharedPreferences instance that can be used to retrieve and modify the preference values.
@removed
/** * Retrieve and hold the contents of the preferences file, 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. * * @param file Desired preferences file. 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 (Editor.commit()). * @param mode Operating mode. * * @return The single {@link SharedPreferences} instance that can be used * to retrieve and modify the preference values. * * @see #getSharedPreferencesPath(String) * @see #MODE_PRIVATE * @removed */
public abstract SharedPreferences getSharedPreferences(File file, @PreferencesMode int mode);
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.
Params:
  • sourceContext – The source context which contains the existing shared preferences to move.
  • name – The name of the shared preferences file.
See Also:
Returns:true if the move was successful or if the shared preferences didn't exist in the source context, otherwise false.
/** * 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. * * @param sourceContext The source context which contains the existing * shared preferences to move. * @param name The name of the shared preferences file. * @return {@code true} if the move was successful or if the shared * preferences didn't exist in the source context, otherwise * {@code false}. * @see #createDeviceProtectedStorageContext() */
public abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name);
Delete an existing shared preferences file.
Params:
  • name – The name (unique in the application package) of the shared preferences file.
See Also:
Returns:true if the shared preferences file was successfully deleted; else false.
/** * Delete an existing shared preferences file. * * @param name The name (unique in the application package) of the shared * preferences file. * @return {@code true} if the shared preferences file was successfully * deleted; else {@code false}. * @see #getSharedPreferences(String, int) */
public abstract boolean deleteSharedPreferences(String name);
@hide
/** @hide */
public abstract void reloadSharedPreferences();
Open a private file associated with this Context's application package for reading.
Params:
  • name – The name of the file to open; can not contain path separators.
See Also:
Returns:The resulting FileInputStream.
/** * Open a private file associated with this Context's application package * for reading. * * @param name The name of the file to open; can not contain path * separators. * * @return The resulting {@link FileInputStream}. * * @see #openFileOutput * @see #fileList * @see #deleteFile * @see java.io.FileInputStream#FileInputStream(String) */
public abstract FileInputStream openFileInput(String name) throws FileNotFoundException;
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.

Params:
  • name – The name of the file to open; can not contain path separators.
  • mode – Operating mode.
See Also:
Returns:The resulting FileOutputStream.
/** * Open a private file associated with this Context's application package * for writing. Creates the file if it doesn't already exist. * <p> * No additional permissions are required for the calling app to read or * write the returned file. * * @param name The name of the file to open; can not contain path * separators. * @param mode Operating mode. * @return The resulting {@link FileOutputStream}. * @see #MODE_APPEND * @see #MODE_PRIVATE * @see #openFileInput * @see #fileList * @see #deleteFile * @see java.io.FileOutputStream#FileOutputStream(String) */
public abstract FileOutputStream openFileOutput(String name, @FileMode int mode) throws FileNotFoundException;
Delete the given private file associated with this Context's application package.
Params:
  • name – The name of the file to delete; can not contain path separators.
See Also:
Returns:true if the file was successfully deleted; else false.
/** * Delete the given private file associated with this Context's * application package. * * @param name The name of the file to delete; can not contain path * separators. * * @return {@code true} if the file was successfully deleted; else * {@code false}. * * @see #openFileInput * @see #openFileOutput * @see #fileList * @see java.io.File#delete() */
public abstract boolean deleteFile(String name);
Returns the absolute path on the filesystem where a file created with openFileOutput is stored.

The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.

Params:
  • name – The name of the file for which you would like to get its path.
See Also:
Returns:An absolute path to the given file.
/** * Returns the absolute path on the filesystem where a file created with * {@link #openFileOutput} is stored. * <p> * 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. * * @param name The name of the file for which you would like to get * its path. * * @return An absolute path to the given file. * * @see #openFileOutput * @see #getFilesDir * @see #getDir */
public abstract File getFileStreamPath(String name);
Returns the absolute path on the filesystem where a file created with getSharedPreferences(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.

Params:
  • name – The name of the shared preferences for which you would like to get a path.
See Also:
Returns:An absolute path to the given file.
@removed
/** * Returns the absolute path on the filesystem where a file created with * {@link #getSharedPreferences(String, int)} is stored. * <p> * 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. * * @param name The name of the shared preferences for which you would like * to get a path. * @return An absolute path to the given file. * @see #getSharedPreferences(String, int) * @removed */
public abstract File getSharedPreferencesPath(String name);
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(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.

See Also:
/** * 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 {@link #getFilesDir()}, * {@link #getCacheDir()}, {@link #getDir(String, int)}, or other storage * APIs on this class. * <p> * 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. * <p> * No additional permissions are required for the calling app to read or * write files under the returned path. * * @see ApplicationInfo#dataDir */
public abstract File getDataDir();
Returns the absolute path to the directory on the filesystem where files created with openFileOutput are stored.

The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.

No additional permissions are required for the calling app to read or write files under the returned path.

See Also:
Returns:The path of the directory holding application files.
/** * Returns the absolute path to the directory on the filesystem where files * created with {@link #openFileOutput} are stored. * <p> * 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. * <p> * No additional permissions are required for the calling app to read or * write files under the returned path. * * @return The path of the directory holding application files. * @see #openFileOutput * @see #getFileStreamPath * @see #getDir */
public abstract File getFilesDir();
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.

See Also:
Returns:The path of the directory holding application files that will not be automatically backed up to remote storage.
/** * Returns the absolute path to the directory on the filesystem similar to * {@link #getFilesDir()}. The difference is that files placed under this * directory will be excluded from automatic backup to remote storage. See * {@link android.app.backup.BackupAgent BackupAgent} for a full discussion * of the automatic backup mechanism in Android. * <p> * 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. * <p> * No additional permissions are required for the calling app to read or * write files under the returned path. * * @return The path of the directory holding application files that will not * be automatically backed up to remote storage. * @see #openFileOutput * @see #getFileStreamPath * @see #getDir * @see android.app.backup.BackupAgent */
public abstract File getNoBackupFilesDir();
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 WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE can write to these files.

If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), it's 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 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, WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE and/or READ_EXTERNAL_STORAGE.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:

{@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java private_file}

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:

{@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java private_picture}
Params:
See Also:
Returns:the absolute path to application-specific directory. May return null if shared storage is not currently available.
/** * 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. * <p> * This is like {@link #getFilesDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * If a shared storage device is emulated (as determined by * {@link Environment#isExternalStorageEmulated(File)}), it's 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 {@link #getFilesDir()}, etc. * <p> * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions * are required to read or write to the returned path; it's always * accessible to the calling app. This only applies to paths generated for * package name of the calling application. To access paths belonging to * other packages, * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required. * <p> * On devices with multiple users (as described by {@link UserManager}), * each user has their own isolated shared storage. Applications only have * access to the shared storage for the user they're running as. * <p> * The returned path may change over time if different shared storage media * is inserted, so only relative paths should be persisted. * <p> * Here is an example of typical code to manipulate a file in an * application's shared storage: * </p> * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java * private_file} * <p> * If you supply a non-null <var>type</var> 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 * {@link android.media.MediaScannerConnection#scanFile(Context, String[], String[], android.media.MediaScannerConnection.OnScanCompletedListener) * MediaScannerConnection.scanFile}. Note that this is not the same as * {@link android.os.Environment#getExternalStoragePublicDirectory * 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 * {@link android.os.Environment#getExternalStoragePublicDirectory * Environment.getExternalStoragePublicDirectory()}, the directory returned * here will be automatically created for you. * <p> * Here is an example of typical code to manipulate a picture in an * application's shared storage and add it to the media database: * </p> * {@sample development/samples/ApiDemos/src/com/example/android/apis/content/ExternalStorage.java * private_picture} * * @param type The type of files directory to return. May be {@code null} * for the root of the files directory or one of the following * constants for a subdirectory: * {@link android.os.Environment#DIRECTORY_MUSIC}, * {@link android.os.Environment#DIRECTORY_PODCASTS}, * {@link android.os.Environment#DIRECTORY_RINGTONES}, * {@link android.os.Environment#DIRECTORY_ALARMS}, * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS}, * {@link android.os.Environment#DIRECTORY_PICTURES}, or * {@link android.os.Environment#DIRECTORY_MOVIES}. * @return the absolute path to application-specific directory. May return * {@code null} if shared storage is not currently available. * @see #getFilesDir * @see #getExternalFilesDirs(String) * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
@Nullable public abstract File getExternalFilesDir(@Nullable 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 WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE can write to these files.

If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), it's 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.

Params:
See Also:
Returns: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(String).
/** * 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. * <p> * This is like {@link #getFilesDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * If a shared storage device is emulated (as determined by * {@link Environment#isExternalStorageEmulated(File)}), it's 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 {@link #getFilesDir()}, etc. * <p> * 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. * <p> * 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 {@link StatFs}. * <p> * 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. * <p> * The returned path may change over time if different shared storage media * is inserted, so only relative paths should be persisted. * * @param type The type of files directory to return. May be {@code null} * for the root of the files directory or one of the following * constants for a subdirectory: * {@link android.os.Environment#DIRECTORY_MUSIC}, * {@link android.os.Environment#DIRECTORY_PODCASTS}, * {@link android.os.Environment#DIRECTORY_RINGTONES}, * {@link android.os.Environment#DIRECTORY_ALARMS}, * {@link android.os.Environment#DIRECTORY_NOTIFICATIONS}, * {@link android.os.Environment#DIRECTORY_PICTURES}, or * {@link android.os.Environment#DIRECTORY_MOVIES}. * @return the absolute paths to application-specific directories. Some * individual paths may be {@code null} if that shared storage is * not currently available. The first path returned is the same as * {@link #getExternalFilesDir(String)}. * @see #getExternalFilesDir(String) * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
public abstract File[] getExternalFilesDirs(String type);
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 WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE can write to these files.

Starting in VERSION_CODES.KITKAT, no permissions are required to read or write to the path that this method returns. However, starting from VERSION_CODES.M, to read the OBB expansion files, you must declare the READ_EXTERNAL_STORAGE.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 VERSION_CODES.N, READ_EXTERNAL_STORAGE.READ_EXTERNAL_STORAGE permission is not required, so don’t ask for this permission at runtime. To handle both cases, your app must first try to read the OBB file, and if it fails, you must request READ_EXTERNAL_STORAGE.READ_EXTERNAL_STORAGE permission at runtime.

The following code snippet shows how to do this:

File obb = new File(obb_filename);
boolean open_failed = false;
try {
    BufferedReader br = new BufferedReader(new FileReader(obb));
    open_failed = false;
    ReadObbFile(br);
} catch (IOException e) {
    open_failed = true;
}
if (open_failed) {
    // request READ_EXTERNAL_STORAGE permission before reading OBB file
    ReadObbFileWithPermission();
}
On devices with multiple users (as described by UserManager), multiple users may share the same OBB storage location. Applications should ensure that multiple instances running under different users don't interfere with each other.
See Also:
Returns:the absolute path to application-specific directory. May return null if shared storage is not currently available.
/** * 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. * <p> * This is like {@link #getFilesDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions * are required to read or write to the path that this method returns. * However, starting from {@link android.os.Build.VERSION_CODES#M}, * to read the OBB expansion files, you must declare the * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission in the app manifest and ask for * permission at runtime as follows: * </p> * <p> * {@code <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" * android:maxSdkVersion="23" />} * </p> * <p> * Starting from {@link android.os.Build.VERSION_CODES#N}, * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} * permission is not required, so don’t ask for this * permission at runtime. To handle both cases, your app must first try to read the OBB file, * and if it fails, you must request * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} permission at runtime. * </p> * * <p> * The following code snippet shows how to do this: * </p> * * <pre> * 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(); * } * </pre> * * On devices with multiple users (as described by {@link UserManager}), * multiple users may share the same OBB storage location. Applications * should ensure that multiple instances running under different users don't * interfere with each other. * * @return the absolute path to application-specific directory. May return * {@code null} if shared storage is not currently available. * @see #getObbDirs() * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
public abstract File getObbDir();
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 WRITE_EXTERNAL_STORAGE.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.

See Also:
Returns: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()
/** * 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. * <p> * This is like {@link #getFilesDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * 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. * <p> * 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 {@link StatFs}. * <p> * No additional permissions are required for the calling app to read or * write files under the returned path. Write access outside of these paths * on secondary external storage devices is not available. * * @return the absolute paths to application-specific directories. Some * individual paths may be {@code null} if that shared storage is * not currently available. The first path returned is the same as * {@link #getObbDir()} * @see #getObbDir() * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
public abstract File[] getObbDirs();
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(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.

See Also:
Returns:The path of the directory holding application cache files.
/** * Returns the absolute path to the application specific cache directory on * the filesystem. * <p> * 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 {@link File#lastModified()}. If * desired, you can exert more control over how files are deleted using * {@link StorageManager#setCacheBehaviorGroup(File, boolean)} and * {@link StorageManager#setCacheBehaviorTombstone(File, boolean)}. * <p> * Apps are strongly encouraged to keep their usage of cache space below the * quota returned by * {@link 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. * <p> * 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. * <p> * 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. * <p> * Apps require no extra permissions to read or write to the returned path, * since this path lives in their private storage. * * @return The path of the directory holding application cache files. * @see #openFileOutput * @see #getFileStreamPath * @see #getDir * @see #getExternalCacheDir */
public abstract File getCacheDir();
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:The path of the directory holding application code cache files.
/** * Returns the absolute path to the application specific cache directory on * the filesystem designed for storing cached code. * <p> * The system will delete any files stored in this location both when your * specific application is upgraded, and when the entire platform is * upgraded. * <p> * This location is optimal for storing compiled or optimized code generated * by your application at runtime. * <p> * 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. * <p> * Apps require no extra permissions to read or write to the returned path, * since this path lives in their private storage. * * @return The path of the directory holding application code cache files. */
public abstract File getCodeCacheDir();
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 VERSION_CODES.JELLY_BEAN_MR1 or later and Environment.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 WRITE_EXTERNAL_STORAGE.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 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, WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE and/or READ_EXTERNAL_STORAGE.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.

See Also:
Returns:the absolute path to application-specific directory. May return null if shared storage is not currently available.
/** * 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. * <p> * This is like {@link #getCacheDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>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 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and * {@link Environment#isExternalStorageEmulated(File)} returns true. * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * If a shared storage device is emulated (as determined by * {@link 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 * {@link #getCacheDir()}. * <p> * Starting in {@link android.os.Build.VERSION_CODES#KITKAT}, no permissions * are required to read or write to the returned path; it's always * accessible to the calling app. This only applies to paths generated for * package name of the calling application. To access paths belonging to * other packages, * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} and/or * {@link android.Manifest.permission#READ_EXTERNAL_STORAGE} are required. * <p> * On devices with multiple users (as described by {@link UserManager}), * each user has their own isolated shared storage. Applications only have * access to the shared storage for the user they're running as. * <p> * The returned path may change over time if different shared storage media * is inserted, so only relative paths should be persisted. * * @return the absolute path to application-specific directory. May return * {@code null} if shared storage is not currently available. * @see #getCacheDir * @see #getExternalCacheDirs() * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
@Nullable public abstract File getExternalCacheDir();
Returns absolute path to application-specific directory in the preloaded cache.

Files stored in the cache directory can be deleted when the device runs low on storage. There is no guarantee when these files will be deleted.

@hide
/** * Returns absolute path to application-specific directory in the preloaded cache. * <p>Files stored in the cache directory can be deleted when the device runs low on storage. * There is no guarantee when these files will be deleted. * @hide */
@Nullable @SystemApi public abstract File getPreloadsFileCache();
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 VERSION_CODES.JELLY_BEAN_MR1 or later and Environment.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 WRITE_EXTERNAL_STORAGE.WRITE_EXTERNAL_STORAGE can write to these files.

If a shared storage device is emulated (as determined by Environment.isExternalStorageEmulated(File)), it's 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.

See Also:
Returns: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().
/** * 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. * <p> * This is like {@link #getCacheDir()} in that these files will be deleted * when the application is uninstalled, however there are some important * differences: * <ul> * <li>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 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} or later and * {@link Environment#isExternalStorageEmulated(File)} returns true. * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * If a shared storage device is emulated (as determined by * {@link Environment#isExternalStorageEmulated(File)}), it's 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 * {@link #getCacheDir()}. * <p> * 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. * <p> * 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 {@link StatFs}. * <p> * 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. * <p> * The returned paths may change over time if different shared storage media * is inserted, so only relative paths should be persisted. * * @return the absolute paths to application-specific directories. Some * individual paths may be {@code null} if that shared storage is * not currently available. The first path returned is the same as * {@link #getExternalCacheDir()}. * @see #getExternalCacheDir() * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
public abstract File[] getExternalCacheDirs();
Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place media files. These files are scanned and made available to other apps through MediaStore.

This is like getExternalFilesDirs in that these files will be deleted when the application is uninstalled, however there are some important differences:

  • Shared storage may not always be available, since removable media can be ejected by the user. Media state can be checked using Environment.getExternalStorageState(File).
  • There is no security enforced with these files. For example, any application holding WRITE_EXTERNAL_STORAGE.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.

See Also:
Returns:the absolute paths to application-specific directories. Some individual paths may be null if that shared storage is not currently available.
/** * 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 * {@link MediaStore}. * <p> * This is like {@link #getExternalFilesDirs} in that these files will be * deleted when the application is uninstalled, however there are some * important differences: * <ul> * <li>Shared storage may not always be available, since removable media can * be ejected by the user. Media state can be checked using * {@link Environment#getExternalStorageState(File)}. * <li>There is no security enforced with these files. For example, any * application holding * {@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE} can write to * these files. * </ul> * <p> * 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. * <p> * 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 {@link StatFs}. * <p> * 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. * <p> * The returned paths may change over time if different shared storage media * is inserted, so only relative paths should be persisted. * * @return the absolute paths to application-specific directories. Some * individual paths may be {@code null} if that shared storage is * not currently available. * @see Environment#getExternalStorageState(File) * @see Environment#isExternalStorageEmulated(File) * @see Environment#isExternalStorageRemovable(File) */
public abstract File[] getExternalMediaDirs();
Returns an array of strings naming the private files associated with this Context's application package.
See Also:
Returns:Array of strings naming the private files.
/** * Returns an array of strings naming the private files associated with * this Context's application package. * * @return Array of strings naming the private files. * * @see #openFileInput * @see #openFileOutput * @see #deleteFile */
public abstract String[] fileList();
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.

Params:
  • name – Name of the directory to retrieve. This is a directory that is created as part of your application data.
  • mode – Operating mode.
See Also:
Returns:A File object for the requested directory. The directory will have been created if it does not already exist.
/** * 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. * <p> * 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. * <p> * Apps require no extra permissions to read or write to the returned path, * since this path lives in their private storage. * * @param name Name of the directory to retrieve. This is a directory * that is created as part of your application data. * @param mode Operating mode. * * @return A {@link File} object for the requested directory. The directory * will have been created if it does not already exist. * * @see #openFileOutput(String, int) */
public abstract File getDir(String name, @FileMode int mode);
Open a new private SQLiteDatabase associated with this Context's application package. Create the database file if it doesn't exist.
Params:
  • name – The name (unique in the application package) of the database.
  • mode – Operating mode.
  • factory – An optional factory class that is called to instantiate a cursor when query is called.
Throws:
See Also:
Returns:The contents of a newly created database with the given name.
/** * Open a new private SQLiteDatabase associated with this Context's * application package. Create the database file if it doesn't exist. * * @param name The name (unique in the application package) of the database. * @param mode Operating mode. * @param factory An optional factory class that is called to instantiate a * cursor when query is called. * @return The contents of a newly created database with the given name. * @throws android.database.sqlite.SQLiteException if the database file * could not be opened. * @see #MODE_PRIVATE * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING * @see #MODE_NO_LOCALIZED_COLLATORS * @see #deleteDatabase */
public abstract SQLiteDatabase openOrCreateDatabase(String name, @DatabaseMode int mode, CursorFactory factory);
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.

Params:
  • name – The name (unique in the application package) of the database.
  • mode – Operating mode.
  • factory – An optional factory class that is called to instantiate a cursor when query is called.
  • errorHandler – the DatabaseErrorHandler to be used when sqlite reports database corruption. if null, DefaultDatabaseErrorHandler is assumed.
Throws:
See Also:
Returns:The contents of a newly created database with the given name.
/** * Open a new private SQLiteDatabase associated with this Context's * application package. Creates the database file if it doesn't exist. * <p> * Accepts input param: a concrete instance of {@link DatabaseErrorHandler} * to be used to handle corruption when sqlite reports database corruption. * </p> * * @param name The name (unique in the application package) of the database. * @param mode Operating mode. * @param factory An optional factory class that is called to instantiate a * cursor when query is called. * @param errorHandler the {@link DatabaseErrorHandler} to be used when * sqlite reports database corruption. if null, * {@link android.database.DefaultDatabaseErrorHandler} is * assumed. * @return The contents of a newly created database with the given name. * @throws android.database.sqlite.SQLiteException if the database file * could not be opened. * @see #MODE_PRIVATE * @see #MODE_ENABLE_WRITE_AHEAD_LOGGING * @see #MODE_NO_LOCALIZED_COLLATORS * @see #deleteDatabase */
public abstract SQLiteDatabase openOrCreateDatabase(String name, @DatabaseMode int mode, CursorFactory factory, @Nullable DatabaseErrorHandler errorHandler);
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.

Params:
  • sourceContext – The source context which contains the existing database to move.
  • name – The name of the database file.
See Also:
Returns:true if the move was successful or if the database didn't exist in the source context, otherwise false.
/** * 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. * <p> * The database must be closed before being moved. * * @param sourceContext The source context which contains the existing * database to move. * @param name The name of the database file. * @return {@code true} if the move was successful or if the database didn't * exist in the source context, otherwise {@code false}. * @see #createDeviceProtectedStorageContext() */
public abstract boolean moveDatabaseFrom(Context sourceContext, String name);
Delete an existing private SQLiteDatabase associated with this Context's application package.
Params:
  • name – The name (unique in the application package) of the database.
See Also:
Returns:true if the database was successfully deleted; else false.
/** * Delete an existing private SQLiteDatabase associated with this Context's * application package. * * @param name The name (unique in the application package) of the * database. * * @return {@code true} if the database was successfully deleted; else {@code false}. * * @see #openOrCreateDatabase */
public abstract boolean deleteDatabase(String name);
Returns the absolute path on the filesystem where a database created with openOrCreateDatabase is stored.

The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.

Params:
  • name – The name of the database for which you would like to get its path.
See Also:
Returns:An absolute path to the given database.
/** * Returns the absolute path on the filesystem where a database created with * {@link #openOrCreateDatabase} is stored. * <p> * 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. * * @param name The name of the database for which you would like to get * its path. * * @return An absolute path to the given database. * * @see #openOrCreateDatabase */
public abstract File getDatabasePath(String name);
Returns an array of strings naming the private databases associated with this Context's application package.
See Also:
Returns:Array of strings naming the private databases.
/** * Returns an array of strings naming the private databases associated with * this Context's application package. * * @return Array of strings naming the private databases. * * @see #openOrCreateDatabase * @see #deleteDatabase */
public abstract String[] databaseList();
Deprecated:Use WallpaperManager.get() instead.
/** * @deprecated Use {@link android.app.WallpaperManager#getDrawable * WallpaperManager.get()} instead. */
@Deprecated public abstract Drawable getWallpaper();
Deprecated:Use WallpaperManager.peek() instead.
/** * @deprecated Use {@link android.app.WallpaperManager#peekDrawable * WallpaperManager.peek()} instead. */
@Deprecated public abstract Drawable peekWallpaper();
Deprecated:Use WallpaperManager.getDesiredMinimumWidth() instead.
/** * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumWidth() * WallpaperManager.getDesiredMinimumWidth()} instead. */
@Deprecated public abstract int getWallpaperDesiredMinimumWidth();
Deprecated:Use WallpaperManager.getDesiredMinimumHeight() instead.
/** * @deprecated Use {@link android.app.WallpaperManager#getDesiredMinimumHeight() * WallpaperManager.getDesiredMinimumHeight()} instead. */
@Deprecated public abstract int getWallpaperDesiredMinimumHeight();
Deprecated:Use WallpaperManager.set() instead.

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

/** * @deprecated Use {@link android.app.WallpaperManager#setBitmap(Bitmap) * WallpaperManager.set()} instead. * <p>This method requires the caller to hold the permission * {@link android.Manifest.permission#SET_WALLPAPER}. */
@Deprecated public abstract void setWallpaper(Bitmap bitmap) throws IOException;
Deprecated:Use WallpaperManager.set() instead.

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

/** * @deprecated Use {@link android.app.WallpaperManager#setStream(InputStream) * WallpaperManager.set()} instead. * <p>This method requires the caller to hold the permission * {@link android.Manifest.permission#SET_WALLPAPER}. */
@Deprecated public abstract void setWallpaper(InputStream data) throws IOException;
Deprecated:Use WallpaperManager.clear() instead.

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

/** * @deprecated Use {@link android.app.WallpaperManager#clear * WallpaperManager.clear()} instead. * <p>This method requires the caller to hold the permission * {@link android.Manifest.permission#SET_WALLPAPER}. */
@Deprecated public abstract void clearWallpaper() throws IOException;
Same as startActivity(Intent, Bundle) with no options specified.
Params:
  • intent – The description of the activity to start.
Throws:
See Also:
/** * Same as {@link #startActivity(Intent, Bundle)} with no options * specified. * * @param intent The description of the activity to start. * * @throws ActivityNotFoundException &nbsp; *` * @see #startActivity(Intent, Bundle) * @see PackageManager#resolveActivity */
public abstract void startActivity(@RequiresPermission Intent intent);
Version of startActivity(Intent) that allows you to specify the user the activity will be started for. This is not available to applications that are not pre-installed on the system image.
Params:
  • intent – The description of the activity to start.
  • user – The UserHandle of the user to start this activity for.
Throws:
@hide
/** * Version of {@link #startActivity(Intent)} that allows you to specify the * user the activity will be started for. This is not available to applications * that are not pre-installed on the system image. * @param intent The description of the activity to start. * @param user The UserHandle of the user to start this activity for. * @throws ActivityNotFoundException &nbsp; * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL) public void startActivityAsUser(@RequiresPermission Intent intent, UserHandle user) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
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.

Params:
  • intent – The description of the activity to start.
  • options – Additional options for how the Activity should be started. May be null if there are no options. See ActivityOptions for how to build the Bundle supplied here; there are no supported definitions for building it manually.
Throws:
See Also:
/** * Launch a new activity. You will not receive any information about when * the activity exits. * * <p>Note that if this method is being called from outside of an * {@link android.app.Activity} Context, then the Intent must include * the {@link 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. * * <p>This method throws {@link ActivityNotFoundException} * if there was no Activity found to run the given Intent. * * @param intent The description of the activity to start. * @param options Additional options for how the Activity should be started. * May be null if there are no options. See {@link android.app.ActivityOptions} * for how to build the Bundle supplied here; there are no supported definitions * for building it manually. * * @throws ActivityNotFoundException &nbsp; * * @see #startActivity(Intent) * @see PackageManager#resolveActivity */
public abstract void startActivity(@RequiresPermission Intent intent, @Nullable Bundle options);
Version of startActivity(Intent, Bundle) that allows you to specify the user the activity will be started for. This is not available to applications that are not pre-installed on the system image.
Params:
  • intent – The description of the activity to start.
  • options – Additional options for how the Activity should be started. May be null if there are no options. See ActivityOptions for how to build the Bundle supplied here; there are no supported definitions for building it manually.
  • userId – The UserHandle of the user to start this activity for.
Throws:
@hide
/** * Version of {@link #startActivity(Intent, Bundle)} that allows you to specify the * user the activity will be started for. This is not available to applications * that are not pre-installed on the system image. * @param intent The description of the activity to start. * @param options Additional options for how the Activity should be started. * May be null if there are no options. See {@link android.app.ActivityOptions} * for how to build the Bundle supplied here; there are no supported definitions * for building it manually. * @param userId The UserHandle of the user to start this activity for. * @throws ActivityNotFoundException &nbsp; * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL) public void startActivityAsUser(@RequiresPermission Intent intent, @Nullable Bundle options, UserHandle userId) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
Version of startActivity(Intent, Bundle) that returns a result to the caller. This is only supported for Views and Fragments.
Params:
  • who – The identifier for the calling element that will receive the result.
  • intent – The intent to start.
  • requestCode – The code that will be returned with onActivityResult() identifying this request.
  • options – Additional options for how the Activity should be started. May be null if there are no options. See ActivityOptions for how to build the Bundle supplied here; there are no supported definitions for building it manually.
@hide
/** * Version of {@link #startActivity(Intent, Bundle)} that returns a result to the caller. This * is only supported for Views and Fragments. * @param who The identifier for the calling element that will receive the result. * @param intent The intent to start. * @param requestCode The code that will be returned with onActivityResult() identifying this * request. * @param options Additional options for how the Activity should be started. * May be null if there are no options. See {@link android.app.ActivityOptions} * for how to build the Bundle supplied here; there are no supported definitions * for building it manually. * @hide */
public void startActivityForResult( @NonNull String who, Intent intent, int requestCode, @Nullable Bundle options) { throw new RuntimeException("This method is only implemented for Activity-based Contexts. " + "Check canStartActivityForResult() before calling."); }
Identifies whether this Context instance will be able to process calls to startActivityForResult(String, Intent, int, Bundle).
@hide
/** * Identifies whether this Context instance will be able to process calls to * {@link #startActivityForResult(String, Intent, int, Bundle)}. * @hide */
public boolean canStartActivityForResult() { return false; }
Same as startActivities(Intent[], Bundle) with no options specified.
Params:
  • intents – An array of Intents to be started.
Throws:
See Also:
/** * Same as {@link #startActivities(Intent[], Bundle)} with no options * specified. * * @param intents An array of Intents to be started. * * @throws ActivityNotFoundException &nbsp; * * @see #startActivities(Intent[], Bundle) * @see PackageManager#resolveActivity */
public abstract void startActivities(@RequiresPermission Intent[] intents);
Launch multiple new activities. This is generally the same as calling startActivity(Intent) for the first Intent in the array, that activity during its creation calling startActivity(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.

Params:
  • intents – An array of Intents to be started.
  • options – Additional options for how the Activity should be started. See startActivity(Intent, Bundle) Context.startActivity(Intent, Bundle)} for more details.
Throws:
See Also:
/** * Launch multiple new activities. This is generally the same as calling * {@link #startActivity(Intent)} for the first Intent in the array, * that activity during its creation calling {@link #startActivity(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). * * <p>This method throws {@link ActivityNotFoundException} * if there was no Activity found for <em>any</em> 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. * * @param intents An array of Intents to be started. * @param options Additional options for how the Activity should be started. * See {@link android.content.Context#startActivity(Intent, Bundle)} * Context.startActivity(Intent, Bundle)} for more details. * * @throws ActivityNotFoundException &nbsp; * * @see #startActivities(Intent[]) * @see PackageManager#resolveActivity */
public abstract void startActivities(@RequiresPermission Intent[] intents, Bundle options);
Params:
  • intents – An array of Intents to be started.
  • options – Additional options for how the Activity should be started.
  • userHandle – The user for whom to launch the activities See startActivity(Intent, Bundle) Context.startActivity(Intent, Bundle)} for more details.
Throws:
See Also:
@hide Launch multiple new activities. This is generally the same as calling startActivity(Intent) for the first Intent in the array, that activity during its creation calling startActivity(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.

Returns:The corresponding flag ActivityManager.START_CANCELED, ActivityManager.START_SUCCESS etc. indicating whether the launch was successful.
/** * @hide * Launch multiple new activities. This is generally the same as calling * {@link #startActivity(Intent)} for the first Intent in the array, * that activity during its creation calling {@link #startActivity(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). * * <p>This method throws {@link ActivityNotFoundException} * if there was no Activity found for <em>any</em> 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. * * @param intents An array of Intents to be started. * @param options Additional options for how the Activity should be started. * @param userHandle The user for whom to launch the activities * See {@link android.content.Context#startActivity(Intent, Bundle)} * Context.startActivity(Intent, Bundle)} for more details. * * @return The corresponding flag {@link ActivityManager#START_CANCELED}, * {@link ActivityManager#START_SUCCESS} etc. indicating whether the launch was * successful. * * @throws ActivityNotFoundException &nbsp; * * @see #startActivities(Intent[]) * @see PackageManager#resolveActivity */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL) public int startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
Params:
  • intent – The IntentSender to launch.
  • fillInIntent – If non-null, this will be provided as the intent parameter to IntentSender.sendIntent.
  • flagsMask – Intent flags in the original IntentSender that you would like to change.
  • flagsValues – Desired values for any bits set in flagsMask
  • extraFlags – Always set to 0.
See Also:
/** * Same as {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)} * with no options specified. * * @param intent The IntentSender to launch. * @param fillInIntent If non-null, this will be provided as the * intent parameter to {@link IntentSender#sendIntent}. * @param flagsMask Intent flags in the original IntentSender that you * would like to change. * @param flagsValues Desired values for any bits set in * <var>flagsMask</var> * @param extraFlags Always set to 0. * * @see #startActivity(Intent) * @see #startIntentSender(IntentSender, Intent, int, int, int, Bundle) */
public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent, @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues, int extraFlags) throws IntentSender.SendIntentException;
Like startActivity(Intent, 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(Intent) here; otherwise, its associated action will be executed (such as sending a broadcast) as if you had called IntentSender.sendIntent on it.
Params:
  • intent – The IntentSender to launch.
  • fillInIntent – If non-null, this will be provided as the intent parameter to IntentSender.sendIntent.
  • flagsMask – Intent flags in the original IntentSender that you would like to change.
  • flagsValues – Desired values for any bits set in flagsMask
  • extraFlags – Always set to 0.
  • options – Additional options for how the Activity should be started. See startActivity(Intent, Bundle) Context.startActivity(Intent, Bundle)} for more details. If options have also been supplied by the IntentSender, options given here will override any that conflict with those given by the IntentSender.
See Also:
/** * Like {@link #startActivity(Intent, 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 {@link #startActivity(Intent)} * here; otherwise, its associated action will be executed (such as * sending a broadcast) as if you had called * {@link IntentSender#sendIntent IntentSender.sendIntent} on it. * * @param intent The IntentSender to launch. * @param fillInIntent If non-null, this will be provided as the * intent parameter to {@link IntentSender#sendIntent}. * @param flagsMask Intent flags in the original IntentSender that you * would like to change. * @param flagsValues Desired values for any bits set in * <var>flagsMask</var> * @param extraFlags Always set to 0. * @param options Additional options for how the Activity should be started. * See {@link android.content.Context#startActivity(Intent, Bundle)} * Context.startActivity(Intent, Bundle)} for more details. If options * have also been supplied by the IntentSender, options given here will * override any that conflict with those given by the IntentSender. * * @see #startActivity(Intent, Bundle) * @see #startIntentSender(IntentSender, Intent, int, int, int) */
public abstract void startIntentSender(IntentSender intent, @Nullable Intent fillInIntent, @Intent.MutableFlags int flagsMask, @Intent.MutableFlags int flagsValues, int extraFlags, @Nullable Bundle options) throws IntentSender.SendIntentException;
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(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
See Also:
/** * 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) */
public abstract void sendBroadcast(@RequiresPermission Intent intent);
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(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermission – (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.
See Also:
/** * 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermission (optional) String naming a permission that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent) * @see #sendOrderedBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) */
public abstract void sendBroadcast(@RequiresPermission Intent intent, @Nullable String receiverPermission);
Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermissions – Array of names of permissions that a receiver must hold in order to receive your broadcast. If null or empty, no permissions are required.
See Also:
@hide
/** * Broadcast the given intent to all interested BroadcastReceivers, allowing * an array of required permissions to be enforced. This call is asynchronous; it returns * immediately, and you will continue executing while the receivers are run. No results are * propagated from receivers and receivers can not abort the broadcast. If you want to allow * receivers to propagate results or abort the broadcast, you must send an ordered broadcast * using {@link #sendOrderedBroadcast(Intent, String)}. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermissions Array of names of permissions that a receiver must hold * in order to receive your broadcast. * If null or empty, no permissions are required. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent) * @see #sendOrderedBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) * @hide */
public abstract void sendBroadcastMultiplePermissions(Intent intent, String[] receiverPermissions);
Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run. No results are propagated from receivers and receivers can not abort the broadcast. If you want to allow receivers to propagate results or abort the broadcast, you must send an ordered broadcast using sendOrderedBroadcast(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – The user to send the broadcast to.
  • receiverPermissions – Array of names of permissions that a receiver must hold in order to receive your broadcast. If null or empty, no permissions are required.
See Also:
@hide
/** * Broadcast the given intent to all interested BroadcastReceivers, allowing * an array of required permissions to be enforced. This call is asynchronous; it returns * immediately, and you will continue executing while the receivers are run. No results are * propagated from receivers and receivers can not abort the broadcast. If you want to allow * receivers to propagate results or abort the broadcast, you must send an ordered broadcast * using {@link #sendOrderedBroadcast(Intent, String)}. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user The user to send the broadcast to. * @param receiverPermissions Array of names of permissions that a receiver must hold * in order to receive your broadcast. * If null or empty, no permissions are required. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent) * @see #sendOrderedBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) * @hide */
public abstract void sendBroadcastAsUserMultiplePermissions(Intent intent, UserHandle user, String[] receiverPermissions);
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(Intent, String).

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermission – (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • options – (optional) Additional sending options, generated from a BroadcastOptions.
See Also:
@hide
/** * 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermission (optional) String naming a permission that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param options (optional) Additional sending options, generated from a * {@link android.app.BroadcastOptions}. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent) * @see #sendOrderedBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) * @hide */
@SystemApi public abstract void sendBroadcast(Intent intent, @Nullable String receiverPermission, @Nullable Bundle options);
Like sendBroadcast(Intent, String), but also allows specification of an associated app op as per AppOpsManager.
@hide
/** * Like {@link #sendBroadcast(Intent, String)}, but also allows specification * of an associated app op as per {@link android.app.AppOpsManager}. * @hide */
public abstract void sendBroadcast(Intent intent, String receiverPermission, int appOp);
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.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermission – (optional) String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.
See Also:
/** * 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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermission (optional) String naming a permissions that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * * @see android.content.BroadcastReceiver * @see #registerReceiver * @see #sendBroadcast(Intent) * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) */
public abstract void sendOrderedBroadcast(@RequiresPermission Intent intent, @Nullable String receiverPermission);
Version of sendBroadcast(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(Intent, String).

Like sendBroadcast(Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermission – String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • resultReceiver – Your own BroadcastReceiver to treat as the final receiver of the broadcast.
  • scheduler – A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
  • initialCode – An initial value for the result code. Often Activity.RESULT_OK.
  • initialData – An initial value for the result data. Often null.
  • initialExtras – An initial value for the result extras. Often null.
See Also:
/** * Version of {@link #sendBroadcast(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 * {@link 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>Like {@link #sendBroadcast(Intent)}, this method is * asynchronous; it will return before * resultReceiver.onReceive() is called. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermission String naming a permissions that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param resultReceiver Your own BroadcastReceiver to treat as the final * receiver of the broadcast. * @param scheduler A custom Handler with which to schedule the * resultReceiver callback; if null it will be * scheduled in the Context's main thread. * @param initialCode An initial value for the result code. Often * Activity.RESULT_OK. * @param initialData An initial value for the result data. Often * null. * @param initialExtras An initial value for the result extras. Often * null. * * @see #sendBroadcast(Intent) * @see #sendBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String) * @see android.content.BroadcastReceiver * @see #registerReceiver * @see android.app.Activity#RESULT_OK */
public abstract void sendOrderedBroadcast(@RequiresPermission @NonNull Intent intent, @Nullable String receiverPermission, @Nullable BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
Version of sendBroadcast(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(Intent, String).

Like sendBroadcast(Intent), this method is asynchronous; it will return before resultReceiver.onReceive() is called.

See BroadcastReceiver for more information on Intent broadcasts.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • receiverPermission – String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • options – (optional) Additional sending options, generated from a BroadcastOptions.
  • resultReceiver – Your own BroadcastReceiver to treat as the final receiver of the broadcast.
  • scheduler – A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
  • initialCode – An initial value for the result code. Often Activity.RESULT_OK.
  • initialData – An initial value for the result data. Often null.
  • initialExtras – An initial value for the result extras. Often null.
See Also:
@hide
/** * Version of {@link #sendBroadcast(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 * {@link 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>Like {@link #sendBroadcast(Intent)}, this method is * asynchronous; it will return before * resultReceiver.onReceive() is called. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param receiverPermission String naming a permissions that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param options (optional) Additional sending options, generated from a * {@link android.app.BroadcastOptions}. * @param resultReceiver Your own BroadcastReceiver to treat as the final * receiver of the broadcast. * @param scheduler A custom Handler with which to schedule the * resultReceiver callback; if null it will be * scheduled in the Context's main thread. * @param initialCode An initial value for the result code. Often * Activity.RESULT_OK. * @param initialData An initial value for the result data. Often * null. * @param initialExtras An initial value for the result extras. Often * null. * @see #sendBroadcast(Intent) * @see #sendBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String) * @see android.content.BroadcastReceiver * @see #registerReceiver * @see android.app.Activity#RESULT_OK * @hide */
@SystemApi public abstract void sendOrderedBroadcast(@NonNull Intent intent, @Nullable String receiverPermission, @Nullable Bundle options, @Nullable BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
Like sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle), but also allows specification of an associated app op as per AppOpsManager.
@hide
/** * Like {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler, * int, String, android.os.Bundle)}, but also allows specification * of an associated app op as per {@link android.app.AppOpsManager}. * @hide */
public abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, int appOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras);
Version of sendBroadcast(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.
Params:
  • intent – The intent to broadcast
  • user – UserHandle to send the intent to.
See Also:
/** * Version of {@link #sendBroadcast(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. * @param intent The intent to broadcast * @param user UserHandle to send the intent to. * @see #sendBroadcast(Intent) */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user);
Version of sendBroadcast(Intent, 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.
Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – UserHandle to send the intent to.
  • receiverPermission – (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.
See Also:
/** * Version of {@link #sendBroadcast(Intent, 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. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user UserHandle to send the intent to. * @param receiverPermission (optional) String naming a permission that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * * @see #sendBroadcast(Intent, String) */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, @Nullable String receiverPermission);
Version of sendBroadcast(Intent, String, 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.
Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – UserHandle to send the intent to.
  • receiverPermission – (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • options – (optional) Additional sending options, generated from a BroadcastOptions.
See Also:
@hide
/** * Version of {@link #sendBroadcast(Intent, String, 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. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user UserHandle to send the intent to. * @param receiverPermission (optional) String naming a permission that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param options (optional) Additional sending options, generated from a * {@link android.app.BroadcastOptions}. * * @see #sendBroadcast(Intent, String, Bundle) * @hide */
@SystemApi @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, @Nullable String receiverPermission, @Nullable Bundle options);
Version of sendBroadcast(Intent, 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.
Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – UserHandle to send the intent to.
  • receiverPermission – (optional) String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • appOp – The app op associated with the broadcast.
See Also:
@hide
/** * Version of {@link #sendBroadcast(Intent, 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. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user UserHandle to send the intent to. * @param receiverPermission (optional) String naming a permission that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param appOp The app op associated with the broadcast. * * @see #sendBroadcast(Intent, String) * * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, @Nullable String receiverPermission, int appOp);
Version of sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, 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.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – UserHandle to send the intent to.
  • receiverPermission – String naming a permissions that a receiver must hold in order to receive your broadcast. If null, no permission is required.
  • resultReceiver – Your own BroadcastReceiver to treat as the final receiver of the broadcast.
  • scheduler – A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
  • initialCode – An initial value for the result code. Often Activity.RESULT_OK.
  • initialData – An initial value for the result data. Often null.
  • initialExtras – An initial value for the result extras. Often null.
See Also:
/** * Version of * {@link #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, 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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user UserHandle to send the intent to. * @param receiverPermission String naming a permissions that * a receiver must hold in order to receive your broadcast. * If null, no permission is required. * @param resultReceiver Your own BroadcastReceiver to treat as the final * receiver of the broadcast. * @param scheduler A custom Handler with which to schedule the * resultReceiver callback; if null it will be * scheduled in the Context's main thread. * @param initialCode An initial value for the result code. Often * Activity.RESULT_OK. * @param initialData An initial value for the result data. Often * null. * @param initialExtras An initial value for the result extras. Often * null. * * @see #sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle) */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendOrderedBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, @Nullable String receiverPermission, BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
Similar to above but takes an appOp as well, to enforce restrictions.
See Also:
  • sendOrderedBroadcastAsUser(Intent, UserHandle, String, BroadcastReceiver, Handler, int, String, Bundle)
@hide
/** * Similar to above but takes an appOp as well, to enforce restrictions. * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String, * BroadcastReceiver, Handler, int, String, Bundle) * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, @Nullable String receiverPermission, int appOp, BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);
Similar to above but takes an appOp as well, to enforce restrictions, and an options Bundle.
See Also:
  • sendOrderedBroadcastAsUser(Intent, UserHandle, String, BroadcastReceiver, Handler, int, String, Bundle)
@hide
/** * Similar to above but takes an appOp as well, to enforce restrictions, and an options Bundle. * @see #sendOrderedBroadcastAsUser(Intent, UserHandle, String, * BroadcastReceiver, Handler, int, String, Bundle) * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, @Nullable String receiverPermission, int appOp, @Nullable Bundle options, BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);

Perform a sendBroadcast(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(BroadcastReceiver, IntentFilter). In all other ways, this behaves the same as sendBroadcast(Intent).

Params:
  • 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.
See Also:
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.
/** * <p>Perform a {@link #sendBroadcast(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 {@link #registerReceiver(BroadcastReceiver, IntentFilter)}. In * all other ways, this behaves the same as * {@link #sendBroadcast(Intent)}. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param 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. * * @see #sendBroadcast(Intent) * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) */
@Deprecated @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY) public abstract void sendStickyBroadcast(@RequiresPermission Intent intent);

Version of sendStickyBroadcast that allows you to receive data back from the broadcast. This is accomplished by supplying your own BroadcastReceiver when calling, which will be treated as a final receiver at the end of the broadcast -- its BroadcastReceiver.onReceive method will be called with the result values collected from the other receivers. The broadcast will be serialized in the same way as calling sendOrderedBroadcast(Intent, String).

Like sendBroadcast(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.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • resultReceiver – Your own BroadcastReceiver to treat as the final receiver of the broadcast.
  • scheduler – A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
  • initialCode – An initial value for the result code. Often Activity.RESULT_OK.
  • initialData – An initial value for the result data. Often null.
  • initialExtras – An initial value for the result extras. Often null.
See Also:
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.
/** * <p>Version of {@link #sendStickyBroadcast} that allows you to * receive data back from the broadcast. This is accomplished by * supplying your own BroadcastReceiver when calling, which will be * treated as a final receiver at the end of the broadcast -- its * {@link 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 * {@link #sendOrderedBroadcast(Intent, String)}. * * <p>Like {@link #sendBroadcast(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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param resultReceiver Your own BroadcastReceiver to treat as the final * receiver of the broadcast. * @param scheduler A custom Handler with which to schedule the * resultReceiver callback; if null it will be * scheduled in the Context's main thread. * @param initialCode An initial value for the result code. Often * Activity.RESULT_OK. * @param initialData An initial value for the result data. Often * null. * @param initialExtras An initial value for the result extras. Often * null. * * @see #sendBroadcast(Intent) * @see #sendBroadcast(Intent, String) * @see #sendOrderedBroadcast(Intent, String) * @see #sendStickyBroadcast(Intent) * @see android.content.BroadcastReceiver * @see #registerReceiver * @see android.app.Activity#RESULT_OK */
@Deprecated @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY) public abstract void sendStickyOrderedBroadcast(@RequiresPermission Intent intent, BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);

Remove the data previously sent with sendStickyBroadcast, so that it is as if the sticky broadcast had never happened.

Params:
  • intent – The Intent that was previously broadcast.
See Also:
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.
/** * <p>Remove the data previously sent with {@link #sendStickyBroadcast}, * so that it is as if the sticky broadcast had never happened. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param intent The Intent that was previously broadcast. * * @see #sendStickyBroadcast */
@Deprecated @RequiresPermission(android.Manifest.permission.BROADCAST_STICKY) public abstract void removeStickyBroadcast(@RequiresPermission Intent intent);

Version of sendStickyBroadcast(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.

Params:
  • 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 to send the intent to.
See Also:
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.
/** * <p>Version of {@link #sendStickyBroadcast(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. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param 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. * @param user UserHandle to send the intent to. * * @see #sendBroadcast(Intent) */
@Deprecated @RequiresPermission(allOf = { android.Manifest.permission.INTERACT_ACROSS_USERS, android.Manifest.permission.BROADCAST_STICKY }) public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user);
@hide This is just here for sending CONNECTIVITY_ACTION.
/** * @hide * This is just here for sending CONNECTIVITY_ACTION. */
@Deprecated @RequiresPermission(allOf = { android.Manifest.permission.INTERACT_ACROSS_USERS, android.Manifest.permission.BROADCAST_STICKY }) public abstract void sendStickyBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, Bundle options);

Version of sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, 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.

Params:
  • intent – The Intent to broadcast; all receivers matching this Intent will receive the broadcast.
  • user – UserHandle to send the intent to.
  • resultReceiver – Your own BroadcastReceiver to treat as the final receiver of the broadcast.
  • scheduler – A custom Handler with which to schedule the resultReceiver callback; if null it will be scheduled in the Context's main thread.
  • initialCode – An initial value for the result code. Often Activity.RESULT_OK.
  • initialData – An initial value for the result data. Often null.
  • initialExtras – An initial value for the result extras. Often null.
See Also:
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.
/** * <p>Version of * {@link #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, 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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param intent The Intent to broadcast; all receivers matching this * Intent will receive the broadcast. * @param user UserHandle to send the intent to. * @param resultReceiver Your own BroadcastReceiver to treat as the final * receiver of the broadcast. * @param scheduler A custom Handler with which to schedule the * resultReceiver callback; if null it will be * scheduled in the Context's main thread. * @param initialCode An initial value for the result code. Often * Activity.RESULT_OK. * @param initialData An initial value for the result data. Often * null. * @param initialExtras An initial value for the result extras. Often * null. * * @see #sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle) */
@Deprecated @RequiresPermission(allOf = { android.Manifest.permission.INTERACT_ACROSS_USERS, android.Manifest.permission.BROADCAST_STICKY }) public abstract void sendStickyOrderedBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user, BroadcastReceiver resultReceiver, @Nullable Handler scheduler, int initialCode, @Nullable String initialData, @Nullable Bundle initialExtras);

Version of removeStickyBroadcast(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 BROADCAST_STICKY.BROADCAST_STICKY permission in order to use this API. If you do not hold that permission, SecurityException will be thrown.

Params:
  • intent – The Intent that was previously broadcast.
  • user – UserHandle to remove the sticky broadcast from.
See Also:
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.
/** * <p>Version of {@link #removeStickyBroadcast(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. * * <p>You must hold the {@link android.Manifest.permission#BROADCAST_STICKY} * permission in order to use this API. If you do not hold that * permission, {@link SecurityException} will be thrown. * * @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 <em>something</em> * has changed, with another mechanism for apps to retrieve the current value whenever * desired. * * @param intent The Intent that was previously broadcast. * @param user UserHandle to remove the sticky broadcast from. * * @see #sendStickyBroadcastAsUser */
@Deprecated @RequiresPermission(allOf = { android.Manifest.permission.INTERACT_ACROSS_USERS, android.Manifest.permission.BROADCAST_STICKY }) public abstract void removeStickyBroadcastAsUser(@RequiresPermission Intent intent, UserHandle user);
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 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.

Note: this method cannot be called from a BroadcastReceiver component; that is, from a BroadcastReceiver that is declared in an application's manifest. It is okay, however, to call this method from another BroadcastReceiver that has itself been registered at run time with registerReceiver, since the lifetime of such a registered BroadcastReceiver is tied to the object that registered it.

Params:
  • receiver – The BroadcastReceiver to handle the broadcast.
  • filter – Selects the Intent broadcasts to be received.
See Also:
Returns:The first sticky intent found that matches filter, or null if there are none.
/** * Register a BroadcastReceiver to be run in the main activity thread. The * <var>receiver</var> will be called with any broadcast Intent that * matches <var>filter</var>, in the main application thread. * * <p>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 * <strong>and</strong> sent to your <var>receiver</var> as if it had just * been broadcast. * * <p>There may be multiple sticky Intents that match <var>filter</var>, * in which case each of these will be sent to <var>receiver</var>. 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. * * <p>If you know the Intent your are registering for is sticky, you can * supply null for your <var>receiver</var>. In this case, no receiver is * registered -- the function simply returns the sticky Intent that * matches <var>filter</var>. In the case of multiple matches, the same * rules as described above apply. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers * registered with this method will correctly respect the * {@link 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.</p> * * <p class="note">Note: this method <em>cannot be called from a * {@link BroadcastReceiver} component;</em> 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 {@link #registerReceiver}, since the lifetime of such a * registered BroadcastReceiver is tied to the object that registered it.</p> * * @param receiver The BroadcastReceiver to handle the broadcast. * @param filter Selects the Intent broadcasts to be received. * * @return The first sticky intent found that matches <var>filter</var>, * or null if there are none. * * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) * @see #sendBroadcast * @see #unregisterReceiver */
@Nullable public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter);
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. See registerReceiver(BroadcastReceiver, 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 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.

Params:
  • receiver – The BroadcastReceiver to handle the broadcast.
  • filter – Selects the Intent broadcasts to be received.
  • flags – Additional options for the receiver. May be 0 or RECEIVER_VISIBLE_TO_INSTANT_APPS.
See Also:
Returns:The first sticky intent found that matches filter, or null if there are none.
/** * Register to receive intent broadcasts, with the receiver optionally being * exposed to Instant Apps. See * {@link #registerReceiver(BroadcastReceiver, 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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers * registered with this method will correctly respect the * {@link 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.</p> * * @param receiver The BroadcastReceiver to handle the broadcast. * @param filter Selects the Intent broadcasts to be received. * @param flags Additional options for the receiver. May be 0 or * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}. * * @return The first sticky intent found that matches <var>filter</var>, * or null if there are none. * * @see #registerReceiver(BroadcastReceiver, IntentFilter) * @see #sendBroadcast * @see #unregisterReceiver */
@Nullable public abstract Intent registerReceiver(@Nullable BroadcastReceiver receiver, IntentFilter filter, @RegisterReceiverFlags int flags);
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(BroadcastReceiver, 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 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.

Params:
  • receiver – The BroadcastReceiver to handle the broadcast.
  • filter – Selects the Intent broadcasts to be received.
  • broadcastPermission – String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required.
  • scheduler – Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used.
See Also:
Returns:The first sticky intent found that matches filter, or null if there are none.
/** * Register to receive intent broadcasts, to run in the context of * <var>scheduler</var>. See * {@link #registerReceiver(BroadcastReceiver, 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. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers * registered with this method will correctly respect the * {@link 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.</p> * * @param receiver The BroadcastReceiver to handle the broadcast. * @param filter Selects the Intent broadcasts to be received. * @param broadcastPermission String naming a permissions that a * broadcaster must hold in order to send an Intent to you. If null, * no permission is required. * @param scheduler Handler identifying the thread that will receive * the Intent. If null, the main thread of the process will be used. * * @return The first sticky intent found that matches <var>filter</var>, * or null if there are none. * * @see #registerReceiver(BroadcastReceiver, IntentFilter) * @see #sendBroadcast * @see #unregisterReceiver */
@Nullable public abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler);
Register to receive intent broadcasts, to run in the context of scheduler. See registerReceiver(BroadcastReceiver, IntentFilter, int) and registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) for more information.

See BroadcastReceiver for more information on Intent broadcasts.

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

Params:
  • receiver – The BroadcastReceiver to handle the broadcast.
  • filter – Selects the Intent broadcasts to be received.
  • broadcastPermission – String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required.
  • scheduler – Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used.
  • flags – Additional options for the receiver. May be 0 or RECEIVER_VISIBLE_TO_INSTANT_APPS.
See Also:
Returns:The first sticky intent found that matches filter, or null if there are none.
/** * Register to receive intent broadcasts, to run in the context of * <var>scheduler</var>. See * {@link #registerReceiver(BroadcastReceiver, IntentFilter, int)} and * {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)} * for more information. * * <p>See {@link BroadcastReceiver} for more information on Intent broadcasts. * * <p>As of {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH}, receivers * registered with this method will correctly respect the * {@link 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.</p> * * @param receiver The BroadcastReceiver to handle the broadcast. * @param filter Selects the Intent broadcasts to be received. * @param broadcastPermission String naming a permissions that a * broadcaster must hold in order to send an Intent to you. If null, * no permission is required. * @param scheduler Handler identifying the thread that will receive * the Intent. If null, the main thread of the process will be used. * @param flags Additional options for the receiver. May be 0 or * {@link #RECEIVER_VISIBLE_TO_INSTANT_APPS}. * * @return The first sticky intent found that matches <var>filter</var>, * or null if there are none. * * @see #registerReceiver(BroadcastReceiver, IntentFilter, int) * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) * @see #sendBroadcast * @see #unregisterReceiver */
@Nullable public abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler, @RegisterReceiverFlags int flags);
Params:
  • receiver – The BroadcastReceiver to handle the broadcast.
  • user – UserHandle to send the intent to.
  • filter – Selects the Intent broadcasts to be received.
  • broadcastPermission – String naming a permissions that a broadcaster must hold in order to send an Intent to you. If null, no permission is required.
  • scheduler – Handler identifying the thread that will receive the Intent. If null, the main thread of the process will be used.
See Also:
@hide Same as but for a specific user. This receiver will receiver broadcasts that are sent to the requested user.
Returns:The first sticky intent found that matches filter, or null if there are none.
/** * @hide * Same as {@link #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) * but for a specific user. This receiver will receiver broadcasts that * are sent to the requested user. * * @param receiver The BroadcastReceiver to handle the broadcast. * @param user UserHandle to send the intent to. * @param filter Selects the Intent broadcasts to be received. * @param broadcastPermission String naming a permissions that a * broadcaster must hold in order to send an Intent to you. If null, * no permission is required. * @param scheduler Handler identifying the thread that will receive * the Intent. If null, the main thread of the process will be used. * * @return The first sticky intent found that matches <var>filter</var>, * or null if there are none. * * @see #registerReceiver(BroadcastReceiver, IntentFilter, String, Handler) * @see #sendBroadcast * @see #unregisterReceiver */
@Nullable @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS_FULL) public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver, UserHandle user, IntentFilter filter, @Nullable String broadcastPermission, @Nullable Handler scheduler);
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
Params:
  • receiver – The BroadcastReceiver to unregister.
See Also:
/** * Unregister a previously registered BroadcastReceiver. <em>All</em> * filters that have been registered for this BroadcastReceiver will be * removed. * * @param receiver The BroadcastReceiver to unregister. * * @see #registerReceiver */
public abstract void unregisterReceiver(BroadcastReceiver receiver);
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 method, with the intent given here. This provides a convenient way to submit jobs to a service without having to bind and call on to its interface.

Using startService() overrides the default service lifetime that is managed by bindService: it requires the service to remain running until stopService is called, regardless of whether any clients are connected to it. Note that calls to startService() do not nest: no matter how many times you call startService(), a single call to stopService will stop it.

The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.

This function will throw SecurityException if you do not have permission to start the given service.

Note: Each call to startService() results in significant work done by the system to manage service lifecycle surrounding the processing of the intent, which can take multiple milliseconds of CPU time. Due to this cost, startService() should not be used for frequent intent delivery to a service, and only for scheduling significant work. Use bound services for high frequency calls.

Params:
  • service – 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.
Throws:
  • SecurityException – If the caller does not have permission to access the service or the service can not be found.
  • IllegalStateException – If the application is in a state where the service can not be started (such as not in the foreground in a state when services are allowed).
See Also:
Returns:If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned.
/** * 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. * * <p>Every call to this method will result in a corresponding call to * the target service's {@link android.app.Service#onStartCommand} method, * with the <var>intent</var> given here. This provides a convenient way * to submit jobs to a service without having to bind and call on to its * interface. * * <p>Using startService() overrides the default service lifetime that is * managed by {@link #bindService}: it requires the service to remain * running until {@link #stopService} is called, regardless of whether * any clients are connected to it. Note that calls to startService() * do not nest: no matter how many times you call startService(), * a single call to {@link #stopService} will stop it. * * <p>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. * * <p>This function will throw {@link SecurityException} if you do not * have permission to start the given service. * * <p class="note"><strong>Note:</strong> 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 {@link #bindService bound services} * for high frequency calls. * </p> * * @param service Identifies the service to be started. The Intent must be * fully explicit (supplying a component name). Additional values * may be included in the Intent extras to supply arguments along with * this specific start call. * * @return If the service is being started or is already running, the * {@link ComponentName} of the actual service that was started is * returned; else if the service does not exist null is returned. * * @throws SecurityException If the caller does not have permission to access the service * or the service can not be found. * @throws IllegalStateException If the application is in a state where the service * can not be started (such as not in the foreground in a state when services are allowed). * * @see #stopService * @see #bindService */
@Nullable public abstract ComponentName startService(Intent service);
Similar to startService(Intent), but with an implicit promise that the Service will call startForeground(int, android.app.Notification) once it begins running. The service is given an amount of time comparable to the ANR interval to do this, otherwise the system will automatically stop the service and declare the app ANR.

Unlike the ordinary startService(Intent), this method can be used at any time, regardless of whether the app hosting the service is in a foreground state.

Params:
  • service – 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.
Throws:
  • SecurityException – If the caller does not have permission to access the service or the service can not be found.
See Also:
Returns:If the service is being started or is already running, the ComponentName of the actual service that was started is returned; else if the service does not exist null is returned.
/** * Similar to {@link #startService(Intent)}, but with an implicit promise that the * Service will call {@link android.app.Service#startForeground(int, android.app.Notification) * 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 stop the service and declare the app ANR. * * <p>Unlike the ordinary {@link #startService(Intent)}, this method can be used * at any time, regardless of whether the app hosting the service is in a foreground * state. * * @param service Identifies the service to be started. The Intent must be * fully explicit (supplying a component name). Additional values * may be included in the Intent extras to supply arguments along with * this specific start call. * * @return If the service is being started or is already running, the * {@link ComponentName} of the actual service that was started is * returned; else if the service does not exist null is returned. * * @throws SecurityException If the caller does not have permission to access the service * or the service can not be found. * * @see #stopService * @see android.app.Service#startForeground(int, android.app.Notification) */
@Nullable public abstract ComponentName startForegroundService(Intent service);
@hidelike startForegroundService(Intent) but for a specific user.
/** * @hide like {@link #startForegroundService(Intent)} but for a specific user. */
@Nullable @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract ComponentName startForegroundServiceAsUser(Intent service, UserHandle user);
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.

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.

Params:
  • service – Description of the service to be stopped. The Intent must be either fully explicit (supplying a component name) or specify a specific package name it is targeted to.
Throws:
  • SecurityException – If the caller does not have permission to access the service or the service can not be found.
  • IllegalStateException – If the application is in a state where the service can not be started (such as not in the foreground in a state when services are allowed).
See Also:
Returns: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.
/** * 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. * * <p>Note that if a stopped service still has {@link ServiceConnection} * objects bound to it with the {@link #BIND_AUTO_CREATE} set, it will * not be destroyed until all of these bindings are removed. See * the {@link android.app.Service} documentation for more details on a * service's lifecycle. * * <p>This function will throw {@link SecurityException} if you do not * have permission to stop the given service. * * @param service Description of the service to be stopped. The Intent must be either * fully explicit (supplying a component name) or specify a specific package * name it is targeted to. * * @return If there is a service matching the given Intent that is already * running, then it is stopped and {@code true} is returned; else {@code false} is returned. * * @throws SecurityException If the caller does not have permission to access the service * or the service can not be found. * @throws IllegalStateException If the application is in a state where the service * can not be started (such as not in the foreground in a state when services are allowed). * * @see #startService */
public abstract boolean stopService(Intent service);
@hidelike startService(Intent) but for a specific user.
/** * @hide like {@link #startService(Intent)} but for a specific user. */
@Nullable @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract ComponentName startServiceAsUser(Intent service, UserHandle user);
@hidelike stopService(Intent) but for a specific user.
/** * @hide like {@link #stopService(Intent)} but for a specific user. */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public abstract boolean stopServiceAsUser(Intent service, UserHandle user);
Connect 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().

This method will throw SecurityException if the calling app does not have permission to bind to the given service.

Note: this method cannot be called from a BroadcastReceiver component. A pattern you can use to communicate from a BroadcastReceiver to a Service is to call startService with the arguments containing the command to be sent, with the service calling its Service.stopSelf(int) method when done executing that command. See the API demo App/Service/Service Start Arguments Controller for an illustration of this. It is okay, however, to use this method from a BroadcastReceiver that has been registered with registerReceiver, since the lifetime of this BroadcastReceiver is tied to another object (the one that registered it).

Params:
Throws:
  • SecurityException – If the caller does not have permission to access the service or the service can not be found.
See Also:
Returns: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. If this value is true, you should later call unbindService to release the connection.
/** * Connect to an application service, creating it if needed. This defines * a dependency between your application and the service. The given * <var>conn</var> 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. * * <p>If the service does not support binding, it may return {@code null} from * its {@link android.app.Service#onBind(Intent) onBind()} method. If it does, then * the ServiceConnection's * {@link ServiceConnection#onNullBinding(ComponentName) onNullBinding()} method * will be invoked instead of * {@link ServiceConnection#onServiceConnected(ComponentName, IBinder) onServiceConnected()}. * * <p>This method will throw {@link SecurityException} if the calling app does not * have permission to bind to the given service. * * <p class="note">Note: this method <em>cannot be called from a * {@link BroadcastReceiver} component</em>. A pattern you can use to * communicate from a BroadcastReceiver to a Service is to call * {@link #startService} with the arguments containing the command to be * sent, with the service calling its * {@link android.app.Service#stopSelf(int)} method when done executing * that command. See the API demo App/Service/Service Start Arguments * Controller for an illustration of this. It is okay, however, to use * this method from a BroadcastReceiver that has been registered with * {@link #registerReceiver}, since the lifetime of this BroadcastReceiver * is tied to another object (the one that registered it).</p> * * @param service Identifies the service to connect to. The Intent must * specify an explicit component name. * @param conn Receives information as the service is started and stopped. * This must be a valid ServiceConnection object; it must not be null. * @param flags Operation options for the binding. May be 0, * {@link #BIND_AUTO_CREATE}, {@link #BIND_DEBUG_UNBIND}, * {@link #BIND_NOT_FOREGROUND}, {@link #BIND_ABOVE_CLIENT}, * {@link #BIND_ALLOW_OOM_MANAGEMENT}, or * {@link #BIND_WAIVE_PRIORITY}. * @return {@code true} if the system is in the process of bringing up a * service that your client has permission to bind to; {@code false} * if the system couldn't find the service or if your client doesn't * have permission to bind to it. If this value is {@code true}, you * should later call {@link #unbindService} to release the * connection. * * @throws SecurityException If the caller does not have permission to access the service * or the service can not be found. * * @see #unbindService * @see #startService * @see #BIND_AUTO_CREATE * @see #BIND_DEBUG_UNBIND * @see #BIND_NOT_FOREGROUND */
public abstract boolean bindService(@RequiresPermission Intent service, @NonNull ServiceConnection conn, @BindServiceFlags int flags);
Same as bindService(Intent, ServiceConnection, int), but with an explicit userHandle argument for use by system server and other multi-user aware code.
@hide
/** * Same as {@link #bindService(Intent, ServiceConnection, int)}, but with an explicit userHandle * argument for use by system server and other multi-user aware code. * @hide */
@SystemApi @SuppressWarnings("unused") @RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public boolean bindServiceAsUser(@RequiresPermission Intent service, ServiceConnection conn, int flags, UserHandle user) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
Same as bindService(Intent, ServiceConnection, int, UserHandle), but with an explicit non-null Handler to run the ServiceConnection callbacks on.
@hide
/** * Same as {@link #bindService(Intent, ServiceConnection, int, UserHandle)}, but with an * explicit non-null Handler to run the ServiceConnection callbacks on. * * @hide */
@RequiresPermission(android.Manifest.permission.INTERACT_ACROSS_USERS) public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, Handler handler, UserHandle user) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
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.
Params:
  • conn – The connection interface previously supplied to bindService(). This parameter must not be null.
See Also:
/** * 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. * * @param conn The connection interface previously supplied to * bindService(). This parameter must not be null. * * @see #bindService */
public abstract void unbindService(@NonNull ServiceConnection conn);
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).

Params:
  • className – Name of the Instrumentation component to be run.
  • profileFile – Optional path to write profiling data as the instrumentation runs, or null for no profiling.
  • arguments – Additional optional arguments to pass to the instrumentation, or null.
Returns:true if the instrumentation was successfully started, else false if it could not be found.
/** * Start executing an {@link android.app.Instrumentation} class. The given * Instrumentation component will be run by killing its target application * (if currently running), starting the target process, instantiating the * instrumentation component, and then letting it drive the application. * * <p>This function is not synchronous -- it returns as soon as the * instrumentation has started and while it is running. * * <p>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). * * @param className Name of the Instrumentation component to be run. * @param profileFile Optional path to write profiling data as the * instrumentation runs, or null for no profiling. * @param arguments Additional optional arguments to pass to the * instrumentation, or null. * * @return {@code true} if the instrumentation was successfully started, * else {@code false} if it could not be found. */
public abstract boolean startInstrumentation(@NonNull ComponentName className, @Nullable String profileFile, @Nullable Bundle arguments);
@hide
/** @hide */
@StringDef(suffix = { "_SERVICE" }, value = { POWER_SERVICE, WINDOW_SERVICE, LAYOUT_INFLATER_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, NOTIFICATION_SERVICE, ACCESSIBILITY_SERVICE, CAPTIONING_SERVICE, KEYGUARD_SERVICE, LOCATION_SERVICE, //@hide: COUNTRY_DETECTOR, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, WALLPAPER_SERVICE, TIME_ZONE_RULES_MANAGER_SERVICE, VIBRATOR_SERVICE, //@hide: STATUS_BAR_SERVICE, CONNECTIVITY_SERVICE, IPSEC_SERVICE, //@hide: UPDATE_LOCK_SERVICE, //@hide: NETWORKMANAGEMENT_SERVICE, NETWORK_STATS_SERVICE, //@hide: NETWORK_POLICY_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_SCANNING_SERVICE, //@hide: LOWPAN_SERVICE, //@hide: WIFI_RTT_SERVICE, //@hide: ETHERNET_SERVICE, WIFI_RTT_RANGING_SERVICE, NSD_SERVICE, AUDIO_SERVICE, FINGERPRINT_SERVICE, MEDIA_ROUTER_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, CARRIER_CONFIG_SERVICE, TELECOM_SERVICE, CLIPBOARD_SERVICE, INPUT_METHOD_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TEXT_CLASSIFICATION_SERVICE, APPWIDGET_SERVICE, //@hide: VOICE_INTERACTION_MANAGER_SERVICE, //@hide: BACKUP_SERVICE, DROPBOX_SERVICE, //@hide: DEVICE_IDLE_CONTROLLER, DEVICE_POLICY_SERVICE, UI_MODE_SERVICE, DOWNLOAD_SERVICE, NFC_SERVICE, BLUETOOTH_SERVICE, //@hide: SIP_SERVICE, USB_SERVICE, LAUNCHER_APPS_SERVICE, //@hide: SERIAL_SERVICE, //@hide: HDMI_CONTROL_SERVICE, INPUT_SERVICE, DISPLAY_SERVICE, USER_SERVICE, RESTRICTIONS_SERVICE, APP_OPS_SERVICE, CAMERA_SERVICE, PRINT_SERVICE, CONSUMER_IR_SERVICE, //@hide: TRUST_SERVICE, TV_INPUT_SERVICE, //@hide: NETWORK_SCORE_SERVICE, USAGE_STATS_SERVICE, MEDIA_SESSION_SERVICE, BATTERY_SERVICE, JOB_SCHEDULER_SERVICE, //@hide: PERSISTENT_DATA_BLOCK_SERVICE, //@hide: OEM_LOCK_SERVICE, MEDIA_PROJECTION_SERVICE, MIDI_SERVICE, RADIO_SERVICE, HARDWARE_PROPERTIES_SERVICE, //@hide: SOUND_TRIGGER_SERVICE, SHORTCUT_SERVICE, //@hide: CONTEXTHUB_SERVICE, SYSTEM_HEALTH_SERVICE, //@hide: INCIDENT_SERVICE, //@hide: STATS_COMPANION_SERVICE, COMPANION_DEVICE_SERVICE, CROSS_PROFILE_APPS_SERVICE, //@hide: SYSTEM_UPDATE_SERVICE, }) @Retention(RetentionPolicy.SOURCE) public @interface ServiceName {}
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.
LAYOUT_INFLATER_SERVICE ("layout_inflater")
A LayoutInflater for inflating layout resources in this context.
ACTIVITY_SERVICE ("activity")
A ActivityManager for interacting with the global activity state of the system.
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_SERVICE ("vibrator")
A Vibrator for interacting with the vibrator hardware.
CONNECTIVITY_SERVICE ("connection")
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 NYC, 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.

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

Params:
  • name – The name of the desired service.
See Also:
Returns:The service or null if the name does not exist.
/** * 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: * * <dl> * <dt> {@link #WINDOW_SERVICE} ("window") * <dd> The top-level window manager in which you can place custom * windows. The returned object is a {@link android.view.WindowManager}. * <dt> {@link #LAYOUT_INFLATER_SERVICE} ("layout_inflater") * <dd> A {@link android.view.LayoutInflater} for inflating layout resources * in this context. * <dt> {@link #ACTIVITY_SERVICE} ("activity") * <dd> A {@link android.app.ActivityManager} for interacting with the * global activity state of the system. * <dt> {@link #POWER_SERVICE} ("power") * <dd> A {@link android.os.PowerManager} for controlling power * management. * <dt> {@link #ALARM_SERVICE} ("alarm") * <dd> A {@link android.app.AlarmManager} for receiving intents at the * time of your choosing. * <dt> {@link #NOTIFICATION_SERVICE} ("notification") * <dd> A {@link android.app.NotificationManager} for informing the user * of background events. * <dt> {@link #KEYGUARD_SERVICE} ("keyguard") * <dd> A {@link android.app.KeyguardManager} for controlling keyguard. * <dt> {@link #LOCATION_SERVICE} ("location") * <dd> A {@link android.location.LocationManager} for controlling location * (e.g., GPS) updates. * <dt> {@link #SEARCH_SERVICE} ("search") * <dd> A {@link android.app.SearchManager} for handling search. * <dt> {@link #VIBRATOR_SERVICE} ("vibrator") * <dd> A {@link android.os.Vibrator} for interacting with the vibrator * hardware. * <dt> {@link #CONNECTIVITY_SERVICE} ("connection") * <dd> A {@link android.net.ConnectivityManager ConnectivityManager} for * handling management of network connections. * <dt> {@link #IPSEC_SERVICE} ("ipsec") * <dd> A {@link android.net.IpSecManager IpSecManager} for managing IPSec on * sockets and networks. * <dt> {@link #WIFI_SERVICE} ("wifi") * <dd> A {@link android.net.wifi.WifiManager WifiManager} for management of Wi-Fi * connectivity. On releases before NYC, it should only be obtained from an application * context, and not from any other derived context to avoid memory leaks within the calling * process. * <dt> {@link #WIFI_AWARE_SERVICE} ("wifiaware") * <dd> A {@link android.net.wifi.aware.WifiAwareManager WifiAwareManager} for management of * Wi-Fi Aware discovery and connectivity. * <dt> {@link #WIFI_P2P_SERVICE} ("wifip2p") * <dd> A {@link android.net.wifi.p2p.WifiP2pManager WifiP2pManager} for management of * Wi-Fi Direct connectivity. * <dt> {@link #INPUT_METHOD_SERVICE} ("input_method") * <dd> An {@link android.view.inputmethod.InputMethodManager InputMethodManager} * for management of input methods. * <dt> {@link #UI_MODE_SERVICE} ("uimode") * <dd> An {@link android.app.UiModeManager} for controlling UI modes. * <dt> {@link #DOWNLOAD_SERVICE} ("download") * <dd> A {@link android.app.DownloadManager} for requesting HTTP downloads * <dt> {@link #BATTERY_SERVICE} ("batterymanager") * <dd> A {@link android.os.BatteryManager} for managing battery state * <dt> {@link #JOB_SCHEDULER_SERVICE} ("taskmanager") * <dd> A {@link android.app.job.JobScheduler} for managing scheduled tasks * <dt> {@link #NETWORK_STATS_SERVICE} ("netstats") * <dd> A {@link android.app.usage.NetworkStatsManager NetworkStatsManager} for querying network * usage statistics. * <dt> {@link #HARDWARE_PROPERTIES_SERVICE} ("hardware_properties") * <dd> A {@link android.os.HardwarePropertiesManager} for accessing hardware properties. * </dl> * * <p>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.) * * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true, * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE}, * {@link #FINGERPRINT_SERVICE}, {@link #SHORTCUT_SERVICE}, {@link #USB_SERVICE}, * {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE}, {@link #WIFI_SERVICE}, * {@link #WIFI_AWARE_SERVICE}. For these services this method will return <code>null</code>. * Generally, if you are running as an instant app you should always check whether the result * of this method is null. * * @param name The name of the desired service. * * @return The service or null if the name does not exist. * * @see #WINDOW_SERVICE * @see android.view.WindowManager * @see #LAYOUT_INFLATER_SERVICE * @see android.view.LayoutInflater * @see #ACTIVITY_SERVICE * @see android.app.ActivityManager * @see #POWER_SERVICE * @see android.os.PowerManager * @see #ALARM_SERVICE * @see android.app.AlarmManager * @see #NOTIFICATION_SERVICE * @see android.app.NotificationManager * @see #KEYGUARD_SERVICE * @see android.app.KeyguardManager * @see #LOCATION_SERVICE * @see android.location.LocationManager * @see #SEARCH_SERVICE * @see android.app.SearchManager * @see #SENSOR_SERVICE * @see android.hardware.SensorManager * @see #STORAGE_SERVICE * @see android.os.storage.StorageManager * @see #VIBRATOR_SERVICE * @see android.os.Vibrator * @see #CONNECTIVITY_SERVICE * @see android.net.ConnectivityManager * @see #WIFI_SERVICE * @see android.net.wifi.WifiManager * @see #AUDIO_SERVICE * @see android.media.AudioManager * @see #MEDIA_ROUTER_SERVICE * @see android.media.MediaRouter * @see #TELEPHONY_SERVICE * @see android.telephony.TelephonyManager * @see #TELEPHONY_SUBSCRIPTION_SERVICE * @see android.telephony.SubscriptionManager * @see #CARRIER_CONFIG_SERVICE * @see android.telephony.CarrierConfigManager * @see #INPUT_METHOD_SERVICE * @see android.view.inputmethod.InputMethodManager * @see #UI_MODE_SERVICE * @see android.app.UiModeManager * @see #DOWNLOAD_SERVICE * @see android.app.DownloadManager * @see #BATTERY_SERVICE * @see android.os.BatteryManager * @see #JOB_SCHEDULER_SERVICE * @see android.app.job.JobScheduler * @see #NETWORK_STATS_SERVICE * @see android.app.usage.NetworkStatsManager * @see android.os.HardwarePropertiesManager * @see #HARDWARE_PROPERTIES_SERVICE */
public abstract @Nullable Object getSystemService(@ServiceName @NonNull String name);
Return the handle to a system-level service by class.

Currently available classes are: WindowManager, LayoutInflater, ActivityManager, PowerManager, AlarmManager, NotificationManager, KeyguardManager, LocationManager, SearchManager, Vibrator, ConnectivityManager, WifiManager, AudioManager, MediaRouter, TelephonyManager, SubscriptionManager, InputMethodManager, UiModeManager, DownloadManager, BatteryManager, JobScheduler, NetworkStatsManager.

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

Params:
  • serviceClass – The class of the desired service.
Returns:The service or null if the class is not a supported system service.
/** * Return the handle to a system-level service by class. * <p> * Currently available classes are: * {@link android.view.WindowManager}, {@link android.view.LayoutInflater}, * {@link android.app.ActivityManager}, {@link android.os.PowerManager}, * {@link android.app.AlarmManager}, {@link android.app.NotificationManager}, * {@link android.app.KeyguardManager}, {@link android.location.LocationManager}, * {@link android.app.SearchManager}, {@link android.os.Vibrator}, * {@link android.net.ConnectivityManager}, * {@link android.net.wifi.WifiManager}, * {@link android.media.AudioManager}, {@link android.media.MediaRouter}, * {@link android.telephony.TelephonyManager}, {@link android.telephony.SubscriptionManager}, * {@link android.view.inputmethod.InputMethodManager}, * {@link android.app.UiModeManager}, {@link android.app.DownloadManager}, * {@link android.os.BatteryManager}, {@link android.app.job.JobScheduler}, * {@link android.app.usage.NetworkStatsManager}. * </p><p> * 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.) * </p> * * <p>Note: Instant apps, for which {@link PackageManager#isInstantApp()} returns true, * don't have access to the following system services: {@link #DEVICE_POLICY_SERVICE}, * {@link #FINGERPRINT_SERVICE}, {@link #SHORTCUT_SERVICE}, {@link #USB_SERVICE}, * {@link #WALLPAPER_SERVICE}, {@link #WIFI_P2P_SERVICE}, {@link #WIFI_SERVICE}, * {@link #WIFI_AWARE_SERVICE}. For these services this method will return <code>null</code>. * Generally, if you are running as an instant app you should always check whether the result * of this method is null. * * @param serviceClass The class of the desired service. * @return The service or null if the class is not a supported system service. */
@SuppressWarnings("unchecked") public final @Nullable <T> T getSystemService(@NonNull Class<T> serviceClass) { // Because subclasses may override getSystemService(String) we cannot // perform a lookup by class alone. We must first map the class to its // service name then invoke the string-based method. String serviceName = getSystemServiceName(serviceClass); return serviceName != null ? (T)getSystemService(serviceName) : null; }
Gets the name of the system-level service that is represented by the specified class.
Params:
  • serviceClass – The class of the desired service.
Returns:The service name or null if the class is not a supported system service.
/** * Gets the name of the system-level service that is represented by the specified class. * * @param serviceClass The class of the desired service. * @return The service name or null if the class is not a supported system service. */
public abstract @Nullable String getSystemServiceName(@NonNull Class<?> serviceClass);
Use with getSystemService(String) to retrieve a PowerManager for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.PowerManager} for controlling power management, * including "wake locks," which let you keep the device on while * you're running long tasks. */
public static final String POWER_SERVICE = "power";
Use with getSystemService(String) to retrieve a RecoverySystem for accessing the recovery system service.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.RecoverySystem} for accessing the recovery system * service. * * @see #getSystemService(String) * @hide */
public static final String RECOVERY_SERVICE = "recovery";
Use with getSystemService(String) to retrieve a SystemUpdateManager for accessing the system update manager service.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.SystemUpdateManager} for accessing the system update * manager service. * * @see #getSystemService(String) * @hide */
@SystemApi public static final String SYSTEM_UPDATE_SERVICE = "system_update";
Use with getSystemService(String) to retrieve a WindowManager for accessing the system's window manager.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.WindowManager} for accessing the system's window * manager. * * @see #getSystemService(String) * @see android.view.WindowManager */
public static final String WINDOW_SERVICE = "window";
Use with getSystemService(String) to retrieve a LayoutInflater for inflating layout resources in this context.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.LayoutInflater} for inflating layout resources in this * context. * * @see #getSystemService(String) * @see android.view.LayoutInflater */
public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
Use with getSystemService(String) to retrieve a AccountManager for receiving intents at a time of your choosing.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.accounts.AccountManager} for receiving intents at a * time of your choosing. * * @see #getSystemService(String) * @see android.accounts.AccountManager */
public static final String ACCOUNT_SERVICE = "account";
Use with getSystemService(String) to retrieve a ActivityManager for interacting with the global system state.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.ActivityManager} for interacting with the global * system state. * * @see #getSystemService(String) * @see android.app.ActivityManager */
public static final String ACTIVITY_SERVICE = "activity";
Use with getSystemService(String) to retrieve a AlarmManager for receiving intents at a time of your choosing.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.AlarmManager} for receiving intents at a * time of your choosing. * * @see #getSystemService(String) * @see android.app.AlarmManager */
public static final String ALARM_SERVICE = "alarm";
Use with getSystemService(String) to retrieve a NotificationManager for informing the user of background events.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.NotificationManager} for informing the user of * background events. * * @see #getSystemService(String) * @see android.app.NotificationManager */
public static final String NOTIFICATION_SERVICE = "notification";
Use with getSystemService(String) to retrieve a AccessibilityManager for giving the user feedback for UI events through the registered event listeners.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.accessibility.AccessibilityManager} for giving the user * feedback for UI events through the registered event listeners. * * @see #getSystemService(String) * @see android.view.accessibility.AccessibilityManager */
public static final String ACCESSIBILITY_SERVICE = "accessibility";
Use with getSystemService(String) to retrieve a CaptioningManager for obtaining captioning properties and listening for changes in captioning preferences.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.accessibility.CaptioningManager} for obtaining * captioning properties and listening for changes in captioning * preferences. * * @see #getSystemService(String) * @see android.view.accessibility.CaptioningManager */
public static final String CAPTIONING_SERVICE = "captioning";
Use with getSystemService(String) to retrieve a KeyguardManager for controlling keyguard.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.KeyguardManager} for controlling keyguard. * * @see #getSystemService(String) * @see android.app.KeyguardManager */
public static final String KEYGUARD_SERVICE = "keyguard";
Use with getSystemService(String) to retrieve a LocationManager for controlling location updates.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.location.LocationManager} for controlling location * updates. * * @see #getSystemService(String) * @see android.location.LocationManager */
public static final String LOCATION_SERVICE = "location";
Use with getSystemService(String) to retrieve a CountryDetector for detecting the country that the user is in.
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.location.CountryDetector} for detecting the country that * the user is in. * * @hide */
public static final String COUNTRY_DETECTOR = "country_detector";
Use with getSystemService(String) to retrieve a SearchManager for handling searches.

Configuration.UI_MODE_TYPE_WATCH does not support SearchManager.

See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.SearchManager} for handling searches. * * <p> * {@link Configuration#UI_MODE_TYPE_WATCH} does not support * {@link android.app.SearchManager}. * * @see #getSystemService * @see android.app.SearchManager */
public static final String SEARCH_SERVICE = "search";
Use with getSystemService(String) to retrieve a SensorManager for accessing sensors.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.hardware.SensorManager} for accessing sensors. * * @see #getSystemService(String) * @see android.hardware.SensorManager */
public static final String SENSOR_SERVICE = "sensor";
Use with getSystemService(String) to retrieve a StorageManager for accessing system storage functions.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.os.storage.StorageManager} for accessing system storage * functions. * * @see #getSystemService(String) * @see android.os.storage.StorageManager */
public static final String STORAGE_SERVICE = "storage";
Use with getSystemService(String) to retrieve a StorageStatsManager for accessing system storage statistics.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.usage.StorageStatsManager} for accessing system storage * statistics. * * @see #getSystemService(String) * @see android.app.usage.StorageStatsManager */
public static final String STORAGE_STATS_SERVICE = "storagestats";
Use with getSystemService(String) to retrieve a com.android.server.WallpaperService for accessing wallpapers.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * com.android.server.WallpaperService for accessing wallpapers. * * @see #getSystemService(String) */
public static final String WALLPAPER_SERVICE = "wallpaper";
Use with getSystemService(String) to retrieve a Vibrator for interacting with the vibration hardware.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.os.Vibrator} for interacting with the vibration hardware. * * @see #getSystemService(String) * @see android.os.Vibrator */
public static final String VIBRATOR_SERVICE = "vibrator";
Use with getSystemService(String) to retrieve a StatusBarManager for interacting with the status bar.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.StatusBarManager} for interacting with the status bar. * * @see #getSystemService(String) * @see android.app.StatusBarManager * @hide */
public static final String STATUS_BAR_SERVICE = "statusbar";
Use with getSystemService(String) to retrieve a ConnectivityManager for handling management of network connections.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.ConnectivityManager} for handling management of * network connections. * * @see #getSystemService(String) * @see android.net.ConnectivityManager */
public static final String CONNECTIVITY_SERVICE = "connectivity";
Use with getSystemService(String) to retrieve a IpSecManager for encrypting Sockets or Networks with IPSec.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.net.IpSecManager} for encrypting Sockets or Networks with * IPSec. * * @see #getSystemService(String) */
public static final String IPSEC_SERVICE = "ipsec";
Use with getSystemService(String) to retrieve a IUpdateLock for managing runtime sequences that must not be interrupted by headless OTA application or similar.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.os.IUpdateLock} for managing runtime sequences that * must not be interrupted by headless OTA application or similar. * * @hide * @see #getSystemService(String) * @see android.os.UpdateLock */
public static final String UPDATE_LOCK_SERVICE = "updatelock";
Constant for the internal network management service, not really a Context service.
@hide
/** * Constant for the internal network management service, not really a Context service. * @hide */
public static final String NETWORKMANAGEMENT_SERVICE = "network_management";
Use with getSystemService(String) to retrieve a SliceManagerService for managing slices.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link com.android.server.slice.SliceManagerService} for managing slices. * @hide * @see #getSystemService(String) */
public static final String SLICE_SERVICE = "slice";
Use with getSystemService(String) to retrieve a NetworkStatsManager for querying network usage stats.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.usage.NetworkStatsManager} for querying network usage stats. * * @see #getSystemService(String) * @see android.app.usage.NetworkStatsManager */
public static final String NETWORK_STATS_SERVICE = "netstats";
{@hide}
/** {@hide} */
public static final String NETWORK_POLICY_SERVICE = "netpolicy";
{@hide}
/** {@hide} */
public static final String NETWORK_WATCHLIST_SERVICE = "network_watchlist";
Use with getSystemService(String) to retrieve a WifiManager for handling management of Wi-Fi access.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.wifi.WifiManager} for handling management of * Wi-Fi access. * * @see #getSystemService(String) * @see android.net.wifi.WifiManager */
public static final String WIFI_SERVICE = "wifi";
Use with getSystemService(String) to retrieve a WifiP2pManager for handling management of Wi-Fi peer-to-peer connections.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.wifi.p2p.WifiP2pManager} for handling management of * Wi-Fi peer-to-peer connections. * * @see #getSystemService(String) * @see android.net.wifi.p2p.WifiP2pManager */
public static final String WIFI_P2P_SERVICE = "wifip2p";
Use with getSystemService(String) to retrieve a WifiAwareManager for handling management of Wi-Fi Aware.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.net.wifi.aware.WifiAwareManager} for handling management of * Wi-Fi Aware. * * @see #getSystemService(String) * @see android.net.wifi.aware.WifiAwareManager */
public static final String WIFI_AWARE_SERVICE = "wifiaware";
Use with getSystemService(String) to retrieve a WifiScanner for scanning the wifi universe
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.wifi.WifiScanner} for scanning the wifi universe * * @see #getSystemService(String) * @see android.net.wifi.WifiScanner * @hide */
@SystemApi public static final String WIFI_SCANNING_SERVICE = "wifiscanner";
Use with getSystemService(String) to retrieve a RttManager for ranging devices with wifi
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.wifi.RttManager} for ranging devices with wifi * * @see #getSystemService(String) * @see android.net.wifi.RttManager * @hide */
@SystemApi @Deprecated public static final String WIFI_RTT_SERVICE = "rttmanager";
Use with getSystemService(String) to retrieve a WifiRttManager for ranging devices with wifi Note: this is a replacement for WIFI_RTT_SERVICE above. It will be renamed once final implementation in place.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.wifi.rtt.WifiRttManager} for ranging devices with wifi * * Note: this is a replacement for WIFI_RTT_SERVICE above. It will * be renamed once final implementation in place. * * @see #getSystemService(String) * @see android.net.wifi.rtt.WifiRttManager */
public static final String WIFI_RTT_RANGING_SERVICE = "wifirtt";
Use with getSystemService(String) to retrieve a LowpanManager for handling management of LoWPAN access.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.lowpan.LowpanManager} for handling management of * LoWPAN access. * * @see #getSystemService(String) * @see android.net.lowpan.LowpanManager * * @hide */
public static final String LOWPAN_SERVICE = "lowpan";
Use with getSystemService(String) to retrieve a EthernetManager for handling management of Ethernet access.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.EthernetManager} for handling management of * Ethernet access. * * @see #getSystemService(String) * @see android.net.EthernetManager * * @hide */
public static final String ETHERNET_SERVICE = "ethernet";
Use with getSystemService(String) to retrieve a NsdManager for handling management of network service discovery
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.net.nsd.NsdManager} for handling management of network service * discovery * * @see #getSystemService(String) * @see android.net.nsd.NsdManager */
public static final String NSD_SERVICE = "servicediscovery";
Use with getSystemService(String) to retrieve a AudioManager for handling management of volume, ringer modes and audio routing.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.media.AudioManager} for handling management of volume, * ringer modes and audio routing. * * @see #getSystemService(String) * @see android.media.AudioManager */
public static final String AUDIO_SERVICE = "audio";
Use with getSystemService(String) to retrieve a FingerprintManager for handling management of fingerprints.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.fingerprint.FingerprintManager} for handling management * of fingerprints. * * @see #getSystemService(String) * @see android.hardware.fingerprint.FingerprintManager */
public static final String FINGERPRINT_SERVICE = "fingerprint";
Use with getSystemService(String) to retrieve a MediaRouter for controlling and managing routing of media.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.media.MediaRouter} for controlling and managing * routing of media. * * @see #getSystemService(String) * @see android.media.MediaRouter */
public static final String MEDIA_ROUTER_SERVICE = "media_router";
Use with getSystemService(String) to retrieve a MediaSessionManager for managing media Sessions.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.media.session.MediaSessionManager} for managing media Sessions. * * @see #getSystemService(String) * @see android.media.session.MediaSessionManager */
public static final String MEDIA_SESSION_SERVICE = "media_session";
Use with getSystemService(String) to retrieve a TelephonyManager for handling management the telephony features of the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telephony.TelephonyManager} for handling management the * telephony features of the device. * * @see #getSystemService(String) * @see android.telephony.TelephonyManager */
public static final String TELEPHONY_SERVICE = "phone";
Use with getSystemService(String) to retrieve a SubscriptionManager for handling management the telephony subscriptions of the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telephony.SubscriptionManager} for handling management the * telephony subscriptions of the device. * * @see #getSystemService(String) * @see android.telephony.SubscriptionManager */
public static final String TELEPHONY_SUBSCRIPTION_SERVICE = "telephony_subscription_service";
Use with getSystemService(String) to retrieve a TelecomManager to manage telecom-related features of the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telecom.TelecomManager} to manage telecom-related features * of the device. * * @see #getSystemService(String) * @see android.telecom.TelecomManager */
public static final String TELECOM_SERVICE = "telecom";
Use with getSystemService(String) to retrieve a CarrierConfigManager for reading carrier configuration values.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telephony.CarrierConfigManager} for reading carrier configuration values. * * @see #getSystemService(String) * @see android.telephony.CarrierConfigManager */
public static final String CARRIER_CONFIG_SERVICE = "carrier_config";
Use with getSystemService(String) to retrieve a EuiccManager to manage the device eUICC (embedded SIM).
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telephony.euicc.EuiccManager} to manage the device eUICC (embedded SIM). * * @see #getSystemService(String) * @see android.telephony.euicc.EuiccManager */
public static final String EUICC_SERVICE = "euicc";
Use with getSystemService(String) to retrieve a EuiccCardManager to access the device eUICC (embedded SIM).
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.telephony.euicc.EuiccCardManager} to access the device eUICC (embedded SIM). * * @see #getSystemService(String) * @see android.telephony.euicc.EuiccCardManager * @hide */
@SystemApi public static final String EUICC_CARD_SERVICE = "euicc_card";
Use with getSystemService(String) to retrieve a ClipboardManager for accessing and modifying the contents of the global clipboard.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.content.ClipboardManager} for accessing and modifying * the contents of the global clipboard. * * @see #getSystemService(String) * @see android.content.ClipboardManager */
public static final String CLIPBOARD_SERVICE = "clipboard";
Use with getSystemService(String) to retrieve a TextClassificationManager for text classification services.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link TextClassificationManager} for text classification services. * * @see #getSystemService(String) * @see TextClassificationManager */
public static final String TEXT_CLASSIFICATION_SERVICE = "textclassification";
Use with getSystemService(String) to retrieve a InputMethodManager for accessing input methods.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.inputmethod.InputMethodManager} for accessing input * methods. * * @see #getSystemService(String) */
public static final String INPUT_METHOD_SERVICE = "input_method";
Use with getSystemService(String) to retrieve a TextServicesManager for accessing text services.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.view.textservice.TextServicesManager} for accessing * text services. * * @see #getSystemService(String) */
public static final String TEXT_SERVICES_MANAGER_SERVICE = "textservices";
Use with getSystemService(String) to retrieve a AppWidgetManager for accessing AppWidgets.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.appwidget.AppWidgetManager} for accessing AppWidgets. * * @see #getSystemService(String) */
public static final String APPWIDGET_SERVICE = "appwidget";
Official published name of the (internal) voice interaction manager service.
See Also:
@hide
/** * Official published name of the (internal) voice interaction manager service. * * @hide * @see #getSystemService(String) */
public static final String VOICE_INTERACTION_MANAGER_SERVICE = "voiceinteraction";
Official published name of the (internal) autofill service.
See Also:
@hide
/** * Official published name of the (internal) autofill service. * * @hide * @see #getSystemService(String) */
public static final String AUTOFILL_MANAGER_SERVICE = "autofill";
Use with getSystemService(String) to access the SoundTriggerService.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to access the * {@link com.android.server.voiceinteraction.SoundTriggerService}. * * @hide * @see #getSystemService(String) */
public static final String SOUND_TRIGGER_SERVICE = "soundtrigger";
Use with getSystemService(String) to retrieve an IBackupManager for communicating with the backup mechanism.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve an * {@link android.app.backup.IBackupManager IBackupManager} for communicating * with the backup mechanism. * @hide * * @see #getSystemService(String) */
@SystemApi public static final String BACKUP_SERVICE = "backup";
Use with getSystemService(String) to retrieve a DropBoxManager instance for recording diagnostic logs.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.DropBoxManager} instance for recording * diagnostic logs. * @see #getSystemService(String) */
public static final String DROPBOX_SERVICE = "dropbox";
System service name for the DeviceIdleManager.
See Also:
  • getSystemService(String)
@hide
/** * System service name for the DeviceIdleManager. * @see #getSystemService(String) * @hide */
public static final String DEVICE_IDLE_CONTROLLER = "deviceidle";
Use with getSystemService(String) to retrieve a DevicePolicyManager for working with global device policy management.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.admin.DevicePolicyManager} for working with global * device policy management. * * @see #getSystemService(String) */
public static final String DEVICE_POLICY_SERVICE = "device_policy";
Use with getSystemService(String) to retrieve a UiModeManager for controlling UI modes.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.UiModeManager} for controlling UI modes. * * @see #getSystemService(String) */
public static final String UI_MODE_SERVICE = "uimode";
Use with getSystemService(String) to retrieve a DownloadManager for requesting HTTP downloads.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.DownloadManager} for requesting HTTP downloads. * * @see #getSystemService(String) */
public static final String DOWNLOAD_SERVICE = "download";
Use with getSystemService(String) to retrieve a BatteryManager for managing battery state.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.BatteryManager} for managing battery state. * * @see #getSystemService(String) */
public static final String BATTERY_SERVICE = "batterymanager";
Use with getSystemService(String) to retrieve a NfcManager for using NFC.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.nfc.NfcManager} for using NFC. * * @see #getSystemService(String) */
public static final String NFC_SERVICE = "nfc";
Use with getSystemService(String) to retrieve a BluetoothManager for using Bluetooth.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.bluetooth.BluetoothManager} for using Bluetooth. * * @see #getSystemService(String) */
public static final String BLUETOOTH_SERVICE = "bluetooth"; /** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.net.sip.SipManager} for accessing the SIP related service. * * @see #getSystemService(String) */
@hide
/** @hide */
public static final String SIP_SERVICE = "sip";
Use with getSystemService(String) to retrieve a UsbManager for access to USB devices (as a USB host) and for controlling this device's behavior as a USB device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.hardware.usb.UsbManager} for access to USB devices (as a USB host) * and for controlling this device's behavior as a USB device. * * @see #getSystemService(String) * @see android.hardware.usb.UsbManager */
public static final String USB_SERVICE = "usb";
Use with getSystemService(String) to retrieve a SerialManager for access to serial ports.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.hardware.SerialManager} for access to serial ports. * * @see #getSystemService(String) * @see android.hardware.SerialManager * * @hide */
public static final String SERIAL_SERVICE = "serial";
Use with getSystemService(String) to retrieve a HdmiControlManager for controlling and managing HDMI-CEC protocol.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.hdmi.HdmiControlManager} for controlling and managing * HDMI-CEC protocol. * * @see #getSystemService(String) * @see android.hardware.hdmi.HdmiControlManager * @hide */
@SystemApi public static final String HDMI_CONTROL_SERVICE = "hdmi_control";
Use with getSystemService(String) to retrieve a InputManager for interacting with input devices.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.input.InputManager} for interacting with input devices. * * @see #getSystemService(String) * @see android.hardware.input.InputManager */
public static final String INPUT_SERVICE = "input";
Use with getSystemService(String) to retrieve a DisplayManager for interacting with display devices.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.display.DisplayManager} for interacting with display devices. * * @see #getSystemService(String) * @see android.hardware.display.DisplayManager */
public static final String DISPLAY_SERVICE = "display";
Use with getSystemService(String) to retrieve a UserManager for managing users on devices that support multiple users.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.UserManager} for managing users on devices that support multiple users. * * @see #getSystemService(String) * @see android.os.UserManager */
public static final String USER_SERVICE = "user";
Use with getSystemService(String) to retrieve a LauncherApps for querying and monitoring launchable apps across profiles of a user.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.content.pm.LauncherApps} for querying and monitoring launchable apps across * profiles of a user. * * @see #getSystemService(String) * @see android.content.pm.LauncherApps */
public static final String LAUNCHER_APPS_SERVICE = "launcherapps";
Use with getSystemService(String) to retrieve a RestrictionsManager for retrieving application restrictions and requesting permissions for restricted operations.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.content.RestrictionsManager} for retrieving application restrictions * and requesting permissions for restricted operations. * @see #getSystemService(String) * @see android.content.RestrictionsManager */
public static final String RESTRICTIONS_SERVICE = "restrictions";
Use with getSystemService(String) to retrieve a AppOpsManager for tracking application operations on the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.app.AppOpsManager} for tracking application operations * on the device. * * @see #getSystemService(String) * @see android.app.AppOpsManager */
public static final String APP_OPS_SERVICE = "appops";
Use with getSystemService(String) to retrieve a CameraManager for interacting with camera devices.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.camera2.CameraManager} for interacting with * camera devices. * * @see #getSystemService(String) * @see android.hardware.camera2.CameraManager */
public static final String CAMERA_SERVICE = "camera";
PrintManager for printing and managing printers and print tasks.
See Also:
/** * {@link android.print.PrintManager} for printing and managing * printers and print tasks. * * @see #getSystemService(String) * @see android.print.PrintManager */
public static final String PRINT_SERVICE = "print";
Use with getSystemService(String) to retrieve a CompanionDeviceManager for managing companion devices
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.companion.CompanionDeviceManager} for managing companion devices * * @see #getSystemService(String) * @see android.companion.CompanionDeviceManager */
public static final String COMPANION_DEVICE_SERVICE = "companiondevice";
Use with getSystemService(String) to retrieve a ConsumerIrManager for transmitting infrared signals from the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.ConsumerIrManager} for transmitting infrared * signals from the device. * * @see #getSystemService(String) * @see android.hardware.ConsumerIrManager */
public static final String CONSUMER_IR_SERVICE = "consumer_ir";
TrustManager for managing trust agents.
See Also:
@hide
/** * {@link android.app.trust.TrustManager} for managing trust agents. * @see #getSystemService(String) * @see android.app.trust.TrustManager * @hide */
public static final String TRUST_SERVICE = "trust";
Use with getSystemService(String) to retrieve a TvInputManager for interacting with TV inputs on the device.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.media.tv.TvInputManager} for interacting with TV inputs * on the device. * * @see #getSystemService(String) * @see android.media.tv.TvInputManager */
public static final String TV_INPUT_SERVICE = "tv_input";
NetworkScoreManager for managing network scoring.
See Also:
@hide
/** * {@link android.net.NetworkScoreManager} for managing network scoring. * @see #getSystemService(String) * @see android.net.NetworkScoreManager * @hide */
@SystemApi public static final String NETWORK_SCORE_SERVICE = "network_score";
Use with getSystemService(String) to retrieve a UsageStatsManager for querying device usage stats.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.usage.UsageStatsManager} for querying device usage stats. * * @see #getSystemService(String) * @see android.app.usage.UsageStatsManager */
public static final String USAGE_STATS_SERVICE = "usagestats";
Use with getSystemService(String) to retrieve a JobScheduler instance for managing occasional background tasks.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.app.job.JobScheduler} instance for managing occasional * background tasks. * @see #getSystemService(String) * @see android.app.job.JobScheduler */
public static final String JOB_SCHEDULER_SERVICE = "jobscheduler";
Use with getSystemService(String) to retrieve a PersistentDataBlockManager instance for interacting with a storage device that lives across factory resets.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.service.persistentdata.PersistentDataBlockManager} instance * for interacting with a storage device that lives across factory resets. * * @see #getSystemService(String) * @see android.service.persistentdata.PersistentDataBlockManager * @hide */
@SystemApi public static final String PERSISTENT_DATA_BLOCK_SERVICE = "persistent_data_block";
Use with getSystemService(String) to retrieve a OemLockManager instance for managing the OEM lock.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.service.oemlock.OemLockManager} instance for managing the OEM lock. * * @see #getSystemService(String) * @see android.service.oemlock.OemLockManager * @hide */
@SystemApi public static final String OEM_LOCK_SERVICE = "oem_lock";
Use with getSystemService(String) to retrieve a MediaProjectionManager instance for managing media projection sessions.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.media.projection.MediaProjectionManager} instance for managing * media projection sessions. * @see #getSystemService(String) * @see android.media.projection.MediaProjectionManager */
public static final String MEDIA_PROJECTION_SERVICE = "media_projection";
Use with getSystemService(String) to retrieve a MidiManager for accessing the MIDI service.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.media.midi.MidiManager} for accessing the MIDI service. * * @see #getSystemService(String) */
public static final String MIDI_SERVICE = "midi";
Use with getSystemService(String) to retrieve a RadioManager for accessing the broadcast radio service.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.hardware.radio.RadioManager} for accessing the broadcast radio service. * * @see #getSystemService(String) * @hide */
public static final String RADIO_SERVICE = "broadcastradio";
Use with getSystemService(String) to retrieve a HardwarePropertiesManager for accessing the hardware properties service.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.HardwarePropertiesManager} for accessing the hardware properties service. * * @see #getSystemService(String) */
public static final String HARDWARE_PROPERTIES_SERVICE = "hardware_properties";
Use with getSystemService(String) to retrieve a ShortcutManager for accessing the launcher shortcut service.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.content.pm.ShortcutManager} for accessing the launcher shortcut service. * * @see #getSystemService(String) * @see android.content.pm.ShortcutManager */
public static final String SHORTCUT_SERVICE = "shortcut";
Use with getSystemService(String) to retrieve a ContextHubManager for accessing context hubs.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.hardware.location.ContextHubManager} for accessing context hubs. * * @see #getSystemService(String) * @see android.hardware.location.ContextHubManager * * @hide */
@SystemApi public static final String CONTEXTHUB_SERVICE = "contexthub";
Use with getSystemService(String) to retrieve a SystemHealthManager for accessing system health (battery, power, memory, etc) metrics.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.os.health.SystemHealthManager} for accessing system health (battery, power, * memory, etc) metrics. * * @see #getSystemService(String) */
public static final String SYSTEM_HEALTH_SERVICE = "systemhealth";
Gatekeeper Service.
@hide
/** * Gatekeeper Service. * @hide */
public static final String GATEKEEPER_SERVICE = "android.service.gatekeeper.IGateKeeperService";
Service defining the policy for access to device identifiers.
@hide
/** * Service defining the policy for access to device identifiers. * @hide */
public static final String DEVICE_IDENTIFIERS_SERVICE = "device_identifiers";
Service to report a system health "incident"
@hide
/** * Service to report a system health "incident" * @hide */
public static final String INCIDENT_SERVICE = "incident";
Service to assist statsd in obtaining general stats.
@hide
/** * Service to assist statsd in obtaining general stats. * @hide */
public static final String STATS_COMPANION_SERVICE = "statscompanion";
Use with getSystemService(String) to retrieve an StatsManager.
@hide
/** * Use with {@link #getSystemService(String)} to retrieve an {@link android.app.StatsManager}. * @hide */
@SystemApi public static final String STATS_MANAGER = "stats";
Use with getSystemService(String) to retrieve a OverlayManager for managing overlay packages.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a {@link * android.content.om.OverlayManager} for managing overlay packages. * * @see #getSystemService(String) * @see android.content.om.OverlayManager * @hide */
public static final String OVERLAY_SERVICE = "overlay";
Use with getSystemService(String) to retrieve a VrManager for accessing the VR service.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link VrManager} for accessing the VR service. * * @see #getSystemService(String) * @hide */
@SystemApi public static final String VR_SERVICE = "vrmanager";
Use with getSystemService(String) to retrieve an ITimeZoneRulesManager.
See Also:
@hide
/** * Use with {@link #getSystemService(String)} to retrieve an * {@link android.app.timezone.ITimeZoneRulesManager}. * @hide * * @see #getSystemService(String) */
public static final String TIME_ZONE_RULES_MANAGER_SERVICE = "timezone";
Use with getSystemService(String) to retrieve a CrossProfileApps for cross profile operations.
See Also:
/** * Use with {@link #getSystemService(String)} to retrieve a * {@link android.content.pm.CrossProfileApps} for cross profile operations. * * @see #getSystemService(String) */
public static final String CROSS_PROFILE_APPS_SERVICE = "crossprofileapps";
Use with getSystemService to retrieve a ISecureElementService for accessing the SecureElementService.
@hide
/** * Use with {@link #getSystemService} to retrieve a * {@link android.se.omapi.ISecureElementService} * for accessing the SecureElementService. * * @hide */
@SystemApi public static final String SECURE_ELEMENT_SERVICE = "secure_element";
Determine whether the given permission is allowed for a particular process and user ID running in the system.
Params:
  • permission – The name of the permission being checked.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the given pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether the given permission is allowed for a particular * process and user ID running in the system. * * @param permission The name of the permission being checked. * @param pid The process ID being checked against. Must be > 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * * @return {@link PackageManager#PERMISSION_GRANTED} if the given * pid/uid is allowed that permission, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see PackageManager#checkPermission(String, String) * @see #checkCallingPermission */
@CheckResult(suggest="#enforcePermission(String,int,int,String)") @PackageManager.PermissionResult public abstract int checkPermission(@NonNull String permission, int pid, int uid);
@hide
/** @hide */
@PackageManager.PermissionResult public abstract int checkPermission(@NonNull String permission, int pid, int uid, IBinder callerToken);
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(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 to avoid this protection.
Params:
  • permission – The name of the permission being checked.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether the calling process of an IPC you are handling has been * granted a particular permission. This is basically the same as calling * {@link #checkPermission(String, int, int)} with the pid and uid returned * by {@link android.os.Binder#getCallingPid} and * {@link android.os.Binder#getCallingUid}. One important difference * is that if you are not currently processing an IPC, this function * will always fail. This is done to protect against accidentally * leaking permissions; you can use {@link #checkCallingOrSelfPermission} * to avoid this protection. * * @param permission The name of the permission being checked. * * @return {@link PackageManager#PERMISSION_GRANTED} if the calling * pid/uid is allowed that permission, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see PackageManager#checkPermission(String, String) * @see #checkPermission * @see #checkCallingOrSelfPermission */
@CheckResult(suggest="#enforceCallingPermission(String,String)") @PackageManager.PermissionResult public abstract int checkCallingPermission(@NonNull String permission);
Determine whether the calling process of an IPC or you have been granted a particular permission. This is the same as checkCallingPermission, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Params:
  • permission – The name of the permission being checked.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the calling pid/uid is allowed that permission, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether the calling process of an IPC <em>or you</em> have been * granted a particular permission. This is the same as * {@link #checkCallingPermission}, except it grants your own permissions * if you are not currently processing an IPC. Use with care! * * @param permission The name of the permission being checked. * * @return {@link PackageManager#PERMISSION_GRANTED} if the calling * pid/uid is allowed that permission, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see PackageManager#checkPermission(String, String) * @see #checkPermission * @see #checkCallingPermission */
@CheckResult(suggest="#enforceCallingOrSelfPermission(String,String)") @PackageManager.PermissionResult public abstract int checkCallingOrSelfPermission(@NonNull String permission);
Determine whether you have been granted a particular permission.
Params:
  • permission – The name of the permission being checked.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if you have the permission, or PackageManager.PERMISSION_DENIED if not.
/** * Determine whether <em>you</em> have been granted a particular permission. * * @param permission The name of the permission being checked. * * @return {@link PackageManager#PERMISSION_GRANTED} if you have the * permission, or {@link PackageManager#PERMISSION_DENIED} if not. * * @see PackageManager#checkPermission(String, String) * @see #checkCallingPermission(String) */
@PackageManager.PermissionResult public abstract int checkSelfPermission(@NonNull String permission);
If the given permission is not allowed for a particular process and user ID running in the system, throw a SecurityException.
Params:
  • permission – The name of the permission being checked.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If the given permission is not allowed for a particular process * and user ID running in the system, throw a {@link SecurityException}. * * @param permission The name of the permission being checked. * @param pid The process ID being checked against. Must be &gt; 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * @param message A message to include in the exception if it is thrown. * * @see #checkPermission(String, int, int) */
public abstract void enforcePermission( @NonNull String permission, int pid, int uid, @Nullable 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(String, int, int, 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 to avoid this protection.
Params:
  • permission – The name of the permission being checked.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If the calling process of an IPC you are handling has not been * granted a particular permission, throw a {@link * SecurityException}. This is basically the same as calling * {@link #enforcePermission(String, int, int, String)} with the * pid and uid returned by {@link android.os.Binder#getCallingPid} * and {@link android.os.Binder#getCallingUid}. One important * difference is that if you are not currently processing an IPC, * this function will always throw the SecurityException. This is * done to protect against accidentally leaking permissions; you * can use {@link #enforceCallingOrSelfPermission} to avoid this * protection. * * @param permission The name of the permission being checked. * @param message A message to include in the exception if it is thrown. * * @see #checkCallingPermission(String) */
public abstract void enforceCallingPermission( @NonNull String permission, @Nullable 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, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Params:
  • permission – The name of the permission being checked.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If neither you nor the calling process of an IPC you are * handling has been granted a particular permission, throw a * {@link SecurityException}. This is the same as {@link * #enforceCallingPermission}, except it grants your own * permissions if you are not currently processing an IPC. Use * with care! * * @param permission The name of the permission being checked. * @param message A message to include in the exception if it is thrown. * * @see #checkCallingOrSelfPermission(String) */
public abstract void enforceCallingOrSelfPermission( @NonNull String permission, @Nullable String message);
Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. This can be used to grant specific, temporary permissions, typically in response to user interaction (such as the user opening an attachment that you would like someone else to display).

Normally you should use Intent.FLAG_GRANT_READ_URI_PERMISSION or Intent.FLAG_GRANT_WRITE_URI_PERMISSION with the Intent being used to start an activity instead of this function directly. If you use this function directly, you should be sure to call revokeUriPermission when the target should no longer be allowed to access it.

To succeed, the content provider owning the Uri must have set the grantUriPermissions attribute in its manifest or included the <grant-uri-permissions> tag.

Params:
  • toPackage – The package you would like to allow to access the Uri.
  • uri – The Uri you would like to grant access to.
  • modeFlags – The desired access modes.
See Also:
/** * 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). * * <p>Normally you should use {@link Intent#FLAG_GRANT_READ_URI_PERMISSION * Intent.FLAG_GRANT_READ_URI_PERMISSION} or * {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION * 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 * {@link #revokeUriPermission} when the target should no longer be allowed * to access it. * * <p>To succeed, the content provider owning the Uri must have set the * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions * grantUriPermissions} attribute in its manifest or included the * {@link android.R.styleable#AndroidManifestGrantUriPermission * &lt;grant-uri-permissions&gt;} tag. * * @param toPackage The package you would like to allow to access the Uri. * @param uri The Uri you would like to grant access to. * @param modeFlags The desired access modes. * * @see #revokeUriPermission */
public abstract void grantUriPermission(String toPackage, Uri uri, @Intent.GrantUriMode int modeFlags);
Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission or any other mechanism. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.

Prior to 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 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(String, 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.

Params:
  • uri – The Uri you would like to revoke access to.
  • modeFlags – The access modes to revoke.
See Also:
/** * Remove all permissions to access a particular content provider Uri * that were previously added with {@link #grantUriPermission} or <em>any other</em> 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. * * <p>Prior to {@link android.os.Build.VERSION_CODES#LOLLIPOP}, if you did not have * regular permission access to a Uri, but had received access to it through * a specific Uri permission grant, you could not revoke that grant with this * function and a {@link SecurityException} would be thrown. As of * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, this function will not throw a security * exception, but will remove whatever permission grants to the Uri had been given to the app * (or none).</p> * * <p>Unlike {@link #revokeUriPermission(String, 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.</p> * * @param uri The Uri you would like to revoke access to. * @param modeFlags The access modes to revoke. * * @see #grantUriPermission */
public abstract void revokeUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission for a specific target package. The given Uri will match all previously granted Uris that are the same or a sub-path of the given Uri. That is, revoking "content://foo/target" will revoke both "content://foo/target" and "content://foo/target/sub", but not "content://foo". It will not remove any prefix grants that exist at a higher level.

Unlike revokeUriPermission(Uri, int), this method will only revoke permissions that had been explicitly granted through grantUriPermission and only for the package specified. Any matching grants that have happened through other mechanisms (clipboard, activity launching, service starting, etc) will not be removed.

Params:
  • toPackage – The package you had previously granted access to.
  • uri – The Uri you would like to revoke access to.
  • modeFlags – The access modes to revoke.
See Also:
/** * Remove permissions to access a particular content provider Uri * that were previously added with {@link #grantUriPermission} for a specific target * package. The given Uri will match all previously granted Uris that are the same or a * sub-path of the given Uri. That is, revoking "content://foo/target" will * revoke both "content://foo/target" and "content://foo/target/sub", but not * "content://foo". It will not remove any prefix grants that exist at a * higher level. * * <p>Unlike {@link #revokeUriPermission(Uri, int)}, this method will <em>only</em> * revoke permissions that had been explicitly granted through {@link #grantUriPermission} * and only for the package specified. Any matching grants that have happened through * other mechanisms (clipboard, activity launching, service starting, etc) will not be * removed.</p> * * @param toPackage The package you had previously granted access to. * @param uri The Uri you would like to revoke access to. * @param modeFlags The access modes to revoke. * * @see #grantUriPermission */
public abstract void revokeUriPermission(String toPackage, Uri uri, @Intent.AccessUriMode int modeFlags);
Determine whether a particular process and user ID 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.
Params:
  • uri – The uri that is being checked.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
  • modeFlags – The access modes to check.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the given pid/uid is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether a particular process and user ID 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. * * @param uri The uri that is being checked. * @param pid The process ID being checked against. Must be &gt; 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * @param modeFlags The access modes to check. * * @return {@link PackageManager#PERMISSION_GRANTED} if the given * pid/uid is allowed to access that uri, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see #checkCallingUriPermission */
@CheckResult(suggest="#enforceUriPermission(Uri,int,int,String)") @PackageManager.PermissionResult public abstract int checkUriPermission(Uri uri, int pid, int uid, @Intent.AccessUriMode int modeFlags);
@hide
/** @hide */
@PackageManager.PermissionResult public abstract int checkUriPermission(Uri uri, int pid, int uid, @Intent.AccessUriMode int modeFlags, IBinder callerToken);
Determine whether the calling process and user ID has been granted permission to access a specific URI. This is basically the same as calling checkUriPermission(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.
Params:
  • uri – The uri that is being checked.
  • modeFlags – The access modes to check.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether the calling process and user ID has been * granted permission to access a specific URI. This is basically * the same as calling {@link #checkUriPermission(Uri, int, int, * int)} with the pid and uid returned by {@link * android.os.Binder#getCallingPid} and {@link * android.os.Binder#getCallingUid}. One important difference is * that if you are not currently processing an IPC, this function * will always fail. * * @param uri The uri that is being checked. * @param modeFlags The access modes to check. * * @return {@link PackageManager#PERMISSION_GRANTED} if the caller * is allowed to access that uri, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see #checkUriPermission(Uri, int, int, int) */
@CheckResult(suggest="#enforceCallingUriPermission(Uri,int,String)") @PackageManager.PermissionResult public abstract int checkCallingUriPermission(Uri uri, @Intent.AccessUriMode 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, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Params:
  • uri – The uri that is being checked.
  • modeFlags – The access modes to check.
See Also:
Returns:PackageManager.PERMISSION_GRANTED if the caller is allowed to access that uri, or PackageManager.PERMISSION_DENIED if it is not.
/** * Determine whether the calling process of an IPC <em>or you</em> has been granted * permission to access a specific URI. This is the same as * {@link #checkCallingUriPermission}, except it grants your own permissions * if you are not currently processing an IPC. Use with care! * * @param uri The uri that is being checked. * @param modeFlags The access modes to check. * * @return {@link PackageManager#PERMISSION_GRANTED} if the caller * is allowed to access that uri, or * {@link PackageManager#PERMISSION_DENIED} if it is not. * * @see #checkCallingUriPermission */
@CheckResult(suggest="#enforceCallingOrSelfUriPermission(Uri,int,String)") @PackageManager.PermissionResult public abstract int checkCallingOrSelfUriPermission(Uri uri, @Intent.AccessUriMode int modeFlags);
Check both a Uri and normal permission. This allows you to perform both checkPermission and checkUriPermission in one call.
Params:
  • uri – The Uri whose permission is to be checked, or null to not do this check.
  • readPermission – The permission that provides overall read access, or null to not do this check.
  • writePermission – The permission that provides overall write access, or null to not do this check.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
  • modeFlags – The access modes to check.
Returns: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.
/** * Check both a Uri and normal permission. This allows you to perform * both {@link #checkPermission} and {@link #checkUriPermission} in one * call. * * @param uri The Uri whose permission is to be checked, or null to not * do this check. * @param readPermission The permission that provides overall read access, * or null to not do this check. * @param writePermission The permission that provides overall write * access, or null to not do this check. * @param pid The process ID being checked against. Must be &gt; 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * @param modeFlags The access modes to check. * * @return {@link PackageManager#PERMISSION_GRANTED} if the caller * is allowed to access that uri or holds one of the given permissions, or * {@link PackageManager#PERMISSION_DENIED} if it is not. */
@CheckResult(suggest="#enforceUriPermission(Uri,String,String,int,int,int,String)") @PackageManager.PermissionResult public abstract int checkUriPermission(@Nullable Uri uri, @Nullable String readPermission, @Nullable String writePermission, int pid, int uid, @Intent.AccessUriMode int modeFlags);
If a particular process and user ID 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.
Params:
  • uri – The uri that is being checked.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
  • modeFlags – The access modes to enforce.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If a particular process and user ID has not been granted * permission to access a specific URI, throw {@link * 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. * * @param uri The uri that is being checked. * @param pid The process ID being checked against. Must be &gt; 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * @param modeFlags The access modes to enforce. * @param message A message to include in the exception if it is thrown. * * @see #checkUriPermission(Uri, int, int, int) */
public abstract void enforceUriPermission( Uri uri, int pid, int uid, @Intent.AccessUriMode int modeFlags, String message);
If the calling process and user ID has not been granted permission to access a specific URI, throw SecurityException. This is basically the same as calling enforceUriPermission(Uri, int, int, int, 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.
Params:
  • uri – The uri that is being checked.
  • modeFlags – The access modes to enforce.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If the calling process and user ID has not been granted * permission to access a specific URI, throw {@link * SecurityException}. This is basically the same as calling * {@link #enforceUriPermission(Uri, int, int, int, String)} with * the pid and uid returned by {@link * android.os.Binder#getCallingPid} and {@link * android.os.Binder#getCallingUid}. One important difference is * that if you are not currently processing an IPC, this function * will always throw a SecurityException. * * @param uri The uri that is being checked. * @param modeFlags The access modes to enforce. * @param message A message to include in the exception if it is thrown. * * @see #checkCallingUriPermission(Uri, int) */
public abstract void enforceCallingUriPermission( Uri uri, @Intent.AccessUriMode 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, except it grants your own permissions if you are not currently processing an IPC. Use with care!
Params:
  • uri – The uri that is being checked.
  • modeFlags – The access modes to enforce.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * If the calling process of an IPC <em>or you</em> has not been * granted permission to access a specific URI, throw {@link * SecurityException}. This is the same as {@link * #enforceCallingUriPermission}, except it grants your own * permissions if you are not currently processing an IPC. Use * with care! * * @param uri The uri that is being checked. * @param modeFlags The access modes to enforce. * @param message A message to include in the exception if it is thrown. * * @see #checkCallingOrSelfUriPermission(Uri, int) */
public abstract void enforceCallingOrSelfUriPermission( Uri uri, @Intent.AccessUriMode int modeFlags, String message);
Enforce both a Uri and normal permission. This allows you to perform both enforcePermission and enforceUriPermission in one call.
Params:
  • uri – The Uri whose permission is to be checked, or null to not do this check.
  • readPermission – The permission that provides overall read access, or null to not do this check.
  • writePermission – The permission that provides overall write access, or null to not do this check.
  • pid – The process ID being checked against. Must be > 0.
  • uid – The user ID being checked against. A uid of 0 is the root user, which will pass every permission check.
  • modeFlags – The access modes to enforce.
  • message – A message to include in the exception if it is thrown.
See Also:
/** * Enforce both a Uri and normal permission. This allows you to perform * both {@link #enforcePermission} and {@link #enforceUriPermission} in one * call. * * @param uri The Uri whose permission is to be checked, or null to not * do this check. * @param readPermission The permission that provides overall read access, * or null to not do this check. * @param writePermission The permission that provides overall write * access, or null to not do this check. * @param pid The process ID being checked against. Must be &gt; 0. * @param uid The user ID being checked against. A uid of 0 is the root * user, which will pass every permission check. * @param modeFlags The access modes to enforce. * @param message A message to include in the exception if it is thrown. * * @see #checkUriPermission(Uri, String, String, int, int, int) */
public abstract void enforceUriPermission( @Nullable Uri uri, @Nullable String readPermission, @Nullable String writePermission, int pid, int uid, @Intent.AccessUriMode int modeFlags, @Nullable String message);
@hide
/** @hide */
@IntDef(flag = true, prefix = { "CONTEXT_" }, value = { CONTEXT_INCLUDE_CODE, CONTEXT_IGNORE_SECURITY, CONTEXT_RESTRICTED, CONTEXT_DEVICE_PROTECTED_STORAGE, CONTEXT_CREDENTIAL_PROTECTED_STORAGE, CONTEXT_REGISTER_PACKAGE, }) @Retention(RetentionPolicy.SOURCE) public @interface CreatePackageOptions {}
Flag for use with createPackageContext: include the application code with the context. This means loading code into the caller's process, so that getClassLoader() can be used to instantiate the application's classes. Setting this flags imposes security restrictions on what application context you can access; if the requested application can not be safely loaded into your process, java.lang.SecurityException will be thrown. If this flag is not set, there will be no restrictions on the packages that can be loaded, but getClassLoader will always return the default system class loader.
/** * Flag for use with {@link #createPackageContext}: include the application * code with the context. This means loading code into the caller's * process, so that {@link #getClassLoader()} can be used to instantiate * the application's classes. Setting this flags imposes security * restrictions on what application context you can access; if the * requested application can not be safely loaded into your process, * java.lang.SecurityException will be thrown. If this flag is not set, * there will be no restrictions on the packages that can be loaded, * but {@link #getClassLoader} will always return the default system * class loader. */
public static final int CONTEXT_INCLUDE_CODE = 0x00000001;
Flag for use with createPackageContext: ignore any security restrictions on the Context being requested, allowing it to always be loaded. For use with CONTEXT_INCLUDE_CODE to allow code to be loaded into a process even when it isn't safe to do so. Use with extreme care!
/** * Flag for use with {@link #createPackageContext}: ignore any security * restrictions on the Context being requested, allowing it to always * be loaded. For use with {@link #CONTEXT_INCLUDE_CODE} to allow code * to be loaded into a process even when it isn't safe to do so. Use * with extreme care! */
public static final int CONTEXT_IGNORE_SECURITY = 0x00000002;
Flag for use with createPackageContext: a restricted context may disable specific features. For instance, a View associated with a restricted context would ignore particular XML attributes.
/** * Flag for use with {@link #createPackageContext}: a restricted context may * disable specific features. For instance, a View associated with a restricted * context would ignore particular XML attributes. */
public static final int CONTEXT_RESTRICTED = 0x00000004;
Flag for use with createPackageContext: point all file APIs at device-protected storage.
@hide
/** * Flag for use with {@link #createPackageContext}: point all file APIs at * device-protected storage. * * @hide */
public static final int CONTEXT_DEVICE_PROTECTED_STORAGE = 0x00000008;
Flag for use with createPackageContext: point all file APIs at credential-protected storage.
@hide
/** * Flag for use with {@link #createPackageContext}: point all file APIs at * credential-protected storage. * * @hide */
public static final int CONTEXT_CREDENTIAL_PROTECTED_STORAGE = 0x00000010;
@hideUsed to indicate we should tell the activity manager about the process loading this code.
/** * @hide Used to indicate we should tell the activity manager about the process * loading this code. */
public static final int CONTEXT_REGISTER_PACKAGE = 0x40000000;
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 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}.

Params:
  • packageName – Name of the application's package.
  • flags – Option flags.
Throws:
Returns:A Context for the application.
/** * 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. * * <p>Throws {@link android.content.pm.PackageManager.NameNotFoundException} if there is no * application with the given package name. * * <p>Throws {@link java.lang.SecurityException} if the Context requested * can not be loaded into the caller's process for security reasons (see * {@link #CONTEXT_INCLUDE_CODE} for more information}. * * @param packageName Name of the application's package. * @param flags Option flags. * * @return A {@link Context} for the application. * * @throws SecurityException &nbsp; * @throws PackageManager.NameNotFoundException if there is no application with * the given package name. */
public abstract Context createPackageContext(String packageName, @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Similar to createPackageContext(String, int), but with a different UserHandle. For example, getContentResolver() will open any Uri as the given user.
@hide
/** * Similar to {@link #createPackageContext(String, int)}, but with a * different {@link UserHandle}. For example, {@link #getContentResolver()} * will open any {@link Uri} as the given user. * * @hide */
@SystemApi public Context createPackageContextAsUser( String packageName, @CreatePackageOptions int flags, UserHandle user) throws PackageManager.NameNotFoundException { if (Build.IS_ENG) { throw new IllegalStateException("createPackageContextAsUser not overridden!"); } return this; }
Creates a context given an ApplicationInfo.
@hide
/** * Creates a context given an {@link android.content.pm.ApplicationInfo}. * * @hide */
public abstract Context createApplicationContext(ApplicationInfo application, @CreatePackageOptions int flags) throws PackageManager.NameNotFoundException;
Return a new Context object for the given split name. The new Context has a ClassLoader and Resources object that can access the split's and all of its dependencies' code/resources. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same split) may be so the Context itself can be fairly lightweight.
Params:
  • splitName – The name of the split to include, as declared in the split's AndroidManifest.xml.
Returns:A Context with the given split's code and/or resources loaded.
/** * Return a new Context object for the given split name. The new Context has a ClassLoader and * Resources object that can access the split's and all of its dependencies' code/resources. * Each call to this method returns a new instance of a Context object; * Context objects are not shared, however common state (ClassLoader, other Resources for * the same split) may be so the Context itself can be fairly lightweight. * * @param splitName The name of the split to include, as declared in the split's * <code>AndroidManifest.xml</code>. * @return A {@link Context} with the given split's code and/or resources loaded. */
public abstract Context createContextForSplit(String splitName) throws PackageManager.NameNotFoundException;
Get the user associated with this context
@hide
/** * Get the user associated with this context * @hide */
@TestApi public UserHandle getUser() { return android.os.Process.myUserHandle(); }
Get the user associated with this context
@hide
/** * Get the user associated with this context * @hide */
@TestApi public @UserIdInt int getUserId() { return android.os.UserHandle.myUserId(); }
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.
Params:
  • overrideConfiguration – 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.
Returns:A Context with the given configuration override.
/** * 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. * * @param overrideConfiguration A {@link 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. * * @return A {@link Context} with the given configuration override. */
public abstract Context createConfigurationContext( @NonNull Configuration overrideConfiguration);
Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display. 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. The returned display Context provides a WindowManager (see getSystemService(String)) that is configured to show windows on the given display. The WindowManager's WindowManager.getDefaultDisplay method can be used to retrieve the Display from the returned Context.
Params:
  • display – A Display object specifying the display for whose metrics the Context's resources should be tailored and upon which new windows should be shown.
Returns:A Context for the display.
/** * Return a new Context object for the current Context but whose resources * are adjusted to match the metrics of the given Display. 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. * * The returned display Context provides a {@link WindowManager} * (see {@link #getSystemService(String)}) that is configured to show windows * on the given display. The WindowManager's {@link WindowManager#getDefaultDisplay} * method can be used to retrieve the Display from the returned Context. * * @param display A {@link Display} object specifying the display * for whose metrics the Context's resources should be tailored and upon which * new windows should be shown. * * @return A {@link Context} for the display. */
public abstract Context createDisplayContext(@NonNull Display display);
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.

On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).

Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.

If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.

Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.

See Also:
  • isDeviceProtectedStorage()
/** * Return a new Context object for the current Context but whose storage * APIs are backed by device-protected storage. * <p> * 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 * <em>before and after</em> the user has authenticated with their * credentials (such as a lock pattern or PIN). * <p> * 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. * <p> * 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. * <p> * Each call to this method returns a new instance of a Context object; * Context objects are not shared, however common state (ClassLoader, other * Resources for the same configuration) may be so the Context itself can be * fairly lightweight. * * @see #isDeviceProtectedStorage() */
public abstract Context createDeviceProtectedStorageContext();
Return a new Context object for the current Context but whose storage APIs are backed by credential-protected storage. This is the default storage area for apps unless defaultToDeviceProtectedStorage.defaultToDeviceProtectedStorage was requested.

On devices with direct boot, data stored in this location is encrypted with a key tied to user credentials, which can be accessed only after the user has entered their credentials (such as a lock pattern or PIN).

If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.

Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.

See Also:
@hide
/** * Return a new Context object for the current Context but whose storage * APIs are backed by credential-protected storage. This is the default * storage area for apps unless * {@link android.R.attr#defaultToDeviceProtectedStorage} was requested. * <p> * On devices with direct boot, data stored in this location is encrypted * with a key tied to user credentials, which can be accessed * <em>only after</em> the user has entered their credentials (such as a * lock pattern or PIN). * <p> * 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. * <p> * Each call to this method returns a new instance of a Context object; * Context objects are not shared, however common state (ClassLoader, other * Resources for the same configuration) may be so the Context itself can be * fairly lightweight. * * @see #isCredentialProtectedStorage() * @hide */
@SystemApi public abstract Context createCredentialProtectedStorageContext();
Gets the display adjustments holder for this context. This information is provided on a per-application or activity basis and is used to simulate lower density display metrics for legacy applications and restricted screen sizes.
Params:
  • displayId – The display id for which to get compatibility info.
Returns:The compatibility info holder, or null if not required by the application.
@hide
/** * Gets the display adjustments holder for this context. This information * is provided on a per-application or activity basis and is used to simulate lower density * display metrics for legacy applications and restricted screen sizes. * * @param displayId The display id for which to get compatibility info. * @return The compatibility info holder, or null if not required by the application. * @hide */
public abstract DisplayAdjustments getDisplayAdjustments(int displayId);
@hide
/** * @hide */
public abstract Display getDisplay();
@hide
/** * @hide */
public abstract void updateDisplay(int displayId);
Indicates whether this Context is restricted.
See Also:
Returns:true if this Context is restricted, false otherwise.
/** * Indicates whether this Context is restricted. * * @return {@code true} if this Context is restricted, {@code false} otherwise. * * @see #CONTEXT_RESTRICTED */
public boolean isRestricted() { return false; }
Indicates if the storage APIs of this Context are backed by device-protected storage.
See Also:
  • createDeviceProtectedStorageContext()
/** * Indicates if the storage APIs of this Context are backed by * device-protected storage. * * @see #createDeviceProtectedStorageContext() */
public abstract boolean isDeviceProtectedStorage();
Indicates if the storage APIs of this Context are backed by credential-protected storage.
See Also:
  • createCredentialProtectedStorageContext()
@hide
/** * Indicates if the storage APIs of this Context are backed by * credential-protected storage. * * @see #createCredentialProtectedStorageContext() * @hide */
@SystemApi public abstract boolean isCredentialProtectedStorage();
Returns true if the context can load unsafe resources, e.g. fonts.
@hide
/** * Returns true if the context can load unsafe resources, e.g. fonts. * @hide */
public abstract boolean canLoadUnsafeResources();
@hide
/** * @hide */
public IBinder getActivityToken() { throw new RuntimeException("Not implemented. Must override in a subclass."); }
@hide
/** * @hide */
@Nullable public IServiceConnection getServiceDispatcher(ServiceConnection conn, Handler handler, int flags) { throw new RuntimeException("Not implemented. Must override in a subclass."); }
@hide
/** * @hide */
public IApplicationThread getIApplicationThread() { throw new RuntimeException("Not implemented. Must override in a subclass."); }
@hide
/** * @hide */
public Handler getMainThreadHandler() { throw new RuntimeException("Not implemented. Must override in a subclass."); }
@hide
/** * @hide */
public AutofillClient getAutofillClient() { return null; }
@hide
/** * @hide */
public void setAutofillClient(@SuppressWarnings("unused") AutofillClient client) { }
@hide
/** * @hide */
public boolean isAutofillCompatibilityEnabled() { return false; }
@hide
/** * @hide */
@TestApi public void setAutofillCompatibilityEnabled( @SuppressWarnings("unused") boolean autofillCompatEnabled) { }
Throws an exception if the Context is using system resources, which are non-runtime-overlay-themable and may show inconsistent UI.
@hide
/** * Throws an exception if the Context is using system resources, * which are non-runtime-overlay-themable and may show inconsistent UI. * @hide */
public void assertRuntimeOverlayThemable() { // Resources.getSystem() is a singleton and the only Resources not managed by // ResourcesManager; therefore Resources.getSystem() is not themable. if (getResources() == Resources.getSystem()) { throw new IllegalArgumentException("Non-UI context used to display UI; " + "get a UI context from ActivityThread#getSystemUiContext()"); } } }