public abstract class Context extends Object
Modifier and Type | Class and Description |
---|---|
static interface |
Context.BindServiceFlags |
static interface |
Context.CreatePackageOptions |
static interface |
Context.ServiceName |
Modifier and Type | Field and Description |
---|---|
static String |
ACCESSIBILITY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
AccessibilityManager for giving the user
feedback for UI events through the registered event listeners. |
static String |
ACCOUNT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
android.accounts.AccountManager for receiving intents at a
time of your choosing. |
static String |
ACTIVITY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
ActivityManager for interacting with the global
system state. |
static String |
ALARM_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
AlarmManager for receiving intents at a
time of your choosing. |
static String |
APP_OPS_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
AppOpsManager for tracking application operations
on the device. |
static String |
APPWIDGET_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
AppWidgetManager for accessing AppWidgets. |
static String |
AUDIO_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
AudioManager for handling management of volume,
ringer modes and audio routing. |
static String |
BACKUP_SERVICE
Use with
getSystemService(java.lang.String) to retrieve an
IBackupManager for communicating
with the backup mechanism. |
static String |
BATTERY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
BatteryManager for managing battery state. |
static int |
BIND_ABOVE_CLIENT
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : indicates that the client application
binding to this service considers the service to be more important than
the app itself. |
static int |
BIND_ADJUST_WITH_ACTIVITY
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : If binding from an activity, allow the
target service's process importance to be raised based on whether the
activity is visible to the user, regardless whether another flag is
used to reduce the amount that the client process's overall importance
is used to impact it. |
static int |
BIND_ALLOW_OOM_MANAGEMENT
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : allow the process hosting the bound
service to go through its normal memory management. |
static int |
BIND_ALLOW_WHITELIST_MANAGEMENT |
static int |
BIND_AUTO_CREATE
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : automatically create the service as long
as the binding exists. |
static int |
BIND_DEBUG_UNBIND
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : include debugging help for mismatched
calls to unbind. |
static int |
BIND_EXTERNAL_SERVICE
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : The service being bound is an
isolated ,
external service. |
static int |
BIND_FOREGROUND_SERVICE |
static int |
BIND_FOREGROUND_SERVICE_WHILE_AWAKE |
static int |
BIND_IMPORTANT
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : this service is very important to
the client, so should be brought to the foreground process level
when the client is. |
static int |
BIND_NOT_FOREGROUND
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : don't allow this binding to raise
the target service's process to the foreground scheduling priority. |
static int |
BIND_NOT_VISIBLE
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : Don't consider the bound service to be
visible, even if the caller is visible. |
static int |
BIND_SHOWING_UI |
static int |
BIND_TREAT_LIKE_ACTIVITY |
static int |
BIND_VISIBLE |
static int |
BIND_WAIVE_PRIORITY
Flag for
bindService(android.content.Intent, android.content.ServiceConnection, int) : don't impact the scheduling or
memory management priority of the target service's hosting process. |
static String |
BLUETOOTH_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
BluetoothManager for using Bluetooth. |
static String |
CAMERA_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
CameraManager for interacting with
camera devices. |
static String |
CAPTIONING_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
CaptioningManager for obtaining
captioning properties and listening for changes in captioning
preferences. |
static String |
CARRIER_CONFIG_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
CarrierConfigManager for reading carrier configuration values. |
static String |
CLIPBOARD_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
ClipboardManager for accessing and modifying
ClipboardManager for accessing and modifying
the contents of the global clipboard. |
static String |
CONNECTIVITY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a ConnectivityManager for handling management of
network connections. |
static String |
CONSUMER_IR_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
ConsumerIrManager for transmitting infrared
signals from the device. |
static int |
CONTEXT_CREDENTIAL_PROTECTED_STORAGE
Flag for use with
createPackageContext(java.lang.String, int) : point all file APIs at
credential-protected storage. |
static int |
CONTEXT_DEVICE_PROTECTED_STORAGE
Flag for use with
createPackageContext(java.lang.String, int) : point all file APIs at
device-protected storage. |
static int |
CONTEXT_IGNORE_SECURITY
Flag for use with
createPackageContext(java.lang.String, int) : ignore any security
restrictions on the Context being requested, allowing it to always
be loaded. |
static int |
CONTEXT_INCLUDE_CODE
Flag for use with
createPackageContext(java.lang.String, int) : include the application
code with the context. |
static int |
CONTEXT_REGISTER_PACKAGE |
static int |
CONTEXT_RESTRICTED
Flag for use with
createPackageContext(java.lang.String, int) : a restricted context may
disable specific features. |
static String |
CONTEXTHUB_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a ContextHubManager for accessing context hubs. |
static String |
COUNTRY_DETECTOR
Use with
getSystemService(java.lang.String) to retrieve a
CountryDetector for detecting the country that
the user is in. |
static String |
DEVICE_IDLE_CONTROLLER
System service name for the DeviceIdleController.
|
static String |
DEVICE_POLICY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
DevicePolicyManager for working with global
device policy management. |
static String |
DISPLAY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
DisplayManager for interacting with display devices. |
static String |
DOWNLOAD_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
DownloadManager for requesting HTTP downloads. |
static String |
DROPBOX_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
DropBoxManager instance for recording
diagnostic logs. |
static String |
ETHERNET_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a EthernetManager for handling management of
Ethernet access. |
static String |
FINGERPRINT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
FingerprintManager for handling management
of fingerprints. |
static String |
GATEKEEPER_SERVICE
Gatekeeper Service.
|
static String |
HARDWARE_PROPERTIES_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
HardwarePropertiesManager for accessing the hardware properties service. |
static String |
HDMI_CONTROL_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
HdmiControlManager for controlling and managing
HDMI-CEC protocol. |
static String |
INPUT_METHOD_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
InputMethodManager for accessing input
methods. |
static String |
INPUT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
InputManager for interacting with input devices. |
static String |
JOB_SCHEDULER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a JobScheduler instance for managing occasional
background tasks. |
static String |
KEYGUARD_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
NotificationManager for controlling keyguard. |
static String |
LAUNCHER_APPS_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
LauncherApps for querying and monitoring launchable apps across
profiles of a user. |
static String |
LAYOUT_INFLATER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
LayoutInflater for inflating layout resources in this
context. |
static String |
LOCATION_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a LocationManager for controlling location
updates. |
static String |
MEDIA_PROJECTION_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a MediaProjectionManager instance for managing
media projection sessions. |
static String |
MEDIA_ROUTER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
MediaRouter for controlling and managing
routing of media. |
static String |
MEDIA_SESSION_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
MediaSessionManager for managing media Sessions. |
static String |
MIDI_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
MidiManager for accessing the MIDI service. |
static int |
MODE_APPEND
File creation mode: for use with
openFileOutput(java.lang.String, int) , if the file
already exists then write data to the end of the existing file
instead of erasing it. |
static int |
MODE_ENABLE_WRITE_AHEAD_LOGGING
Database open flag: when set, the database is opened with write-ahead
logging enabled by default.
|
static int |
MODE_MULTI_PROCESS
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 . |
static int |
MODE_NO_LOCALIZED_COLLATORS
Database open flag: when set, the database is opened without support for
localized collators.
|
static int |
MODE_PRIVATE
File creation mode: the default mode, where the created file can only
be accessed by the calling application (or all applications sharing the
same user ID).
|
static int |
MODE_WORLD_READABLE
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. |
static int |
MODE_WORLD_WRITEABLE
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. |
static String |
NETWORK_POLICY_SERVICE |
static String |
NETWORK_SCORE_SERVICE
NetworkScoreManager for managing network scoring. |
static String |
NETWORK_STATS_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a NetworkStatsManager for querying network usage stats. |
static String |
NETWORKMANAGEMENT_SERVICE
Constant for the internal network management service, not really a Context service.
|
static String |
NFC_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
NfcManager for using NFC. |
static String |
NOTIFICATION_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
NotificationManager for informing the user of
background events. |
static String |
NSD_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a NsdManager for handling management of network service
discovery |
static String |
PERSISTENT_DATA_BLOCK_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a PersistentDataBlockManager instance
for interacting with a storage device that lives across factory resets. |
static String |
POWER_SERVICE
Use with
getSystemService(java.lang.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. |
static String |
PRINT_SERVICE
PrintManager for printing and managing
printers and print tasks. |
static String |
RADIO_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
RadioManager for accessing the broadcast radio service. |
static String |
RECOVERY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
RecoverySystem for accessing the recovery system
service. |
static String |
RESTRICTIONS_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
RestrictionsManager for retrieving application restrictions
and requesting permissions for restricted operations. |
static String |
SEARCH_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a SearchManager for handling searches. |
static String |
SENSOR_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a SensorManager for accessing sensors. |
static String |
SERIAL_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a SerialManager for access to serial ports. |
static String |
SHORTCUT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
ShortcutManager for accessing the launcher shortcut service. |
static String |
SIP_SERVICE |
static String |
SOUND_TRIGGER_SERVICE
Use with
getSystemService(java.lang.String) to access the
com.android.server.voiceinteraction.SoundTriggerService . |
static String |
STATUS_BAR_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a StatusBarManager for interacting with the status bar. |
static String |
STORAGE_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a StorageManager for accessing system storage
functions. |
static String |
SYSTEM_HEALTH_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
SystemHealthManager for accessing system health (battery, power,
memory, etc) metrics. |
static String |
TELECOM_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
TelecomManager to manage telecom-related features
of the device. |
static String |
TELEPHONY_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
TelephonyManager for handling management the
telephony features of the device. |
static String |
TELEPHONY_SUBSCRIPTION_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
SubscriptionManager for handling management the
telephony subscriptions of the device. |
static String |
TEXT_SERVICES_MANAGER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
TextServicesManager for accessing
text services. |
static String |
TRUST_SERVICE
TrustManager for managing trust agents. |
static String |
TV_INPUT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
TvInputManager for interacting with TV inputs
on the device. |
static String |
UI_MODE_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
UiModeManager for controlling UI modes. |
static String |
UPDATE_LOCK_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a android.os.IUpdateLock for managing runtime sequences that
must not be interrupted by headless OTA application or similar. |
static String |
USAGE_STATS_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a UsageStatsManager for querying device usage stats. |
static String |
USB_SERVICE
Use with
getSystemService(java.lang.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. |
static String |
USER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
UserManager for managing users on devices that support multiple users. |
static String |
VIBRATOR_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a Vibrator for interacting with the vibration hardware. |
static String |
VOICE_INTERACTION_MANAGER_SERVICE
Official published name of the (internal) voice interaction manager service.
|
static String |
WALLPAPER_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
com.android.server.WallpaperService for accessing wallpapers. |
static String |
WIFI_NAN_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
WifiNanManager for handling management of
Wi-Fi NAN discovery and connections. |
static String |
WIFI_P2P_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a WifiP2pManager for handling management of
Wi-Fi peer-to-peer connections. |
static String |
WIFI_RTT_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a RttManager for ranging devices with wifi |
static String |
WIFI_SCANNING_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a WifiScanner for scanning the wifi universe |
static String |
WIFI_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a WifiManager for handling management of
Wi-Fi access. |
static String |
WINDOW_SERVICE
Use with
getSystemService(java.lang.String) to retrieve a
WindowManager for accessing the system's window
manager. |
Constructor and Description |
---|
Context() |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
bindService(Intent service,
ServiceConnection conn,
int flags)
Connect to an application service, creating it if needed.
|
boolean |
bindServiceAsUser(Intent service,
ServiceConnection conn,
int flags,
Handler handler,
UserHandle user)
Same as
#bindService(Intent, ServiceConnection, int, UserHandle) , but with an
explicit non-null Handler to run the ServiceConnection callbacks on. |
boolean |
bindServiceAsUser(Intent service,
ServiceConnection conn,
int flags,
UserHandle user)
Same as
bindService(Intent, ServiceConnection, int) , but with an explicit userHandle
argument for use by system server and other multi-user aware code. |
boolean |
canStartActivityForResult()
Identifies whether this Context instance will be able to process calls to
startActivityForResult(String, Intent, int, Bundle) . |
abstract int |
checkCallingOrSelfPermission(String permission)
Determine whether the calling process of an IPC or you have been
granted a particular permission.
|
abstract int |
checkCallingOrSelfUriPermission(Uri uri,
int modeFlags)
Determine whether the calling process of an IPC or you has been granted
permission to access a specific URI.
|
abstract int |
checkCallingPermission(String permission)
Determine whether the calling process of an IPC you are handling has been
granted a particular permission.
|
abstract int |
checkCallingUriPermission(Uri uri,
int modeFlags)
Determine whether the calling process and user ID has been
granted permission to access a specific URI.
|
abstract int |
checkPermission(String permission,
int pid,
int uid)
Determine whether the given permission is allowed for a particular
process and user ID running in the system.
|
abstract int |
checkPermission(String permission,
int pid,
int uid,
IBinder callerToken) |
abstract int |
checkSelfPermission(String permission)
Determine whether you have been granted a particular permission.
|
abstract int |
checkUriPermission(Uri uri,
int pid,
int uid,
int modeFlags)
Determine whether a particular process and user ID has been granted
permission to access a specific URI.
|
abstract int |
checkUriPermission(Uri uri,
int pid,
int uid,
int modeFlags,
IBinder callerToken) |
abstract int |
checkUriPermission(Uri uri,
String readPermission,
String writePermission,
int pid,
int uid,
int modeFlags)
Check both a Uri and normal permission.
|
abstract void |
clearWallpaper()
Deprecated.
Use
WallpaperManager.clear() instead.
This method requires the caller to hold the permission
|
abstract Context |
createApplicationContext(ApplicationInfo application,
int flags)
Creates a context given an
ApplicationInfo . |
abstract Context |
createConfigurationContext(Configuration overrideConfiguration)
Return a new Context object for the current Context but whose resources
are adjusted to match the given Configuration.
|
Context |
createCredentialEncryptedStorageContext()
Deprecated.
|
abstract Context |
createCredentialProtectedStorageContext()
Return a new Context object for the current Context but whose storage
APIs are backed by credential-protected storage.
|
Context |
createDeviceEncryptedStorageContext()
Deprecated.
|
abstract Context |
createDeviceProtectedStorageContext()
Return a new Context object for the current Context but whose storage
APIs are backed by device-protected storage.
|
abstract Context |
createDisplayContext(Display display)
Return a new Context object for the current Context but whose resources
are adjusted to match the metrics of the given Display.
|
abstract Context |
createPackageContext(String packageName,
int flags)
Return a new Context object for the given application name.
|
abstract Context |
createPackageContextAsUser(String packageName,
int flags,
UserHandle user)
Similar to
createPackageContext(String, int) , but with a
different UserHandle . |
abstract String[] |
databaseList()
Returns an array of strings naming the private databases associated with
this Context's application package.
|
abstract boolean |
deleteDatabase(String name)
Delete an existing private SQLiteDatabase associated with this Context's
application package.
|
abstract boolean |
deleteFile(String name)
Delete the given private file associated with this Context's
application package.
|
abstract boolean |
deleteSharedPreferences(String name)
Delete an existing shared preferences file.
|
abstract void |
enforceCallingOrSelfPermission(String permission,
String message)
If neither you nor the calling process of an IPC you are
handling has been granted a particular permission, throw a
SecurityException . |
abstract void |
enforceCallingOrSelfUriPermission(Uri uri,
int modeFlags,
String message)
If the calling process of an IPC or you has not been
granted permission to access a specific URI, throw
SecurityException . |
abstract void |
enforceCallingPermission(String permission,
String message)
If the calling process of an IPC you are handling has not been
granted a particular permission, throw a
SecurityException . |
abstract void |
enforceCallingUriPermission(Uri uri,
int modeFlags,
String message)
If the calling process and user ID has not been granted
permission to access a specific URI, throw
SecurityException . |
abstract void |
enforcePermission(String permission,
int pid,
int uid,
String message)
If the given permission is not allowed for a particular process
and user ID running in the system, throw a
SecurityException . |
abstract void |
enforceUriPermission(Uri uri,
int pid,
int uid,
int modeFlags,
String message)
If a particular process and user ID has not been granted
permission to access a specific URI, throw
SecurityException . |
abstract void |
enforceUriPermission(Uri uri,
String readPermission,
String writePermission,
int pid,
int uid,
int modeFlags,
String message)
Enforce both a Uri and normal permission.
|
abstract String[] |
fileList()
Returns an array of strings naming the private files associated with
this Context's application package.
|
abstract Context |
getApplicationContext()
Return the context of the single, global Application object of the
current process.
|
abstract ApplicationInfo |
getApplicationInfo()
Return the full application info for this context's package.
|
abstract AssetManager |
getAssets()
Returns an AssetManager instance for the application's package.
|
abstract String |
getBasePackageName() |
abstract File |
getCacheDir()
Returns the absolute path to the application specific cache directory on
the filesystem.
|
abstract ClassLoader |
getClassLoader()
Return a class loader you can use to retrieve classes in this package.
|
abstract File |
getCodeCacheDir()
Returns the absolute path to the application specific cache directory on
the filesystem designed for storing cached code.
|
int |
getColor(int id)
Returns a color associated with a particular resource ID and styled for
the current theme.
|
ColorStateList |
getColorStateList(int id)
Returns a color state list associated with a particular resource ID and
styled for the current theme.
|
abstract ContentResolver |
getContentResolver()
Return a ContentResolver instance for your application's package.
|
abstract File |
getDatabasePath(String name)
Returns the absolute path on the filesystem where a database created with
openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory) is stored. |
abstract File |
getDataDir()
Returns the absolute path to the directory on the filesystem where all
private files belonging to this app are stored.
|
abstract File |
getDir(String name,
int mode)
Retrieve, creating if needed, a new directory in which the application
can place its own custom data files.
|
abstract Display |
getDisplay() |
abstract DisplayAdjustments |
getDisplayAdjustments(int displayId)
Gets the display adjustments holder for this context.
|
Drawable |
getDrawable(int id)
Returns a drawable object associated with a particular resource ID and
styled for the current theme.
|
abstract File |
getExternalCacheDir()
Returns absolute path to application-specific directory on the primary
shared/external storage device where the application can place cache
files it owns.
|
abstract File[] |
getExternalCacheDirs()
Returns absolute paths to application-specific directories on all
shared/external storage devices where the application can place cache
files it owns.
|
abstract File |
getExternalFilesDir(String type)
Returns the absolute path to the directory on the primary shared/external
storage device where the application can place persistent files it owns.
|
abstract File[] |
getExternalFilesDirs(String type)
Returns absolute paths to application-specific directories on all
shared/external storage devices where the application can place
persistent files it owns.
|
abstract File[] |
getExternalMediaDirs()
Returns absolute paths to application-specific directories on all
shared/external storage devices where the application can place media
files.
|
abstract File |
getFilesDir()
Returns the absolute path to the directory on the filesystem where files
created with
openFileOutput(java.lang.String, int) are stored. |
abstract File |
getFileStreamPath(String name)
Returns the absolute path on the filesystem where a file created with
openFileOutput(java.lang.String, int) is stored. |
abstract Looper |
getMainLooper()
Return the Looper for the main thread of the current process.
|
abstract File |
getNoBackupFilesDir()
Returns the absolute path to the directory on the filesystem similar to
getFilesDir() . |
abstract File |
getObbDir()
Return the primary shared/external storage directory where this
application's OBB files (if there are any) can be found.
|
abstract File[] |
getObbDirs()
Returns absolute paths to application-specific directories on all
shared/external storage devices where the application's OBB files (if
there are any) can be found.
|
abstract String |
getOpPackageName() |
abstract String |
getPackageCodePath()
Return the full path to this context's primary Android package.
|
abstract PackageManager |
getPackageManager()
Return PackageManager instance to find global package information.
|
abstract String |
getPackageName()
Return the name of this application's package.
|
abstract String |
getPackageResourcePath()
Return the full path to this context's primary Android package.
|
abstract Resources |
getResources()
Returns a Resources instance for the application's package.
|
abstract SharedPreferences |
getSharedPreferences(File file,
int mode)
Retrieve and hold the contents of the preferences file, returning
a SharedPreferences through which you can retrieve and modify its
values.
|
abstract SharedPreferences |
getSharedPreferences(String name,
int mode)
Retrieve and hold the contents of the preferences file 'name', returning
a SharedPreferences through which you can retrieve and modify its
values.
|
abstract File |
getSharedPreferencesPath(String name)
Returns the absolute path on the filesystem where a file created with
getSharedPreferences(String, int) is stored. |
File |
getSharedPrefsFile(String name)
Deprecated.
|
String |
getString(int resId)
Returns a localized string from the application's package's
default string table.
|
String |
getString(int resId,
Object... formatArgs)
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(java.lang.String, java.lang.Object...) . |
<T> T |
getSystemService(Class<T> serviceClass)
Return the handle to a system-level service by class.
|
abstract Object |
getSystemService(String name)
Return the handle to a system-level service by name.
|
abstract String |
getSystemServiceName(Class<?> serviceClass)
Gets the name of the system-level service that is represented by the specified class.
|
CharSequence |
getText(int resId)
Return a localized, styled CharSequence from the application's package's
default string table.
|
abstract Resources.Theme |
getTheme()
Return the Theme object associated with this Context.
|
int |
getThemeResId() |
abstract int |
getUserId()
Get the userId associated with this context
|
abstract Drawable |
getWallpaper()
Deprecated.
Use
WallpaperManager.get() instead. |
abstract int |
getWallpaperDesiredMinimumHeight()
Deprecated.
Use
WallpaperManager.getDesiredMinimumHeight() instead. |
abstract int |
getWallpaperDesiredMinimumWidth()
Deprecated.
Use
WallpaperManager.getDesiredMinimumWidth() instead. |
abstract void |
grantUriPermission(String toPackage,
Uri uri,
int modeFlags)
Grant permission to access a specific Uri to another package, regardless
of whether that package has general permission to access the Uri's
content provider.
|
boolean |
isCredentialEncryptedStorage()
Deprecated.
|
abstract boolean |
isCredentialProtectedStorage()
Indicates if the storage APIs of this Context are backed by
credential-protected storage.
|
boolean |
isDeviceEncryptedStorage()
Deprecated.
|
abstract boolean |
isDeviceProtectedStorage()
Indicates if the storage APIs of this Context are backed by
device-protected storage.
|
boolean |
isRestricted()
Indicates whether this Context is restricted.
|
boolean |
migrateDatabaseFrom(Context sourceContext,
String name)
Deprecated.
|
boolean |
migrateSharedPreferencesFrom(Context sourceContext,
String name)
Deprecated.
|
abstract boolean |
moveDatabaseFrom(Context sourceContext,
String name)
Move an existing database file from the given source storage context to
this context.
|
abstract boolean |
moveSharedPreferencesFrom(Context sourceContext,
String name)
Move an existing shared preferences file from the given source storage
context to this context.
|
TypedArray |
obtainStyledAttributes(AttributeSet set,
int[] attrs)
Retrieve styled attribute information in this Context's theme.
|
TypedArray |
obtainStyledAttributes(AttributeSet set,
int[] attrs,
int defStyleAttr,
int defStyleRes)
Retrieve styled attribute information in this Context's theme.
|
TypedArray |
obtainStyledAttributes(int[] attrs)
Retrieve styled attribute information in this Context's theme.
|
TypedArray |
obtainStyledAttributes(int resid,
int[] attrs)
Retrieve styled attribute information in this Context's theme.
|
abstract FileInputStream |
openFileInput(String name)
Open a private file associated with this Context's application package
for reading.
|
abstract FileOutputStream |
openFileOutput(String name,
int mode)
Open a private file associated with this Context's application package
for writing.
|
abstract SQLiteDatabase |
openOrCreateDatabase(String name,
int mode,
SQLiteDatabase.CursorFactory factory)
Open a new private SQLiteDatabase associated with this Context's
application package.
|
abstract SQLiteDatabase |
openOrCreateDatabase(String name,
int mode,
SQLiteDatabase.CursorFactory factory,
DatabaseErrorHandler errorHandler)
Open a new private SQLiteDatabase associated with this Context's
application package.
|
abstract Drawable |
peekWallpaper()
Deprecated.
Use
WallpaperManager.peek() instead. |
void |
registerComponentCallbacks(ComponentCallbacks callback)
Add a new
ComponentCallbacks to the base application of the
Context, which will be called at the same times as the ComponentCallbacks
methods of activities and other components are called. |
abstract Intent |
registerReceiver(BroadcastReceiver receiver,
IntentFilter filter)
Register a BroadcastReceiver to be run in the main activity thread.
|
abstract Intent |
registerReceiver(BroadcastReceiver receiver,
IntentFilter filter,
String broadcastPermission,
Handler scheduler)
Register to receive intent broadcasts, to run in the context of
scheduler.
|
abstract Intent |
registerReceiverAsUser(BroadcastReceiver receiver,
UserHandle user,
IntentFilter filter,
String broadcastPermission,
Handler scheduler) |
abstract void |
removeStickyBroadcast(Intent 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 something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
|
abstract void |
removeStickyBroadcastAsUser(Intent intent,
UserHandle user)
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.
|
abstract void |
revokeUriPermission(Uri uri,
int modeFlags)
Remove all permissions to access a particular content provider Uri
that were previously added with
grantUriPermission(java.lang.String, android.net.Uri, int) . |
abstract void |
sendBroadcast(Intent intent)
Broadcast the given intent to all interested BroadcastReceivers.
|
abstract void |
sendBroadcast(Intent intent,
String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an optional required permission to be enforced.
|
abstract void |
sendBroadcast(Intent intent,
String receiverPermission,
Bundle options)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an optional required permission to be enforced.
|
abstract void |
sendBroadcast(Intent intent,
String receiverPermission,
int appOp)
Like
sendBroadcast(Intent, String) , but also allows specification
of an associated app op as per AppOpsManager . |
abstract void |
sendBroadcastAsUser(Intent intent,
UserHandle user)
Version of
sendBroadcast(Intent) that allows you to specify the
user the broadcast will be sent to. |
abstract void |
sendBroadcastAsUser(Intent intent,
UserHandle user,
String receiverPermission)
Version of
sendBroadcast(Intent, String) that allows you to specify the
user the broadcast will be sent to. |
abstract void |
sendBroadcastAsUser(Intent intent,
UserHandle user,
String receiverPermission,
int appOp)
Version of
sendBroadcast(Intent, String) that allows you to specify the
user the broadcast will be sent to. |
abstract void |
sendBroadcastMultiplePermissions(Intent intent,
String[] receiverPermissions)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an array of required permissions to be enforced.
|
abstract void |
sendOrderedBroadcast(Intent intent,
String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, delivering
them one at a time to allow more preferred receivers to consume the
broadcast before it is delivered to less preferred receivers.
|
abstract void |
sendOrderedBroadcast(Intent intent,
String receiverPermission,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Version of
sendBroadcast(Intent) that allows you to
receive data back from the broadcast. |
abstract void |
sendOrderedBroadcast(Intent intent,
String receiverPermission,
Bundle options,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Version of
sendBroadcast(Intent) that allows you to
receive data back from the broadcast. |
abstract void |
sendOrderedBroadcast(Intent intent,
String receiverPermission,
int appOp,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Like
sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler,
int, String, android.os.Bundle) , but also allows specification
of an associated app op as per AppOpsManager . |
abstract void |
sendOrderedBroadcastAsUser(Intent intent,
UserHandle user,
String receiverPermission,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Version of
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
that allows you to specify the
user the broadcast will be sent to. |
abstract void |
sendOrderedBroadcastAsUser(Intent intent,
UserHandle user,
String receiverPermission,
int appOp,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Similar to above but takes an appOp as well, to enforce restrictions.
|
abstract void |
sendOrderedBroadcastAsUser(Intent intent,
UserHandle user,
String receiverPermission,
int appOp,
Bundle options,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
Similar to above but takes an appOp as well, to enforce restrictions, and an options Bundle.
|
abstract void |
sendStickyBroadcast(Intent 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 something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
|
abstract void |
sendStickyBroadcastAsUser(Intent intent,
UserHandle user)
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.
|
abstract void |
sendStickyBroadcastAsUser(Intent intent,
UserHandle user,
Bundle options)
Deprecated.
|
abstract void |
sendStickyOrderedBroadcast(Intent intent,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
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.
|
abstract void |
sendStickyOrderedBroadcastAsUser(Intent intent,
UserHandle user,
BroadcastReceiver resultReceiver,
Handler scheduler,
int initialCode,
String initialData,
Bundle initialExtras)
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.
|
abstract void |
setTheme(int resid)
Set the base theme for this context.
|
abstract void |
setWallpaper(Bitmap bitmap)
Deprecated.
Use
WallpaperManager.set() instead.
This method requires the caller to hold the permission
|
abstract void |
setWallpaper(InputStream data)
Deprecated.
Use
WallpaperManager.set() instead.
This method requires the caller to hold the permission
|
abstract void |
startActivities(Intent[] intents)
Same as
startActivities(Intent[], Bundle) with no options
specified. |
abstract void |
startActivities(Intent[] intents,
Bundle options)
Launch multiple new activities.
|
void |
startActivitiesAsUser(Intent[] intents,
Bundle options,
UserHandle userHandle) |
abstract void |
startActivity(Intent intent)
Same as
startActivity(Intent, Bundle) with no options
specified. |
abstract void |
startActivity(Intent intent,
Bundle options)
Launch a new activity.
|
void |
startActivityAsUser(Intent intent,
Bundle options,
UserHandle userId)
Version of
startActivity(Intent, Bundle) that allows you to specify the
user the activity will be started for. |
void |
startActivityAsUser(Intent intent,
UserHandle user)
Version of
startActivity(Intent) that allows you to specify the
user the activity will be started for. |
void |
startActivityForResult(String who,
Intent intent,
int requestCode,
Bundle options)
Version of
startActivity(Intent, Bundle) that returns a result to the caller. |
abstract boolean |
startInstrumentation(ComponentName className,
String profileFile,
Bundle arguments)
Start executing an
Instrumentation class. |
abstract void |
startIntentSender(IntentSender intent,
Intent fillInIntent,
int flagsMask,
int flagsValues,
int extraFlags)
Same as
startIntentSender(IntentSender, Intent, int, int, int, Bundle)
with no options specified. |
abstract void |
startIntentSender(IntentSender intent,
Intent fillInIntent,
int flagsMask,
int flagsValues,
int extraFlags,
Bundle options)
Like
startActivity(Intent, Bundle) , but taking a IntentSender
to start. |
abstract ComponentName |
startService(Intent service)
Request that a given application service be started.
|
abstract ComponentName |
startServiceAsUser(Intent service,
UserHandle user) |
abstract boolean |
stopService(Intent service)
Request that a given application service be stopped.
|
abstract boolean |
stopServiceAsUser(Intent service,
UserHandle user) |
abstract void |
unbindService(ServiceConnection conn)
Disconnect from an application service.
|
void |
unregisterComponentCallbacks(ComponentCallbacks callback)
Remove a
ComponentCallbacks object that was previously registered
with registerComponentCallbacks(ComponentCallbacks) . |
abstract void |
unregisterReceiver(BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver.
|
public static final int MODE_PRIVATE
@Deprecated public static final int MODE_WORLD_READABLE
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.
As of Build.VERSION_CODES.N
attempting to use this
mode will throw a SecurityException
.
@Deprecated public static final int MODE_WORLD_WRITEABLE
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.
As of Build.VERSION_CODES.N
attempting to use this
mode will throw a SecurityException
.
public static final int MODE_APPEND
openFileOutput(java.lang.String, int)
, if the file
already exists then write data to the end of the existing file
instead of erasing it.@Deprecated public static final int MODE_MULTI_PROCESS
ContentProvider
.This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targetting such releases. For applications targetting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.
public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING
#openOrCreateDatabase(String, int, CursorFactory)
,
#openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
,
SQLiteDatabase.enableWriteAheadLogging()
,
Constant Field Valuespublic static final int MODE_NO_LOCALIZED_COLLATORS
#openOrCreateDatabase(String, int, CursorFactory)
,
#openOrCreateDatabase(String, int, CursorFactory, DatabaseErrorHandler)
,
SQLiteDatabase.NO_LOCALIZED_COLLATORS
,
Constant Field Valuespublic static final int BIND_AUTO_CREATE
bindService(android.content.Intent, android.content.ServiceConnection, int)
: automatically create the service as long
as the binding exists. Note that while this will create the service,
its Service.onStartCommand(android.content.Intent, int, int)
method will still only be called due to an
explicit call to startService(android.content.Intent)
. Even without that, though,
this still provides you with access to the service object while the
service is created.
Note that prior to Build.VERSION_CODES.ICE_CREAM_SANDWICH
,
not supplying this flag would also impact how important the system
consider's the target service's process to be. When set, the only way
for it to be raised was by binding from a service in which case it will
only be important when that activity is in the foreground. Now to
achieve this behavior you must explicitly supply the new flag
BIND_ADJUST_WITH_ACTIVITY
. For compatibility, old applications
that don't specify BIND_AUTO_CREATE
will automatically have
the flags BIND_WAIVE_PRIORITY
and
BIND_ADJUST_WITH_ACTIVITY
set for them in order to achieve
the same result.
public static final int BIND_DEBUG_UNBIND
bindService(android.content.Intent, android.content.ServiceConnection, int)
: include debugging help for mismatched
calls to unbind. When this flag is set, the callstack of the following
unbindService(android.content.ServiceConnection)
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_NOT_FOREGROUND
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_ABOVE_CLIENT
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_ALLOW_OOM_MANAGEMENT
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_WAIVE_PRIORITY
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_IMPORTANT
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_ADJUST_WITH_ACTIVITY
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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_ALLOW_WHITELIST_MANAGEMENT
public static final int BIND_FOREGROUND_SERVICE_WHILE_AWAKE
public static final int BIND_FOREGROUND_SERVICE
public static final int BIND_TREAT_LIKE_ACTIVITY
public static final int BIND_VISIBLE
public static final int BIND_SHOWING_UI
public static final int BIND_NOT_VISIBLE
bindService(android.content.Intent, android.content.ServiceConnection, int)
: Don't consider the bound service to be
visible, even if the caller is visible.public static final int BIND_EXTERNAL_SERVICE
bindService(android.content.Intent, android.content.ServiceConnection, int)
: 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.
public static final String POWER_SERVICE
getSystemService(java.lang.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.public static final String RECOVERY_SERVICE
getSystemService(java.lang.String)
to retrieve a
RecoverySystem
for accessing the recovery system
service.public static final String WINDOW_SERVICE
getSystemService(java.lang.String)
to retrieve a
WindowManager
for accessing the system's window
manager.public static final String LAYOUT_INFLATER_SERVICE
getSystemService(java.lang.String)
to retrieve a
LayoutInflater
for inflating layout resources in this
context.public static final String ACCOUNT_SERVICE
getSystemService(java.lang.String)
to retrieve a
android.accounts.AccountManager
for receiving intents at a
time of your choosing.getSystemService(java.lang.String)
,
android.accounts.AccountManager
,
Constant Field Valuespublic static final String ACTIVITY_SERVICE
getSystemService(java.lang.String)
to retrieve a
ActivityManager
for interacting with the global
system state.public static final String ALARM_SERVICE
getSystemService(java.lang.String)
to retrieve a
AlarmManager
for receiving intents at a
time of your choosing.public static final String NOTIFICATION_SERVICE
getSystemService(java.lang.String)
to retrieve a
NotificationManager
for informing the user of
background events.public static final String ACCESSIBILITY_SERVICE
getSystemService(java.lang.String)
to retrieve a
AccessibilityManager
for giving the user
feedback for UI events through the registered event listeners.public static final String CAPTIONING_SERVICE
getSystemService(java.lang.String)
to retrieve a
CaptioningManager
for obtaining
captioning properties and listening for changes in captioning
preferences.public static final String KEYGUARD_SERVICE
getSystemService(java.lang.String)
to retrieve a
NotificationManager
for controlling keyguard.public static final String LOCATION_SERVICE
getSystemService(java.lang.String)
to retrieve a LocationManager
for controlling location
updates.public static final String COUNTRY_DETECTOR
getSystemService(java.lang.String)
to retrieve a
CountryDetector
for detecting the country that
the user is in.public static final String SEARCH_SERVICE
getSystemService(java.lang.String)
to retrieve a SearchManager
for handling searches.public static final String SENSOR_SERVICE
getSystemService(java.lang.String)
to retrieve a SensorManager
for accessing sensors.public static final String STORAGE_SERVICE
getSystemService(java.lang.String)
to retrieve a StorageManager
for accessing system storage
functions.public static final String WALLPAPER_SERVICE
getSystemService(java.lang.String)
to retrieve a
com.android.server.WallpaperService for accessing wallpapers.public static final String VIBRATOR_SERVICE
getSystemService(java.lang.String)
to retrieve a Vibrator
for interacting with the vibration hardware.public static final String STATUS_BAR_SERVICE
getSystemService(java.lang.String)
to retrieve a StatusBarManager
for interacting with the status bar.public static final String CONNECTIVITY_SERVICE
getSystemService(java.lang.String)
to retrieve a ConnectivityManager
for handling management of
network connections.public static final String UPDATE_LOCK_SERVICE
getSystemService(java.lang.String)
to retrieve a android.os.IUpdateLock
for managing runtime sequences that
must not be interrupted by headless OTA application or similar.public static final String NETWORKMANAGEMENT_SERVICE
public static final String NETWORK_STATS_SERVICE
getSystemService(java.lang.String)
to retrieve a NetworkStatsManager
for querying network usage stats.public static final String NETWORK_POLICY_SERVICE
public static final String WIFI_SERVICE
getSystemService(java.lang.String)
to retrieve a WifiManager
for handling management of
Wi-Fi access.public static final String WIFI_P2P_SERVICE
getSystemService(java.lang.String)
to retrieve a WifiP2pManager
for handling management of
Wi-Fi peer-to-peer connections.public static final String WIFI_NAN_SERVICE
getSystemService(java.lang.String)
to retrieve a
WifiNanManager
for handling management of
Wi-Fi NAN discovery and connections.public static final String WIFI_SCANNING_SERVICE
getSystemService(java.lang.String)
to retrieve a WifiScanner
for scanning the wifi universepublic static final String WIFI_RTT_SERVICE
getSystemService(java.lang.String)
to retrieve a RttManager
for ranging devices with wifipublic static final String ETHERNET_SERVICE
getSystemService(java.lang.String)
to retrieve a EthernetManager
for handling management of
Ethernet access.public static final String NSD_SERVICE
getSystemService(java.lang.String)
to retrieve a NsdManager
for handling management of network service
discoverypublic static final String AUDIO_SERVICE
getSystemService(java.lang.String)
to retrieve a
AudioManager
for handling management of volume,
ringer modes and audio routing.public static final String FINGERPRINT_SERVICE
getSystemService(java.lang.String)
to retrieve a
FingerprintManager
for handling management
of fingerprints.public static final String MEDIA_ROUTER_SERVICE
getSystemService(java.lang.String)
to retrieve a
MediaRouter
for controlling and managing
routing of media.public static final String MEDIA_SESSION_SERVICE
getSystemService(java.lang.String)
to retrieve a
MediaSessionManager
for managing media Sessions.public static final String TELEPHONY_SERVICE
getSystemService(java.lang.String)
to retrieve a
TelephonyManager
for handling management the
telephony features of the device.public static final String TELEPHONY_SUBSCRIPTION_SERVICE
getSystemService(java.lang.String)
to retrieve a
SubscriptionManager
for handling management the
telephony subscriptions of the device.public static final String TELECOM_SERVICE
getSystemService(java.lang.String)
to retrieve a
TelecomManager
to manage telecom-related features
of the device.public static final String CARRIER_CONFIG_SERVICE
getSystemService(java.lang.String)
to retrieve a
CarrierConfigManager
for reading carrier configuration values.public static final String CLIPBOARD_SERVICE
getSystemService(java.lang.String)
to retrieve a
ClipboardManager
for accessing and modifying
ClipboardManager
for accessing and modifying
the contents of the global clipboard.public static final String INPUT_METHOD_SERVICE
getSystemService(java.lang.String)
to retrieve a
InputMethodManager
for accessing input
methods.public static final String TEXT_SERVICES_MANAGER_SERVICE
getSystemService(java.lang.String)
to retrieve a
TextServicesManager
for accessing
text services.public static final String APPWIDGET_SERVICE
getSystemService(java.lang.String)
to retrieve a
AppWidgetManager
for accessing AppWidgets.public static final String VOICE_INTERACTION_MANAGER_SERVICE
public static final String SOUND_TRIGGER_SERVICE
getSystemService(java.lang.String)
to access the
com.android.server.voiceinteraction.SoundTriggerService
.public static final String BACKUP_SERVICE
getSystemService(java.lang.String)
to retrieve an
IBackupManager
for communicating
with the backup mechanism.public static final String DROPBOX_SERVICE
getSystemService(java.lang.String)
to retrieve a
DropBoxManager
instance for recording
diagnostic logs.public static final String DEVICE_IDLE_CONTROLLER
public static final String DEVICE_POLICY_SERVICE
getSystemService(java.lang.String)
to retrieve a
DevicePolicyManager
for working with global
device policy management.public static final String UI_MODE_SERVICE
getSystemService(java.lang.String)
to retrieve a
UiModeManager
for controlling UI modes.public static final String DOWNLOAD_SERVICE
getSystemService(java.lang.String)
to retrieve a
DownloadManager
for requesting HTTP downloads.public static final String BATTERY_SERVICE
getSystemService(java.lang.String)
to retrieve a
BatteryManager
for managing battery state.public static final String NFC_SERVICE
getSystemService(java.lang.String)
to retrieve a
NfcManager
for using NFC.public static final String BLUETOOTH_SERVICE
getSystemService(java.lang.String)
to retrieve a
BluetoothManager
for using Bluetooth.public static final String SIP_SERVICE
public static final String USB_SERVICE
getSystemService(java.lang.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.public static final String SERIAL_SERVICE
getSystemService(java.lang.String)
to retrieve a SerialManager
for access to serial ports.public static final String HDMI_CONTROL_SERVICE
getSystemService(java.lang.String)
to retrieve a
HdmiControlManager
for controlling and managing
HDMI-CEC protocol.public static final String INPUT_SERVICE
getSystemService(java.lang.String)
to retrieve a
InputManager
for interacting with input devices.public static final String DISPLAY_SERVICE
getSystemService(java.lang.String)
to retrieve a
DisplayManager
for interacting with display devices.public static final String USER_SERVICE
getSystemService(java.lang.String)
to retrieve a
UserManager
for managing users on devices that support multiple users.public static final String LAUNCHER_APPS_SERVICE
getSystemService(java.lang.String)
to retrieve a
LauncherApps
for querying and monitoring launchable apps across
profiles of a user.public static final String RESTRICTIONS_SERVICE
getSystemService(java.lang.String)
to retrieve a
RestrictionsManager
for retrieving application restrictions
and requesting permissions for restricted operations.public static final String APP_OPS_SERVICE
getSystemService(java.lang.String)
to retrieve a
AppOpsManager
for tracking application operations
on the device.public static final String CAMERA_SERVICE
getSystemService(java.lang.String)
to retrieve a
CameraManager
for interacting with
camera devices.public static final String PRINT_SERVICE
PrintManager
for printing and managing
printers and print tasks.public static final String CONSUMER_IR_SERVICE
getSystemService(java.lang.String)
to retrieve a
ConsumerIrManager
for transmitting infrared
signals from the device.public static final String TRUST_SERVICE
TrustManager
for managing trust agents.public static final String TV_INPUT_SERVICE
getSystemService(java.lang.String)
to retrieve a
TvInputManager
for interacting with TV inputs
on the device.public static final String NETWORK_SCORE_SERVICE
NetworkScoreManager
for managing network scoring.public static final String USAGE_STATS_SERVICE
getSystemService(java.lang.String)
to retrieve a UsageStatsManager
for querying device usage stats.public static final String JOB_SCHEDULER_SERVICE
getSystemService(java.lang.String)
to retrieve a JobScheduler
instance for managing occasional
background tasks.public static final String PERSISTENT_DATA_BLOCK_SERVICE
getSystemService(java.lang.String)
to retrieve a PersistentDataBlockManager
instance
for interacting with a storage device that lives across factory resets.public static final String MEDIA_PROJECTION_SERVICE
getSystemService(java.lang.String)
to retrieve a MediaProjectionManager
instance for managing
media projection sessions.public static final String MIDI_SERVICE
getSystemService(java.lang.String)
to retrieve a
MidiManager
for accessing the MIDI service.public static final String RADIO_SERVICE
getSystemService(java.lang.String)
to retrieve a
RadioManager
for accessing the broadcast radio service.public static final String HARDWARE_PROPERTIES_SERVICE
getSystemService(java.lang.String)
to retrieve a
HardwarePropertiesManager
for accessing the hardware properties service.public static final String SHORTCUT_SERVICE
getSystemService(java.lang.String)
to retrieve a
ShortcutManager
for accessing the launcher shortcut service.public static final String CONTEXTHUB_SERVICE
getSystemService(java.lang.String)
to retrieve a ContextHubManager
for accessing context hubs.public static final String SYSTEM_HEALTH_SERVICE
getSystemService(java.lang.String)
to retrieve a
SystemHealthManager
for accessing system health (battery, power,
memory, etc) metrics.public static final String GATEKEEPER_SERVICE
public static final int CONTEXT_INCLUDE_CODE
createPackageContext(java.lang.String, int)
: 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.public static final int CONTEXT_IGNORE_SECURITY
createPackageContext(java.lang.String, int)
: 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!public static final int CONTEXT_RESTRICTED
createPackageContext(java.lang.String, int)
: 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_DEVICE_PROTECTED_STORAGE
createPackageContext(java.lang.String, int)
: point all file APIs at
device-protected storage.public static final int CONTEXT_CREDENTIAL_PROTECTED_STORAGE
createPackageContext(java.lang.String, int)
: point all file APIs at
credential-protected storage.public static final int CONTEXT_REGISTER_PACKAGE
public abstract AssetManager getAssets()
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.
getResources()
public abstract Resources getResources()
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.
getAssets()
public abstract PackageManager getPackageManager()
public abstract ContentResolver getContentResolver()
public abstract Looper getMainLooper()
By definition, this method returns the same result as would be obtained
by calling Looper.getMainLooper()
.
public abstract Context getApplicationContext()
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.
public void registerComponentCallbacks(ComponentCallbacks callback)
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(android.content.ComponentCallbacks)
when
appropriate in the future; this will not be removed for you.callback
- The interface to call. This can be either a
ComponentCallbacks
or ComponentCallbacks2
interface.public void unregisterComponentCallbacks(ComponentCallbacks callback)
ComponentCallbacks
object that was previously registered
with registerComponentCallbacks(ComponentCallbacks)
.public final CharSequence getText(@StringRes int resId)
resId
- Resource id for the CharSequence textpublic final String getString(@StringRes int resId)
resId
- Resource id for the stringpublic final String getString(@StringRes int resId, Object... formatArgs)
Formatter
and String.format(java.lang.String, java.lang.Object...)
.resId
- Resource id for the format stringformatArgs
- The format arguments that will be used for
substitution.public final int getColor(@ColorRes int id)
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.Resources.NotFoundException
- if the given ID
does not exist.public final Drawable getDrawable(@DrawableRes int id)
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.null
if the resource could not be resolved.Resources.NotFoundException
- if the given ID
does not exist.public final ColorStateList getColorStateList(@ColorRes int id)
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.null
if the resource could not be
resolved.Resources.NotFoundException
- if the given ID
does not exist.public abstract void setTheme(@StyleRes int resid)
Activity.setContentView(int)
or
LayoutInflater.inflate(int, android.view.ViewGroup)
).resid
- The style resource describing the theme.public int getThemeResId()
public abstract Resources.Theme getTheme()
public final TypedArray obtainStyledAttributes(@StyleableRes int[] attrs)
Resources.Theme.obtainStyledAttributes(int[])
for more information.public final TypedArray obtainStyledAttributes(@StyleRes int resid, @StyleableRes int[] attrs) throws Resources.NotFoundException
Resources.Theme.obtainStyledAttributes(int, int[])
for more information.public final TypedArray obtainStyledAttributes(AttributeSet set, @StyleableRes int[] attrs)
Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.public final TypedArray obtainStyledAttributes(AttributeSet set, @StyleableRes int[] attrs, @AttrRes int defStyleAttr, @StyleRes int defStyleRes)
Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.public abstract ClassLoader getClassLoader()
public abstract String getPackageName()
public abstract String getBasePackageName()
public abstract String getOpPackageName()
public abstract ApplicationInfo getApplicationInfo()
public abstract String getPackageResourcePath()
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
public abstract String getPackageCodePath()
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
@Deprecated public File getSharedPrefsFile(String name)
getSharedPreferencesPath(String)
public abstract SharedPreferences getSharedPreferences(String name, int mode)
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. Use 0 or MODE_PRIVATE
for the
default operation.SharedPreferences
instance that can be used
to retrieve and modify the preference values.MODE_PRIVATE
public abstract SharedPreferences getSharedPreferences(File file, int mode)
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. Use 0 or MODE_PRIVATE
for the
default operation.SharedPreferences
instance that can be used
to retrieve and modify the preference values.getSharedPreferencesPath(String)
,
MODE_PRIVATE
public abstract boolean moveSharedPreferencesFrom(Context sourceContext, String name)
sourceContext
- The source context which contains the existing
shared preferences to move.name
- The name of the shared preferences file.true
if the move was successful or if the shared
preferences didn't exist in the source context, otherwise
false
.createDeviceProtectedStorageContext()
@Deprecated public boolean migrateSharedPreferencesFrom(Context sourceContext, String name)
public abstract boolean deleteSharedPreferences(String name)
name
- The name (unique in the application package) of the shared
preferences file.true
if the shared preferences file was successfully
deleted; else false
.getSharedPreferences(String, int)
public abstract FileInputStream openFileInput(String name) throws FileNotFoundException
name
- The name of the file to open; can not contain path
separators.FileInputStream
.FileNotFoundException
openFileOutput(java.lang.String, int)
,
fileList()
,
deleteFile(java.lang.String)
,
FileInputStream.FileInputStream(String)
public abstract FileOutputStream openFileOutput(String name, int mode) throws FileNotFoundException
No additional permissions are required for the calling app to read or write the returned file.
name
- The name of the file to open; can not contain path
separators.mode
- Operating mode. Use 0 or MODE_PRIVATE
for the
default operation. Use MODE_APPEND
to append to an
existing file.FileOutputStream
.FileNotFoundException
MODE_APPEND
,
MODE_PRIVATE
,
openFileInput(java.lang.String)
,
fileList()
,
deleteFile(java.lang.String)
,
FileOutputStream.FileOutputStream(String)
public abstract boolean deleteFile(String name)
name
- The name of the file to delete; can not contain path
separators.true
if the file was successfully deleted; else
false
.openFileInput(java.lang.String)
,
openFileOutput(java.lang.String, int)
,
fileList()
,
File.delete()
public abstract File getFileStreamPath(String name)
openFileOutput(java.lang.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.
name
- The name of the file for which you would like to get
its path.openFileOutput(java.lang.String, int)
,
getFilesDir()
,
getDir(java.lang.String, int)
public abstract File getSharedPreferencesPath(String name)
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.
name
- The name of the shared preferences for which you would like
to get a path.getSharedPreferences(String, int)
public abstract File getDataDir()
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.
ApplicationInfo.dataDir
public abstract File getFilesDir()
openFileOutput(java.lang.String, int)
are stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
openFileOutput(java.lang.String, int)
,
getFileStreamPath(java.lang.String)
,
getDir(java.lang.String, int)
public abstract File getNoBackupFilesDir()
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.
openFileOutput(java.lang.String, int)
,
getFileStreamPath(java.lang.String)
,
getDir(java.lang.String, int)
,
BackupAgent
public abstract File getExternalFilesDir(String type)
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Environment.getExternalStorageState(File)
.
android.Manifest.permission#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 Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the returned path; it's always
accessible to the calling app. This only applies to paths generated for
package name of the calling application. To access paths belonging to
other packages,
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
and/or
android.Manifest.permission#READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
),
each user has their own isolated shared storage. Applications only have
access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Here is an example of typical code to manipulate a file in an application's shared storage:
If you supply a non-null type to this function, the returned
file will be a path to a sub-directory of the given type. Though these
files are not automatically scanned by the media scanner, you can
explicitly add them to the media database with
MediaScannerConnection.scanFile
. Note that this is not the same as
Environment.getExternalStoragePublicDirectory()
, which provides
directories of media shared by all applications. The directories returned
here are owned by the application, and their contents will be removed
when the application is uninstalled. Unlike
Environment.getExternalStoragePublicDirectory()
, the directory returned
here will be automatically created for you.
Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:
type
- The type of files directory to return. May be null
for the root of the files directory or one of the following
constants for a subdirectory:
Environment.DIRECTORY_MUSIC
,
Environment.DIRECTORY_PODCASTS
,
Environment.DIRECTORY_RINGTONES
,
Environment.DIRECTORY_ALARMS
,
Environment.DIRECTORY_NOTIFICATIONS
,
Environment.DIRECTORY_PICTURES
, or
Environment.DIRECTORY_MOVIES
.null
if shared storage is not currently available.getFilesDir()
,
getExternalFilesDirs(String)
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File[] getExternalFilesDirs(String type)
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Environment.getExternalStorageState(File)
.
android.Manifest.permission#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.
type
- The type of files directory to return. May be null
for the root of the files directory or one of the following
constants for a subdirectory:
Environment.DIRECTORY_MUSIC
,
Environment.DIRECTORY_PODCASTS
,
Environment.DIRECTORY_RINGTONES
,
Environment.DIRECTORY_ALARMS
,
Environment.DIRECTORY_NOTIFICATIONS
,
Environment.DIRECTORY_PICTURES
, or
Environment.DIRECTORY_MOVIES
.null
if that shared storage is
not currently available. The first path returned is the same as
getExternalFilesDir(String)
.getExternalFilesDir(String)
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File getObbDir()
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Environment.getExternalStorageState(File)
.
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to
these files.
Starting in Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the returned path; it's always
accessible to the calling app. This only applies to paths generated for
package name of the calling application. To access paths belonging to
other packages,
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
and/or
android.Manifest.permission#READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
),
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.
null
if shared storage is not currently available.getObbDirs()
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File[] getObbDirs()
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Environment.getExternalStorageState(File)
.
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to
these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For
example, an app may choose to store large files on the device with the
most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
null
if that shared storage is
not currently available. The first path returned is the same as
getObbDir()
getObbDir()
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File getCacheDir()
Note: you should not rely on the system deleting these
files for you; you should always have a reasonable maximum, such as 1 MB,
for the amount of space you consume with cache files, and prune those
files when exceeding that space. If your app requires a larger
cache (larger than 1 MB), you should use getExternalCacheDir()
instead.
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.
openFileOutput(java.lang.String, int)
,
getFileStreamPath(java.lang.String)
,
getDir(java.lang.String, int)
,
getExternalCacheDir()
public abstract File getCodeCacheDir()
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.
public abstract File getExternalCacheDir()
This is like getCacheDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Build.VERSION_CODES.JELLY_BEAN_MR1
or later and
Environment.isExternalStorageEmulated(File)
returns true.
Environment.getExternalStorageState(File)
.
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to
these files.
If a shared storage device is emulated (as determined by
Environment.isExternalStorageEmulated(File)
), its contents are
backed by a private user data partition, which means there is little
benefit to storing data here instead of the private directory returned by
getCacheDir()
.
Starting in Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the returned path; it's always
accessible to the calling app. This only applies to paths generated for
package name of the calling application. To access paths belonging to
other packages,
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
and/or
android.Manifest.permission#READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
),
each user has their own isolated shared storage. Applications only have
access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
null
if shared storage is not currently available.getCacheDir()
,
getExternalCacheDirs()
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File[] getExternalCacheDirs()
This is like getCacheDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
Build.VERSION_CODES.JELLY_BEAN_MR1
or later and
Environment.isExternalStorageEmulated(File)
returns true.
Environment.getExternalStorageState(File)
.
android.Manifest.permission#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.
null
if that shared storage is
not currently available. The first path returned is the same as
getExternalCacheDir()
.getExternalCacheDir()
,
Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract File[] getExternalMediaDirs()
MediaStore
.
This is like getExternalFilesDirs(java.lang.String)
in that these files will be
deleted when the application is uninstalled, however there are some
important differences:
Environment.getExternalStorageState(File)
.
android.Manifest.permission#WRITE_EXTERNAL_STORAGE
can write to
these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For
example, an app may choose to store large files on the device with the
most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
null
if that shared storage is
not currently available.Environment.getExternalStorageState(File)
,
Environment.isExternalStorageEmulated(File)
,
Environment.isExternalStorageRemovable(File)
public abstract String[] fileList()
openFileInput(java.lang.String)
,
openFileOutput(java.lang.String, int)
,
deleteFile(java.lang.String)
public abstract File getDir(String name, int mode)
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.
name
- Name of the directory to retrieve. This is a directory
that is created as part of your application data.mode
- Operating mode. Use 0 or MODE_PRIVATE
for the
default operation.File
object for the requested directory. The directory
will have been created if it does not already exist.openFileOutput(String, int)
public abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)
name
- The name (unique in the application package) of the database.mode
- Operating mode. Use 0 or MODE_PRIVATE
for the
default operation. Use
MODE_ENABLE_WRITE_AHEAD_LOGGING
to enable write-ahead
logging by default. Use MODE_NO_LOCALIZED_COLLATORS
to disable localized collators.factory
- An optional factory class that is called to instantiate a
cursor when query is called.SQLiteException
- if the database file
could not be opened.MODE_PRIVATE
,
MODE_ENABLE_WRITE_AHEAD_LOGGING
,
MODE_NO_LOCALIZED_COLLATORS
,
deleteDatabase(java.lang.String)
public abstract SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)
Accepts input param: a concrete instance of DatabaseErrorHandler
to be used to handle corruption when sqlite reports database corruption.
name
- The name (unique in the application package) of the database.mode
- Operating mode. Use 0 or MODE_PRIVATE
for the
default operation. Use
MODE_ENABLE_WRITE_AHEAD_LOGGING
to enable write-ahead
logging by default. Use MODE_NO_LOCALIZED_COLLATORS
to disable localized collators.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.SQLiteException
- if the database file
could not be opened.MODE_PRIVATE
,
MODE_ENABLE_WRITE_AHEAD_LOGGING
,
MODE_NO_LOCALIZED_COLLATORS
,
deleteDatabase(java.lang.String)
public abstract boolean moveDatabaseFrom(Context sourceContext, String name)
The database must be closed before being moved.
sourceContext
- The source context which contains the existing
database to move.name
- The name of the database file.true
if the move was successful or if the database didn't
exist in the source context, otherwise false
.createDeviceProtectedStorageContext()
@Deprecated public boolean migrateDatabaseFrom(Context sourceContext, String name)
public abstract boolean deleteDatabase(String name)
name
- The name (unique in the application package) of the
database.true
if the database was successfully deleted; else false
.openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory)
public abstract File getDatabasePath(String name)
openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory)
is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
name
- The name of the database for which you would like to get
its path.openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory)
public abstract String[] databaseList()
openOrCreateDatabase(java.lang.String, int, android.database.sqlite.SQLiteDatabase.CursorFactory)
,
deleteDatabase(java.lang.String)
@Deprecated public abstract Drawable getWallpaper()
WallpaperManager.get()
instead.@Deprecated public abstract Drawable peekWallpaper()
WallpaperManager.peek()
instead.@Deprecated public abstract int getWallpaperDesiredMinimumWidth()
WallpaperManager.getDesiredMinimumWidth()
instead.@Deprecated public abstract int getWallpaperDesiredMinimumHeight()
WallpaperManager.getDesiredMinimumHeight()
instead.@Deprecated public abstract void setWallpaper(Bitmap bitmap) throws IOException
WallpaperManager.set()
instead.
This method requires the caller to hold the permission
android.Manifest.permission#SET_WALLPAPER
.
IOException
@Deprecated public abstract void setWallpaper(InputStream data) throws IOException
WallpaperManager.set()
instead.
This method requires the caller to hold the permission
android.Manifest.permission#SET_WALLPAPER
.
IOException
@Deprecated public abstract void clearWallpaper() throws IOException
WallpaperManager.clear()
instead.
This method requires the caller to hold the permission
android.Manifest.permission#SET_WALLPAPER
.
IOException
public abstract void startActivity(Intent intent)
startActivity(Intent, Bundle)
with no options
specified.intent
- The description of the activity to start.ActivityNotFoundException
-
`startActivity(Intent, Bundle)
,
PackageManager.resolveActivity(android.content.Intent, int)
public void startActivityAsUser(Intent intent, UserHandle user)
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. Using it requires holding
the INTERACT_ACROSS_USERS_FULL permission.intent
- The description of the activity to start.user
- The UserHandle of the user to start this activity for.ActivityNotFoundException
- public abstract void startActivity(Intent intent, Bundle options)
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.
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.ActivityNotFoundException
- startActivity(Intent)
,
PackageManager.resolveActivity(android.content.Intent, int)
public void startActivityAsUser(Intent intent, Bundle options, UserHandle userId)
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. Using it requires holding
the INTERACT_ACROSS_USERS_FULL permission.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.ActivityNotFoundException
- public void startActivityForResult(String who, Intent intent, int requestCode, Bundle options)
startActivity(Intent, Bundle)
that returns a result to the caller. This
is only supported for Views and Fragments.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.public boolean canStartActivityForResult()
startActivityForResult(String, Intent, int, Bundle)
.public abstract void startActivities(Intent[] intents)
startActivities(Intent[], Bundle)
with no options
specified.intents
- An array of Intents to be started.ActivityNotFoundException
- startActivities(Intent[], Bundle)
,
PackageManager.resolveActivity(android.content.Intent, int)
public abstract void startActivities(Intent[] intents, Bundle options)
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.
intents
- An array of Intents to be started.options
- Additional options for how the Activity should be started.
See Context.startActivity(Intent, Bundle)
for more details.ActivityNotFoundException
- startActivities(Intent[])
,
PackageManager.resolveActivity(android.content.Intent, int)
public void startActivitiesAsUser(Intent[] intents, Bundle options, UserHandle userHandle)
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 Context.startActivity(Intent, Bundle)
for more details.ActivityNotFoundException
- startActivities(Intent[])
,
PackageManager.resolveActivity(android.content.Intent, int)
public abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) throws IntentSender.SendIntentException
startIntentSender(IntentSender, Intent, int, int, int, Bundle)
with no options specified.intent
- The IntentSender to launch.fillInIntent
- If non-null, this will be provided as the
intent parameter to IntentSender.sendIntent(android.content.Context, int, android.content.Intent, android.content.IntentSender.OnFinished, android.os.Handler)
.flagsMask
- Intent flags in the original IntentSender that you
would like to change.flagsValues
- Desired values for any bits set in
flagsMaskextraFlags
- Always set to 0.IntentSender.SendIntentException
startActivity(Intent)
,
startIntentSender(IntentSender, Intent, int, int, int, Bundle)
public abstract void startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) throws IntentSender.SendIntentException
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.intent
- The IntentSender to launch.fillInIntent
- If non-null, this will be provided as the
intent parameter to IntentSender.sendIntent(android.content.Context, int, android.content.Intent, android.content.IntentSender.OnFinished, android.os.Handler)
.flagsMask
- Intent flags in the original IntentSender that you
would like to change.flagsValues
- Desired values for any bits set in
flagsMaskextraFlags
- Always set to 0.options
- Additional options for how the Activity should be started.
See 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.IntentSender.SendIntentException
startActivity(Intent, Bundle)
,
startIntentSender(IntentSender, Intent, int, int, int)
public abstract void sendBroadcast(Intent intent)
sendOrderedBroadcast(Intent, String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
intent
- The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
sendBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendBroadcast(Intent intent, String receiverPermission)
sendOrderedBroadcast(Intent, String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
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.BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
sendBroadcast(Intent)
,
sendOrderedBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendBroadcastMultiplePermissions(Intent intent, String[] receiverPermissions)
sendOrderedBroadcast(Intent, String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
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.BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
sendBroadcast(Intent)
,
sendOrderedBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendBroadcast(Intent intent, String receiverPermission, Bundle options)
sendOrderedBroadcast(Intent, String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
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
.BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
sendBroadcast(Intent)
,
sendOrderedBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendBroadcast(Intent intent, String receiverPermission, int appOp)
sendBroadcast(Intent, String)
, but also allows specification
of an associated app op as per AppOpsManager
.public abstract void sendOrderedBroadcast(Intent intent, String receiverPermission)
See BroadcastReceiver
for more information on Intent broadcasts.
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.BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
sendBroadcast(Intent)
,
sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
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(android.content.Context, android.content.Intent)
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.
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.sendBroadcast(Intent)
,
sendBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String)
,
BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
Activity.RESULT_OK
public abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
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(android.content.Context, android.content.Intent)
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.
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.sendBroadcast(Intent)
,
sendBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String)
,
BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
Activity.RESULT_OK
public abstract void sendOrderedBroadcast(Intent intent, String receiverPermission, int appOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
sendOrderedBroadcast(Intent, String, BroadcastReceiver, android.os.Handler,
int, String, android.os.Bundle)
, but also allows specification
of an associated app op as per AppOpsManager
.public abstract void sendBroadcastAsUser(Intent intent, UserHandle user)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.intent
- The intent to broadcastuser
- UserHandle to send the intent to.sendBroadcast(Intent)
public abstract void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.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.sendBroadcast(Intent, String)
public abstract void sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, int appOp)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.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.sendBroadcast(Intent, String)
public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.
See BroadcastReceiver
for more information on Intent broadcasts.
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.sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)
public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, int appOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
public abstract void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, int appOp, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
@Deprecated public abstract void sendStickyBroadcast(Intent intent)
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)
.
You must hold the android.Manifest.permission#BROADCAST_STICKY
permission in order to use this API. If you do not hold that
permission, SecurityException
will be thrown.
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.sendBroadcast(Intent)
,
sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
@Deprecated public abstract void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendStickyBroadcast(android.content.Intent)
that allows you to
receive data back from the broadcast. This is accomplished by
supplying your own BroadcastReceiver when calling, which will be
treated as a final receiver at the end of the broadcast -- its
BroadcastReceiver.onReceive(android.content.Context, android.content.Intent)
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.
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.sendBroadcast(Intent)
,
sendBroadcast(Intent, String)
,
sendOrderedBroadcast(Intent, String)
,
sendStickyBroadcast(Intent)
,
BroadcastReceiver
,
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
,
Activity.RESULT_OK
@Deprecated public abstract void removeStickyBroadcast(Intent intent)
Remove the data previously sent with sendStickyBroadcast(android.content.Intent)
,
so that it is as if the sticky broadcast had never happened.
You must hold the android.Manifest.permission#BROADCAST_STICKY
permission in order to use this API. If you do not hold that
permission, SecurityException
will be thrown.
intent
- The Intent that was previously broadcast.sendStickyBroadcast(android.content.Intent)
@Deprecated public abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.
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.sendBroadcast(Intent)
@Deprecated public abstract void sendStickyBroadcastAsUser(Intent intent, UserHandle user, Bundle options)
@Deprecated public abstract void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.
See BroadcastReceiver
for more information on Intent broadcasts.
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.sendStickyOrderedBroadcast(Intent, BroadcastReceiver, Handler, int, String, Bundle)
@Deprecated public abstract void removeStickyBroadcastAsUser(Intent intent, UserHandle user)
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. Using it requires holding
the INTERACT_ACROSS_USERS permission.
You must hold the android.Manifest.permission#BROADCAST_STICKY
permission in order to use this API. If you do not hold that
permission, SecurityException
will be thrown.
intent
- The Intent that was previously broadcast.user
- UserHandle to remove the sticky broadcast from.sendStickyBroadcastAsUser(android.content.Intent, android.os.UserHandle)
public abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter)
The system may broadcast Intents that are "sticky" -- these stay around after the broadcast as finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.
There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.
If you know the Intent your are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.
See BroadcastReceiver
for more information on Intent broadcasts.
As of Build.VERSION_CODES.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(android.content.BroadcastReceiver, android.content.IntentFilter)
, since the lifetime of such a
registered BroadcastReceiver is tied to the object that registered it.
receiver
- The BroadcastReceiver to handle the broadcast.filter
- Selects the Intent broadcasts to be received.registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
,
sendBroadcast(android.content.Intent)
,
unregisterReceiver(android.content.BroadcastReceiver)
public abstract Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
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 Build.VERSION_CODES.ICE_CREAM_SANDWICH
, receivers
registered with this method will correctly respect the
Intent.setPackage(String)
specified for an Intent being broadcast.
Prior to that, it would be ignored and delivered to all matching registered
receivers. Be careful if using this for security.
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.registerReceiver(BroadcastReceiver, IntentFilter)
,
sendBroadcast(android.content.Intent)
,
unregisterReceiver(android.content.BroadcastReceiver)
public abstract Intent registerReceiverAsUser(BroadcastReceiver receiver, UserHandle user, IntentFilter filter, String broadcastPermission, Handler scheduler)
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.registerReceiver(BroadcastReceiver, IntentFilter, String, Handler)
,
sendBroadcast(android.content.Intent)
,
unregisterReceiver(android.content.BroadcastReceiver)
public abstract void unregisterReceiver(BroadcastReceiver receiver)
receiver
- The BroadcastReceiver to unregister.registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
public abstract ComponentName startService(Intent service)
Every call to this method will result in a corresponding call to
the target service's Service.onStartCommand(android.content.Intent, int, int)
method,
with the intent given here. This provides a convenient way
to submit jobs to a service without having to bind and call on to its
interface.
Using startService() overrides the default service lifetime that is
managed by bindService(android.content.Intent, android.content.ServiceConnection, int)
: it requires the service to remain
running until stopService(android.content.Intent)
is called, regardless of whether
any clients are connected to it. Note that calls to startService()
are not nesting: no matter how many times you call startService(),
a single call to stopService(android.content.Intent)
will stop it.
The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.
This function will throw SecurityException
if you do not
have permission to start the given service.
Note: Each call to startService()
results in significant work done by the system to manage service
lifecycle surrounding the processing of the intent, which can take
multiple milliseconds of CPU time. Due to this cost, startService()
should not be used for frequent intent delivery to a service, and only
for scheduling significant work. Use bound services
for high frequency calls.
service
- Identifies the service to be started. The Intent must be either
fully explicit (supplying a component name) or specify a specific package
name it is targetted to. Additional values
may be included in the Intent extras to supply arguments along with
this specific start call.ComponentName
of the actual service that was started is
returned; else if the service does not exist null is returned.SecurityException
- stopService(android.content.Intent)
,
bindService(android.content.Intent, android.content.ServiceConnection, int)
public abstract boolean stopService(Intent service)
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.
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 targetted to.true
is returned; else false
is returned.SecurityException
- startService(android.content.Intent)
public abstract ComponentName startServiceAsUser(Intent service, UserHandle user)
public abstract boolean stopServiceAsUser(Intent service, UserHandle user)
public abstract boolean bindService(Intent service, ServiceConnection conn, int flags)
This function will throw SecurityException
if you do not
have permission to bind to the given service.
Note: this method can not be called from a
BroadcastReceiver
component. A pattern you can use to
communicate from a BroadcastReceiver to a Service is to call
startService(android.content.Intent)
with the arguments containing the command to be
sent, with the service calling its
Service.stopSelf(int)
method when done executing
that command. See the API demo App/Service/Service Start Arguments
Controller for an illustration of this. It is okay, however, to use
this method from a BroadcastReceiver that has been registered with
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
, since the lifetime of this BroadcastReceiver
is tied to another object (the one that registered it).
service
- Identifies the service to connect to. The Intent may
specify either an explicit component name, or a logical
description (action, category, etc) to match an
IntentFilter
published by a service.conn
- Receives information as the service is started and stopped.
This must be a valid ServiceConnection object; it must not be null.flags
- Operation options for the binding. May be 0,
BIND_AUTO_CREATE
, BIND_DEBUG_UNBIND
,
BIND_NOT_FOREGROUND
, BIND_ABOVE_CLIENT
,
BIND_ALLOW_OOM_MANAGEMENT
, or
BIND_WAIVE_PRIORITY
.true
is returned;
false
is returned if the connection is not made so you will not
receive the service object.SecurityException
- unbindService(android.content.ServiceConnection)
,
startService(android.content.Intent)
,
BIND_AUTO_CREATE
,
BIND_DEBUG_UNBIND
,
BIND_NOT_FOREGROUND
public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user)
bindService(Intent, ServiceConnection, int)
, but with an explicit userHandle
argument for use by system server and other multi-user aware code.public boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, Handler handler, UserHandle user)
#bindService(Intent, ServiceConnection, int, UserHandle)
, but with an
explicit non-null Handler to run the ServiceConnection callbacks on.public abstract void unbindService(ServiceConnection conn)
conn
- The connection interface previously supplied to
bindService(). This parameter must not be null.bindService(android.content.Intent, android.content.ServiceConnection, int)
public abstract boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments)
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).
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.true
if the instrumentation was successfully started,
else false
if it could not be found.public abstract Object getSystemService(String name)
WINDOW_SERVICE
("window")
WindowManager
.
LAYOUT_INFLATER_SERVICE
("layout_inflater")
LayoutInflater
for inflating layout resources
in this context.
ACTIVITY_SERVICE
("activity")
ActivityManager
for interacting with the
global activity state of the system.
POWER_SERVICE
("power")
PowerManager
for controlling power
management.
ALARM_SERVICE
("alarm")
AlarmManager
for receiving intents at the
time of your choosing.
NOTIFICATION_SERVICE
("notification")
NotificationManager
for informing the user
of background events.
KEYGUARD_SERVICE
("keyguard")
KeyguardManager
for controlling keyguard.
LOCATION_SERVICE
("location")
LocationManager
for controlling location
(e.g., GPS) updates.
SEARCH_SERVICE
("search")
SearchManager
for handling search.
VIBRATOR_SERVICE
("vibrator")
Vibrator
for interacting with the vibrator
hardware.
CONNECTIVITY_SERVICE
("connection")
ConnectivityManager
for
handling management of network connections.
WIFI_SERVICE
("wifi")
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_P2P_SERVICE
("wifip2p")
WifiP2pManager
for management of
Wi-Fi Direct connectivity.
INPUT_METHOD_SERVICE
("input_method")
InputMethodManager
for management of input methods.
UI_MODE_SERVICE
("uimode")
UiModeManager
for controlling UI modes.
DOWNLOAD_SERVICE
("download")
DownloadManager
for requesting HTTP downloads
BATTERY_SERVICE
("batterymanager")
BatteryManager
for managing battery state
JOB_SCHEDULER_SERVICE
("taskmanager")
JobScheduler
for managing scheduled tasks
NETWORK_STATS_SERVICE
("netstats")
NetworkStatsManager
for querying network
usage statistics.
HARDWARE_PROPERTIES_SERVICE
("hardware_properties")
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.)
name
- The name of the desired service.WINDOW_SERVICE
,
WindowManager
,
LAYOUT_INFLATER_SERVICE
,
LayoutInflater
,
ACTIVITY_SERVICE
,
ActivityManager
,
POWER_SERVICE
,
PowerManager
,
ALARM_SERVICE
,
AlarmManager
,
NOTIFICATION_SERVICE
,
NotificationManager
,
KEYGUARD_SERVICE
,
KeyguardManager
,
LOCATION_SERVICE
,
LocationManager
,
SEARCH_SERVICE
,
SearchManager
,
SENSOR_SERVICE
,
SensorManager
,
STORAGE_SERVICE
,
StorageManager
,
VIBRATOR_SERVICE
,
Vibrator
,
CONNECTIVITY_SERVICE
,
ConnectivityManager
,
WIFI_SERVICE
,
WifiManager
,
AUDIO_SERVICE
,
AudioManager
,
MEDIA_ROUTER_SERVICE
,
MediaRouter
,
TELEPHONY_SERVICE
,
TelephonyManager
,
TELEPHONY_SUBSCRIPTION_SERVICE
,
SubscriptionManager
,
CARRIER_CONFIG_SERVICE
,
CarrierConfigManager
,
INPUT_METHOD_SERVICE
,
InputMethodManager
,
UI_MODE_SERVICE
,
UiModeManager
,
DOWNLOAD_SERVICE
,
DownloadManager
,
BATTERY_SERVICE
,
BatteryManager
,
JOB_SCHEDULER_SERVICE
,
JobScheduler
,
NETWORK_STATS_SERVICE
,
NetworkStatsManager
,
HardwarePropertiesManager
,
HARDWARE_PROPERTIES_SERVICE
public final <T> T getSystemService(Class<T> serviceClass)
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.)
serviceClass
- The class of the desired service.public abstract String getSystemServiceName(Class<?> serviceClass)
serviceClass
- The class of the desired service.public abstract int checkPermission(String permission, int pid, int uid)
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.PackageManager.PERMISSION_GRANTED
if the given
pid/uid is allowed that permission, or
PackageManager.PERMISSION_DENIED
if it is not.PackageManager.checkPermission(String, String)
,
checkCallingPermission(java.lang.String)
public abstract int checkPermission(String permission, int pid, int uid, IBinder callerToken)
public abstract int checkCallingPermission(String permission)
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(java.lang.String)
to avoid this protection.permission
- The name of the permission being checked.PackageManager.PERMISSION_GRANTED
if the calling
pid/uid is allowed that permission, or
PackageManager.PERMISSION_DENIED
if it is not.PackageManager.checkPermission(String, String)
,
checkPermission(java.lang.String, int, int)
,
checkCallingOrSelfPermission(java.lang.String)
public abstract int checkCallingOrSelfPermission(String permission)
checkCallingPermission(java.lang.String)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!permission
- The name of the permission being checked.PackageManager.PERMISSION_GRANTED
if the calling
pid/uid is allowed that permission, or
PackageManager.PERMISSION_DENIED
if it is not.PackageManager.checkPermission(String, String)
,
checkPermission(java.lang.String, int, int)
,
checkCallingPermission(java.lang.String)
public abstract int checkSelfPermission(String permission)
permission
- The name of the permission being checked.PackageManager.PERMISSION_GRANTED
if you have the
permission, or PackageManager.PERMISSION_DENIED
if not.PackageManager.checkPermission(String, String)
,
checkCallingPermission(String)
public abstract void enforcePermission(String permission, int pid, int uid, String message)
SecurityException
.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.checkPermission(String, int, int)
public abstract void enforceCallingPermission(String permission, String message)
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(java.lang.String, java.lang.String)
to avoid this
protection.permission
- The name of the permission being checked.message
- A message to include in the exception if it is thrown.checkCallingPermission(String)
public abstract void enforceCallingOrSelfPermission(String permission, String message)
SecurityException
. This is the same as enforceCallingPermission(java.lang.String, java.lang.String)
, except it grants your own
permissions if you are not currently processing an IPC. Use
with care!permission
- The name of the permission being checked.message
- A message to include in the exception if it is thrown.checkCallingOrSelfPermission(String)
public abstract void grantUriPermission(String toPackage, Uri uri, int modeFlags)
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(android.net.Uri, int)
when the target should no longer be allowed
to access it.
To succeed, the content provider owning the Uri must have set the
grantUriPermissions
attribute in its manifest or included the
<grant-uri-permissions>
tag.
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. Any combination of
Intent.FLAG_GRANT_READ_URI_PERMISSION
,
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
,
Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
, or
Intent.FLAG_GRANT_PREFIX_URI_PERMISSION
.revokeUriPermission(android.net.Uri, int)
public abstract void revokeUriPermission(Uri uri, int modeFlags)
grantUriPermission(java.lang.String, android.net.Uri, int)
. The given
Uri will match all previously granted Uris that are the same or a
sub-path of the given Uri. That is, revoking "content://foo/target" will
revoke both "content://foo/target" and "content://foo/target/sub", but not
"content://foo". It will not remove any prefix grants that exist at a
higher level.
Prior to Build.VERSION_CODES.LOLLIPOP
, if you did not have
regular permission access to a Uri, but had received access to it through
a specific Uri permission grant, you could not revoke that grant with this
function and a SecurityException
would be thrown. As of
Build.VERSION_CODES.LOLLIPOP
, this function will not throw a security exception,
but will remove whatever permission grants to the Uri had been given to the app
(or none).
uri
- The Uri you would like to revoke access to.modeFlags
- The desired access modes. Any combination of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.grantUriPermission(java.lang.String, android.net.Uri, int)
public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags)
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 type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.PackageManager.PERMISSION_GRANTED
if the given
pid/uid is allowed to access that uri, or
PackageManager.PERMISSION_DENIED
if it is not.checkCallingUriPermission(android.net.Uri, int)
public abstract int checkUriPermission(Uri uri, int pid, int uid, int modeFlags, IBinder callerToken)
public abstract int checkCallingUriPermission(Uri uri, int modeFlags)
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.uri
- The uri that is being checked.modeFlags
- The type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.PackageManager.PERMISSION_GRANTED
if the caller
is allowed to access that uri, or
PackageManager.PERMISSION_DENIED
if it is not.checkUriPermission(Uri, int, int, int)
public abstract int checkCallingOrSelfUriPermission(Uri uri, int modeFlags)
checkCallingUriPermission(android.net.Uri, int)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!uri
- The uri that is being checked.modeFlags
- The type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.PackageManager.PERMISSION_GRANTED
if the caller
is allowed to access that uri, or
PackageManager.PERMISSION_DENIED
if it is not.checkCallingUriPermission(android.net.Uri, int)
public abstract int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
checkPermission(java.lang.String, int, int)
and checkUriPermission(android.net.Uri, int, int, int)
in one
call.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 type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.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.public abstract void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)
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.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 type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.message
- A message to include in the exception if it is thrown.checkUriPermission(Uri, int, int, int)
public abstract void enforceCallingUriPermission(Uri uri, int modeFlags, String message)
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.uri
- The uri that is being checked.modeFlags
- The type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.message
- A message to include in the exception if it is thrown.checkCallingUriPermission(Uri, int)
public abstract void enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)
SecurityException
. This is the same as enforceCallingUriPermission(android.net.Uri, int, java.lang.String)
, except it grants your own
permissions if you are not currently processing an IPC. Use
with care!uri
- The uri that is being checked.modeFlags
- The type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.message
- A message to include in the exception if it is thrown.checkCallingOrSelfUriPermission(Uri, int)
public abstract void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
enforcePermission(java.lang.String, int, int, java.lang.String)
and enforceUriPermission(android.net.Uri, int, int, int, java.lang.String)
in one
call.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 type of access to grant. May be one or both of
Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
.message
- A message to include in the exception if it is thrown.checkUriPermission(Uri, String, String, int, int, int)
public abstract Context createPackageContext(String packageName, int flags) throws PackageManager.NameNotFoundException
Throws PackageManager.NameNotFoundException
if there is no
application with the given package name.
Throws SecurityException
if the Context requested
can not be loaded into the caller's process for security reasons (see
CONTEXT_INCLUDE_CODE
for more information}.
packageName
- Name of the application's package.flags
- Option flags, one of CONTEXT_INCLUDE_CODE
or CONTEXT_IGNORE_SECURITY
.Context
for the application.SecurityException
- PackageManager.NameNotFoundException
- if there is no application with
the given package name.public abstract Context createPackageContextAsUser(String packageName, int flags, UserHandle user) throws PackageManager.NameNotFoundException
createPackageContext(String, int)
, but with a
different UserHandle
. For example, getContentResolver()
will open any Uri
as the given user.public abstract Context createApplicationContext(ApplicationInfo application, int flags) throws PackageManager.NameNotFoundException
ApplicationInfo
.public abstract int getUserId()
public abstract Context createConfigurationContext(Configuration overrideConfiguration)
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.Context
with the given configuration override.public abstract Context createDisplayContext(Display display)
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.public abstract Context createDeviceProtectedStorageContext()
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.
isDeviceProtectedStorage()
@Deprecated public Context createDeviceEncryptedStorageContext()
public abstract Context createCredentialProtectedStorageContext()
android.R.attr#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.
isCredentialProtectedStorage()
@Deprecated public Context createCredentialEncryptedStorageContext()
public abstract DisplayAdjustments getDisplayAdjustments(int displayId)
displayId
- The display id for which to get compatibility info.public abstract Display getDisplay()
public boolean isRestricted()
true
if this Context is restricted, false
otherwise.CONTEXT_RESTRICTED
public abstract boolean isDeviceProtectedStorage()
createDeviceProtectedStorageContext()
@Deprecated public boolean isDeviceEncryptedStorage()
public abstract boolean isCredentialProtectedStorage()
@Deprecated public boolean isCredentialEncryptedStorage()