Context | Android Developers
source link: https://developer.android.com/reference/android/content/Context
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
- Android API Reference
- Overview
- Android Platform
- Packages
- API level
- Class Index
- Package Index
- android
- android.accessibilityservice
- android.accounts
- android.animation
- android.annotation
- android.app
- android.app.admin
- android.app.appsearch
- android.app.appsearch.exceptions
- android.app.assist
- android.app.backup
- android.app.blob
- android.app.job
- android.app.people
- android.app.role
- android.app.slice
- android.app.usage
- android.appwidget
- android.bluetooth
- android.bluetooth.le
- android.companion
- android.content
- android.content.pm
- android.content.pm.verify.domain
- android.content.res
- android.content.res.loader
- android.database
- android.database.sqlite
- android.drm
- android.gesture
- android.graphics
- android.graphics.drawable
- android.graphics.drawable.shapes
- android.graphics.fonts
- android.graphics.pdf
- android.graphics.text
- android.hardware
- android.hardware.biometrics
- android.hardware.camera2
- android.hardware.camera2.params
- android.hardware.display
- android.hardware.fingerprint
- android.hardware.input
- android.hardware.lights
- android.hardware.usb
- android.icu.lang
- android.icu.math
- android.icu.number
- android.icu.text
- android.icu.util
- android.inputmethodservice
- android.location
- android.location.provider
- android.media
- android.media.audiofx
- android.media.browse
- android.media.effect
- android.media.metrics
- android.media.midi
- android.media.projection
- android.media.session
- android.media.tv
- android.mtp
- android.net
- android.net.eap
- android.net.http
- android.net.ipsec.ike
- android.net.ipsec.ike.exceptions
- android.net.nsd
- android.net.rtp
- android.net.sip
- android.net.ssl
- android.net.vcn
- android.net.wifi
- android.net.wifi.aware
- android.net.wifi.hotspot2
- android.net.wifi.hotspot2.omadm
- android.net.wifi.hotspot2.pps
- android.net.wifi.p2p
- android.net.wifi.p2p.nsd
- android.net.wifi.rtt
- android.nfc
- android.nfc.cardemulation
- android.nfc.tech
- android.opengl
- android.os
- android.os.health
- android.os.storage
- android.os.strictmode
- android.preference
- android.print
- android.print.pdf
- android.printservice
- android.provider
- android.renderscript
- android.sax
- android.se.omapi
- android.security
- android.security.identity
- android.security.keystore
- android.service.autofill
- android.service.carrier
- android.service.chooser
- android.service.controls
- android.service.controls.actions
- android.service.controls.templates
- android.service.dreams
- android.service.media
- android.service.notification
- android.service.quickaccesswallet
- android.service.quicksettings
- android.service.restrictions
- android.service.textservice
- android.service.voice
- android.service.vr
- android.service.wallpaper
- android.speech
- android.speech.tts
- android.system
- android.telecom
- android.telephony
- android.telephony.cdma
- android.telephony.data
- android.telephony.emergency
- android.telephony.euicc
- android.telephony.gsm
- android.telephony.ims
- android.telephony.ims.feature
- android.telephony.mbms
- android.test
- android.test.mock
- android.test.suitebuilder
- android.test.suitebuilder.annotation
- android.text
- android.text.format
- android.text.method
- android.text.style
- android.text.util
- android.transition
- android.util
- android.util.proto
- android.view
- android.view.accessibility
- android.view.animation
- android.view.autofill
- android.view.contentcapture
- android.view.displayhash
- android.view.inputmethod
- android.view.inspector
- android.view.textclassifier
- android.view.textservice
- android.webkit
- android.widget
- android.widget.inline
- android.window
- com.android.net.module.util
- com.google.android.collect
- com.google.android.gles_jni
- com.google.android.util
- dalvik.annotation
- dalvik.bytecode
- dalvik.system
- java.awt.font
- java.beans
- java.io
- java.lang
- java.lang.annotation
- java.lang.invoke
- java.lang.ref
- java.lang.reflect
- java.math
- java.net
- java.nio
- java.nio.channels
- java.nio.channels.spi
- java.nio.charset
- java.nio.charset.spi
- java.nio.file
- java.nio.file.attribute
- java.nio.file.spi
- java.security
- java.security.acl
- java.security.cert
- java.security.interfaces
- java.security.spec
- java.sql
- java.text
- java.time
- java.time.chrono
- java.time.format
- java.time.temporal
- java.time.zone
- java.util
- java.util.concurrent
- java.util.concurrent.atomic
- java.util.concurrent.locks
- java.util.function
- java.util.jar
- java.util.logging
- java.util.prefs
- java.util.regex
- java.util.stream
- java.util.zip
- javax.crypto
- javax.crypto.interfaces
- javax.crypto.spec
- javax.microedition.khronos.egl
- javax.microedition.khronos.opengles
- javax.net
- javax.net.ssl
- javax.security.auth
- javax.security.auth.callback
- javax.security.auth.login
- javax.security.auth.x500
- javax.security.cert
- javax.sql
- javax.xml
- javax.xml.datatype
- javax.xml.namespace
- javax.xml.parsers
- javax.xml.transform
- javax.xml.transform.dom
- javax.xml.transform.sax
- javax.xml.transform.stream
- javax.xml.validation
- javax.xml.xpath
- junit.framework
- junit.runner
- org.apache.http.conn
- org.apache.http.conn.scheme
- org.apache.http.conn.ssl
- org.apache.http.params
- org.json
- org.w3c.dom
- org.w3c.dom.ls
- org.xml.sax
- org.xml.sax.ext
- org.xml.sax.helpers
- org.xmlpull.v1
- org.xmlpull.v1.sax2
Context
public
abstract
class
Context
extends Object
Interface to global information about an application environment. This is an abstract class whose implementation is provided by the Android system. It allows access to application-specific resources and classes, as well as up-calls for application-level operations such as launching activities, broadcasting and receiving intents, etc.
Summary
Constants
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.
String
ACCOUNT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AccountManager
for receiving intents at a
time of your choosing.
String
ACTIVITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ActivityManager
for interacting with the global
system state.
String
ALARM_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AlarmManager
for receiving intents at a
time of your choosing.
String
APPWIDGET_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AppWidgetManager
for accessing AppWidgets.
String
APP_OPS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AppOpsManager
for tracking application operations
on the device.
String
APP_SEARCH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
AppSearchManager
for
indexing and querying app data managed by the system.
String
AUDIO_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AudioManager
for handling management of volume,
ringer modes and audio routing.
String
BATTERY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BatteryManager
for managing battery state.
int
BIND_ABOVE_CLIENT
Flag for bindService(Intent, ServiceConnection, int)
: indicates that the client application
binding to this service considers the service to be more important than
the app itself.
int
BIND_ADJUST_WITH_ACTIVITY
Flag for bindService(Intent, 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.
int
BIND_ALLOW_OOM_MANAGEMENT
Flag for bindService(Intent, ServiceConnection, int)
: allow the process hosting the bound
service to go through its normal memory management.
int
BIND_AUTO_CREATE
Flag for bindService(Intent, ServiceConnection, int)
: automatically create the service as long
as the binding exists.
int
BIND_DEBUG_UNBIND
Flag for bindService(Intent, ServiceConnection, int)
: include debugging help for mismatched
calls to unbind.
int
BIND_EXTERNAL_SERVICE
Flag for bindService(Intent, ServiceConnection, int)
: The service being bound is an
isolated
,
external
service.
int
BIND_IMPORTANT
Flag for bindService(Intent, ServiceConnection, int)
: this service is very important to
the client, so should be brought to the foreground process level
when the client is.
int
BIND_INCLUDE_CAPABILITIES
Flag for bindService(Intent, ServiceConnection, int)
: If binding from an app that has specific capabilities
due to its foreground state such as an activity or foreground service, then this flag will
allow the bound app to get the same capabilities, as long as it has the required permissions
as well.
int
BIND_NOT_FOREGROUND
Flag for bindService(Intent, ServiceConnection, int)
: don't allow this binding to raise
the target service's process to the foreground scheduling priority.
int
BIND_NOT_PERCEPTIBLE
Flag for bindService(Intent, ServiceConnection, int)
: If binding from an app that is visible or user-perceptible,
lower the target service's importance to below the perceptible level.
int
BIND_WAIVE_PRIORITY
Flag for bindService(Intent, ServiceConnection, int)
: don't impact the scheduling or
memory management priority of the target service's hosting process.
String
BIOMETRIC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BiometricManager
for handling
biometric and PIN/pattern/password authentication.
String
BLOB_STORE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a BlobStoreManager
for contributing and accessing data blobs
from the blob store maintained by the system.
String
BLUETOOTH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BluetoothManager
for using Bluetooth.
String
BUGREPORT_SERVICE
Service to capture a bugreport.
String
CAMERA_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CameraManager
for interacting with
camera devices.
String
CAPTIONING_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CaptioningManager
for obtaining
captioning properties and listening for changes in captioning
preferences.
String
CARRIER_CONFIG_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CarrierConfigManager
for reading carrier configuration values.
String
CLIPBOARD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ClipboardManager
for accessing and modifying
the contents of the global clipboard.
String
COMPANION_DEVICE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CompanionDeviceManager
for managing companion devices
String
CONNECTIVITY_DIAGNOSTICS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a ConnectivityDiagnosticsManager
for performing network connectivity diagnostics
as well as receiving network connectivity information from the system.
String
CONNECTIVITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a ConnectivityManager
for handling management of
network connections.
String
CONSUMER_IR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ConsumerIrManager
for transmitting infrared
signals from the device.
int
CONTEXT_IGNORE_SECURITY
Flag for use with createPackageContext(String, int)
: ignore any security
restrictions on the Context being requested, allowing it to always
be loaded.
int
CONTEXT_INCLUDE_CODE
Flag for use with createPackageContext(String, int)
: include the application
code with the context.
int
CONTEXT_RESTRICTED
Flag for use with createPackageContext(String, int)
: a restricted context may
disable specific features.
String
CROSS_PROFILE_APPS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CrossProfileApps
for cross profile operations.
String
DEVICE_POLICY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DevicePolicyManager
for working with global
device policy management.
String
DISPLAY_HASH_SERVICE
Use with getSystemService(java.lang.String)
to access
DisplayHashManager
to handle display hashes.
String
DISPLAY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DisplayManager
for interacting with display devices.
String
DOMAIN_VERIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to access
DomainVerificationManager
to retrieve approval and
user state for declared web domains.
String
DOWNLOAD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DownloadManager
for requesting HTTP downloads.
String
DROPBOX_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DropBoxManager
instance for recording
diagnostic logs.
String
EUICC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
EuiccManager
to manage the device eUICC (embedded SIM).
String
FILE_INTEGRITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
FileIntegrityManager
.
String
FINGERPRINT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
FingerprintManager
for handling management
of fingerprints.
String
GAME_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
GameManager
.
String
HARDWARE_PROPERTIES_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
HardwarePropertiesManager
for accessing the hardware properties service.
String
INPUT_METHOD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
InputMethodManager
for accessing input
methods.
String
INPUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
InputManager
for interacting with input devices.
String
IPSEC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
IpSecManager
for encrypting Sockets or Networks with
IPSec.
String
JOB_SCHEDULER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a JobScheduler
instance for managing occasional
background tasks.
String
KEYGUARD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
KeyguardManager
for controlling keyguard.
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.
String
LAYOUT_INFLATER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
LayoutInflater
for inflating layout resources in this
context.
String
LOCATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a LocationManager
for controlling location
updates.
String
MEDIA_COMMUNICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaCommunicationManager
for managing MediaSession2
.
String
MEDIA_METRICS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaMetricsManager
for interacting with media metrics
on the device.
String
MEDIA_PROJECTION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a MediaProjectionManager
instance for managing
media projection sessions.
String
MEDIA_ROUTER_SERVICE
Use with getSystemService(Class)
to retrieve a
MediaRouter
for controlling and managing
routing of media.
String
MEDIA_SESSION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaSessionManager
for managing media Sessions.
String
MIDI_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MidiManager
for accessing the MIDI service.
int
MODE_APPEND
File creation mode: for use with openFileOutput(String, int)
, if the file
already exists then write data to the end of the existing file
instead of erasing it.
int
MODE_ENABLE_WRITE_AHEAD_LOGGING
Database open flag: when set, the database is opened with write-ahead logging enabled by default.
int
MODE_MULTI_PROCESS
This constant was deprecated
in API level 23.
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
.
int
MODE_NO_LOCALIZED_COLLATORS
Database open flag: when set, the database is opened without support for localized collators.
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).
int
MODE_WORLD_READABLE
This constant was deprecated
in API level 17.
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.
int
MODE_WORLD_WRITEABLE
This constant was deprecated
in API level 17.
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.
String
NETWORK_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a NetworkStatsManager
for querying network usage stats.
String
NFC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
NfcManager
for using NFC.
String
NOTIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
NotificationManager
for informing the user of
background events.
String
NSD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a NsdManager
for handling management of network service
discovery
String
PEOPLE_SERVICE
Use with getSystemService(java.lang.String)
to access a PeopleManager
to interact
with your published conversations.
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.
String
PRINT_SERVICE
PrintManager
for printing and managing
printers and print tasks.
int
RECEIVER_VISIBLE_TO_INSTANT_APPS
Flag for registerReceiver(BroadcastReceiver, IntentFilter)
: The receiver can receive broadcasts from Instant Apps.
String
RESTRICTIONS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
RestrictionsManager
for retrieving application restrictions
and requesting permissions for restricted operations.
String
ROLE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a RoleManager
for managing roles.
String
SEARCH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a SearchManager
for handling searches.
String
SENSOR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a SensorManager
for accessing sensors.
String
SHORTCUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ShortcutManager
for accessing the launcher shortcut service.
String
STORAGE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a StorageManager
for accessing system storage
functions.
String
STORAGE_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a StorageStatsManager
for accessing system storage
statistics.
String
SYSTEM_HEALTH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
SystemHealthManager
for accessing system health (battery, power,
memory, etc) metrics.
String
TELECOM_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TelecomManager
to manage telecom-related features
of the device.
String
TELEPHONY_IMS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
ImsManager
.
String
TELEPHONY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TelephonyManager
for handling management the
telephony features of the device.
String
TELEPHONY_SUBSCRIPTION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
SubscriptionManager
for handling management the
telephony subscriptions of the device.
String
TEXT_CLASSIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TextClassificationManager
for text classification services.
String
TEXT_SERVICES_MANAGER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TextServicesManager
for accessing
text services.
String
TV_INPUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TvInputManager
for interacting with TV inputs
on the device.
String
UI_MODE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
UiModeManager
for controlling UI modes.
String
USAGE_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a UsageStatsManager
for querying device usage stats.
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.
String
USER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
UserManager
for managing users on devices that support multiple users.
String
VIBRATOR_MANAGER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a VibratorManager
for accessing the device vibrators, interacting with individual ones and playing synchronized
effects on multiple vibrators.
String
VIBRATOR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a Vibrator
for
interacting with the vibration hardware.
String
VPN_MANAGEMENT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a VpnManager
to
manage profiles for the platform built-in VPN.
String
WALLPAPER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
com.android.server.WallpaperService for accessing wallpapers.
String
WIFI_AWARE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
WifiAwareManager
for handling management of
Wi-Fi Aware.
String
WIFI_P2P_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiP2pManager
for handling management of
Wi-Fi peer-to-peer connections.
String
WIFI_RTT_RANGING_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiRttManager
for ranging devices with wifi.
String
WIFI_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiManager
for handling management of
Wi-Fi access.
String
WINDOW_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
WindowManager
for accessing the system's window
manager.
Public constructors
Context()
Public methods
boolean
bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)
Variation of bindService(Intent, ServiceConnection, int)
that, in the specific case of isolated
services, allows the caller to generate multiple instances of a service
from a single component declaration.
boolean
bindService(Intent service, int flags, Executor executor, ServiceConnection conn)
Same as bindService(android.content.Intent, android.content.ServiceConnection, int)
with executor to control
ServiceConnection callbacks.
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, UserHandle user)
Binds to a service in the given user
in the same manner as
bindService(android.content.Intent, android.content.ServiceConnection, int)
.
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.
int[]
checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)
Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.
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.
int[]
checkCallingUriPermissions(List<Uri> uris, int modeFlags)
Determine whether the calling process and user ID has been granted permission to access a list of URIs.
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
checkSelfPermission(String permission)
Determine whether you have been granted a particular permission.
abstract
int
checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
Check both a Uri and normal 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.
int[]
checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)
Determine whether a particular process and user ID has been granted permission to access a list of URIs.
abstract
void
clearWallpaper()
This method was deprecated
in API level 15.
Use WallpaperManager.clear()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
Context
createAttributionContext(String attributionTag)
Return a new Context object for the current Context but attribute to a different tag.
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
createContext(ContextParams contextParams)
Creates a context with specific properties and behaviors.
abstract
Context
createContextForSplit(String splitName)
Return a new Context object for the given split name.
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.
Context
createWindowContext(int type, Bundle options)
Creates a Context for a non-activity window.
Context
createWindowContext(Display display, int type, Bundle options)
Creates a Context
for a non-activity
window on the given
Display
.
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, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
Enforce both a Uri and normal permission.
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
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.
String
getAttributionTag()
Attribution can be used in complex apps to logically separate parts of the app.
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.
final
int
getColor(int id)
Returns a color associated with a particular resource ID and styled for the current theme.
final
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
getDataDir()
Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
abstract
File
getDatabasePath(String name)
Returns the absolute path on the filesystem where a database created with
openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)
is 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.
Display
getDisplay()
Get the display this context is associated with.
final
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()
This method was deprecated
in API level 30.
These directories still exist and are scanned, but developers
are encouraged to migrate to inserting content into a
MediaStore
collection directly, as any app can
contribute new media to MediaStore
with no
permissions required, starting in
Build.VERSION_CODES.Q
.
abstract
File
getFileStreamPath(String name)
Returns the absolute path on the filesystem where a file created with
openFileOutput(String, int)
is stored.
abstract
File
getFilesDir()
Returns the absolute path to the directory on the filesystem where files
created with openFileOutput(String, int)
are stored.
Executor
getMainExecutor()
Return an Executor
that will run enqueued tasks on the main
thread associated with this context.
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.
String
getOpPackageName()
Return the package name that should be used for AppOpsManager
calls from
this context, so that app ops manager's uid verification will work with the name.
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.
ContextParams
getParams()
Return the set of parameters which this Context was created with, if it
was created via createContext(android.content.ContextParams)
.
abstract
Resources
getResources()
Returns a Resources instance for the application's package.
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.
final
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(String, Object...)
.
final
String
getString(int resId)
Returns a localized string from the application's package's default string table.
final
<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.
final
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.
abstract
Drawable
getWallpaper()
This method was deprecated
in API level 15.
Use WallpaperManager.get()
instead.
abstract
int
getWallpaperDesiredMinimumHeight()
This method was deprecated
in API level 15.
Use WallpaperManager.getDesiredMinimumHeight()
instead.
abstract
int
getWallpaperDesiredMinimumWidth()
This method was deprecated
in API level 15.
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.
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
isUiContext()
Returns true
if the context is a UI context which can access UI components such as
WindowManager
, LayoutInflater
or
WallpaperManager
.
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.
final
TypedArray
obtainStyledAttributes(AttributeSet set, int[] attrs)
Retrieve styled attribute information in this Context's theme.
final
TypedArray
obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)
Retrieve styled attribute information in this Context's theme.
final
TypedArray
obtainStyledAttributes(int resid, int[] attrs)
Retrieve styled attribute information in this Context's theme.
final
TypedArray
obtainStyledAttributes(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, DatabaseErrorHandler errorHandler)
Open a new private SQLiteDatabase associated with this Context's application package.
abstract
SQLiteDatabase
openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)
Open a new private SQLiteDatabase associated with this Context's application package.
abstract
Drawable
peekWallpaper()
This method was deprecated
in API level 15.
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, int flags)
Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.
abstract
Intent
registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)
Register to receive intent broadcasts, to run in the context of scheduler.
abstract
Intent
registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
Register to receive intent broadcasts, to run in the context of scheduler.
abstract
void
removeStickyBroadcast(Intent intent)
This method was deprecated in API level 21. 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)
This method was deprecated in API level 21. 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(String, Uri, int)
or any other mechanism.
abstract
void
revokeUriPermission(String toPackage, Uri uri, int modeFlags)
Remove permissions to access a particular content provider Uri
that were previously added with grantUriPermission(String, Uri, int)
for a specific target
package.
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)
Broadcast the given intent to all interested BroadcastReceivers.
abstract
void
sendBroadcastAsUser(Intent intent, UserHandle user)
Version of sendBroadcast(android.content.Intent)
that allows you to specify the
user the broadcast will be sent to.
abstract
void
sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)
Version of sendBroadcast(android.content.Intent, java.lang.String)
that allows you to specify the
user the broadcast will be sent to.
void
sendBroadcastWithMultiplePermissions(Intent intent, String[] receiverPermissions)
Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced.
void
sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the App Op to enforce restrictions on which receivers
the broadcast will be sent to.
abstract
void
sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendBroadcast(android.content.Intent)
that allows you to
receive data back from the broadcast.
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
sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the
user the broadcast will be sent to.
abstract
void
sendStickyBroadcast(Intent intent)
This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void
sendStickyBroadcast(Intent intent, Bundle options)
This method was deprecated in API level S. 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)
This method was deprecated in API level 21. 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
sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method was deprecated in API level 21. 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)
This method was deprecated in API level 21. 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)
This method was deprecated
in API level 15.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
abstract
void
setWallpaper(InputStream data)
This method was deprecated
in API level 15.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
abstract
void
startActivities(Intent[] intents, Bundle options)
Launch multiple new activities.
abstract
void
startActivities(Intent[] intents)
Same as startActivities(android.content.Intent[], android.os.Bundle)
with no options
specified.
abstract
void
startActivity(Intent intent)
Same as startActivity(android.content.Intent, android.os.Bundle)
with no options
specified.
abstract
void
startActivity(Intent intent, Bundle options)
Launch a new activity.
abstract
ComponentName
startForegroundService(Intent service)
Similar to startService(android.content.Intent)
, but with an implicit promise that the
Service will call startForeground(int, android.app.Notification)
once it begins running.
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(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle)
with no options specified.
abstract
void
startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
Like startActivity(android.content.Intent, android.os.Bundle)
, but taking a IntentSender
to start.
abstract
ComponentName
startService(Intent service)
Request that a given application service be started.
abstract
boolean
stopService(Intent service)
Request that a given application service be stopped.
abstract
void
unbindService(ServiceConnection conn)
Disconnect from an application service.
void
unregisterComponentCallbacks(ComponentCallbacks callback)
Remove a ComponentCallbacks
object that was previously registered
with registerComponentCallbacks(android.content.ComponentCallbacks)
.
abstract
void
unregisterReceiver(BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver.
void
updateServiceGroup(ServiceConnection conn, int group, int importance)
For a service previously bound with bindService(Intent, ServiceConnection, int)
or a related method, change
how the system manages that service's process in relation to other processes.
Inherited methods
From class
java.lang.Object
Constants
ACCESSIBILITY_SERVICE
public static final 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.
Constant Value: "accessibility"
ACCOUNT_SERVICE
public static final String ACCOUNT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AccountManager
for receiving intents at a
time of your choosing.
Constant Value: "account"
ACTIVITY_SERVICE
public static final String ACTIVITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ActivityManager
for interacting with the global
system state.
Constant Value: "activity"
ALARM_SERVICE
public static final String ALARM_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AlarmManager
for receiving intents at a
time of your choosing.
Constant Value: "alarm"
APPWIDGET_SERVICE
public static final String APPWIDGET_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AppWidgetManager
for accessing AppWidgets.
See also:
Constant Value: "appwidget"
APP_OPS_SERVICE
public static final String APP_OPS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AppOpsManager
for tracking application operations
on the device.
Constant Value: "appops"
APP_SEARCH_SERVICE
public static final String APP_SEARCH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
AppSearchManager
for
indexing and querying app data managed by the system.
See also:
Constant Value: "app_search"
AUDIO_SERVICE
public static final String AUDIO_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
AudioManager
for handling management of volume,
ringer modes and audio routing.
Constant Value: "audio"
BATTERY_SERVICE
public static final String BATTERY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BatteryManager
for managing battery state.
See also:
Constant Value: "batterymanager"
BIND_ABOVE_CLIENT
public static final int BIND_ABOVE_CLIENT
Flag for bindService(Intent, 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.
Constant Value: 8 (0x00000008)
BIND_ADJUST_WITH_ACTIVITY
public static final int BIND_ADJUST_WITH_ACTIVITY
Flag for bindService(Intent, 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.
Constant Value: 128 (0x00000080)
BIND_ALLOW_OOM_MANAGEMENT
public static final int BIND_ALLOW_OOM_MANAGEMENT
Flag for bindService(Intent, 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.
Constant Value: 16 (0x00000010)
BIND_AUTO_CREATE
public static final int BIND_AUTO_CREATE
Flag for bindService(Intent, ServiceConnection, int)
: automatically create the service as long
as the binding exists. Note that while this will create the service,
its Service.onStartCommand(Intent, int, int)
method will still only be called due to an
explicit call to startService(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.
Constant Value: 1 (0x00000001)
BIND_DEBUG_UNBIND
public static final int BIND_DEBUG_UNBIND
Flag for bindService(Intent, ServiceConnection, int)
: include debugging help for mismatched
calls to unbind. When this flag is set, the callstack of the following
unbindService(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.
Constant Value: 2 (0x00000002)
BIND_EXTERNAL_SERVICE
public static final int BIND_EXTERNAL_SERVICE
Flag for bindService(Intent, 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.
Constant Value: -2147483648 (0x80000000)
BIND_IMPORTANT
public static final int BIND_IMPORTANT
Flag for bindService(Intent, 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.
Constant Value: 64 (0x00000040)
BIND_INCLUDE_CAPABILITIES
public static final int BIND_INCLUDE_CAPABILITIES
Flag for bindService(Intent, ServiceConnection, int)
: If binding from an app that has specific capabilities
due to its foreground state such as an activity or foreground service, then this flag will
allow the bound app to get the same capabilities, as long as it has the required permissions
as well.
If binding from a top app and its target SDK version is at or above
Build.VERSION_CODES.R
, the app needs to
explicitly use BIND_INCLUDE_CAPABILITIES flag to pass all capabilities to the service so the
other app can have while-use-use access such as location, camera, microphone from background.
If binding from a top app and its target SDK version is below
Build.VERSION_CODES.R
, BIND_INCLUDE_CAPABILITIES is implicit.
Constant Value: 4096 (0x00001000)
BIND_NOT_FOREGROUND
public static final int BIND_NOT_FOREGROUND
Flag for bindService(Intent, 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.
Constant Value: 4 (0x00000004)
BIND_NOT_PERCEPTIBLE
public static final int BIND_NOT_PERCEPTIBLE
Flag for bindService(Intent, ServiceConnection, int)
: If binding from an app that is visible or user-perceptible,
lower the target service's importance to below the perceptible level. This allows
the system to (temporarily) expunge the bound process from memory to make room for more
important user-perceptible processes.
Constant Value: 256 (0x00000100)
BIND_WAIVE_PRIORITY
public static final int BIND_WAIVE_PRIORITY
Flag for bindService(Intent, 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.
Constant Value: 32 (0x00000020)
BIOMETRIC_SERVICE
public static final String BIOMETRIC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BiometricManager
for handling
biometric and PIN/pattern/password authentication.
Constant Value: "biometric"
BLOB_STORE_SERVICE
public static final String BLOB_STORE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a BlobStoreManager
for contributing and accessing data blobs
from the blob store maintained by the system.
Constant Value: "blob_store"
BLUETOOTH_SERVICE
public static final String BLUETOOTH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
BluetoothManager
for using Bluetooth.
See also:
Constant Value: "bluetooth"
BUGREPORT_SERVICE
public static final String BUGREPORT_SERVICE
Service to capture a bugreport.
Constant Value: "bugreport"
CAMERA_SERVICE
public static final String CAMERA_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CameraManager
for interacting with
camera devices.
Constant Value: "camera"
CAPTIONING_SERVICE
public static final String CAPTIONING_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CaptioningManager
for obtaining
captioning properties and listening for changes in captioning
preferences.
Constant Value: "captioning"
CARRIER_CONFIG_SERVICE
public static final String CARRIER_CONFIG_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CarrierConfigManager
for reading carrier configuration values.
Constant Value: "carrier_config"
CLIPBOARD_SERVICE
public static final String CLIPBOARD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ClipboardManager
for accessing and modifying
the contents of the global clipboard.
Constant Value: "clipboard"
COMPANION_DEVICE_SERVICE
public static final String COMPANION_DEVICE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CompanionDeviceManager
for managing companion devices
Constant Value: "companiondevice"
CONNECTIVITY_DIAGNOSTICS_SERVICE
public static final String CONNECTIVITY_DIAGNOSTICS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a ConnectivityDiagnosticsManager
for performing network connectivity diagnostics
as well as receiving network connectivity information from the system.
Constant Value: "connectivity_diagnostics"
CONNECTIVITY_SERVICE
public static final String CONNECTIVITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a ConnectivityManager
for handling management of
network connections.
Constant Value: "connectivity"
CONSUMER_IR_SERVICE
public static final String CONSUMER_IR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ConsumerIrManager
for transmitting infrared
signals from the device.
Constant Value: "consumer_ir"
CONTEXT_IGNORE_SECURITY
public static final int CONTEXT_IGNORE_SECURITY
Flag for use with createPackageContext(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!
Constant Value: 2 (0x00000002)
CONTEXT_INCLUDE_CODE
public static final int CONTEXT_INCLUDE_CODE
Flag for use with createPackageContext(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.
Constant Value: 1 (0x00000001)
CONTEXT_RESTRICTED
public static final int CONTEXT_RESTRICTED
Flag for use with createPackageContext(String, int)
: a restricted context may
disable specific features. For instance, a View associated with a restricted
context would ignore particular XML attributes.
Constant Value: 4 (0x00000004)
CROSS_PROFILE_APPS_SERVICE
public static final String CROSS_PROFILE_APPS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
CrossProfileApps
for cross profile operations.
See also:
Constant Value: "crossprofileapps"
DEVICE_POLICY_SERVICE
public static final String DEVICE_POLICY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DevicePolicyManager
for working with global
device policy management.
See also:
Constant Value: "device_policy"
DISPLAY_HASH_SERVICE
public static final String DISPLAY_HASH_SERVICE
Use with getSystemService(java.lang.String)
to access
DisplayHashManager
to handle display hashes.
See also:
Constant Value: "display_hash"
DISPLAY_SERVICE
public static final String DISPLAY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DisplayManager
for interacting with display devices.
Constant Value: "display"
DOMAIN_VERIFICATION_SERVICE
public static final String DOMAIN_VERIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to access
DomainVerificationManager
to retrieve approval and
user state for declared web domains.
Constant Value: "domain_verification"
DOWNLOAD_SERVICE
public static final String DOWNLOAD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DownloadManager
for requesting HTTP downloads.
See also:
Constant Value: "download"
DROPBOX_SERVICE
public static final String DROPBOX_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
DropBoxManager
instance for recording
diagnostic logs.
See also:
Constant Value: "dropbox"
EUICC_SERVICE
public static final String EUICC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
EuiccManager
to manage the device eUICC (embedded SIM).
Constant Value: "euicc"
FILE_INTEGRITY_SERVICE
public static final String FILE_INTEGRITY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
FileIntegrityManager
.
Constant Value: "file_integrity"
FINGERPRINT_SERVICE
public static final String FINGERPRINT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
FingerprintManager
for handling management
of fingerprints.
Constant Value: "fingerprint"
HARDWARE_PROPERTIES_SERVICE
public static final String HARDWARE_PROPERTIES_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
HardwarePropertiesManager
for accessing the hardware properties service.
See also:
Constant Value: "hardware_properties"
INPUT_METHOD_SERVICE
public static final String INPUT_METHOD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
InputMethodManager
for accessing input
methods.
See also:
Constant Value: "input_method"
INPUT_SERVICE
public static final String INPUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
InputManager
for interacting with input devices.
Constant Value: "input"
IPSEC_SERVICE
public static final String IPSEC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
IpSecManager
for encrypting Sockets or Networks with
IPSec.
See also:
Constant Value: "ipsec"
JOB_SCHEDULER_SERVICE
public static final String JOB_SCHEDULER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a JobScheduler
instance for managing occasional
background tasks.
Constant Value: "jobscheduler"
KEYGUARD_SERVICE
public static final String KEYGUARD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
KeyguardManager
for controlling keyguard.
Constant Value: "keyguard"
LAUNCHER_APPS_SERVICE
public static final 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.
Constant Value: "launcherapps"
LAYOUT_INFLATER_SERVICE
public static final String LAYOUT_INFLATER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
LayoutInflater
for inflating layout resources in this
context.
Constant Value: "layout_inflater"
LOCATION_SERVICE
public static final String LOCATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a LocationManager
for controlling location
updates.
Constant Value: "location"
MEDIA_COMMUNICATION_SERVICE
public static final String MEDIA_COMMUNICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaCommunicationManager
for managing MediaSession2
.
Constant Value: "media_communication"
MEDIA_METRICS_SERVICE
public static final String MEDIA_METRICS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaMetricsManager
for interacting with media metrics
on the device.
Constant Value: "media_metrics"
MEDIA_PROJECTION_SERVICE
public static final String MEDIA_PROJECTION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a MediaProjectionManager
instance for managing
media projection sessions.
Constant Value: "media_projection"
MEDIA_ROUTER_SERVICE
public static final String MEDIA_ROUTER_SERVICE
Use with getSystemService(Class)
to retrieve a
MediaRouter
for controlling and managing
routing of media.
Constant Value: "media_router"
MEDIA_SESSION_SERVICE
public static final String MEDIA_SESSION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MediaSessionManager
for managing media Sessions.
Constant Value: "media_session"
MIDI_SERVICE
public static final String MIDI_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
MidiManager
for accessing the MIDI service.
See also:
Constant Value: "midi"
MODE_APPEND
public static final int MODE_APPEND
File creation mode: for use with openFileOutput(String, int)
, if the file
already exists then write data to the end of the existing file
instead of erasing it.
See also:
Constant Value: 32768 (0x00008000)
MODE_ENABLE_WRITE_AHEAD_LOGGING
public static final int MODE_ENABLE_WRITE_AHEAD_LOGGING
Database open flag: when set, the database is opened with write-ahead logging enabled by default.
Constant Value: 8 (0x00000008)
MODE_MULTI_PROCESS
public static final int MODE_MULTI_PROCESS
This constant was deprecated
in API level 23.
MODE_MULTI_PROCESS does not work reliably in
some versions of Android, and furthermore does not provide any
mechanism for reconciling concurrent modifications across
processes. Applications should not attempt to use it. Instead,
they should use an explicit cross-process data management
approach such as ContentProvider
.
SharedPreference loading flag: when set, the file on disk will be checked for modification even if the shared preferences instance is already loaded in this process. This behavior is sometimes desired in cases where the application has multiple processes, all writing to the same SharedPreferences file. Generally there are better forms of communication between processes, though.
This was the legacy (but undocumented) behavior in and before Gingerbread (Android 2.3) and this flag is implied when targeting such releases. For applications targeting SDK versions greater than Android 2.3, this flag must be explicitly set if desired.
See also:
Constant Value: 4 (0x00000004)
MODE_NO_LOCALIZED_COLLATORS
public static final int MODE_NO_LOCALIZED_COLLATORS
Database open flag: when set, the database is opened without support for localized collators.
Constant Value: 16 (0x00000010)
MODE_PRIVATE
public static final 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).
Constant Value: 0 (0x00000000)
MODE_WORLD_READABLE
public static final int MODE_WORLD_READABLE
This constant was deprecated
in API level 17.
Creating world-readable files is very dangerous, and likely
to cause security holes in applications. It is strongly
discouraged; instead, applications should use more formal
mechanism for interactions such as ContentProvider
,
BroadcastReceiver
, and Service
.
There are no guarantees that this access mode will remain on
a file, such as when it goes through a backup and restore.
File creation mode: allow all other applications to have read access to the created file.
Starting from Build.VERSION_CODES.N
, attempting to use this
mode throws a SecurityException
.
Constant Value: 1 (0x00000001)
MODE_WORLD_WRITEABLE
public static final int MODE_WORLD_WRITEABLE
This constant was deprecated
in API level 17.
Creating world-writable files is very dangerous, and likely
to cause security holes in applications. It is strongly
discouraged; instead, applications should use more formal
mechanism for interactions such as ContentProvider
,
BroadcastReceiver
, and Service
.
There are no guarantees that this access mode will remain on
a file, such as when it goes through a backup and restore.
File creation mode: allow all other applications to have write access to the created file.
Starting from Build.VERSION_CODES.N
, attempting to use this
mode will throw a SecurityException
.
Constant Value: 2 (0x00000002)
NETWORK_STATS_SERVICE
public static final String NETWORK_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a NetworkStatsManager
for querying network usage stats.
Constant Value: "netstats"
NFC_SERVICE
public static final String NFC_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
NfcManager
for using NFC.
See also:
Constant Value: "nfc"
NOTIFICATION_SERVICE
public static final String NOTIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
NotificationManager
for informing the user of
background events.
Constant Value: "notification"
NSD_SERVICE
public static final String NSD_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a NsdManager
for handling management of network service
discovery
Constant Value: "servicediscovery"
PEOPLE_SERVICE
public static final String PEOPLE_SERVICE
Use with getSystemService(java.lang.String)
to access a PeopleManager
to interact
with your published conversations.
See also:
Constant Value: "people"
POWER_SERVICE
public static final 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.
Constant Value: "power"
PRINT_SERVICE
public static final String PRINT_SERVICE
PrintManager
for printing and managing
printers and print tasks.
Constant Value: "print"
RECEIVER_VISIBLE_TO_INSTANT_APPS
public static final int RECEIVER_VISIBLE_TO_INSTANT_APPS
Flag for registerReceiver(BroadcastReceiver, IntentFilter)
: The receiver can receive broadcasts from Instant Apps.
Constant Value: 1 (0x00000001)
RESTRICTIONS_SERVICE
public static final String RESTRICTIONS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
RestrictionsManager
for retrieving application restrictions
and requesting permissions for restricted operations.
Constant Value: "restrictions"
ROLE_SERVICE
public static final String ROLE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a RoleManager
for managing roles.
Constant Value: "role"
SENSOR_SERVICE
public static final String SENSOR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a SensorManager
for accessing sensors.
Constant Value: "sensor"
SHORTCUT_SERVICE
public static final String SHORTCUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
ShortcutManager
for accessing the launcher shortcut service.
Constant Value: "shortcut"
STORAGE_SERVICE
public static final String STORAGE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a StorageManager
for accessing system storage
functions.
Constant Value: "storage"
STORAGE_STATS_SERVICE
public static final String STORAGE_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a StorageStatsManager
for accessing system storage
statistics.
Constant Value: "storagestats"
SYSTEM_HEALTH_SERVICE
public static final String SYSTEM_HEALTH_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
SystemHealthManager
for accessing system health (battery, power,
memory, etc) metrics.
See also:
Constant Value: "systemhealth"
TELECOM_SERVICE
public static final String TELECOM_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TelecomManager
to manage telecom-related features
of the device.
Constant Value: "telecom"
TELEPHONY_IMS_SERVICE
public static final String TELEPHONY_IMS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve an
ImsManager
.
Constant Value: "telephony_ims"
TELEPHONY_SERVICE
public static final String TELEPHONY_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TelephonyManager
for handling management the
telephony features of the device.
Constant Value: "phone"
TELEPHONY_SUBSCRIPTION_SERVICE
public static final String TELEPHONY_SUBSCRIPTION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
SubscriptionManager
for handling management the
telephony subscriptions of the device.
Constant Value: "telephony_subscription_service"
TEXT_CLASSIFICATION_SERVICE
public static final String TEXT_CLASSIFICATION_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TextClassificationManager
for text classification services.
Constant Value: "textclassification"
TEXT_SERVICES_MANAGER_SERVICE
public static final String TEXT_SERVICES_MANAGER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TextServicesManager
for accessing
text services.
See also:
Constant Value: "textservices"
TV_INPUT_SERVICE
public static final String TV_INPUT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
TvInputManager
for interacting with TV inputs
on the device.
Constant Value: "tv_input"
UI_MODE_SERVICE
public static final String UI_MODE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
UiModeManager
for controlling UI modes.
See also:
Constant Value: "uimode"
USAGE_STATS_SERVICE
public static final String USAGE_STATS_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a UsageStatsManager
for querying device usage stats.
Constant Value: "usagestats"
USB_SERVICE
public static final 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.
Constant Value: "usb"
USER_SERVICE
public static final String USER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
UserManager
for managing users on devices that support multiple users.
Constant Value: "user"
VIBRATOR_MANAGER_SERVICE
public static final String VIBRATOR_MANAGER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a VibratorManager
for accessing the device vibrators, interacting with individual ones and playing synchronized
effects on multiple vibrators.
Constant Value: "vibrator_manager"
VIBRATOR_SERVICE
public static final String VIBRATOR_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a Vibrator
for
interacting with the vibration hardware.
Constant Value: "vibrator"
VPN_MANAGEMENT_SERVICE
public static final String VPN_MANAGEMENT_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a VpnManager
to
manage profiles for the platform built-in VPN.
See also:
Constant Value: "vpn_management"
WALLPAPER_SERVICE
public static final String WALLPAPER_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
com.android.server.WallpaperService for accessing wallpapers.
See also:
Constant Value: "wallpaper"
WIFI_AWARE_SERVICE
public static final String WIFI_AWARE_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
WifiAwareManager
for handling management of
Wi-Fi Aware.
Constant Value: "wifiaware"
WIFI_P2P_SERVICE
public static final String WIFI_P2P_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiP2pManager
for handling management of
Wi-Fi peer-to-peer connections.
Constant Value: "wifip2p"
WIFI_RTT_RANGING_SERVICE
public static final String WIFI_RTT_RANGING_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiRttManager
for ranging devices with wifi.
Constant Value: "wifirtt"
WIFI_SERVICE
public static final String WIFI_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a WifiManager
for handling management of
Wi-Fi access.
Constant Value: "wifi"
WINDOW_SERVICE
public static final String WINDOW_SERVICE
Use with getSystemService(java.lang.String)
to retrieve a
WindowManager
for accessing the system's window
manager.
Constant Value: "window"
Public constructors
Context
public Context ()
Public methods
bindIsolatedService
public boolean bindIsolatedService (Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)
Variation of bindService(Intent, ServiceConnection, int)
that, in the specific case of isolated
services, allows the caller to generate multiple instances of a service
from a single component declaration. In other words, you can use this to bind
to a service that has specified R.attr.isolatedProcess
and, in
addition to the existing behavior of running in an isolated process, you can
also through the arguments here have the system bring up multiple concurrent
processes hosting their own instances of that service. The instanceName
you provide here identifies the different instances, and you can use
updateServiceGroup(android.content.ServiceConnection, int, int)
to tell the system how it
should manage each of these instances.
Parametersservice
Intent
: Identifies the service to connect to. The Intent must
specify an explicit component name.
This value cannot be null
.
flags
int
: Operation options for the binding as per bindService(Intent, ServiceConnection, int)
.
Value is either 0
or a combination of BIND_AUTO_CREATE
, BIND_DEBUG_UNBIND
, BIND_NOT_FOREGROUND
, BIND_ABOVE_CLIENT
, BIND_ALLOW_OOM_MANAGEMENT
, BIND_WAIVE_PRIORITY
, BIND_IMPORTANT
, BIND_ADJUST_WITH_ACTIVITY
, BIND_NOT_PERCEPTIBLE
, and BIND_INCLUDE_CAPABILITIES
instanceName
String
: Unique identifier for the service instance. Each unique
name here will result in a different service instance being created. Identifiers
must only contain ASCII letters, digits, underscores, and periods.
This value cannot be null
.
executor
Executor
: Callbacks on ServiceConnection will be called on executor.
Must use same instance for the same instance of ServiceConnection.
This value cannot be null
.
Callback and listener events are dispatched through this
Executor
, providing an easy way to control which thread is
used. To dispatch events through the main thread of your
application, you can use
Context.getMainExecutor()
.
To dispatch events through a shared thread pool, you can use
AsyncTask#THREAD_POOL_EXECUTOR
.
conn
ServiceConnection
: Receives information as the service is started and stopped.
This must be a valid ServiceConnection object; it must not be null.
This value cannot be null
.
boolean
Returns success of binding as per bindService(Intent, ServiceConnection, int)
.
SecurityException
If the caller does not have permission to access the service
IllegalArgumentException
If the instanceName is invalid.
bindService
public boolean bindService (Intent service, int flags, Executor executor, ServiceConnection conn)
Same as bindService(android.content.Intent, android.content.ServiceConnection, int)
with executor to control
ServiceConnection callbacks.
service
Intent
: This value cannot be null
.
flags
int
: Value is either 0
or a combination of BIND_AUTO_CREATE
, BIND_DEBUG_UNBIND
, BIND_NOT_FOREGROUND
, BIND_ABOVE_CLIENT
, BIND_ALLOW_OOM_MANAGEMENT
, BIND_WAIVE_PRIORITY
, BIND_IMPORTANT
, BIND_ADJUST_WITH_ACTIVITY
, BIND_NOT_PERCEPTIBLE
, and BIND_INCLUDE_CAPABILITIES
executor
Executor
: Callbacks on ServiceConnection will be called on executor. Must use same
instance for the same instance of ServiceConnection.
This value cannot be null
.
Callback and listener events are dispatched through this
Executor
, providing an easy way to control which thread is
used. To dispatch events through the main thread of your
application, you can use
Context.getMainExecutor()
.
To dispatch events through a shared thread pool, you can use
AsyncTask#THREAD_POOL_EXECUTOR
.
conn
ServiceConnection
: This value cannot be null
.
boolean
bindService
public abstract boolean bindService (Intent service, ServiceConnection conn, int flags)
Connect to an application service, creating it if needed. This defines a dependency between your application and the service. The given conn will receive the service object when it is created and be told if it dies and restarts. The service will be considered required by the system only for as long as the calling context exists. For example, if this Context is an Activity that is stopped, the service will not be required to continue running until the Activity is resumed.
If the service does not support binding, it may return null
from
its onBind()
method. If it does, then
the ServiceConnection's
onNullBinding()
method
will be invoked instead of
onServiceConnected()
.
This method will throw SecurityException
if the calling app does not
have permission to bind to the given service.
Note: this method cannot be called from a
BroadcastReceiver
component. A pattern you can use to
communicate from a BroadcastReceiver to a Service is to call
startService(Intent)
with the arguments containing the command to be
sent, with the service calling its
Service.stopSelf(int)
method when done executing
that command. See the API demo App/Service/Service Start Arguments
Controller for an illustration of this. It is okay, however, to use
this method from a BroadcastReceiver that has been registered with
registerReceiver(BroadcastReceiver, IntentFilter)
, since the lifetime of this BroadcastReceiver
is tied to another object (the one that registered it).
boolean
true
if the system is in the process of bringing up a
service that your client has permission to bind to; false
if the system couldn't find the service or if your client doesn't
have permission to bind to it. If this value is true
, you
should later call unbindService(ServiceConnection)
to release the
connection.
SecurityException
If the caller does not have permission to access the service
or the service can not be found.
bindServiceAsUser
public boolean bindServiceAsUser (Intent service, ServiceConnection conn, int flags, UserHandle user)
Binds to a service in the given user
in the same manner as
bindService(android.content.Intent, android.content.ServiceConnection, int)
.
If the given user
is in the same profile group and the target package is the
same as the caller, android.Manifest.permission.INTERACT_ACROSS_PROFILES
is
sufficient. Otherwise, requires android.Manifest.permission.INTERACT_ACROSS_USERS
for interacting with other users.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS or Manifest.permission.INTERACT_ACROSS_PROFILES
service
Intent
: Identifies the service to connect to. The Intent must
specify an explicit component name.
This value cannot be null
.
conn
ServiceConnection
: Receives information as the service is started and stopped.
This must be a valid ServiceConnection object; it must not be null.
This value cannot be null
.
flags
int
: Operation options for the binding. May be 0,
BIND_AUTO_CREATE
, BIND_DEBUG_UNBIND
,
BIND_NOT_FOREGROUND
, BIND_ABOVE_CLIENT
,
BIND_ALLOW_OOM_MANAGEMENT
, BIND_WAIVE_PRIORITY
.
BIND_IMPORTANT
, or
BIND_ADJUST_WITH_ACTIVITY
.
user
UserHandle
: This value cannot be null
.
boolean
true
if the system is in the process of bringing up a
service that your client has permission to bind to; false
if the system couldn't find the service. If this value is true
, you
should later call unbindService(ServiceConnection)
to release the
connection.
SecurityException
if the client does not have the required permission to bind.
checkCallingOrSelfPermission
public abstract int checkCallingOrSelfPermission (String permission)
Determine whether the calling process of an IPC or you have been
granted a particular permission. This is the same as
checkCallingPermission(String)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
checkCallingOrSelfUriPermission
public 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. This is the same as
checkCallingUriPermission(Uri, int)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!
Parametersuri
Uri
: The uri that is being checked.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
See also:
checkCallingOrSelfUriPermissions
public int[] checkCallingOrSelfUriPermissions (List<Uri> uris, int modeFlags)
Determine whether the calling process of an IPC or you has been granted
permission to access a list of URIs. This is the same as
checkCallingUriPermission(Uri, int)
, except it grants your own permissions
if you are not currently processing an IPC. Use with care!
Parametersuris
List
: The list of URIs that is being checked.
This value cannot be null
.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
Returnsint[]
Array of permission grants corresponding to each entry in the list of uris.
PackageManager#PERMISSION_GRANTED
if the given pid/uid is allowed to access that uri,
or PackageManager#PERMISSION_DENIED
if it is not.
This value cannot be null
.
Value is PackageManager.PERMISSION_GRANTED
, or PackageManager.PERMISSION_DENIED
See also:
checkCallingPermission
public abstract int checkCallingPermission (String permission)
Determine whether the calling process of an IPC you are handling has been
granted a particular permission. This is basically the same as calling
checkPermission(java.lang.String, int, int)
with the pid and uid returned
by Binder.getCallingPid()
and
Binder.getCallingUid()
. One important difference
is that if you are not currently processing an IPC, this function
will always fail. This is done to protect against accidentally
leaking permissions; you can use checkCallingOrSelfPermission(String)
to avoid this protection.
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
checkCallingUriPermission
public abstract int checkCallingUriPermission (Uri uri, int modeFlags)
Determine whether the calling process and user ID has been
granted permission to access a specific URI. This is basically
the same as calling checkUriPermission(android.net.Uri, int, int, int)
with the pid and uid returned by Binder.getCallingPid()
and Binder.getCallingUid()
. One important difference is
that if you are not currently processing an IPC, this function
will always fail.
Parametersuri
Uri
: The uri that is being checked.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
See also:
checkCallingUriPermissions
public int[] checkCallingUriPermissions (List<Uri> uris, int modeFlags)
Determine whether the calling process and user ID has been
granted permission to access a list of URIs. This is basically
the same as calling checkUriPermissions(java.util.List, int, int, int)
with the pid and uid returned by Binder.getCallingPid()
and Binder.getCallingUid()
. One important difference is
that if you are not currently processing an IPC, this function
will always fail.
Parametersuris
List
: The list of URIs that is being checked.
This value cannot be null
.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
Returnsint[]
Array of permission grants corresponding to each entry in the list of uris.
PackageManager#PERMISSION_GRANTED
if the given pid/uid is allowed to access that uri,
or PackageManager#PERMISSION_DENIED
if it is not.
This value cannot be null
.
Value is PackageManager.PERMISSION_GRANTED
, or PackageManager.PERMISSION_DENIED
See also:
checkPermission
public 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.
permission
String
: The name of the permission being checked.
This value cannot be null
.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
checkSelfPermission
public abstract int checkSelfPermission (String permission)
Determine whether you have been granted a particular permission.
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
checkUriPermission
public abstract int checkUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)
Check both a Uri and normal permission. This allows you to perform
both checkPermission(String, int, int)
and checkUriPermission(Uri, int, int, int)
in one
call.
Parametersuri
Uri
: The Uri whose permission is to be checked, or null to not
do this check.
This value may be null
.
readPermission
String
: The permission that provides overall read access,
or null to not do this check.
This value may be null
.
writePermission
String
: The permission that provides overall write
access, or null to not do this check.
This value may be null
.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
checkUriPermission
public 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. 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.
Parametersuri
Uri
: The uri that is being checked.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
modeFlags
int
: The access modes to check.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
See also:
checkUriPermissions
public int[] checkUriPermissions (List<Uri> uris, int pid, int uid, int modeFlags)
Determine whether a particular process and user ID has been granted permission to access a list of URIs. This only checks for permissions that have been explicitly granted -- if the given process/uid has more general access to the URI's content provider then this check will always fail.
Parametersuris
List
: The list of URIs that is being checked.
This value cannot be null
.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
modeFlags
int
: The access modes to check for the list of uris
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
Returnsint[]
Array of permission grants corresponding to each entry in the list of uris.
PackageManager#PERMISSION_GRANTED
if the given pid/uid is allowed to access that uri,
or PackageManager#PERMISSION_DENIED
if it is not.
This value cannot be null
.
Value is PackageManager.PERMISSION_GRANTED
, or PackageManager.PERMISSION_DENIED
See also:
clearWallpaper
public abstract void clearWallpaper ()
This method was deprecated
in API level 15.
Use WallpaperManager.clear()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
IOException
createAttributionContext
public Context createAttributionContext (String attributionTag)
Return a new Context object for the current Context but attribute to a different tag. In complex apps attribution tagging can be used to distinguish between separate logical parts.
ParametersattributionTag
String
: The tag or null
to create a context for the default.
This value may be null
.
See also:
createConfigurationContext
public abstract Context createConfigurationContext (Configuration overrideConfiguration)
Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
ParametersoverrideConfiguration
Configuration
: A Configuration
specifying what
values to modify in the base Configuration of the original Context's
resources. If the base configuration changes (such as due to an
orientation change), the resources of this context will also change except
for those that have been explicitly overridden with a value here.
This value cannot be null
.
createContext
public Context createContext (ContextParams contextParams)
Creates a context with specific properties and behaviors.
contextParams
ContextParams
: Parameters for how the new context should behave.
This value cannot be null
.
ReturnsContext
A context with the specified behaviors.
This value cannot be null
.
See also:
createContextForSplit
public abstract Context createContextForSplit (String splitName)
Return a new Context object for the given split name. The new Context has a ClassLoader and Resources object that can access the split's and all of its dependencies' code/resources. Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same split) may be so the Context itself can be fairly lightweight.
splitName
String
: The name of the split to include, as declared in the split's
AndroidManifest.xml
.
createDeviceProtectedStorageContext
public abstract Context createDeviceProtectedStorageContext ()
Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
On devices with direct boot, data stored in this location is encrypted with a key tied to the physical device, and it can be accessed immediately after the device has booted successfully, both before and after the user has authenticated with their credentials (such as a lock pattern or PIN).
Because device-protected data is available without user authentication, you should carefully limit the data you store using this Context. For example, storing sensitive authentication tokens or passwords in the device-protected area is strongly discouraged.
If the underlying device does not have the ability to store device-protected and credential-protected data using different keys, then both storage areas will become available at the same time. They remain as two distinct storage locations on disk, and only the window of availability changes.
Each call to this method returns a new instance of a Context object; Context objects are not shared, however common state (ClassLoader, other Resources for the same configuration) may be so the Context itself can be fairly lightweight.
Context
See also:
createDisplayContext
public 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. 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.
To obtain an instance of a WindowManager
(see getSystemService(java.lang.String)
) that
is configured to show windows on the given display call
createWindowContext(int, android.os.Bundle)
on the returned display Context or use an
Activity
.
Note that invoking #createDisplayContext(Display) from an UI context is not regarded
as an UI context. In other words, it is not suggested to access UI components (such as
obtain a WindowManager
by getSystemService(java.lang.String)
)
from the context created from #createDisplayContext(Display).
Parametersdisplay
Display
: A Display
object specifying the display for whose metrics the
Context's resources should be tailored.
This value cannot be null
.
See also:
createPackageContext
public abstract Context createPackageContext (String packageName, int flags)
Return a new Context object for the given application name. This Context is the same as what the named application gets when it is launched, containing the same resources and class loader. Each call to this method returns a new instance of a Context object; Context objects are not shared, however they share common state (Resources, ClassLoader, etc) so the Context instance itself is fairly lightweight.
Throws PackageManager.NameNotFoundException
if there is no
application with the given package name.
Throws SecurityException
if the Context requested
can not be loaded into the caller's process for security reasons (see
CONTEXT_INCLUDE_CODE
for more information}.
ParameterspackageName
String
: Name of the application's package.
flags
int
: Option flags.
Value is either 0
or a combination of CONTEXT_INCLUDE_CODE
, CONTEXT_IGNORE_SECURITY
, CONTEXT_RESTRICTED
, android.content.Context.CONTEXT_DEVICE_PROTECTED_STORAGE, android.content.Context.CONTEXT_CREDENTIAL_PROTECTED_STORAGE, and android.content.Context.CONTEXT_REGISTER_PACKAGE
createWindowContext
public Context createWindowContext (int type, Bundle options)
Creates a Context for a non-activity window.
A window context is a context that can be used to add non-activity windows, such as
WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY
. A window context
must be created from a context that has an associated Display
, such as
Activity
or a context created with
createDisplayContext(android.view.Display)
.
The window context is created with the appropriate Configuration
for the area of the
display that the windows created with it can occupy; it must be used when
inflating
views, such that they can be inflated with
proper Resources
.
Below is a sample code to add an application overlay window on the primary display:
...
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
final Context windowContext = anyContext.createDisplayContext(primaryDisplay)
.createWindowContext(TYPE_APPLICATION_OVERLAY, null);
final View overlayView = Inflater.from(windowContext).inflate(someLayoutXml, null);
// WindowManager.LayoutParams initialization
...
// The types used in addView and createWindowContext must match.
mParams.type = TYPE_APPLICATION_OVERLAY;
...
windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
This context's configuration and resources are adjusted to an area of the display where the windows with provided type will be added. Note that all windows associated with the same context will have an affinity and can only be moved together between different displays or areas on a display. If there is a need to add different window types, or non-associated windows, separate Contexts should be used.
Creating a window context is an expensive operation. Misuse of this API may lead to a huge performance drop. The best practice is to use the same window context when possible. An approach is to create one window context with specific window type and display and use it everywhere it's needed.
After Build.VERSION_CODES#S
, window context provides the capability to receive
configuration changes for existing token by overriding the
token
of the
WindowManager.LayoutParams
passed in
WindowManager#addView(View, LayoutParams)
. This is useful when an application needs
to attach its window to an existing activity for window token sharing use-case.
Note that the window context in Build.VERSION_CODES#R
didn't have this
capability. This is a no-op for the window context in Build.VERSION_CODES#R
.
final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
final Context windowContext = anyContext.createWindowContext(primaryDisplay,
TYPE_APPLICATION, null);
// Get an existing token.
final IBinder existingToken = activity.getWindow().getAttributes().token;
// The types used in addView() and createWindowContext() must match.
final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION);
params.token = existingToken;
// After WindowManager#addView(), the server side will extract the provided token from
// LayoutParams#token (existingToken in the sample code), and switch to propagate
// configuration changes from the node associated with the provided token.
windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
After Build.VERSION_CODES#S
, window context provides the capability to listen to its
Configuration
changes by calling
registerComponentCallbacks(android.content.ComponentCallbacks)
, while other kinds of Context
will register the ComponentCallbacks
to its
Application context
. Note that window context only propagate
ComponentCallbacks#onConfigurationChanged(Configuration)
callback.
ComponentCallbacks#onLowMemory()
or other callbacks in ComponentCallbacks2
won't be invoked.
Note that using Application
or Service
context for
UI-related queries may result in layout or continuity issues on devices with variable screen
sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect
the Configuration
changes for the visual container.
type
int
: Window type in WindowManager.LayoutParams
Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION_STARTING
, WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION_PANEL
, WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA
, WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL
, WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG
, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR
, WindowManager.LayoutParams.TYPE_SEARCH_BAR
, WindowManager.LayoutParams.TYPE_PHONE
, WindowManager.LayoutParams.TYPE_SYSTEM_ALERT
, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST
, WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY
, WindowManager.LayoutParams.TYPE_PRIORITY_PHONE
, WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG
, WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG
, WindowManager.LayoutParams.TYPE_SYSTEM_ERROR
, WindowManager.LayoutParams.TYPE_INPUT_METHOD
, WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG
, WindowManager.LayoutParams.TYPE_WALLPAPER
, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION
, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, WindowManager.LayoutParams.TYPE_ACCESSIBILITY_OVERLAY
, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY
, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options
Bundle
: A bundle used to pass window-related options
This value may be null
.
createWindowContext
public Context createWindowContext (Display display, int type, Bundle options)
Creates a Context
for a non-activity
window on the given
Display
.
Similar to createWindowContext(int, android.os.Bundle)
, but the display
is passed in,
instead of implicitly using the original Context's Display
.
display
Display
: The Display
to associate with
This value cannot be null
.
type
int
: Window type in WindowManager.LayoutParams
Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION_STARTING
, WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION
, WindowManager.LayoutParams.TYPE_APPLICATION_PANEL
, WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA
, WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL
, WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG
, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR
, WindowManager.LayoutParams.TYPE_SEARCH_BAR
, WindowManager.LayoutParams.TYPE_PHONE
, WindowManager.LayoutParams.TYPE_SYSTEM_ALERT
, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST
, WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY
, WindowManager.LayoutParams.TYPE_PRIORITY_PHONE
, WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG
, WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG
, WindowManager.LayoutParams.TYPE_SYSTEM_ERROR
, WindowManager.LayoutParams.TYPE_INPUT_METHOD
, WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG
, WindowManager.LayoutParams.TYPE_WALLPAPER
, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION
, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, WindowManager.LayoutParams.TYPE_ACCESSIBILITY_OVERLAY
, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY
, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options
Bundle
: A bundle used to pass window-related options.
This value may be null
.
databaseList
public abstract String[] databaseList ()
Returns an array of strings naming the private databases associated with this Context's application package.
String[]
Array of strings naming the private databases.
deleteDatabase
public abstract boolean deleteDatabase (String name)
Delete an existing private SQLiteDatabase associated with this Context's application package.
name
String
: The name (unique in the application package) of the
database.
boolean
true
if the database was successfully deleted; else false
.
deleteFile
public abstract boolean deleteFile (String name)
Delete the given private file associated with this Context's application package.
name
String
: The name of the file to delete; can not contain path
separators.
boolean
true
if the file was successfully deleted; else
false
.
deleteSharedPreferences
public abstract boolean deleteSharedPreferences (String name)
Delete an existing shared preferences file.
name
String
: The name (unique in the application package) of the shared
preferences file.
boolean
true
if the shared preferences file was successfully
deleted; else false
.
See also:
enforceCallingOrSelfPermission
public 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
. This is the same as enforceCallingPermission(String, String)
, except it grants your own
permissions if you are not currently processing an IPC. Use
with care!
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
message
String
: A message to include in the exception if it is thrown.
This value may be null
.
See also:
enforceCallingOrSelfUriPermission
public 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
. This is the same as enforceCallingUriPermission(Uri, int, String)
, except it grants your own
permissions if you are not currently processing an IPC. Use
with care!
uri
Uri
: The uri that is being checked.
modeFlags
int
: The access modes to enforce.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
message
String
: A message to include in the exception if it is thrown.
enforceCallingPermission
public 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
. This is basically the same as calling
enforcePermission(java.lang.String, int, int, java.lang.String)
with the
pid and uid returned by Binder.getCallingPid()
and Binder.getCallingUid()
. One important
difference is that if you are not currently processing an IPC,
this function will always throw the SecurityException. This is
done to protect against accidentally leaking permissions; you
can use enforceCallingOrSelfPermission(String, String)
to avoid this
protection.
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
message
String
: A message to include in the exception if it is thrown.
This value may be null
.
See also:
enforceCallingUriPermission
public 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
. This is basically the same as calling
enforceUriPermission(android.net.Uri, int, int, int, java.lang.String)
with
the pid and uid returned by Binder.getCallingPid()
and Binder.getCallingUid()
. One important difference is
that if you are not currently processing an IPC, this function
will always throw a SecurityException.
uri
Uri
: The uri that is being checked.
modeFlags
int
: The access modes to enforce.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
message
String
: A message to include in the exception if it is thrown.
See also:
enforcePermission
public 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
.
Parameterspermission
String
: The name of the permission being checked.
This value cannot be null
.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
message
String
: A message to include in the exception if it is thrown.
This value may be null
.
See also:
enforceUriPermission
public abstract void enforceUriPermission (Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)
Enforce both a Uri and normal permission. This allows you to perform
both enforcePermission(String, int, int, String)
and enforceUriPermission(Uri, int, int, int, String)
in one
call.
Parametersuri
Uri
: The Uri whose permission is to be checked, or null to not
do this check.
This value may be null
.
readPermission
String
: The permission that provides overall read access,
or null to not do this check.
This value may be null
.
writePermission
String
: The permission that provides overall write
access, or null to not do this check.
This value may be null
.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
modeFlags
int
: The access modes to enforce.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
message
String
: A message to include in the exception if it is thrown.
This value may be null
.
enforceUriPermission
public 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
. 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
Uri
: The uri that is being checked.
pid
int
: The process ID being checked against. Must be > 0.
uid
int
: The user ID being checked against. A uid of 0 is the root
user, which will pass every permission check.
modeFlags
int
: The access modes to enforce.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
message
String
: A message to include in the exception if it is thrown.
See also:
fileList
public abstract String[] fileList ()
Returns an array of strings naming the private files associated with this Context's application package.
String[]
Array of strings naming the private files.
getApplicationContext
public abstract Context getApplicationContext ()
Return the context of the single, global Application object of the current process. This generally should only be used if you need a Context whose lifecycle is separate from the current context, that is tied to the lifetime of the process rather than the current component.
Consider for example how this interacts with
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
:
-
If used from an Activity context, the receiver is being registered within that activity. This means that you are expected to unregister before the activity is done being destroyed; in fact if you do not do so, the framework will clean up your leaked registration as it removes the activity and log an error. Thus, if you use the Activity context to register a receiver that is static (global to the process, not associated with an Activity instance) then that registration will be removed on you at whatever point the activity you used is destroyed.
-
If used from the Context returned here, the receiver is being registered with the global state associated with your application. Thus it will never be unregistered for you. This is necessary if the receiver is associated with static data, not a particular component. However using the ApplicationContext elsewhere can easily lead to serious leaks if you forget to unregister, unbind, etc.
Context
getApplicationInfo
public abstract ApplicationInfo getApplicationInfo ()
Return the full application info for this context's package.
ApplicationInfo
getAssets
public abstract AssetManager getAssets ()
Returns an AssetManager instance for the application's package.
Note: Implementations of this method should return
an AssetManager instance that is consistent with the Resources instance
returned by getResources()
. For example, they should share the
same Configuration
object.
AssetManager
an AssetManager instance for the application's package
See also:
getAttributionTag
public String getAttributionTag ()
Attribution can be used in complex apps to logically separate parts of the app. E.g. a blogging app might also have a instant messaging app built in. In this case two separate tags can for used each sub-feature.
String
the attribution tag this context is for or null
if this is the default.
getCacheDir
public abstract File getCacheDir ()
Returns the absolute path to the application specific cache directory on the filesystem.
The system will automatically delete files in this directory as disk
space is needed elsewhere on the device. The system will always delete
older files first, as reported by File#lastModified()
. If
desired, you can exert more control over how files are deleted using
StorageManager#setCacheBehaviorGroup(File, boolean)
and
StorageManager#setCacheBehaviorTombstone(File, boolean)
.
Apps are strongly encouraged to keep their usage of cache space below the
quota returned by
StorageManager#getCacheQuotaBytes(java.util.UUID)
. If your app
goes above this quota, your cached files will be some of the first to be
deleted when additional disk space is needed. Conversely, if your app
stays under this quota, your cached files will be some of the last to be
deleted when additional disk space is needed.
Note that your cache quota will change over time depending on how frequently the user interacts with your app, and depending on how much system-wide disk space is used.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
File
The path of the directory holding application cache files.
getClassLoader
public abstract ClassLoader getClassLoader ()
Return a class loader you can use to retrieve classes in this package.
ClassLoader
getCodeCacheDir
public abstract File getCodeCacheDir ()
Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
The system will delete any files stored in this location both when your specific application is upgraded, and when the entire platform is upgraded.
This location is optimal for storing compiled or optimized code generated by your application at runtime.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
File
The path of the directory holding application code cache files.
getColor
public final int getColor (int id)
Returns a color associated with a particular resource ID and styled for the current theme.
id
int
: The desired resource identifier, as generated by the aapt
tool. This integer encodes the package, type, and resource
entry. The value 0 is an invalid identifier.
int
A single color value in the form 0xAARRGGBB.
Resources.NotFoundException
if the given ID
does not exist.
getColorStateList
public final ColorStateList getColorStateList (int id)
Returns a color state list associated with a particular resource ID and styled for the current theme.
id
int
: The desired resource identifier, as generated by the aapt
tool. This integer encodes the package, type, and resource
entry. The value 0 is an invalid identifier.
ColorStateList
A color state list.
This value cannot be null
.
Resources.NotFoundException
if the given ID
does not exist.
getContentResolver
public abstract ContentResolver getContentResolver ()
Return a ContentResolver instance for your application's package.
ContentResolver
getDataDir
public abstract File getDataDir ()
Returns the absolute path to the directory on the filesystem where all
private files belonging to this app are stored. Apps should not use this
path directly; they should instead use getFilesDir()
,
getCacheDir()
, getDir(java.lang.String, int)
, or other storage
APIs on this class.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
File
See also:
getDatabasePath
public abstract File getDatabasePath (String name)
Returns the absolute path on the filesystem where a database created with
openOrCreateDatabase(String, int, 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
String
: The name of the database for which you would like to get
its path.
File
An absolute path to the given database.
getDir
public 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. You can use the returned File object to create and access files in this directory. Note that files created through a File object will only be accessible by your own application; you can only set the mode of the entire directory, not of individual files.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
Apps require no extra permissions to read or write to the returned path, since this path lives in their private storage.
Parametersname
String
: Name of the directory to retrieve. This is a directory
that is created as part of your application data.
mode
int
: Operating mode.
Value is either 0
or a combination of MODE_PRIVATE
, MODE_WORLD_READABLE
, MODE_WORLD_WRITEABLE
, and MODE_APPEND
File
A File
object for the requested directory. The directory
will have been created if it does not already exist.
See also:
getDisplay
public Display getDisplay ()
Get the display this context is associated with. Applications should use this method with
Activity
or a context associated with a Display
via
createDisplayContext(android.view.Display)
to get a display object associated with a Context, or
DisplayManager.getDisplay(int)
to get a display object by id.
UnsupportedOperationException
if the method is called on an instance that is not
associated with any display.
getDrawable
public final Drawable getDrawable (int id)
Returns a drawable object associated with a particular resource ID and styled for the current theme.
id
int
: The desired resource identifier, as generated by the aapt
tool. This integer encodes the package, type, and resource
entry. The value 0 is an invalid identifier.
Drawable
An object that can be used to draw this resource.
This value may be null
.
Resources.NotFoundException
if the given ID
does not exist.
getExternalCacheDir
public 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. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- The platform does not always monitor the space available in shared
storage, and thus may not automatically delete these files. Apps should
always manage the maximum space used in this location. Currently the only
time files here will be deleted by the platform is when running on
Build.VERSION_CODES.JELLY_BEAN_MR1
or later andEnvironment#isExternalStorageEmulated(File)
returns true. - Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by
Environment#isExternalStorageEmulated(File)
), its contents are
backed by a private user data partition, which means there is little
benefit to storing data here instead of the private directory returned by
getCacheDir()
.
Starting in Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the returned path; it's always
accessible to the calling app. This only applies to paths generated for
package name of the calling application. To access paths belonging to
other packages,
Manifest.permission.WRITE_EXTERNAL_STORAGE
and/or
Manifest.permission.READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
),
each user has their own isolated shared storage. Applications only have
access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
File
the absolute path to application-specific directory. May return
null
if shared storage is not currently available.
getExternalCacheDirs
public 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. These files are internal to the application, and not typically visible to the user as media.
This is like getCacheDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- The platform does not always monitor the space available in shared
storage, and thus may not automatically delete these files. Apps should
always manage the maximum space used in this location. Currently the only
time files here will be deleted by the platform is when running on
Build.VERSION_CODES.JELLY_BEAN_MR1
or later andEnvironment#isExternalStorageEmulated(File)
returns true. - Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by
Environment#isExternalStorageEmulated(File)
), 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.
File[]
the absolute paths to application-specific directories. Some
individual paths may be null
if that shared storage is
not currently available. The first path returned is the same as
getExternalCacheDir()
.
getExternalFilesDir
public 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. These files are internal to the applications, and not typically visible to the user as media.
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by
Environment#isExternalStorageEmulated(File)
), 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,
Manifest.permission.WRITE_EXTERNAL_STORAGE
and/or
Manifest.permission.READ_EXTERNAL_STORAGE
are required.
On devices with multiple users (as described by UserManager
),
each user has their own isolated shared storage. Applications only have
access to the shared storage for the user they're running as.
The returned path may change over time if different shared storage media is inserted, so only relative paths should be persisted.
Here is an example of typical code to manipulate a file in an application's shared storage:
void createExternalStoragePrivateFile() { // Create a path where we will place our private file on external // storage. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); try { // Very simple code to copy a picture from the application's // resource into the external file. Note that this code does // no error checking, and assumes the picture is small (does not // try to copy it in chunks). Note that if external storage is // not currently mounted this will silently fail. InputStream is = getResources().openRawResource(R.drawable.balloons); OutputStream os = new FileOutputStream(file); byte[] data = new byte[is.available()]; is.read(data); os.write(data); is.close(); os.close(); } catch (IOException e) { // Unable to create file, likely because external storage is // not currently mounted. Log.w("ExternalStorage", "Error writing " + file, e); } } void deleteExternalStoragePrivateFile() { // Get path for the file on external storage. If external // storage is not currently mounted this will fail. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); file.delete(); } boolean hasExternalStoragePrivateFile() { // Get path for the file on external storage. If external // storage is not currently mounted this will fail. File file = new File(getExternalFilesDir(null), "DemoFile.jpg"); return file.exists(); }
If you supply a non-null type to this function, the returned
file will be a path to a sub-directory of the given type. Though these
files are not automatically scanned by the media scanner, you can
explicitly add them to the media database with
MediaScannerConnection.scanFile
. Note that this is not the same as
Environment.getExternalStoragePublicDirectory()
, which provides
directories of media shared by all applications. The directories returned
here are owned by the application, and their contents will be removed
when the application is uninstalled. Unlike
Environment.getExternalStoragePublicDirectory()
, the directory returned
here will be automatically created for you.
Here is an example of typical code to manipulate a picture in an application's shared storage and add it to the media database:
void createExternalStoragePrivatePicture() { // Create a path where we will place our picture in our own private // pictures directory. Note that we don't really need to place a // picture in DIRECTORY_PICTURES, since the media scanner will see // all media in these directories; this may be useful with other // media types such as DIRECTORY_MUSIC however to help it classify // your media for display to the user. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); File file = new File(path, "DemoPicture.jpg"); try { // Very simple code to copy a picture from the application's // resource into the external file. Note that this code does // no error checking, and assumes the picture is small (does not // try to copy it in chunks). Note that if external storage is // not currently mounted this will silently fail. InputStream is = getResources().openRawResource(R.drawable.balloons); OutputStream os = new FileOutputStream(file); byte[] data = new byte[is.available()]; is.read(data); os.write(data); is.close(); os.close(); // Tell the media scanner about the new file so that it is // immediately available to the user. MediaScannerConnection.scanFile(this, new String[] { file.toString() }, null, new MediaScannerConnection.OnScanCompletedListener() { public void onScanCompleted(String path, Uri uri) { Log.i("ExternalStorage", "Scanned " + path + ":"); Log.i("ExternalStorage", "-> uri=" + uri); } }); } catch (IOException e) { // Unable to create file, likely because external storage is // not currently mounted. Log.w("ExternalStorage", "Error writing " + file, e); } } void deleteExternalStoragePrivatePicture() { // Create a path where we will place our picture in the user's // public pictures directory and delete the file. If external // storage is not currently mounted this will fail. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); if (path != null) { File file = new File(path, "DemoPicture.jpg"); file.delete(); } } boolean hasExternalStoragePrivatePicture() { // Create a path where we will place our picture in the user's // public pictures directory and check if the file exists. If // external storage is not currently mounted this will think the // picture doesn't exist. File path = getExternalFilesDir(Environment.DIRECTORY_PICTURES); if (path != null) { File file = new File(path, "DemoPicture.jpg"); return file.exists(); } return false; }
File
the absolute path to application-specific directory. May return
null
if shared storage is not currently available.
getExternalFilesDirs
public 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. These files are internal to the application, and not typically visible to the user as media.
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
If a shared storage device is emulated (as determined by
Environment#isExternalStorageEmulated(File)
), 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.
File[]
the absolute paths to application-specific directories. Some
individual paths may be null
if that shared storage is
not currently available. The first path returned is the same as
getExternalFilesDir(java.lang.String)
.
getExternalMediaDirs
public abstract File[] getExternalMediaDirs ()
This method was deprecated
in API level 30.
These directories still exist and are scanned, but developers
are encouraged to migrate to inserting content into a
MediaStore
collection directly, as any app can
contribute new media to MediaStore
with no
permissions required, starting in
Build.VERSION_CODES.Q
.
Returns absolute paths to application-specific directories on all
shared/external storage devices where the application can place media
files. These files are scanned and made available to other apps through
MediaStore
.
This is like getExternalFilesDirs(String)
in that these files will be
deleted when the application is uninstalled, however there are some
important differences:
- Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For
example, an app may choose to store large files on the device with the
most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
The returned paths may change over time if different shared storage media is inserted, so only relative paths should be persisted.
File[]
the absolute paths to application-specific directories. Some
individual paths may be null
if that shared storage is
not currently available.
getFileStreamPath
public abstract File getFileStreamPath (String name)
Returns the absolute path on the filesystem where a file created with
openFileOutput(String, int)
is stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
name
String
: The name of the file for which you would like to get
its path.
File
An absolute path to the given file.
getFilesDir
public abstract File getFilesDir ()
Returns the absolute path to the directory on the filesystem where files
created with openFileOutput(String, int)
are stored.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
File
The path of the directory holding application files.
getMainExecutor
public Executor getMainExecutor ()
Return an Executor
that will run enqueued tasks on the main
thread associated with this context. This is the thread used to dispatch
calls to application components (activities, services, etc).
Executor
getMainLooper
public abstract Looper getMainLooper ()
Return the Looper for the main thread of the current process. This is the thread used to dispatch calls to application components (activities, services, etc).
By definition, this method returns the same result as would be obtained
by calling Looper.getMainLooper()
.
Looper
The main looper.
getNoBackupFilesDir
public abstract File getNoBackupFilesDir ()
Returns the absolute path to the directory on the filesystem similar to
getFilesDir()
. The difference is that files placed under this
directory will be excluded from automatic backup to remote storage. See
BackupAgent
for a full discussion
of the automatic backup mechanism in Android.
The returned path may change over time if the calling app is moved to an adopted storage device, so only relative paths should be persisted.
No additional permissions are required for the calling app to read or write files under the returned path.
File
The path of the directory holding application files that will not
be automatically backed up to remote storage.
getObbDir
public abstract File getObbDir ()
Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. Note if the application does not have any OBB files, this directory may not exist.
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
Starting in Build.VERSION_CODES.KITKAT
, no permissions
are required to read or write to the path that this method returns.
However, starting from Build.VERSION_CODES.M
,
to read the OBB expansion files, you must declare the
Manifest.permission.READ_EXTERNAL_STORAGE
permission in the app manifest and ask for
permission at runtime as follows:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
android:maxSdkVersion="23" />
Starting from Build.VERSION_CODES.N
,
Manifest.permission.READ_EXTERNAL_STORAGE
permission is not required, so don’t ask for this
permission at runtime. To handle both cases, your app must first try to read the OBB file,
and if it fails, you must request
Manifest.permission.READ_EXTERNAL_STORAGE
permission at runtime.
The following code snippet shows how to do this:
File obb = new File(obb_filename); boolean open_failed = false; try { BufferedReader br = new BufferedReader(new FileReader(obb)); open_failed = false; ReadObbFile(br); } catch (IOException e) { open_failed = true; } if (open_failed) { // request READ_EXTERNAL_STORAGE permission before reading OBB file ReadObbFileWithPermission(); }
On devices with multiple users (as described by UserManager
),
multiple users may share the same OBB storage location. Applications
should ensure that multiple instances running under different users don't
interfere with each other.
File
the absolute path to application-specific directory. May return
null
if shared storage is not currently available.
getObbDirs
public 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. Note if the application does not have any OBB files, these directories may not exist.
This is like getFilesDir()
in that these files will be deleted
when the application is uninstalled, however there are some important
differences:
- Shared storage may not always be available, since removable media can
be ejected by the user. Media state can be checked using
Environment#getExternalStorageState(File)
. - There is no security enforced with these files. For example, any
application holding
Manifest.permission.WRITE_EXTERNAL_STORAGE
can write to these files.
Shared storage devices returned here are considered a stable part of the device, including physical media slots under a protective cover. The returned paths do not include transient devices, such as USB flash drives connected to handheld devices.
An application may store data on any or all of the returned devices. For
example, an app may choose to store large files on the device with the
most available space, as measured by StatFs
.
No additional permissions are required for the calling app to read or write files under the returned path. Write access outside of these paths on secondary external storage devices is not available.
File[]
the absolute paths to application-specific directories. Some
individual paths may be null
if that shared storage is
not currently available. The first path returned is the same as
getObbDir()
getOpPackageName
public String getOpPackageName ()
Return the package name that should be used for AppOpsManager
calls from
this context, so that app ops manager's uid verification will work with the name.
This is not generally intended for third party application developers.
String
This value cannot be null
.
getPackageCodePath
public abstract String getPackageCodePath ()
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains application's primary code and assets.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
String
String Path to the code and assets.
getPackageManager
public abstract PackageManager getPackageManager ()
Return PackageManager instance to find global package information.
PackageManager
getPackageName
public abstract String getPackageName ()
Return the name of this application's package.
String
getPackageResourcePath
public abstract String getPackageResourcePath ()
Return the full path to this context's primary Android package. The Android package is a ZIP file which contains the application's primary resources.
Note: this is not generally useful for applications, since they should not be directly accessing the file system.
String
String Path to the resources.
getParams
public ContextParams getParams ()
Return the set of parameters which this Context was created with, if it
was created via createContext(android.content.ContextParams)
.
ContextParams
This value may be null
.
getResources
public abstract Resources getResources ()
Returns a Resources instance for the application's package.
Note: Implementations of this method should return
a Resources instance that is consistent with the AssetManager instance
returned by getAssets()
. For example, they should share the
same Configuration
object.
Resources
a Resources instance for the application's package
See also:
getSharedPreferences
public 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. Only one instance of the SharedPreferences object is returned to any callers for the same name, meaning they will see each other's edits as soon as they are made.
This method is thread-safe.
If the preferences directory does not already exist, it will be created when this method is called.
If a preferences file by this name does not exist, it will be created when you retrieve an
editor (SharedPreferences#edit()
) and then commit changes (SharedPreferences.Editor.commit()
or SharedPreferences.Editor#apply()
).
Parametersname
String
: Desired preferences file.
mode
int
: Operating mode.
Value is either 0
or a combination of MODE_PRIVATE
, MODE_WORLD_READABLE
, MODE_WORLD_WRITEABLE
, and MODE_MULTI_PROCESS
SharedPreferences
The single SharedPreferences
instance that can be used
to retrieve and modify the preference values.
See also:
getString
public final 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(String, Object...)
.
resId
int
: Resource id for the format string
formatArgs
Object
: The format arguments that will be used for
substitution.
String
The string data associated with the resource, formatted and
stripped of styled text information.
This value cannot be null
.
getString
public final String getString (int resId)
Returns a localized string from the application's package's default string table.
resId
int
: Resource id for the string
String
The string data associated with the resource, stripped of styled
text information.
This value cannot be null
.
getSystemService
public final T getSystemService (Class<T> serviceClass)
Return the handle to a system-level service by class.
Currently available classes are:
WindowManager
, LayoutInflater
,
ActivityManager
, PowerManager
,
AlarmManager
, NotificationManager
,
KeyguardManager
, LocationManager
,
SearchManager
, Vibrator
,
ConnectivityManager
,
WifiManager
,
AudioManager
, MediaRouter
,
TelephonyManager
, SubscriptionManager
,
InputMethodManager
,
UiModeManager
, DownloadManager
,
BatteryManager
, JobScheduler
,
NetworkStatsManager
,
DomainVerificationManager
.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp()
returns true,
don't have access to the following system services: DEVICE_POLICY_SERVICE
,
FINGERPRINT_SERVICE
, KEYGUARD_SERVICE
, SHORTCUT_SERVICE
,
USB_SERVICE
, WALLPAPER_SERVICE
, WIFI_P2P_SERVICE
,
WIFI_SERVICE
, WIFI_AWARE_SERVICE
. For these services this method will
return null
. Generally, if you are running as an instant app you should always
check whether the result of this method is null
.
serviceClass
Class
: The class of the desired service.
This value cannot be null
.
T
The service or null
if the class is not a supported system service. Note:
never throw a RuntimeException
if the name is not supported.
getSystemService
public abstract Object getSystemService (String name)
Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:
WINDOW_SERVICE
("window")
The top-level window manager in which you can place custom
windows. The returned object is a WindowManager
. Must only be obtained
from a visual context such as Activity or a Context created with
createWindowContext(int, android.os.Bundle)
, which are adjusted to the configuration and
visual bounds of an area on screen.
LAYOUT_INFLATER_SERVICE
("layout_inflater")
A LayoutInflater
for inflating layout resources
in this context. Must only be obtained from a visual context such as Activity or a Context
created with createWindowContext(int, android.os.Bundle)
, which are adjusted to the
configuration and visual bounds of an area on screen.
ACTIVITY_SERVICE
("activity")
A ActivityManager
for interacting with the
global activity state of the system.
WALLPAPER_SERVICE
("wallpaper")
A WallpaperService
for accessing wallpapers in this
context. Must only be obtained from a visual context such as Activity or a Context created
with createWindowContext(int, android.os.Bundle)
, which are adjusted to the configuration and
visual bounds of an area on screen.
POWER_SERVICE
("power")
A PowerManager
for controlling power
management.
ALARM_SERVICE
("alarm")
A AlarmManager
for receiving intents at the
time of your choosing.
NOTIFICATION_SERVICE
("notification")
A NotificationManager
for informing the user
of background events.
KEYGUARD_SERVICE
("keyguard")
A KeyguardManager
for controlling keyguard.
LOCATION_SERVICE
("location")
A LocationManager
for controlling location
(e.g., GPS) updates.
SEARCH_SERVICE
("search")
A SearchManager
for handling search.
VIBRATOR_MANAGER_SERVICE
("vibrator_manager")
A VibratorManager
for accessing the device vibrators, interacting
with individual ones and playing synchronized effects on multiple vibrators.
VIBRATOR_SERVICE
("vibrator")
A Vibrator
for interacting with the vibrator hardware.
CONNECTIVITY_SERVICE
("connectivity")
A ConnectivityManager
for
handling management of network connections.
IPSEC_SERVICE
("ipsec")
A IpSecManager
for managing IPSec on
sockets and networks.
WIFI_SERVICE
("wifi")
A WifiManager
for management of Wi-Fi
connectivity. On releases before NYC, it should only be obtained from an application
context, and not from any other derived context to avoid memory leaks within the calling
process.
WIFI_AWARE_SERVICE
("wifiaware")
A WifiAwareManager
for management of
Wi-Fi Aware discovery and connectivity.
WIFI_P2P_SERVICE
("wifip2p")
A WifiP2pManager
for management of
Wi-Fi Direct connectivity.
INPUT_METHOD_SERVICE
("input_method")
An InputMethodManager
for management of input methods.
UI_MODE_SERVICE
("uimode")
An UiModeManager
for controlling UI modes.
DOWNLOAD_SERVICE
("download")
A DownloadManager
for requesting HTTP downloads
BATTERY_SERVICE
("batterymanager")
A BatteryManager
for managing battery state
JOB_SCHEDULER_SERVICE
("taskmanager")
A JobScheduler
for managing scheduled tasks
NETWORK_STATS_SERVICE
("netstats")
A NetworkStatsManager
for querying network
usage statistics.
HARDWARE_PROPERTIES_SERVICE
("hardware_properties")
A HardwarePropertiesManager
for accessing hardware properties.
DOMAIN_VERIFICATION_SERVICE
("domain_verification")
A DomainVerificationManager
for accessing
web domain approval state.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp()
returns true,
don't have access to the following system services: DEVICE_POLICY_SERVICE
,
FINGERPRINT_SERVICE
, KEYGUARD_SERVICE
, SHORTCUT_SERVICE
,
USB_SERVICE
, WALLPAPER_SERVICE
, WIFI_P2P_SERVICE
,
WIFI_SERVICE
, WIFI_AWARE_SERVICE
. For these services this method will
return null
. Generally, if you are running as an instant app you should always
check whether the result of this method is null
.
Note: When implementing this method, keep in mind that new services can be added on newer
Android releases, so if you're looking for just the explicit names mentioned above, make sure
to return null
when you don't recognize the name — if you throw a
RuntimeException
exception instead, you're app might break on new Android releases.
Parametersname
String
: The name of the desired service.
Value is POWER_SERVICE
, WINDOW_SERVICE
, LAYOUT_INFLATER_SERVICE
, ACCOUNT_SERVICE
, ACTIVITY_SERVICE
, ALARM_SERVICE
, NOTIFICATION_SERVICE
, ACCESSIBILITY_SERVICE
, CAPTIONING_SERVICE
, KEYGUARD_SERVICE
, LOCATION_SERVICE
, SEARCH_SERVICE
, SENSOR_SERVICE
, android.content.Context.SENSOR_PRIVACY_SERVICE, STORAGE_SERVICE
, STORAGE_STATS_SERVICE
, WALLPAPER_SERVICE
, android.content.Context.TIME_ZONE_RULES_MANAGER_SERVICE, VIBRATOR_MANAGER_SERVICE
, VIBRATOR_SERVICE
, CONNECTIVITY_SERVICE
, android.content.Context.PAC_PROXY_SERVICE, android.content.Context.VCN_MANAGEMENT_SERVICE, IPSEC_SERVICE
, VPN_MANAGEMENT_SERVICE
, android.content.Context.TEST_NETWORK_SERVICE, NETWORK_STATS_SERVICE
, WIFI_SERVICE
, WIFI_AWARE_SERVICE
, WIFI_P2P_SERVICE
, android.content.Context.WIFI_SCANNING_SERVICE, WIFI_RTT_RANGING_SERVICE
, NSD_SERVICE
, AUDIO_SERVICE
, android.content.Context.AUTH_SERVICE, FINGERPRINT_SERVICE
, BIOMETRIC_SERVICE
, MEDIA_ROUTER_SERVICE
, TELEPHONY_SERVICE
, TELEPHONY_SUBSCRIPTION_SERVICE
, CARRIER_CONFIG_SERVICE
, EUICC_SERVICE
, TELECOM_SERVICE
, CLIPBOARD_SERVICE
, INPUT_METHOD_SERVICE
, TEXT_SERVICES_MANAGER_SERVICE
, TEXT_CLASSIFICATION_SERVICE
, APPWIDGET_SERVICE
, android.content.Context.REBOOT_READINESS_SERVICE, android.content.Context.ROLLBACK_SERVICE, DROPBOX_SERVICE
, DEVICE_POLICY_SERVICE
, UI_MODE_SERVICE
, DOWNLOAD_SERVICE
, NFC_SERVICE
, BLUETOOTH_SERVICE
, USB_SERVICE
, LAUNCHER_APPS_SERVICE
, INPUT_SERVICE
, DISPLAY_SERVICE
, USER_SERVICE
, RESTRICTIONS_SERVICE
, APP_OPS_SERVICE
, ROLE_SERVICE
, CAMERA_SERVICE
, PRINT_SERVICE
, CONSUMER_IR_SERVICE
, TV_INPUT_SERVICE
, USAGE_STATS_SERVICE
, MEDIA_SESSION_SERVICE
, MEDIA_COMMUNICATION_SERVICE
, BATTERY_SERVICE
, JOB_SCHEDULER_SERVICE
, MEDIA_PROJECTION_SERVICE
, MIDI_SERVICE
, android.content.Context.RADIO_SERVICE, HARDWARE_PROPERTIES_SERVICE
, SHORTCUT_SERVICE
, SYSTEM_HEALTH_SERVICE
, COMPANION_DEVICE_SERVICE
, CROSS_PROFILE_APPS_SERVICE
, android.content.Context.PERMISSION_SERVICE, android.content.Context.LIGHTS_SERVICE, android.content.Context.UWB_SERVICE, or MEDIA_METRICS_SERVICE
This value cannot be null
.
Object
The service or null
if the name does not exist.
getSystemServiceName
public abstract String getSystemServiceName (Class<?> serviceClass)
Gets the name of the system-level service that is represented by the specified class.
serviceClass
Class
: The class of the desired service.
This value cannot be null
.
String
The service name or null if the class is not a supported system service.
getText
public final CharSequence getText (int resId)
Return a localized, styled CharSequence from the application's package's default string table.
resId
int
: Resource id for the CharSequence text
CharSequence
This value cannot be null
.
getTheme
public abstract Resources.Theme getTheme ()
Return the Theme object associated with this Context.
Resources.Theme
getWallpaper
public abstract Drawable getWallpaper ()
This method was deprecated
in API level 15.
Use WallpaperManager.get()
instead.
Drawable
getWallpaperDesiredMinimumHeight
public abstract int getWallpaperDesiredMinimumHeight ()
This method was deprecated
in API level 15.
Use WallpaperManager.getDesiredMinimumHeight()
instead.
int
getWallpaperDesiredMinimumWidth
public abstract int getWallpaperDesiredMinimumWidth ()
This method was deprecated
in API level 15.
Use WallpaperManager.getDesiredMinimumWidth()
instead.
int
grantUriPermission
public 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. This can be used to grant specific, temporary permissions, typically in response to user interaction (such as the user opening an attachment that you would like someone else to display).
Normally you should use Intent.FLAG_GRANT_READ_URI_PERMISSION
or
Intent.FLAG_GRANT_WRITE_URI_PERMISSION
with the Intent being used to
start an activity instead of this function directly. If you use this
function directly, you should be sure to call
revokeUriPermission(Uri, int)
when the target should no longer be allowed
to access it.
To succeed, the content provider owning the Uri must have set the
grantUriPermissions
attribute in its manifest or included the
<grant-uri-permissions>
tag.
ParameterstoPackage
String
: The package you would like to allow to access the Uri.
uri
Uri
: The Uri you would like to grant access to.
modeFlags
int
: The desired access modes.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, Intent.FLAG_GRANT_WRITE_URI_PERMISSION
, Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION
, and Intent.FLAG_GRANT_PREFIX_URI_PERMISSION
See also:
isDeviceProtectedStorage
public abstract boolean isDeviceProtectedStorage ()
Indicates if the storage APIs of this Context are backed by device-protected storage.
boolean
See also:
isRestricted
public boolean isRestricted ()
Indicates whether this Context is restricted.
boolean
true
if this Context is restricted, false
otherwise.
See also:
isUiContext
public boolean isUiContext ()
Returns true
if the context is a UI context which can access UI components such as
WindowManager
, LayoutInflater
or
WallpaperManager
. Accessing UI components from non-UI
contexts throws Violation
if
StrictMode.VmPolicy.Builder.detectIncorrectContextUse()
is enabled.
Examples of UI contexts are
an Activity
, a context created from
createWindowContext(int, android.os.Bundle)
or
InputMethodService
Note that even if it is allowed programmatically, it is not suggested to override this
method to bypass IncorrectContextUseViolation
verification.
boolean
moveDatabaseFrom
public abstract boolean moveDatabaseFrom (Context sourceContext, String name)
Move an existing database file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as migrating to device protected storage.
The database must be closed before being moved.
sourceContext
Context
: The source context which contains the existing
database to move.
name
String
: The name of the database file.
boolean
true
if the move was successful or if the database didn't
exist in the source context, otherwise false
.
See also:
moveSharedPreferencesFrom
public abstract boolean moveSharedPreferencesFrom (Context sourceContext, String name)
Move an existing shared preferences file from the given source storage context to this context. This is typically used to migrate data between storage locations after an upgrade, such as moving to device protected storage.
sourceContext
Context
: The source context which contains the existing
shared preferences to move.
name
String
: The name of the shared preferences file.
boolean
true
if the move was successful or if the shared
preferences didn't exist in the source context, otherwise
false
.
See also:
obtainStyledAttributes
public final TypedArray obtainStyledAttributes (AttributeSet set, int[] attrs)
Retrieve styled attribute information in this Context's theme. See
Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.
set
AttributeSet
: This value may be null
.
attrs
int
: This value cannot be null
.
TypedArray
This value cannot be null
.
obtainStyledAttributes
public final TypedArray obtainStyledAttributes (AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)
Retrieve styled attribute information in this Context's theme. See
Resources.Theme.obtainStyledAttributes(AttributeSet, int[], int, int)
for more information.
set
AttributeSet
: This value may be null
.
attrs
int
: This value cannot be null
.
defStyleAttr
int
defStyleRes
int
TypedArray
This value cannot be null
.
obtainStyledAttributes
public final TypedArray obtainStyledAttributes (int resid, int[] attrs)
Retrieve styled attribute information in this Context's theme. See
Resources.Theme.obtainStyledAttributes(int, int[])
for more information.
resid
int
attrs
int
: This value cannot be null
.
TypedArray
This value cannot be null
.
obtainStyledAttributes
public final TypedArray obtainStyledAttributes (int[] attrs)
Retrieve styled attribute information in this Context's theme. See
Resources.Theme.obtainStyledAttributes(int[])
for more information.
attrs
int
: This value cannot be null
.
TypedArray
This value cannot be null
.
openFileInput
public abstract FileInputStream openFileInput (String name)
Open a private file associated with this Context's application package for reading.
name
String
: The name of the file to open; can not contain path
separators.
FileNotFoundException
openFileOutput
public abstract FileOutputStream openFileOutput (String name, int mode)
Open a private file associated with this Context's application package for writing. Creates the file if it doesn't already exist.
No additional permissions are required for the calling app to read or write the returned file.
name
String
: The name of the file to open; can not contain path
separators.
mode
int
: Operating mode.
Value is either 0
or a combination of MODE_PRIVATE
, MODE_WORLD_READABLE
, MODE_WORLD_WRITEABLE
, and MODE_APPEND
FileNotFoundException
openOrCreateDatabase
public abstract SQLiteDatabase openOrCreateDatabase (String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)
Open a new private SQLiteDatabase associated with this Context's application package. Creates the database file if it doesn't exist.
Accepts input param: a concrete instance of DatabaseErrorHandler
to be used to handle corruption when sqlite reports database corruption.
name
String
: The name (unique in the application package) of the database.
mode
int
: Operating mode.
Value is either 0
or a combination of MODE_PRIVATE
, MODE_WORLD_READABLE
, MODE_WORLD_WRITEABLE
, MODE_ENABLE_WRITE_AHEAD_LOGGING
, and MODE_NO_LOCALIZED_COLLATORS
factory
SQLiteDatabase.CursorFactory
: An optional factory class that is called to instantiate a
cursor when query is called.
errorHandler
DatabaseErrorHandler
: the DatabaseErrorHandler
to be used when
sqlite reports database corruption. if null,
DefaultDatabaseErrorHandler
is
assumed.
This value may be null
.
SQLiteDatabase
The contents of a newly created database with the given name.
SQLiteException
if the database file
could not be opened.
openOrCreateDatabase
public abstract SQLiteDatabase openOrCreateDatabase (String name, int mode, SQLiteDatabase.CursorFactory factory)
Open a new private SQLiteDatabase associated with this Context's application package. Create the database file if it doesn't exist.
name
String
: The name (unique in the application package) of the database.
mode
int
: Operating mode.
Value is either 0
or a combination of MODE_PRIVATE
, MODE_WORLD_READABLE
, MODE_WORLD_WRITEABLE
, MODE_ENABLE_WRITE_AHEAD_LOGGING
, and MODE_NO_LOCALIZED_COLLATORS
factory
SQLiteDatabase.CursorFactory
: An optional factory class that is called to instantiate a
cursor when query is called.
SQLiteDatabase
The contents of a newly created database with the given name.
SQLiteException
if the database file
could not be opened.
peekWallpaper
public abstract Drawable peekWallpaper ()
This method was deprecated
in API level 15.
Use WallpaperManager.peek()
instead.
Drawable
registerComponentCallbacks
public void registerComponentCallbacks (ComponentCallbacks callback)
Add a new ComponentCallbacks
to the base application of the
Context, which will be called at the same times as the ComponentCallbacks
methods of activities and other components are called. Note that you
must be sure to use unregisterComponentCallbacks(ComponentCallbacks)
when
appropriate in the future; this will not be removed for you.
After Build.VERSION_CODES#S
, Registering the ComponentCallbacks to Context created
via createWindowContext(int, android.os.Bundle)
or
createWindowContext(android.view.Display, int, android.os.Bundle)
will receive
ComponentCallbacks#onConfigurationChanged(Configuration)
from Window Context rather
than its base application. It is helpful if you want to handle UI components that
associated with the Window Context when the Window Context has configuration changes.
callback
ComponentCallbacks
: The interface to call. This can be either a
ComponentCallbacks
or ComponentCallbacks2
interface.
See also:
registerReceiver
public abstract Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter)
Register a BroadcastReceiver to be run in the main activity thread. The receiver will be called with any broadcast Intent that matches filter, in the main application thread.
The system may broadcast Intents that are "sticky" -- these stay around after the broadcast has finished, to be sent to any later registrations. If your IntentFilter matches one of these sticky Intents, that Intent will be returned by this function and sent to your receiver as if it had just been broadcast.
There may be multiple sticky Intents that match filter, in which case each of these will be sent to receiver. In this case, only one of these can be returned directly by the function; which of these that is returned is arbitrarily decided by the system.
If you know the Intent your are registering for is sticky, you can supply null for your receiver. In this case, no receiver is registered -- the function simply returns the sticky Intent that matches filter. In the case of multiple matches, the same rules as described above apply.
See BroadcastReceiver
for more information on Intent broadcasts.
As of Build.VERSION_CODES.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(BroadcastReceiver, IntentFilter)
, since the lifetime of such a
registered BroadcastReceiver is tied to the object that registered it.
receiver
BroadcastReceiver
: The BroadcastReceiver to handle the broadcast.
This value may be null
.
filter
IntentFilter
: Selects the Intent broadcasts to be received.
Intent
The first sticky intent found that matches filter,
or null if there are none.
registerReceiver
public abstract Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, int flags)
Register to receive intent broadcasts, with the receiver optionally being
exposed to Instant Apps. See
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
for more
information. By default Instant Apps cannot interact with receivers in other
applications, this allows you to expose a receiver that Instant Apps can
interact with.
See BroadcastReceiver
for more information on Intent broadcasts.
As of Build.VERSION_CODES.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.
Parametersreceiver
BroadcastReceiver
: The BroadcastReceiver to handle the broadcast.
This value may be null
.
filter
IntentFilter
: Selects the Intent broadcasts to be received.
flags
int
: Additional options for the receiver. May be 0 or
RECEIVER_VISIBLE_TO_INSTANT_APPS
.
Value is either 0
or RECEIVER_VISIBLE_TO_INSTANT_APPS
Intent
The first sticky intent found that matches filter,
or null if there are none.
registerReceiver
public abstract Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)
Register to receive intent broadcasts, to run in the context of
scheduler. See
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter, int)
and
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter, java.lang.String, android.os.Handler)
for more information.
See BroadcastReceiver
for more information on Intent broadcasts.
As of Build.VERSION_CODES.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.
Parametersreceiver
BroadcastReceiver
: The BroadcastReceiver to handle the broadcast.
filter
IntentFilter
: Selects the Intent broadcasts to be received.
broadcastPermission
String
: String naming a permissions that a
broadcaster must hold in order to send an Intent to you. If null,
no permission is required.
This value may be null
.
scheduler
Handler
: Handler identifying the thread that will receive
the Intent. If null, the main thread of the process will be used.
This value may be null
.
flags
int
: Additional options for the receiver. May be 0 or
RECEIVER_VISIBLE_TO_INSTANT_APPS
.
Value is either 0
or RECEIVER_VISIBLE_TO_INSTANT_APPS
Intent
The first sticky intent found that matches filter,
or null if there are none.
registerReceiver
public abstract Intent registerReceiver (BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)
Register to receive intent broadcasts, to run in the context of
scheduler. See
registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
for more
information. This allows you to enforce permissions on who can
broadcast intents to your receiver, or have the receiver run in
a different thread than the main application thread.
See BroadcastReceiver
for more information on Intent broadcasts.
As of Build.VERSION_CODES.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.
Parametersreceiver
BroadcastReceiver
: The BroadcastReceiver to handle the broadcast.
filter
IntentFilter
: Selects the Intent broadcasts to be received.
broadcastPermission
String
: String naming a permissions that a
broadcaster must hold in order to send an Intent to you. If null,
no permission is required.
This value may be null
.
scheduler
Handler
: Handler identifying the thread that will receive
the Intent. If null, the main thread of the process will be used.
This value may be null
.
Intent
The first sticky intent found that matches filter,
or null if there are none.
removeStickyBroadcast
public abstract void removeStickyBroadcast (Intent intent)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Remove the data previously sent with sendStickyBroadcast(Intent)
,
so that it is as if the sticky broadcast had never happened.
Requires Manifest.permission.BROADCAST_STICKY
intent
Intent
: The Intent that was previously broadcast.
See also:
removeStickyBroadcastAsUser
public abstract void removeStickyBroadcastAsUser (Intent intent, UserHandle user)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Version of removeStickyBroadcast(android.content.Intent)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
You must hold the Manifest.permission.BROADCAST_STICKY
permission in order to use this API. If you do not hold that
permission, SecurityException
will be thrown.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and Manifest.permission.BROADCAST_STICKY
intent
Intent
: The Intent that was previously broadcast.
user
UserHandle
: UserHandle to remove the sticky broadcast from.
revokeUriPermission
public abstract void revokeUriPermission (Uri uri, int modeFlags)
Remove all permissions to access a particular content provider Uri
that were previously added with grantUriPermission(String, Uri, int)
or any other mechanism.
The given Uri will match all previously granted Uris that are the same or a
sub-path of the given Uri. That is, revoking "content://foo/target" will
revoke both "content://foo/target" and "content://foo/target/sub", but not
"content://foo". It will not remove any prefix grants that exist at a
higher level.
Prior to Build.VERSION_CODES.LOLLIPOP
, if you did not have
regular permission access to a Uri, but had received access to it through
a specific Uri permission grant, you could not revoke that grant with this
function and a SecurityException
would be thrown. As of
Build.VERSION_CODES.LOLLIPOP
, this function will not throw a security
exception, but will remove whatever permission grants to the Uri had been given to the app
(or none).
Unlike revokeUriPermission(java.lang.String, android.net.Uri, int)
, this method impacts all permission
grants matching the given Uri, for any package they had been granted to, through any
mechanism this had happened (such as indirectly through the clipboard, activity launch,
service start, etc). That means this can be potentially dangerous to use, as it can
revoke grants that another app could be strongly expecting to stick around.
Parametersuri
Uri
: The Uri you would like to revoke access to.
modeFlags
int
: The access modes to revoke.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
See also:
revokeUriPermission
public abstract void revokeUriPermission (String toPackage, Uri uri, int modeFlags)
Remove permissions to access a particular content provider Uri
that were previously added with grantUriPermission(String, Uri, int)
for a specific target
package. The given Uri will match all previously granted Uris that are the same or a
sub-path of the given Uri. That is, revoking "content://foo/target" will
revoke both "content://foo/target" and "content://foo/target/sub", but not
"content://foo". It will not remove any prefix grants that exist at a
higher level.
Unlike revokeUriPermission(android.net.Uri, int)
, this method will only
revoke permissions that had been explicitly granted through grantUriPermission(String, Uri, int)
and only for the package specified. Any matching grants that have happened through
other mechanisms (clipboard, activity launching, service starting, etc) will not be
removed.
ParameterstoPackage
String
: The package you had previously granted access to.
uri
Uri
: The Uri you would like to revoke access to.
modeFlags
int
: The access modes to revoke.
Value is either 0
or a combination of Intent.FLAG_GRANT_READ_URI_PERMISSION
, and Intent.FLAG_GRANT_WRITE_URI_PERMISSION
See also:
sendBroadcast
public abstract void sendBroadcast (Intent intent, String receiverPermission)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an optional required permission to be enforced. This
call is asynchronous; it returns immediately, and you will continue
executing while the receivers are run. No results are propagated from
receivers and receivers can not abort the broadcast. If you want
to allow receivers to propagate results or abort the broadcast, you must
send an ordered broadcast using
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
receiverPermission
String
: (optional) String naming a permission that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
sendBroadcast
public abstract void sendBroadcast (Intent intent)
Broadcast the given intent to all interested BroadcastReceivers. This
call is asynchronous; it returns immediately, and you will continue
executing while the receivers are run. No results are propagated from
receivers and receivers can not abort the broadcast. If you want
to allow receivers to propagate results or abort the broadcast, you must
send an ordered broadcast using
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
intent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
sendBroadcastAsUser
public abstract void sendBroadcastAsUser (Intent intent, UserHandle user)
Version of sendBroadcast(android.content.Intent)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
intent
Intent
: The intent to broadcast
user
UserHandle
: UserHandle to send the intent to.
See also:
sendBroadcastAsUser
public abstract void sendBroadcastAsUser (Intent intent, UserHandle user, String receiverPermission)
Version of sendBroadcast(android.content.Intent, java.lang.String)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
user
UserHandle
: UserHandle to send the intent to.
receiverPermission
String
: (optional) String naming a permission that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
See also:
sendBroadcastWithMultiplePermissions
public void sendBroadcastWithMultiplePermissions (Intent intent, String[] receiverPermissions)
Broadcast the given intent to all interested BroadcastReceivers, allowing
an array of required permissions to be enforced. This call is asynchronous; it returns
immediately, and you will continue executing while the receivers are run. No results are
propagated from receivers and receivers can not abort the broadcast. If you want to allow
receivers to propagate results or abort the broadcast, you must send an ordered broadcast
using sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
See BroadcastReceiver
for more information on Intent broadcasts.
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
This value cannot be null
.
receiverPermissions
String
: Array of names of permissions that a receiver must hold
in order to receive your broadcast.
If empty, no permissions are required.
This value cannot be null
.
sendOrderedBroadcast
public void sendOrderedBroadcast (Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the App Op to enforce restrictions on which receivers
the broadcast will be sent to.
See BroadcastReceiver
for more information on Intent broadcasts.
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
This value cannot be null
.
receiverPermission
String
: String naming a permissions that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
receiverAppOp
String
: The app op associated with the broadcast. If null, no appOp is
required. If both receiverAppOp and receiverPermission are non-null,
a receiver must have both of them to
receive the broadcast
This value may be null
.
resultReceiver
BroadcastReceiver
: Your own BroadcastReceiver to treat as the final
receiver of the broadcast.
This value may be null
.
scheduler
Handler
: A custom Handler with which to schedule the
resultReceiver callback; if null it will be
scheduled in the Context's main thread.
This value may be null
.
initialCode
int
: An initial value for the result code. Often
Activity.RESULT_OK.
initialData
String
: An initial value for the result data. Often
null.
This value may be null
.
initialExtras
Bundle
: An initial value for the result extras. Often
null.
This value may be null
.
sendOrderedBroadcast
public abstract void sendOrderedBroadcast (Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of sendBroadcast(android.content.Intent)
that allows you to
receive data back from the broadcast. This is accomplished by
supplying your own BroadcastReceiver when calling, which will be
treated as a final receiver at the end of the broadcast -- its
BroadcastReceiver#onReceive
method will be called with
the result values collected from the other receivers. The broadcast will
be serialized in the same way as calling
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is
asynchronous; it will return before
resultReceiver.onReceive() is called.
See BroadcastReceiver
for more information on Intent broadcasts.
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
This value cannot be null
.
receiverPermission
String
: String naming a permissions that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
resultReceiver
BroadcastReceiver
: Your own BroadcastReceiver to treat as the final
receiver of the broadcast.
This value may be null
.
scheduler
Handler
: A custom Handler with which to schedule the
resultReceiver callback; if null it will be
scheduled in the Context's main thread.
This value may be null
.
initialCode
int
: An initial value for the result code. Often
Activity.RESULT_OK.
initialData
String
: An initial value for the result data. Often
null.
This value may be null
.
initialExtras
Bundle
: An initial value for the result extras. Often
null.
This value may be null
.
sendOrderedBroadcast
public 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. This call is asynchronous; it returns immediately, and you will continue executing while the receivers are run.
See BroadcastReceiver
for more information on Intent broadcasts.
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
receiverPermission
String
: (optional) String naming a permissions that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
sendOrderedBroadcastAsUser
public abstract void sendOrderedBroadcastAsUser (Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
Version of
sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
user
UserHandle
: UserHandle to send the intent to.
receiverPermission
String
: String naming a permissions that
a receiver must hold in order to receive your broadcast.
If null, no permission is required.
This value may be null
.
resultReceiver
BroadcastReceiver
: Your own BroadcastReceiver to treat as the final
receiver of the broadcast.
scheduler
Handler
: A custom Handler with which to schedule the
resultReceiver callback; if null it will be
scheduled in the Context's main thread.
This value may be null
.
initialCode
int
: An initial value for the result code. Often
Activity.RESULT_OK.
initialData
String
: An initial value for the result data. Often
null.
This value may be null
.
initialExtras
Bundle
: An initial value for the result extras. Often
null.
This value may be null
.
sendStickyBroadcast
public abstract void sendStickyBroadcast (Intent intent)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Perform a sendBroadcast(android.content.Intent)
that is "sticky," meaning the
Intent you are sending stays around after the broadcast is complete,
so that others can quickly retrieve that data through the return
value of registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
. In
all other ways, this behaves the same as
sendBroadcast(android.content.Intent)
.
Requires Manifest.permission.BROADCAST_STICKY
intent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast, and the Intent will be held to
be re-broadcast to future receivers.
sendStickyBroadcast
public void sendStickyBroadcast (Intent intent, Bundle options)
This method was deprecated
in API level S.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Perform a sendBroadcast(android.content.Intent)
that is "sticky," meaning the
Intent you are sending stays around after the broadcast is complete,
so that others can quickly retrieve that data through the return
value of registerReceiver(android.content.BroadcastReceiver, android.content.IntentFilter)
. In
all other ways, this behaves the same as
sendBroadcast(android.content.Intent)
.
Requires Manifest.permission.BROADCAST_STICKY
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast, and the Intent will be held to
be re-broadcast to future receivers.
This value cannot be null
.
options
Bundle
: (optional) Additional sending options, generated from a
BroadcastOptions
.
This value may be null
.
sendStickyBroadcastAsUser
public abstract void sendStickyBroadcastAsUser (Intent intent, UserHandle user)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Version of sendStickyBroadcast(android.content.Intent)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and Manifest.permission.BROADCAST_STICKY
intent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast, and the Intent will be held to
be re-broadcast to future receivers.
user
UserHandle
: UserHandle to send the intent to.
See also:
sendStickyOrderedBroadcast
public abstract void sendStickyOrderedBroadcast (Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Version of sendStickyBroadcast(Intent)
that allows you to
receive data back from the broadcast. This is accomplished by
supplying your own BroadcastReceiver when calling, which will be
treated as a final receiver at the end of the broadcast -- its
BroadcastReceiver#onReceive
method will be called with
the result values collected from the other receivers. The broadcast will
be serialized in the same way as calling
sendOrderedBroadcast(android.content.Intent, java.lang.String)
.
Like sendBroadcast(android.content.Intent)
, this method is
asynchronous; it will return before
resultReceiver.onReceive() is called. Note that the sticky data
stored is only the data you initially supply to the broadcast, not
the result of any changes made by the receivers.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires Manifest.permission.BROADCAST_STICKY
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
resultReceiver
BroadcastReceiver
: Your own BroadcastReceiver to treat as the final
receiver of the broadcast.
scheduler
Handler
: A custom Handler with which to schedule the
resultReceiver callback; if null it will be
scheduled in the Context's main thread.
This value may be null
.
initialCode
int
: An initial value for the result code. Often
Activity.RESULT_OK.
initialData
String
: An initial value for the result data. Often
null.
This value may be null
.
initialExtras
Bundle
: An initial value for the result extras. Often
null.
This value may be null
.
sendStickyOrderedBroadcastAsUser
public abstract void sendStickyOrderedBroadcastAsUser (Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)
This method was deprecated
in API level 21.
Sticky broadcasts should not be used. They provide no security (anyone
can access them), no protection (anyone can modify them), and many other problems.
The recommended pattern is to use a non-sticky broadcast to report that something
has changed, with another mechanism for apps to retrieve the current value whenever
desired.
Version of
sendStickyOrderedBroadcast(android.content.Intent, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)
that allows you to specify the
user the broadcast will be sent to. This is not available to applications
that are not pre-installed on the system image.
See BroadcastReceiver
for more information on Intent broadcasts.
Requires android.Manifest.permission.INTERACT_ACROSS_USERS and Manifest.permission.BROADCAST_STICKY
Parametersintent
Intent
: The Intent to broadcast; all receivers matching this
Intent will receive the broadcast.
user
UserHandle
: UserHandle to send the intent to.
resultReceiver
BroadcastReceiver
: Your own BroadcastReceiver to treat as the final
receiver of the broadcast.
scheduler
Handler
: A custom Handler with which to schedule the
resultReceiver callback; if null it will be
scheduled in the Context's main thread.
This value may be null
.
initialCode
int
: An initial value for the result code. Often
Activity.RESULT_OK.
initialData
String
: An initial value for the result data. Often
null.
This value may be null
.
initialExtras
Bundle
: An initial value for the result extras. Often
null.
This value may be null
.
setTheme
public abstract void setTheme (int resid)
Set the base theme for this context. Note that this should be called
before any views are instantiated in the Context (for example before
calling Activity.setContentView(View)
or
LayoutInflater.inflate(int, ViewGroup)
).
resid
int
: The style resource describing the theme.
setWallpaper
public abstract void setWallpaper (Bitmap bitmap)
This method was deprecated
in API level 15.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
bitmap
Bitmap
IOException
setWallpaper
public abstract void setWallpaper (InputStream data)
This method was deprecated
in API level 15.
Use WallpaperManager.set()
instead.
This method requires the caller to hold the permission
Manifest.permission.SET_WALLPAPER
.
data
InputStream
IOException
startActivities
public abstract void startActivities (Intent[] intents, Bundle options)
Launch multiple new activities. This is generally the same as calling
startActivity(android.content.Intent)
for the first Intent in the array,
that activity during its creation calling startActivity(android.content.Intent)
for the second entry, etc. Note that unlike that approach, generally
none of the activities except the last in the array will be created
at this point, but rather will be created when the user first visits
them (due to pressing back from the activity on top).
This method throws ActivityNotFoundException
if there was no Activity found for any given Intent. In this
case the state of the activity stack is undefined (some Intents in the
list may be on it, some not), so you probably want to avoid such situations.
intents
Intent
: An array of Intents to be started.
options
Bundle
: Additional options for how the Activity should be started.
See startActivity(Intent, Bundle)
Context.startActivity(Intent, Bundle)} for more details.
startActivity
public abstract void startActivity (Intent intent, Bundle options)
Launch a new activity. You will not receive any information about when the activity exits.
Note that if this method is being called from outside of an
Activity
Context, then the Intent must include
the Intent#FLAG_ACTIVITY_NEW_TASK
launch flag. This is because,
without being started from an existing Activity, there is no existing
task in which to place the new activity and thus it needs to be placed
in its own separate task.
This method throws ActivityNotFoundException
if there was no Activity found to run the given Intent.
Parametersintent
Intent
: The description of the activity to start.
options
Bundle
: Additional options for how the Activity should be started.
May be null if there are no options. See ActivityOptions
for how to build the Bundle supplied here; there are no supported definitions
for building it manually.
This value may be null
.
startForegroundService
public abstract ComponentName startForegroundService (Intent service)
Similar to startService(android.content.Intent)
, but with an implicit promise that the
Service will call startForeground(int, android.app.Notification)
once it begins running. The service is given
an amount of time comparable to the ANR interval to do this, otherwise the system
will automatically stop the service and declare the app ANR.
Unlike the ordinary startService(android.content.Intent)
, this method can be used
at any time, regardless of whether the app hosting the service is in a foreground
state.
service
Intent
: Identifies the service to be started. The Intent must be
fully explicit (supplying a component name). Additional values
may be included in the Intent extras to supply arguments along with
this specific start call.
ComponentName
If the service is being started or is already running, the
ComponentName
of the actual service that was started is
returned; else if the service does not exist null is returned.
SecurityException
If the caller does not have permission to access the service
or the service can not be found.
ForegroundServiceStartNotAllowedException
If the caller app's targeting API is
Build.VERSION_CODES.S
or later, and the foreground service is restricted
from start due to background restriction.
startInstrumentation
public abstract boolean startInstrumentation (ComponentName className, String profileFile, Bundle arguments)
Start executing an Instrumentation
class. The given
Instrumentation component will be run by killing its target application
(if currently running), starting the target process, instantiating the
instrumentation component, and then letting it drive the application.
This function is not synchronous -- it returns as soon as the instrumentation has started and while it is running.
Instrumentation is normally only allowed to run against a package that is either unsigned or signed with a signature that the the instrumentation package is also signed with (ensuring the target trusts the instrumentation).
ParametersclassName
ComponentName
: Name of the Instrumentation component to be run.
This value cannot be null
.
profileFile
String
: Optional path to write profiling data as the
instrumentation runs, or null for no profiling.
This value may be null
.
arguments
Bundle
: Additional optional arguments to pass to the
instrumentation, or null.
This value may be null
.
boolean
true
if the instrumentation was successfully started,
else false
if it could not be found.
startIntentSender
public abstract void startIntentSender (IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
Same as startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle)
with no options specified.
intent
IntentSender
: The IntentSender to launch.
fillInIntent
Intent
: If non-null, this will be provided as the
intent parameter to IntentSender#sendIntent
.
This value may be null
.
flagsMask
int
: Intent flags in the original IntentSender that you
would like to change.
Value is either 0
or a combination of Intent.FLAG_FROM_BACKGROUND
, Intent.FLAG_DEBUG_LOG_RESOLUTION
, Intent.FLAG_EXCLUDE_STOPPED_PACKAGES
, Intent.FLAG_INCLUDE_STOPPED_PACKAGES
, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, Intent.FLAG_ACTIVITY_MATCH_EXTERNAL
, Intent.FLAG_ACTIVITY_NO_HISTORY
, Intent.FLAG_ACTIVITY_SINGLE_TOP
, Intent.FLAG_ACTIVITY_NEW_TASK
, Intent.FLAG_ACTIVITY_MULTIPLE_TASK
, Intent.FLAG_ACTIVITY_CLEAR_TOP
, Intent.FLAG_ACTIVITY_FORWARD_RESULT
, Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP
, Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
, Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT
, Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
, Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NEW_DOCUMENT
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NO_USER_ACTION
, Intent.FLAG_ACTIVITY_REORDER_TO_FRONT
, Intent.FLAG_ACTIVITY_NO_ANIMATION
, Intent.FLAG_ACTIVITY_CLEAR_TASK
, Intent.FLAG_ACTIVITY_TASK_ON_HOME
, Intent.FLAG_ACTIVITY_RETAIN_IN_RECENTS
, Intent.FLAG_ACTIVITY_LAUNCH_ADJACENT
, Intent.FLAG_RECEIVER_REGISTERED_ONLY
, Intent.FLAG_RECEIVER_REPLACE_PENDING
, Intent.FLAG_RECEIVER_FOREGROUND
, Intent.FLAG_RECEIVER_NO_ABORT
, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, Intent.FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS
, and android.content.Intent.FLAG_RECEIVER_OFFLOAD
flagsValues
int
: Desired values for any bits set in
flagsMask
Value is either 0
or a combination of Intent.FLAG_FROM_BACKGROUND
, Intent.FLAG_DEBUG_LOG_RESOLUTION
, Intent.FLAG_EXCLUDE_STOPPED_PACKAGES
, Intent.FLAG_INCLUDE_STOPPED_PACKAGES
, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, Intent.FLAG_ACTIVITY_MATCH_EXTERNAL
, Intent.FLAG_ACTIVITY_NO_HISTORY
, Intent.FLAG_ACTIVITY_SINGLE_TOP
, Intent.FLAG_ACTIVITY_NEW_TASK
, Intent.FLAG_ACTIVITY_MULTIPLE_TASK
, Intent.FLAG_ACTIVITY_CLEAR_TOP
, Intent.FLAG_ACTIVITY_FORWARD_RESULT
, Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP
, Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
, Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT
, Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
, Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NEW_DOCUMENT
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NO_USER_ACTION
, Intent.FLAG_ACTIVITY_REORDER_TO_FRONT
, Intent.FLAG_ACTIVITY_NO_ANIMATION
, Intent.FLAG_ACTIVITY_CLEAR_TASK
, Intent.FLAG_ACTIVITY_TASK_ON_HOME
, Intent.FLAG_ACTIVITY_RETAIN_IN_RECENTS
, Intent.FLAG_ACTIVITY_LAUNCH_ADJACENT
, Intent.FLAG_RECEIVER_REGISTERED_ONLY
, Intent.FLAG_RECEIVER_REPLACE_PENDING
, Intent.FLAG_RECEIVER_FOREGROUND
, Intent.FLAG_RECEIVER_NO_ABORT
, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, Intent.FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS
, and android.content.Intent.FLAG_RECEIVER_OFFLOAD
extraFlags
int
: Always set to 0.
startIntentSender
public abstract void startIntentSender (IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
Like startActivity(android.content.Intent, android.os.Bundle)
, but taking a IntentSender
to start. If the IntentSender is for an activity, that activity will be started
as if you had called the regular startActivity(android.content.Intent)
here; otherwise, its associated action will be executed (such as
sending a broadcast) as if you had called
IntentSender.sendIntent
on it.
Parametersintent
IntentSender
: The IntentSender to launch.
fillInIntent
Intent
: If non-null, this will be provided as the
intent parameter to IntentSender#sendIntent
.
This value may be null
.
flagsMask
int
: Intent flags in the original IntentSender that you
would like to change.
Value is either 0
or a combination of Intent.FLAG_FROM_BACKGROUND
, Intent.FLAG_DEBUG_LOG_RESOLUTION
, Intent.FLAG_EXCLUDE_STOPPED_PACKAGES
, Intent.FLAG_INCLUDE_STOPPED_PACKAGES
, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, Intent.FLAG_ACTIVITY_MATCH_EXTERNAL
, Intent.FLAG_ACTIVITY_NO_HISTORY
, Intent.FLAG_ACTIVITY_SINGLE_TOP
, Intent.FLAG_ACTIVITY_NEW_TASK
, Intent.FLAG_ACTIVITY_MULTIPLE_TASK
, Intent.FLAG_ACTIVITY_CLEAR_TOP
, Intent.FLAG_ACTIVITY_FORWARD_RESULT
, Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP
, Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
, Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT
, Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
, Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NEW_DOCUMENT
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NO_USER_ACTION
, Intent.FLAG_ACTIVITY_REORDER_TO_FRONT
, Intent.FLAG_ACTIVITY_NO_ANIMATION
, Intent.FLAG_ACTIVITY_CLEAR_TASK
, Intent.FLAG_ACTIVITY_TASK_ON_HOME
, Intent.FLAG_ACTIVITY_RETAIN_IN_RECENTS
, Intent.FLAG_ACTIVITY_LAUNCH_ADJACENT
, Intent.FLAG_RECEIVER_REGISTERED_ONLY
, Intent.FLAG_RECEIVER_REPLACE_PENDING
, Intent.FLAG_RECEIVER_FOREGROUND
, Intent.FLAG_RECEIVER_NO_ABORT
, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, Intent.FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS
, and android.content.Intent.FLAG_RECEIVER_OFFLOAD
flagsValues
int
: Desired values for any bits set in
flagsMask
Value is either 0
or a combination of Intent.FLAG_FROM_BACKGROUND
, Intent.FLAG_DEBUG_LOG_RESOLUTION
, Intent.FLAG_EXCLUDE_STOPPED_PACKAGES
, Intent.FLAG_INCLUDE_STOPPED_PACKAGES
, android.content.Intent.FLAG_DEBUG_TRIAGED_MISSING, android.content.Intent.FLAG_IGNORE_EPHEMERAL, Intent.FLAG_ACTIVITY_MATCH_EXTERNAL
, Intent.FLAG_ACTIVITY_NO_HISTORY
, Intent.FLAG_ACTIVITY_SINGLE_TOP
, Intent.FLAG_ACTIVITY_NEW_TASK
, Intent.FLAG_ACTIVITY_MULTIPLE_TASK
, Intent.FLAG_ACTIVITY_CLEAR_TOP
, Intent.FLAG_ACTIVITY_FORWARD_RESULT
, Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP
, Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
, Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT
, Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
, Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NEW_DOCUMENT
, Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
, Intent.FLAG_ACTIVITY_NO_USER_ACTION
, Intent.FLAG_ACTIVITY_REORDER_TO_FRONT
, Intent.FLAG_ACTIVITY_NO_ANIMATION
, Intent.FLAG_ACTIVITY_CLEAR_TASK
, Intent.FLAG_ACTIVITY_TASK_ON_HOME
, Intent.FLAG_ACTIVITY_RETAIN_IN_RECENTS
, Intent.FLAG_ACTIVITY_LAUNCH_ADJACENT
, Intent.FLAG_RECEIVER_REGISTERED_ONLY
, Intent.FLAG_RECEIVER_REPLACE_PENDING
, Intent.FLAG_RECEIVER_FOREGROUND
, Intent.FLAG_RECEIVER_NO_ABORT
, android.content.Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT, android.content.Intent.FLAG_RECEIVER_BOOT_UPGRADE, android.content.Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_EXCLUDE_BACKGROUND, android.content.Intent.FLAG_RECEIVER_FROM_SHELL, Intent.FLAG_RECEIVER_VISIBLE_TO_INSTANT_APPS
, and android.content.Intent.FLAG_RECEIVER_OFFLOAD
extraFlags
int
: Always set to 0.
options
Bundle
: Additional options for how the Activity should be started.
See startActivity(Intent, Bundle)
Context.startActivity(Intent, Bundle)} for more details. If options
have also been supplied by the IntentSender, options given here will
override any that conflict with those given by the IntentSender.
This value may be null
.
startService
public abstract ComponentName startService (Intent service)
Request that a given application service be started. The Intent should either contain the complete class name of a specific service implementation to start, or a specific package name to target. If the Intent is less specified, it logs a warning about this. In this case any of the multiple matching services may be used. If this service is not already running, it will be instantiated and started (creating a process for it if needed); if it is running then it remains running.
Every call to this method will result in a corresponding call to
the target service's Service.onStartCommand(Intent, int, int)
method,
with the intent given here. This provides a convenient way
to submit jobs to a service without having to bind and call on to its
interface.
Using startService() overrides the default service lifetime that is
managed by bindService(Intent, ServiceConnection, int)
: it requires the service to remain
running until stopService(Intent)
is called, regardless of whether
any clients are connected to it. Note that calls to startService()
do not nest: no matter how many times you call startService(),
a single call to stopService(Intent)
will stop it.
The system attempts to keep running services around as much as possible. The only time they should be stopped is if the current foreground application is using so many resources that the service needs to be killed. If any errors happen in the service's process, it will automatically be restarted.
This function will throw SecurityException
if you do not
have permission to start the given service.
Note: Each call to startService()
results in significant work done by the system to manage service
lifecycle surrounding the processing of the intent, which can take
multiple milliseconds of CPU time. Due to this cost, startService()
should not be used for frequent intent delivery to a service, and only
for scheduling significant work. Use bound services
for high frequency calls.
service
Intent
: Identifies the service to be started. The Intent must be
fully explicit (supplying a component name). Additional values
may be included in the Intent extras to supply arguments along with
this specific start call.
ComponentName
If the service is being started or is already running, the
ComponentName
of the actual service that was started is
returned; else if the service does not exist null is returned.
SecurityException
If the caller does not have permission to access the service
or the service can not be found.
IllegalStateException
Before Android Build.VERSION_CODES.S
,
if the application is in a state where the service
can not be started (such as not in the foreground in a state when services are allowed),
IllegalStateException
was thrown.
BackgroundServiceStartNotAllowedException
On Android Build.VERSION_CODES.S
and later,
if the application is in a state where the service
can not be started (such as not in the foreground in a state when services are allowed),
BackgroundServiceStartNotAllowedException
is thrown
This excemption extends IllegalStateException
, so apps can
use catch (IllegalStateException)
to catch both.
stopService
public abstract boolean stopService (Intent service)
Request that a given application service be stopped. If the service is not running, nothing happens. Otherwise it is stopped. Note that calls to startService() are not counted -- this stops the service no matter how many times it was started.
Note that if a stopped service still has ServiceConnection
objects bound to it with the BIND_AUTO_CREATE
set, it will
not be destroyed until all of these bindings are removed. See
the Service
documentation for more details on a
service's lifecycle.
This function will throw SecurityException
if you do not
have permission to stop the given service.
service
Intent
: Description of the service to be stopped. The Intent must be either
fully explicit (supplying a component name) or specify a specific package
name it is targeted to.
boolean
If there is a service matching the given Intent that is already
running, then it is stopped and true
is returned; else false
is returned.
SecurityException
If the caller does not have permission to access the service
or the service can not be found.
IllegalStateException
If the application is in a state where the service
can not be started (such as not in the foreground in a state when services are allowed).
See also:
unbindService
public abstract void unbindService (ServiceConnection conn)
Disconnect from an application service. You will no longer receive calls as the service is restarted, and the service is now allowed to stop at any time.
Parametersconn
ServiceConnection
: The connection interface previously supplied to
bindService(). This parameter must not be null.
This value cannot be null
.
unregisterComponentCallbacks
public void unregisterComponentCallbacks (ComponentCallbacks callback)
Remove a ComponentCallbacks
object that was previously registered
with registerComponentCallbacks(android.content.ComponentCallbacks)
.
callback
ComponentCallbacks
unregisterReceiver
public abstract void unregisterReceiver (BroadcastReceiver receiver)
Unregister a previously registered BroadcastReceiver. All filters that have been registered for this BroadcastReceiver will be removed.
receiver
BroadcastReceiver
: The BroadcastReceiver to unregister.
updateServiceGroup
public void updateServiceGroup (ServiceConnection conn, int group, int importance)
For a service previously bound with bindService(Intent, ServiceConnection, int)
or a related method, change
how the system manages that service's process in relation to other processes. This
doesn't modify the original bind flags that were passed in when binding, but adjusts
how the process will be managed in some cases based on those flags. Currently only
works on isolated processes (will be ignored for non-isolated processes).
Note that this call does not take immediate effect, but will be applied the next
time the impacted process is adjusted for some other reason. Typically you would
call this before then calling a new bindIsolatedService(Intent, int, String, Executor, ServiceConnection)
on the service
of interest, with that binding causing the process to be shuffled accordingly.
conn
ServiceConnection
: The connection interface previously supplied to bindService(). This
parameter must not be null.
This value cannot be null
.
group
int
: A group to put this connection's process in. Upon calling here, this
will override any previous group that was set for that process. The group
tells the system about processes that are logically grouped together, so
should be managed as one unit of importance (such as when being considered
a recently used app). All processes in the same app with the same group
are considered to be related. Supplying 0 reverts to the default behavior
of not grouping.
importance
int
: Additional importance of the processes within a group. Upon calling
here, this will override any previous importance that was set for that
process. The most important process is 0, and higher values are
successively less important. You can view this as describing how
to order the processes in an array, with the processes at the end of
the array being the least important. This value has no meaning besides
indicating how processes should be ordered in that array one after the
other. This provides a way to fine-tune the system's process killing,
guiding it to kill processes at the end of the array first.
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-04-21 UTC.
-
Follow @AndroidDev on Twitter
-
Check out Android Developers on YouTube
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK