Added in API level 4

Summary: Nested Classes | Constants | Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods

AccessibilityService

---

Kotlin |Java

public abstract class AccessibilityService
extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.accessibilityservice.AccessibilityService

---

Accessibility services should only be used to assist users with disabilities in using Android devices and apps. They run in the background and receive callbacks by the system when AccessibilityEvents are fired. Such events denote some state transition in the user interface, for example, the focus has changed, a button has been clicked, etc. Such a service can optionally request the capability for querying the content of the active window. Development of an accessibility service requires extending this class and implementing its abstract methods.

Developer Guides

For more information about creating AccessibilityServices, read the Accessibility developer guide.

Lifecycle

The lifecycle of an accessibility service is managed exclusively by the system and follows the established service life cycle. Starting an accessibility service is triggered exclusively by the user explicitly turning the service on in device settings. After the system binds to a service, it calls AccessibilityService#onServiceConnected(). This method can be overridden by clients that want to perform post binding setup.

An accessibility service stops either when the user turns it off in device settings or when it calls AccessibilityService#disableSelf().

Declaration

An accessibility is declared as any other service in an AndroidManifest.xml, but it must do two things:

• Specify that it handles the "android.accessibilityservice.AccessibilityService" Intent.
• Request the Manifest.permission.BIND_ACCESSIBILITY_SERVICE permission to ensure that only the system can bind to it.

If either of these items is missing, the system will ignore the accessibility service. Following is an example declaration:

 <service android:name=".MyAccessibilityService"
         android:permission="android.permission.BIND_ACCESSIBILITY_SERVICE">
     <intent-filter>
         <action android:name="android.accessibilityservice.AccessibilityService" />
     </intent-filter>
     . . .
 </service>

Configuration

An accessibility service can be configured to receive specific types of accessibility events, listen only to specific packages, get events from each type only once in a given time frame, retrieve window content, specify a settings activity, etc.

There are two approaches for configuring an accessibility service:

• Providing a meta-data entry in the manifest when declaring the service. A service declaration with a meta-data tag is presented below:

   <service android:name=".MyAccessibilityService">
       <intent-filter>
           <action android:name="android.accessibilityservice.AccessibilityService" />
       </intent-filter>
       <meta-data android:name="android.accessibilityservice" android:resource="@xml/accessibilityservice" />
   </service>

  Note: This approach enables setting all properties.

  For more details refer to SERVICE_META_DATA and <accessibility-service>.

• Calling AccessibilityService#setServiceInfo(AccessibilityServiceInfo). Note that this method can be called any time to dynamically change the service configuration.

  Note: This approach enables setting only dynamically configurable properties: AccessibilityServiceInfo#eventTypes, AccessibilityServiceInfo#feedbackType, AccessibilityServiceInfo#flags, AccessibilityServiceInfo#notificationTimeout, AccessibilityServiceInfo#packageNames

  For more details refer to AccessibilityServiceInfo.

Retrieving window content

A service can specify in its declaration that it can retrieve window content which is represented as a tree of AccessibilityWindowInfo and AccessibilityNodeInfo objects. Note that declaring this capability requires that the service declares its configuration via an XML resource referenced by SERVICE_META_DATA.

Window content may be retrieved with AccessibilityEvent.getSource(), AccessibilityService#findFocus(int), AccessibilityService#getWindows(), or AccessibilityService#getRootInActiveWindow().

Note An accessibility service may have requested to be notified for a subset of the event types, and thus be unaware when the node hierarchy has changed. It is also possible for a node to contain outdated information because the window content may change at any time.

Drawing Accessibility Overlays

Accessibility services can draw overlays on top of existing screen contents. Accessibility overlays can be used to visually highlight items on the screen e.g. indicate the current item with accessibility focus. Overlays can also offer the user a way to interact with the service directly and quickly customize the service's behavior.

Accessibility overlays can be attached to a particular window or to the display itself. Attaching an overlay to a window allows the overly to move, grow and shrink as the window does. The overlay will maintain the same relative position within the window bounds as the window moves. The overlay will also maintain the same relative position within the window bounds if the window is resized. To attach an overlay to a window, use attachAccessibilityOverlayToWindow(int, SurfaceControl). Attaching an overlay to the display means that the overlay is independent of the active windows on that display. To attach an overlay to a display, use attachAccessibilityOverlayToDisplay(int, SurfaceControl).

When positioning an overlay that is attached to a window, the service must use window coordinates. In order to position an overlay on top of an existing UI element it is necessary to know the bounds of that element in window coordinates. To find the bounds in window coordinates of an element, find the corresponding AccessibilityNodeInfo as discussed above and call AccessibilityNodeInfo#getBoundsInWindow.

Notification strategy

All accessibility services are notified of all events they have requested, regardless of their feedback type.

Note: The event notification timeout is useful to avoid propagating events to the client too frequently since this is accomplished via an expensive interprocess call. One can think of the timeout as a criteria to determine when event generation has settled down.

Event types

• AccessibilityEvent#TYPE_VIEW_CLICKED
• AccessibilityEvent#TYPE_VIEW_LONG_CLICKED
• AccessibilityEvent#TYPE_VIEW_FOCUSED
• AccessibilityEvent#TYPE_VIEW_SELECTED
• AccessibilityEvent#TYPE_VIEW_TEXT_CHANGED
• AccessibilityEvent#TYPE_WINDOW_STATE_CHANGED
• AccessibilityEvent#TYPE_NOTIFICATION_STATE_CHANGED
• AccessibilityEvent#TYPE_TOUCH_EXPLORATION_GESTURE_START
• AccessibilityEvent#TYPE_TOUCH_EXPLORATION_GESTURE_END
• AccessibilityEvent#TYPE_VIEW_HOVER_ENTER
• AccessibilityEvent#TYPE_VIEW_HOVER_EXIT
• AccessibilityEvent#TYPE_VIEW_SCROLLED
• AccessibilityEvent#TYPE_VIEW_TEXT_SELECTION_CHANGED
• AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED
• AccessibilityEvent#TYPE_ANNOUNCEMENT
• AccessibilityEvent#TYPE_GESTURE_DETECTION_START
• AccessibilityEvent#TYPE_GESTURE_DETECTION_END
• AccessibilityEvent#TYPE_TOUCH_INTERACTION_START
• AccessibilityEvent#TYPE_TOUCH_INTERACTION_END
• AccessibilityEvent#TYPE_VIEW_ACCESSIBILITY_FOCUSED
• AccessibilityEvent#TYPE_WINDOWS_CHANGED
• AccessibilityEvent#TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED

Feedback types

• AccessibilityServiceInfo#FEEDBACK_AUDIBLE
• AccessibilityServiceInfo#FEEDBACK_HAPTIC
• AccessibilityServiceInfo#FEEDBACK_SPOKEN
• AccessibilityServiceInfo#FEEDBACK_VISUAL
• AccessibilityServiceInfo#FEEDBACK_GENERIC
• AccessibilityServiceInfo#FEEDBACK_BRAILLE

See also:

• AccessibilityEvent
• AccessibilityServiceInfo
• AccessibilityManager

Summary

Nested classes
class	AccessibilityService.GestureResultCallback Class used to report status of dispatched gestures
class	AccessibilityService.MagnificationController Used to control and query the state of display magnification.
class	AccessibilityService.ScreenshotResult Can be used to construct a bitmap of the screenshot or any other operations for AccessibilityService#takeScreenshot API.
class	AccessibilityService.SoftKeyboardController Used to control, query, and listen for changes to the soft keyboard show mode.
interface	AccessibilityService.TakeScreenshotCallback Interface used to report status of taking screenshot.

Constants
int	ERROR_TAKE_SCREENSHOT_INTERNAL_ERROR The status of taking screenshot is failure and the reason is internal error.
int	ERROR_TAKE_SCREENSHOT_INTERVAL_TIME_SHORT The status of taking screenshot is failure and the reason is that too little time has elapsed since the last screenshot.
int	ERROR_TAKE_SCREENSHOT_INVALID_DISPLAY The status of taking screenshot is failure and the reason is invalid display Id.
int	ERROR_TAKE_SCREENSHOT_INVALID_WINDOW The status of taking screenshot is failure and the reason is invalid accessibility window Id.
int	ERROR_TAKE_SCREENSHOT_NO_ACCESSIBILITY_ACCESS The status of taking screenshot is failure and the reason is no accessibility access.
int	ERROR_TAKE_SCREENSHOT_SECURE_WINDOW The status of taking screenshot is failure and the reason is the window contains secure content.
int	GESTURE_2_FINGER_DOUBLE_TAP The user has performed a two-finger double tap gesture on the touch screen.
int	GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD The user has performed a two-finger double tap and hold gesture on the touch screen.
int	GESTURE_2_FINGER_SINGLE_TAP The user has performed a two-finger single tap gesture on the touch screen.
int	GESTURE_2_FINGER_SWIPE_DOWN The user has performed a two-finger swipe down gesture on the touch screen.
int	GESTURE_2_FINGER_SWIPE_LEFT The user has performed a two-finger swipe left gesture on the touch screen.
int	GESTURE_2_FINGER_SWIPE_RIGHT The user has performed a two-finger swipe right gesture on the touch screen.
int	GESTURE_2_FINGER_SWIPE_UP The user has performed a two-finger swipe up gesture on the touch screen.
int	GESTURE_2_FINGER_TRIPLE_TAP The user has performed a two-finger triple tap gesture on the touch screen.
int	GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD The user has performed a two-finger triple-tap and hold gesture on the touch screen.
int	GESTURE_3_FINGER_DOUBLE_TAP The user has performed a three-finger double tap gesture on the touch screen.
int	GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD The user has performed a three-finger double tap and hold gesture on the touch screen.
int	GESTURE_3_FINGER_SINGLE_TAP The user has performed a three-finger single tap gesture on the touch screen.
int	GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD The user has performed a three-finger single-tap and hold gesture on the touch screen.
int	GESTURE_3_FINGER_SWIPE_DOWN The user has performed a three-finger swipe down gesture on the touch screen.
int	GESTURE_3_FINGER_SWIPE_LEFT The user has performed a three-finger swipe left gesture on the touch screen.
int	GESTURE_3_FINGER_SWIPE_RIGHT The user has performed a three-finger swipe right gesture on the touch screen.
int	GESTURE_3_FINGER_SWIPE_UP The user has performed a three-finger swipe up gesture on the touch screen.
int	GESTURE_3_FINGER_TRIPLE_TAP The user has performed a three-finger triple tap gesture on the touch screen.
int	GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD The user has performed a three-finger triple-tap and hold gesture on the touch screen.
int	GESTURE_4_FINGER_DOUBLE_TAP The user has performed a four-finger double tap gesture on the touch screen.
int	GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD The user has performed a two-finger double tap and hold gesture on the touch screen.
int	GESTURE_4_FINGER_SINGLE_TAP The user has performed a four-finger single tap gesture on the touch screen.
int	GESTURE_4_FINGER_SWIPE_DOWN The user has performed a four-finger swipe down gesture on the touch screen.
int	GESTURE_4_FINGER_SWIPE_LEFT The user has performed a four-finger swipe left gesture on the touch screen.
int	GESTURE_4_FINGER_SWIPE_RIGHT The user has performed a four-finger swipe right gesture on the touch screen.
int	GESTURE_4_FINGER_SWIPE_UP The user has performed a four-finger swipe up gesture on the touch screen.
int	GESTURE_4_FINGER_TRIPLE_TAP The user has performed a four-finger triple tap gesture on the touch screen.
int	GESTURE_DOUBLE_TAP The user has performed a double tap gesture on the touch screen.
int	GESTURE_DOUBLE_TAP_AND_HOLD The user has performed a double tap and hold gesture on the touch screen.
int	GESTURE_SWIPE_DOWN The user has performed a swipe down gesture on the touch screen.
int	GESTURE_SWIPE_DOWN_AND_LEFT The user has performed a down and left gesture on the touch screen.
int	GESTURE_SWIPE_DOWN_AND_RIGHT The user has performed a down and right gesture on the touch screen.
int	GESTURE_SWIPE_DOWN_AND_UP The user has performed a swipe down and up gesture on the touch screen.
int	GESTURE_SWIPE_LEFT The user has performed a swipe left gesture on the touch screen.
int	GESTURE_SWIPE_LEFT_AND_DOWN The user has performed a left and down gesture on the touch screen.
int	GESTURE_SWIPE_LEFT_AND_RIGHT The user has performed a swipe left and right gesture on the touch screen.
int	GESTURE_SWIPE_LEFT_AND_UP The user has performed a left and up gesture on the touch screen.
int	GESTURE_SWIPE_RIGHT The user has performed a swipe right gesture on the touch screen.
int	GESTURE_SWIPE_RIGHT_AND_DOWN The user has performed a right and down gesture on the touch screen.
int	GESTURE_SWIPE_RIGHT_AND_LEFT The user has performed a swipe right and left gesture on the touch screen.
int	GESTURE_SWIPE_RIGHT_AND_UP The user has performed a right and up gesture on the touch screen.
int	GESTURE_SWIPE_UP The user has performed a swipe up gesture on the touch screen.
int	GESTURE_SWIPE_UP_AND_DOWN The user has performed a swipe up and down gesture on the touch screen.
int	GESTURE_SWIPE_UP_AND_LEFT The user has performed an up and left gesture on the touch screen.
int	GESTURE_SWIPE_UP_AND_RIGHT The user has performed an up and right gesture on the touch screen.
int	GESTURE_UNKNOWN The user has performed an unrecognized gesture on the touch screen.
int	GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS Action to show Launcher's all apps.
int	GLOBAL_ACTION_ACCESSIBILITY_BUTTON Action to trigger the Accessibility Button
int	GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER Action to bring up the Accessibility Button's chooser menu
int	GLOBAL_ACTION_ACCESSIBILITY_SHORTCUT Action to trigger the Accessibility Shortcut.
int	GLOBAL_ACTION_BACK Action to go back.
int	GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE Action to dismiss the notification shade
int	GLOBAL_ACTION_DPAD_CENTER Action to trigger dpad center keyevent.
int	GLOBAL_ACTION_DPAD_DOWN Action to trigger dpad down keyevent.
int	GLOBAL_ACTION_DPAD_LEFT Action to trigger dpad left keyevent.
int	GLOBAL_ACTION_DPAD_RIGHT Action to trigger dpad right keyevent.
int	GLOBAL_ACTION_DPAD_UP Action to trigger dpad up keyevent.
int	GLOBAL_ACTION_HOME Action to go home.
int	GLOBAL_ACTION_KEYCODE_HEADSETHOOK Action to send the KEYCODE_HEADSETHOOK KeyEvent, which is used to answer and hang up calls and play and stop media.
int	GLOBAL_ACTION_LOCK_SCREEN Action to lock the screen
int	GLOBAL_ACTION_NOTIFICATIONS Action to open the notifications.
int	GLOBAL_ACTION_POWER_DIALOG Action to open the power long-press dialog.
int	GLOBAL_ACTION_QUICK_SETTINGS Action to open the quick settings.
int	GLOBAL_ACTION_RECENTS Action to toggle showing the overview of recent apps.
int	GLOBAL_ACTION_TAKE_SCREENSHOT Action to take a screenshot
int	GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN Action to toggle docking the current app's window.
String	SERVICE_INTERFACE The Intent that must be declared as handled by the service.
String	SERVICE_META_DATA Name under which an AccessibilityService component publishes information about itself.
int	SHOW_MODE_AUTO Allow the system to control when the soft keyboard is shown.
int	SHOW_MODE_HIDDEN Never show the soft keyboard.
int	SHOW_MODE_IGNORE_HARD_KEYBOARD Allow the soft keyboard to be shown, even if a hard keyboard is connected

Inherited constants
From class android.app.Service int START_CONTINUATION_MASK Bits returned by onStartCommand(Intent, int, int) describing how to continue the service if it is killed. int START_FLAG_REDELIVERY This flag is set in onStartCommand(Intent, int, int) if the Intent is a re-delivery of a previously delivered intent, because the service had previously returned START_REDELIVER_INTENT but had been killed before calling stopSelf(int) for that Intent. int START_FLAG_RETRY This flag is set in onStartCommand(Intent, int, int) if the Intent is a retry because the original attempt never got to or returned from onStartCommand(android.content.Intent, int, int). int START_NOT_STICKY Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), and there are no new start intents to deliver to it, then take the service out of the started state and don't recreate until a future explicit call to Context.startService(Intent). int START_REDELIVER_INTENT Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), then it will be scheduled for a restart and the last delivered Intent re-delivered to it again via onStartCommand(Intent, int, int). int START_STICKY Constant to return from onStartCommand(Intent, int, int): if this service's process is killed while it is started (after returning from onStartCommand(Intent, int, int)), then leave it in the started state but don't retain this delivered intent. int START_STICKY_COMPATIBILITY Constant to return from onStartCommand(Intent, int, int): compatibility version of START_STICKY that does not guarantee that onStartCommand(Intent, int, int) will be called again after being killed. int STOP_FOREGROUND_DETACH Selector for stopForeground(int): if set, the notification previously supplied to startForeground(int, Notification) will be detached from the service's lifecycle. int STOP_FOREGROUND_LEGACY This constant was deprecated in API level 33. Use STOP_FOREGROUND_DETACH instead. The legacy behavior was inconsistent, leading to bugs around unpredictable results. int STOP_FOREGROUND_REMOVE Selector for stopForeground(int): if supplied, the notification previously supplied to startForeground(int, Notification) will be cancelled and removed from display.
From class android.content.Context 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, BindServiceFlags, Executor, ServiceConnection): 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, BindServiceFlags, Executor, ServiceConnection): 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_ACTIVITY_STARTS Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): If binding from an app that is visible, the bound service is allowed to start an activity from background. int BIND_ALLOW_OOM_MANAGEMENT Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): allow the process hosting the bound service to go through its normal memory management. int BIND_AUTO_CREATE Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): automatically create the service as long as the binding exists. int BIND_DEBUG_UNBIND Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): include debugging help for mismatched calls to unbind. int BIND_EXTERNAL_SERVICE Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): The service being bound is an isolated, external service. long BIND_EXTERNAL_SERVICE_LONG Works in the same way as BIND_EXTERNAL_SERVICE, but it's defined as a long value that is compatible to BindServiceFlags. int BIND_IMPORTANT Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): 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, BindServiceFlags, Executor, ServiceConnection): 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, BindServiceFlags, Executor, ServiceConnection): 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, BindServiceFlags, Executor, ServiceConnection): If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level. int BIND_PACKAGE_ISOLATED_PROCESS Flag for bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection): Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name. int BIND_SHARED_ISOLATED_PROCESS Flag for bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection): Bind the service into a shared isolated process. int BIND_WAIVE_PRIORITY Flag for bindService(Intent, BindServiceFlags, Executor, ServiceConnection): 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. String CONTACT_KEYS_SERVICE Use with getSystemService(java.lang.String) to retrieve a E2eeContactKeysManager to managing contact keys. 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 CREDENTIAL_SERVICE Use with getSystemService(java.lang.String) to retrieve a CredentialManager to authenticate a user to your app. String CROSS_PROFILE_APPS_SERVICE Use with getSystemService(java.lang.String) to retrieve a CrossProfileApps for cross profile operations. int DEVICE_ID_DEFAULT The default device ID, which is the ID of the primary (non-virtual) device. int DEVICE_ID_INVALID Invalid device ID. String DEVICE_LOCK_SERVICE Use with getSystemService(java.lang.String) to retrieve a DeviceLockManager. 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 GRAMMATICAL_INFLECTION_SERVICE Use with getSystemService(java.lang.String) to retrieve a GrammaticalInflectionManager. String HARDWARE_PROPERTIES_SERVICE Use with getSystemService(java.lang.String) to retrieve a HardwarePropertiesManager for accessing the hardware properties service. String HEALTHCONNECT_SERVICE Use with getSystemService(java.lang.String) to retrieve a HealthConnectManager. 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 LOCALE_SERVICE Use with getSystemService(java.lang.String) to retrieve a LocaleManager. 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 OVERLAY_SERVICE Use with getSystemService(java.lang.String) to retrieve a OverlayManager for managing overlay packages. String PEOPLE_SERVICE Use with getSystemService(java.lang.String) to access a PeopleManager to interact with your published conversations. String PERFORMANCE_HINT_SERVICE Use with getSystemService(java.lang.String) to retrieve a PerformanceHintManager for accessing the performance hinting service. String PERSISTENT_DATA_BLOCK_SERVICE Use with getSystemService(java.lang.String) to retrieve a PersistentDataBlockManager instance for interacting with a storage device that lives across factory resets. 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. String PROFILING_SERVICE Use with getSystemService(java.lang.String) to retrieve an ProfilingManager. int RECEIVER_EXPORTED Flag for registerReceiver(BroadcastReceiver, IntentFilter): The receiver can receive broadcasts from other Apps. int RECEIVER_NOT_EXPORTED Flag for registerReceiver(BroadcastReceiver, IntentFilter): The receiver cannot receive broadcasts from other Apps. 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 SECURITY_STATE_SERVICE Use with getSystemService(java.lang.String) to retrieve a SecurityStateManager for accessing the security state manager service. 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 STATUS_BAR_SERVICE Use with getSystemService(java.lang.String) to retrieve a StatusBarManager for interacting with the status bar and quick settings. 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 TV_INTERACTIVE_APP_SERVICE Use with getSystemService(java.lang.String) to retrieve a TvInteractiveAppManager for interacting with TV interactive applications 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 This constant was deprecated in API level 31. Use VibratorManager to retrieve the default system vibrator. String VIRTUAL_DEVICE_SERVICE Use with getSystemService(java.lang.String) to retrieve a VirtualDeviceManager for managing virtual devices. 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.
From interface android.content.ComponentCallbacks2 int TRIM_MEMORY_BACKGROUND Level for onTrimMemory(int): the process has gone on to the LRU list. int TRIM_MEMORY_COMPLETE This constant was deprecated in API level 35. Apps are not notified of this level since API level 34 int TRIM_MEMORY_MODERATE This constant was deprecated in API level 35. Apps are not notified of this level since API level 34 int TRIM_MEMORY_RUNNING_CRITICAL This constant was deprecated in API level 35. Apps are not notified of this level since API level 34 int TRIM_MEMORY_RUNNING_LOW This constant was deprecated in API level 35. Apps are not notified of this level since API level 34 int TRIM_MEMORY_RUNNING_MODERATE This constant was deprecated in API level 35. Apps are not notified of this level since API level 34 int TRIM_MEMORY_UI_HIDDEN Level for onTrimMemory(int): the process had been showing a user interface, and is no longer doing so.

Public constructors
AccessibilityService()

Public methods
void	attachAccessibilityOverlayToDisplay(int displayId, SurfaceControl sc) Attaches a SurfaceControl containing an accessibility overlay to the specified display.
void	attachAccessibilityOverlayToWindow(int accessibilityWindowId, SurfaceControl sc) Attaches an accessibility overlay SurfaceControl to the specified window.
boolean	clearCache() Clears the cache.
boolean	clearCachedSubtree(AccessibilityNodeInfo node) Invalidates node and its subtree in the cache.
Context	createDisplayContext(Display display) Returns a new Context object from the current context but with resources adjusted to match the metrics of display.
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.
final void	disableSelf() Disables the service.
final boolean	dispatchGesture(GestureDescription gesture, AccessibilityService.GestureResultCallback callback, Handler handler) Dispatch a gesture to the touch screen.
AccessibilityNodeInfo	findFocus(int focus) Find the view that has the specified focus type.
final AccessibilityButtonController	getAccessibilityButtonController(int displayId) Returns the controller of specified logical display for the accessibility button within the system's navigation area.
final AccessibilityButtonController	getAccessibilityButtonController() Returns the controller for the accessibility button within the system's navigation area.
final BrailleDisplayController	getBrailleDisplayController() Returns the BrailleDisplayController which may be used to communicate with refreshable Braille displays that provide USB or Bluetooth Braille display HID support.
final FingerprintGestureController	getFingerprintGestureController() Get the controller for fingerprint gestures.
final InputMethod	getInputMethod() Returns the InputMethod instance after the system calls onCreateInputMethod(), which may be used to input text or get editable text selection change notifications.
final AccessibilityService.MagnificationController	getMagnificationController() Returns the magnification controller, which may be used to query and modify the state of display magnification.
AccessibilityNodeInfo	getRootInActiveWindow() Gets the root node in the currently active window if this service can retrieve window content.
AccessibilityNodeInfo	getRootInActiveWindow(int prefetchingStrategy) Gets the root node in the currently active window if this service can retrieve window content.
final AccessibilityServiceInfo	getServiceInfo() Gets the an AccessibilityServiceInfo describing this AccessibilityService.
final AccessibilityService.SoftKeyboardController	getSoftKeyboardController() Returns the soft keyboard controller, which may be used to query and modify the soft keyboard show mode.
final List<AccessibilityNodeInfo.AccessibilityAction>	getSystemActions() Returns a list of system actions available in the system right now.
Object	getSystemService(String name) Return the handle to a system-level service by name.
final TouchInteractionController	getTouchInteractionController(int displayId) Returns the touch interaction controller for the specified logical display, which may be used to detect gestures and otherwise control touch interactions.
List<AccessibilityWindowInfo>	getWindows() Gets the windows on the screen of the default display.
final SparseArray<List<AccessibilityWindowInfo>>	getWindowsOnAllDisplays() Gets the windows on the screen of all displays.
boolean	isCacheEnabled() Returns true if the cache is enabled.
boolean	isNodeInCache(AccessibilityNodeInfo node) Checks if node is in the cache.
abstract void	onAccessibilityEvent(AccessibilityEvent event) Callback for AccessibilityEvents.
final IBinder	onBind(Intent intent) Implement to return the implementation of the internal accessibility service interface.
InputMethod	onCreateInputMethod() The default implementation returns our default InputMethod.
boolean	onGesture(AccessibilityGestureEvent gestureEvent) Called by the system when the user performs a specific gesture on the specific touch screen.
abstract void	onInterrupt() Callback for interrupting the accessibility feedback.
void	onMotionEvent(MotionEvent event) Callback that allows an accessibility service to observe generic MotionEvents.
void	onSystemActionsChanged() This is called when the system action list is changed.
final boolean	performGlobalAction(int action) Performs a global action.
void	setAccessibilityFocusAppearance(int strokeWidth, int color) Sets the strokeWidth and color of the accessibility focus rectangle.
void	setAnimationScale(float scale) Sets the system settings values that control the scaling factor for animations.
boolean	setCacheEnabled(boolean enabled) Sets the cache status.
void	setGestureDetectionPassthroughRegion(int displayId, Region region) When AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, this function requests that touch interactions starting in the specified region of the screen bypass the gesture detector.
final void	setServiceInfo(AccessibilityServiceInfo info) Sets the AccessibilityServiceInfo that describes this service.
void	setTouchExplorationPassthroughRegion(int displayId, Region region) When AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, this function requests that touch interactions starting in the specified region of the screen bypass the touch explorer and go straight to the view hierarchy.
void	takeScreenshot(int displayId, Executor executor, AccessibilityService.TakeScreenshotCallback callback) Takes a screenshot of the specified display and returns it via an AccessibilityService.ScreenshotResult.
void	takeScreenshotOfWindow(int accessibilityWindowId, Executor executor, AccessibilityService.TakeScreenshotCallback callback) Takes a screenshot of the specified window and returns it via an AccessibilityService.ScreenshotResult.

Protected methods
boolean	onGesture(int gestureId) This method was deprecated in API level 30. Override onGesture(android.accessibilityservice.AccessibilityGestureEvent) instead.
boolean	onKeyEvent(KeyEvent event) Callback that allows an accessibility service to observe the key events before they are passed to the rest of the system.
void	onServiceConnected() This method is a part of the AccessibilityService lifecycle and is called after the system has successfully bound to the service.

Inherited methods
From class android.app.Service void attachBaseContext(Context newBase) Set the base context for this ContextWrapper. void dump(FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream. final Application getApplication() Return the application that owns this service. final int getForegroundServiceType() If the service has become a foreground service by calling startForeground(int, android.app.Notification) or startForeground(int, android.app.Notification, int), getForegroundServiceType() returns the current foreground service type. abstract IBinder onBind(Intent intent) Return the communication channel to the service. void onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running. void onCreate() Called by the system when the service is first created. void onDestroy() Called by the system to notify a Service that it is no longer used and is being removed. void onLowMemory() This is called when the overall system is running low on memory, and actively running processes should trim their memory usage. void onRebind(Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its onUnbind(Intent). void onStart(Intent intent, int startId) This method was deprecated in API level 15. Implement onStartCommand(android.content.Intent, int, int) instead. int onStartCommand(Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling Context.startService(Intent), providing the arguments it supplied and a unique integer token representing the start request. void onTaskRemoved(Intent rootIntent) This is called if the service is currently running and the user has removed a task that comes from the service's application. void onTimeout(int startId, int fgsType) Callback called when a particular foreground service type has timed out. void onTimeout(int startId) Callback called on timeout for ServiceInfo#FOREGROUND_SERVICE_TYPE_SHORT_SERVICE. void onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process. boolean onUnbind(Intent intent) Called when all clients have disconnected from a particular interface published by the service. final void startForeground(int id, Notification notification) If your service is started (running through Context#startService(Intent)), then also make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state. final void startForeground(int id, Notification notification, int foregroundServiceType) An overloaded version of startForeground(int, android.app.Notification) with additional foregroundServiceType parameter. final void stopForeground(int notificationBehavior) Remove this service from foreground state, allowing it to be killed if more memory is needed. final void stopForeground(boolean removeNotification) This method was deprecated in API level 33. call stopForeground(int) and pass either STOP_FOREGROUND_REMOVE or STOP_FOREGROUND_DETACH explicitly instead. final void stopSelf() Stop the service, if it was previously started. final void stopSelf(int startId) Old version of stopSelfResult(int) that doesn't return a result. final boolean stopSelfResult(int startId) Stop the service if the most recent time it was started was startId.
From class android.content.ContextWrapper void attachBaseContext(Context base) Set the base context for this ContextWrapper. boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn) Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn) Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks. boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags) See bindService(android.content.Intent, android.content.ServiceConnection, int) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. boolean bindService(Intent service, ServiceConnection conn, int flags) Connects to an application service, creating it if needed. boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn) See bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. int checkCallingOrSelfPermission(String permission) Determine whether the calling process of an IPC or you have been granted a particular permission. int checkCallingOrSelfUriPermission(Uri uri, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI. int[] checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs. int checkCallingPermission(String permission) Determine whether the calling process of an IPC you are handling has been granted a particular permission. int checkCallingUriPermission(Uri uri, int modeFlags) Determine whether the calling process and uid has been granted permission to access a specific URI. int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags) Determine whether the calling process and uid has been granted permission to access a list of URIs. int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and uid has been granted permission to access a specific content URI. int checkPermission(String permission, int pid, int uid) Determine whether the given permission is allowed for a particular process and user ID running in the system. int checkSelfPermission(String permission) Determine whether you have been granted a particular permission. int checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission. int checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and uid has been granted permission to access a specific URI. int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags) Determine whether a particular process and uid has been granted permission to access a list of URIs. void clearWallpaper() This method is deprecated. Use 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. Context createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration. Context createContext(ContextParams contextParams) Creates a context with specific properties and behaviors. Context createDeviceContext(int deviceId) Returns a new Context object from the current context but with device association given by the deviceId. Context createDeviceProtectedStorageContext() Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage. Context createDisplayContext(Display display) Returns a new Context object from the current context but with resources adjusted to match the metrics of display. 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. String[] databaseList() Returns an array of strings naming the private databases associated with this Context's application package. boolean deleteDatabase(String name) Delete an existing private SQLiteDatabase associated with this Context's application package. boolean deleteFile(String name) Delete the given private file associated with this Context's application package. boolean deleteSharedPreferences(String name) Delete an existing shared preferences file. void enforceCallingOrSelfPermission(String permission, String message) If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a SecurityException. 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. 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. void enforceCallingUriPermission(Uri uri, int modeFlags, String message) If the calling process and uid has not been granted permission to access a specific URI, throw SecurityException. 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. void enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission. void enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message) If a particular process and uid has not been granted permission to access a specific URI, throw SecurityException. String[] fileList() Returns an array of strings naming the private files associated with this Context's application package. Context getApplicationContext() Return the context of the single, global Application object of the current process. ApplicationInfo getApplicationInfo() Return the full application info for this context's package. AssetManager getAssets() Returns an AssetManager instance for the application's package. AttributionSource getAttributionSource() Context getBaseContext() File getCacheDir() Returns the absolute path to the application specific cache directory on the filesystem. ClassLoader getClassLoader() Return a class loader you can use to retrieve classes in this package. File getCodeCacheDir() Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code. ContentResolver getContentResolver() Return a ContentResolver instance for your application's package. File getDataDir() Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored. File getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with openOrCreateDatabase(String, int, CursorFactory) is stored. int getDeviceId() Gets the device ID this context is associated with. File getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files. Display getDisplay() Get the display this context is associated with. File getExternalCacheDir() Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns. File[] getExternalCacheDirs() Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns. File getExternalFilesDir(String type) Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns. File[] getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns. File[] getExternalMediaDirs() This method is deprecated. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a MediaStore collection directly, as any app can contribute new media to MediaStore with no permissions required, starting in Build.VERSION_CODES.Q. File getFileStreamPath(String name) Returns the absolute path on the filesystem where a file created with openFileOutput(String, int) is stored. 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. Looper getMainLooper() Return the Looper for the main thread of the current process. File getNoBackupFilesDir() Returns the absolute path to the directory on the filesystem similar to getFilesDir(). File getObbDir() Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found. File[] getObbDirs() Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found. String getPackageCodePath() Return the full path to this context's primary Android package. PackageManager getPackageManager() Return PackageManager instance to find global package information. String getPackageName() Return the name of this application's package. String getPackageResourcePath() Return the full path to this context's primary Android package. ContextParams getParams() Return the set of parameters which this Context was created with, if it was created via createContext(android.content.ContextParams). Resources getResources() Returns a Resources instance for the application's package. SharedPreferences getSharedPreferences(String name, int mode) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values. Object getSystemService(String name) Return the handle to a system-level service by name. String getSystemServiceName(Class<?> serviceClass) Gets the name of the system-level service that is represented by the specified class. Resources.Theme getTheme() Return the Theme object associated with this Context. Drawable getWallpaper() This method is deprecated. Use WallpaperManager.get() instead. int getWallpaperDesiredMinimumHeight() This method is deprecated. Use WallpaperManager.getDesiredMinimumHeight() instead. int getWallpaperDesiredMinimumWidth() This method is deprecated. Use WallpaperManager.getDesiredMinimumWidth() instead. void grantUriPermission(String toPackage, Uri uri, int modeFlags) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider. boolean isDeviceProtectedStorage() Indicates if the storage APIs of this Context are backed by device-protected storage. boolean isRestricted() Indicates whether this Context is restricted. boolean moveDatabaseFrom(Context sourceContext, String name) Move an existing database file from the given source storage context to this context. boolean moveSharedPreferencesFrom(Context sourceContext, String name) Move an existing shared preferences file from the given source storage context to this context. FileInputStream openFileInput(String name) Open a private file associated with this Context's application package for reading. FileOutputStream openFileOutput(String name, int mode) Open a private file associated with this Context's application package for writing. SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package. SQLiteDatabase openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory) Open a new private SQLiteDatabase associated with this Context's application package. Drawable peekWallpaper() This method is deprecated. Use 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. void registerDeviceIdChangeListener(Executor executor, IntConsumer listener) Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system. Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread. Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags) Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps. Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags) Register to receive intent broadcasts, to run in the context of scheduler. Intent registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler) Register to receive intent broadcasts, to run in the context of scheduler. void removeStickyBroadcast(Intent intent) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void removeStickyBroadcastAsUser(Intent intent, UserHandle user) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void revokeSelfPermissionsOnKill(Collection<String> permissions) Triggers the revocation of one or more permissions for the calling package. void revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) or any other mechanism. void revokeUriPermission(String targetPackage, Uri uri, int modeFlags) Remove permissions to access a particular content provider Uri that were previously added with grantUriPermission(String, Uri, int) for a specific target package. void sendBroadcast(Intent intent, String receiverPermission, Bundle options) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. void sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. void sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers. void sendBroadcastAsUser(Intent intent, UserHandle user) Version of sendBroadcast(android.content.Intent) that allows you to specify the user the broadcast will be sent to. 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 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. void sendOrderedBroadcast(Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options) void sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of sendBroadcast(android.content.Intent) that allows you to receive data back from the broadcast. void sendOrderedBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. void sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of 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. void sendStickyBroadcast(Intent intent) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void sendStickyBroadcast(Intent intent, Bundle options) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void sendStickyBroadcastAsUser(Intent intent, UserHandle user) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired. void setTheme(int resid) Set the base theme for this context. void setWallpaper(Bitmap bitmap) This method is deprecated. Use WallpaperManager.set() instead. This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER. void setWallpaper(InputStream data) This method is deprecated. Use WallpaperManager.set() instead. This method requires the caller to hold the permission Manifest.permission.SET_WALLPAPER. void startActivities(Intent[] intents, Bundle options) Launch multiple new activities. void startActivities(Intent[] intents) Same as startActivities(android.content.Intent[], android.os.Bundle) with no options specified. void startActivity(Intent intent) Same as startActivity(android.content.Intent, android.os.Bundle) with no options specified. void startActivity(Intent intent, Bundle options) Launch a new activity. 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. boolean startInstrumentation(ComponentName className, String profileFile, Bundle arguments) Start executing an Instrumentation class. 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. 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. ComponentName startService(Intent service) Request that a given application service be started. boolean stopService(Intent name) Request that a given application service be stopped. void unbindService(ServiceConnection conn) Disconnect from an application service. void unregisterComponentCallbacks(ComponentCallbacks callback) Remove a ComponentCallbacks object that was previously registered with registerComponentCallbacks(android.content.ComponentCallbacks). void unregisterDeviceIdChangeListener(IntConsumer listener) Removes a device ID changed listener from the Context. void unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver. void updateServiceGroup(ServiceConnection conn, int group, int importance) For a service previously bound with bindService(Intent, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.
From class android.content.Context boolean bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn) Variation of bindService(Intent, BindServiceFlags, Executor, ServiceConnection) that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration. boolean bindIsolatedService(Intent service, Context.BindServiceFlags flags, String instanceName, Executor executor, ServiceConnection conn) See bindIsolatedService(android.content.Intent, int, java.lang.String, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. boolean bindService(Intent service, int flags, Executor executor, ServiceConnection conn) Same as bindService(Intent, ServiceConnection, int) with executor to control ServiceConnection callbacks. boolean bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags) See bindService(android.content.Intent, android.content.ServiceConnection, int) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. abstract boolean bindService(Intent service, ServiceConnection conn, int flags) Connects to an application service, creating it if needed. boolean bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn) See bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. boolean bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user) Binds to a service in the given user in the same manner as bindService(Intent, BindServiceFlags, Executor, ServiceConnection). boolean bindServiceAsUser(Intent service, ServiceConnection conn, Context.BindServiceFlags flags, UserHandle user) See bindServiceAsUser(android.content.Intent, android.content.ServiceConnection, int, android.os.UserHandle) Call BindServiceFlags#of(long) to obtain a BindServiceFlags object. 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 uid has been granted permission to access a specific URI. int[] checkCallingUriPermissions(List<Uri> uris, int modeFlags) Determine whether the calling process and uid has been granted permission to access a list of URIs. int checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and uid has been granted permission to access a specific content URI. 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 uid has been granted permission to access a specific URI. int[] checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags) Determine whether a particular process and uid has been granted permission to access a list of URIs. 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. Context createDeviceContext(int deviceId) Returns a new Context object from the current context but with device association given by the deviceId. 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) Returns a new Context object from the current context but with resources adjusted to match the metrics of 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 uid 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 uid 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. AttributionSource getAttributionSource() 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, CursorFactory) is stored. int getDeviceId() Gets the device ID this context is associated with. 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) Returns a localized string from the application's package's default string table. 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 <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. void registerDeviceIdChangeListener(Executor executor, IntConsumer listener) Adds a new device ID changed listener to the Context, which will be called when the device association is changed by the system. 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. void revokeSelfPermissionOnKill(String permName) Triggers the asynchronous revocation of a runtime permission. void revokeSelfPermissionsOnKill(Collection<String> permissions) Triggers the revocation of one or more permissions for the calling package. 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. void sendBroadcast(Intent intent, String receiverPermission, Bundle options) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced. abstract void sendBroadcast(Intent intent, String receiverPermission) 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. void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers. void sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of 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 31. 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). void unregisterDeviceIdChangeListener(IntConsumer listener) Removes a device ID changed listener from the Context. 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, BindServiceFlags, Executor, ServiceConnection) or a related method, change how the system manages that service's process in relation to other processes.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.content.ComponentCallbacks2 abstract void onTrimMemory(int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running. abstract void onLowMemory() This method was deprecated in API level 35. Since API level 14 this is superseded by ComponentCallbacks2#onTrimMemory. Since API level 34 this is never called. Apps targeting API level 34 and above may provide an empty implementation.

Constants

ERROR_TAKE_SCREENSHOT_INTERNAL_ERROR

Added in API level 30

public static final int ERROR_TAKE_SCREENSHOT_INTERNAL_ERROR

The status of taking screenshot is failure and the reason is internal error.

Constant Value: 1 (0x00000001)

ERROR_TAKE_SCREENSHOT_INTERVAL_TIME_SHORT

Added in API level 30

public static final int ERROR_TAKE_SCREENSHOT_INTERVAL_TIME_SHORT

The status of taking screenshot is failure and the reason is that too little time has elapsed since the last screenshot.

Constant Value: 3 (0x00000003)

ERROR_TAKE_SCREENSHOT_INVALID_DISPLAY

Added in API level 30

public static final int ERROR_TAKE_SCREENSHOT_INVALID_DISPLAY

The status of taking screenshot is failure and the reason is invalid display Id.

Constant Value: 4 (0x00000004)

ERROR_TAKE_SCREENSHOT_INVALID_WINDOW

Added in API level 34

public static final int ERROR_TAKE_SCREENSHOT_INVALID_WINDOW

The status of taking screenshot is failure and the reason is invalid accessibility window Id.

Constant Value: 5 (0x00000005)

ERROR_TAKE_SCREENSHOT_NO_ACCESSIBILITY_ACCESS

Added in API level 30

public static final int ERROR_TAKE_SCREENSHOT_NO_ACCESSIBILITY_ACCESS

The status of taking screenshot is failure and the reason is no accessibility access.

Constant Value: 2 (0x00000002)

ERROR_TAKE_SCREENSHOT_SECURE_WINDOW

Added in API level 34

public static final int ERROR_TAKE_SCREENSHOT_SECURE_WINDOW

The status of taking screenshot is failure and the reason is the window contains secure content.

See also:

• WindowManager.LayoutParams.FLAG_SECURE

Constant Value: 6 (0x00000006)

GESTURE_2_FINGER_DOUBLE_TAP

Added in API level 30

public static final int GESTURE_2_FINGER_DOUBLE_TAP

The user has performed a two-finger double tap gesture on the touch screen.

Constant Value: 20 (0x00000014)

GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30

public static final int GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD

The user has performed a two-finger double tap and hold gesture on the touch screen.

Constant Value: 40 (0x00000028)

GESTURE_2_FINGER_SINGLE_TAP

Added in API level 30

public static final int GESTURE_2_FINGER_SINGLE_TAP

The user has performed a two-finger single tap gesture on the touch screen.

Constant Value: 19 (0x00000013)

GESTURE_2_FINGER_SWIPE_DOWN

Added in API level 30

public static final int GESTURE_2_FINGER_SWIPE_DOWN

The user has performed a two-finger swipe down gesture on the touch screen.

Constant Value: 26 (0x0000001a)

GESTURE_2_FINGER_SWIPE_LEFT

Added in API level 30

public static final int GESTURE_2_FINGER_SWIPE_LEFT

The user has performed a two-finger swipe left gesture on the touch screen.

Constant Value: 27 (0x0000001b)

GESTURE_2_FINGER_SWIPE_RIGHT

Added in API level 30

public static final int GESTURE_2_FINGER_SWIPE_RIGHT

The user has performed a two-finger swipe right gesture on the touch screen.

Constant Value: 28 (0x0000001c)

GESTURE_2_FINGER_SWIPE_UP

Added in API level 30

public static final int GESTURE_2_FINGER_SWIPE_UP

The user has performed a two-finger swipe up gesture on the touch screen.

Constant Value: 25 (0x00000019)

GESTURE_2_FINGER_TRIPLE_TAP

Added in API level 30

public static final int GESTURE_2_FINGER_TRIPLE_TAP

The user has performed a two-finger triple tap gesture on the touch screen.

Constant Value: 21 (0x00000015)

GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD

Added in API level 31

public static final int GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD

The user has performed a two-finger triple-tap and hold gesture on the touch screen.

Constant Value: 43 (0x0000002b)

GESTURE_3_FINGER_DOUBLE_TAP

Added in API level 30

public static final int GESTURE_3_FINGER_DOUBLE_TAP

The user has performed a three-finger double tap gesture on the touch screen.

Constant Value: 23 (0x00000017)

GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30

public static final int GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD

The user has performed a three-finger double tap and hold gesture on the touch screen.

Constant Value: 41 (0x00000029)

GESTURE_3_FINGER_SINGLE_TAP

Added in API level 30

public static final int GESTURE_3_FINGER_SINGLE_TAP

The user has performed a three-finger single tap gesture on the touch screen.

Constant Value: 22 (0x00000016)

GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD

Added in API level 31

public static final int GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD

The user has performed a three-finger single-tap and hold gesture on the touch screen.

Constant Value: 44 (0x0000002c)

GESTURE_3_FINGER_SWIPE_DOWN

Added in API level 30

public static final int GESTURE_3_FINGER_SWIPE_DOWN

The user has performed a three-finger swipe down gesture on the touch screen.

Constant Value: 30 (0x0000001e)

GESTURE_3_FINGER_SWIPE_LEFT

Added in API level 30

public static final int GESTURE_3_FINGER_SWIPE_LEFT

The user has performed a three-finger swipe left gesture on the touch screen.

Constant Value: 31 (0x0000001f)

GESTURE_3_FINGER_SWIPE_RIGHT

Added in API level 30

public static final int GESTURE_3_FINGER_SWIPE_RIGHT

The user has performed a three-finger swipe right gesture on the touch screen.

Constant Value: 32 (0x00000020)

GESTURE_3_FINGER_SWIPE_UP

Added in API level 30

public static final int GESTURE_3_FINGER_SWIPE_UP

The user has performed a three-finger swipe up gesture on the touch screen.

Constant Value: 29 (0x0000001d)

GESTURE_3_FINGER_TRIPLE_TAP

Added in API level 30

public static final int GESTURE_3_FINGER_TRIPLE_TAP

The user has performed a three-finger triple tap gesture on the touch screen.

Constant Value: 24 (0x00000018)

GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD

Added in API level 31

public static final int GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD

The user has performed a three-finger triple-tap and hold gesture on the touch screen.

Constant Value: 45 (0x0000002d)

GESTURE_4_FINGER_DOUBLE_TAP

Added in API level 30

public static final int GESTURE_4_FINGER_DOUBLE_TAP

The user has performed a four-finger double tap gesture on the touch screen.

Constant Value: 38 (0x00000026)

GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30

public static final int GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD

The user has performed a two-finger double tap and hold gesture on the touch screen.

Constant Value: 42 (0x0000002a)

GESTURE_4_FINGER_SINGLE_TAP

Added in API level 30

public static final int GESTURE_4_FINGER_SINGLE_TAP

The user has performed a four-finger single tap gesture on the touch screen.

Constant Value: 37 (0x00000025)

GESTURE_4_FINGER_SWIPE_DOWN

Added in API level 30

public static final int GESTURE_4_FINGER_SWIPE_DOWN

The user has performed a four-finger swipe down gesture on the touch screen.

Constant Value: 34 (0x00000022)

GESTURE_4_FINGER_SWIPE_LEFT

Added in API level 30

public static final int GESTURE_4_FINGER_SWIPE_LEFT

The user has performed a four-finger swipe left gesture on the touch screen.

Constant Value: 35 (0x00000023)

GESTURE_4_FINGER_SWIPE_RIGHT

Added in API level 30

public static final int GESTURE_4_FINGER_SWIPE_RIGHT

The user has performed a four-finger swipe right gesture on the touch screen.

Constant Value: 36 (0x00000024)

GESTURE_4_FINGER_SWIPE_UP

Added in API level 30

public static final int GESTURE_4_FINGER_SWIPE_UP

The user has performed a four-finger swipe up gesture on the touch screen.

Constant Value: 33 (0x00000021)

GESTURE_4_FINGER_TRIPLE_TAP

Added in API level 30

public static final int GESTURE_4_FINGER_TRIPLE_TAP

The user has performed a four-finger triple tap gesture on the touch screen.

Constant Value: 39 (0x00000027)

GESTURE_DOUBLE_TAP

Added in API level 30

public static final int GESTURE_DOUBLE_TAP

The user has performed a double tap gesture on the touch screen.

Constant Value: 17 (0x00000011)

GESTURE_DOUBLE_TAP_AND_HOLD

Added in API level 30

public static final int GESTURE_DOUBLE_TAP_AND_HOLD

The user has performed a double tap and hold gesture on the touch screen.

Constant Value: 18 (0x00000012)

GESTURE_SWIPE_DOWN

Added in API level 16

public static final int GESTURE_SWIPE_DOWN

The user has performed a swipe down gesture on the touch screen.

Constant Value: 2 (0x00000002)

GESTURE_SWIPE_DOWN_AND_LEFT

Added in API level 16

public static final int GESTURE_SWIPE_DOWN_AND_LEFT

The user has performed a down and left gesture on the touch screen.

Constant Value: 15 (0x0000000f)

GESTURE_SWIPE_DOWN_AND_RIGHT

Added in API level 16

public static final int GESTURE_SWIPE_DOWN_AND_RIGHT

The user has performed a down and right gesture on the touch screen.

Constant Value: 16 (0x00000010)

GESTURE_SWIPE_DOWN_AND_UP

Added in API level 16

public static final int GESTURE_SWIPE_DOWN_AND_UP

The user has performed a swipe down and up gesture on the touch screen.

Constant Value: 8 (0x00000008)

GESTURE_SWIPE_LEFT

Added in API level 16

public static final int GESTURE_SWIPE_LEFT

The user has performed a swipe left gesture on the touch screen.

Constant Value: 3 (0x00000003)

GESTURE_SWIPE_LEFT_AND_DOWN

Added in API level 16

public static final int GESTURE_SWIPE_LEFT_AND_DOWN

The user has performed a left and down gesture on the touch screen.

Constant Value: 10 (0x0000000a)

GESTURE_SWIPE_LEFT_AND_RIGHT

Added in API level 16

public static final int GESTURE_SWIPE_LEFT_AND_RIGHT

The user has performed a swipe left and right gesture on the touch screen.

Constant Value: 5 (0x00000005)

GESTURE_SWIPE_LEFT_AND_UP

Added in API level 16

public static final int GESTURE_SWIPE_LEFT_AND_UP

The user has performed a left and up gesture on the touch screen.

Constant Value: 9 (0x00000009)

GESTURE_SWIPE_RIGHT

Added in API level 16

public static final int GESTURE_SWIPE_RIGHT

The user has performed a swipe right gesture on the touch screen.

Constant Value: 4 (0x00000004)

GESTURE_SWIPE_RIGHT_AND_DOWN

Added in API level 16

public static final int GESTURE_SWIPE_RIGHT_AND_DOWN

The user has performed a right and down gesture on the touch screen.

Constant Value: 12 (0x0000000c)

GESTURE_SWIPE_RIGHT_AND_LEFT

Added in API level 16

public static final int GESTURE_SWIPE_RIGHT_AND_LEFT

The user has performed a swipe right and left gesture on the touch screen.

Constant Value: 6 (0x00000006)

GESTURE_SWIPE_RIGHT_AND_UP

Added in API level 16

public static final int GESTURE_SWIPE_RIGHT_AND_UP

The user has performed a right and up gesture on the touch screen.

Constant Value: 11 (0x0000000b)

GESTURE_SWIPE_UP

Added in API level 16

public static final int GESTURE_SWIPE_UP

The user has performed a swipe up gesture on the touch screen.

Constant Value: 1 (0x00000001)

GESTURE_SWIPE_UP_AND_DOWN

Added in API level 16

public static final int GESTURE_SWIPE_UP_AND_DOWN

The user has performed a swipe up and down gesture on the touch screen.

Constant Value: 7 (0x00000007)

GESTURE_SWIPE_UP_AND_LEFT

Added in API level 16

public static final int GESTURE_SWIPE_UP_AND_LEFT

The user has performed an up and left gesture on the touch screen.

Constant Value: 13 (0x0000000d)

GESTURE_SWIPE_UP_AND_RIGHT

Added in API level 16

public static final int GESTURE_SWIPE_UP_AND_RIGHT

The user has performed an up and right gesture on the touch screen.

Constant Value: 14 (0x0000000e)

GESTURE_UNKNOWN

Added in API level 31

public static final int GESTURE_UNKNOWN

The user has performed an unrecognized gesture on the touch screen. This gesture is only dispatched when AccessibilityServiceInfo#FLAG_SEND_MOTION_EVENTS is set.

Constant Value: 0 (0x00000000)

GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS

Added in API level 31

public static final int GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS

Action to show Launcher's all apps.

Constant Value: 14 (0x0000000e)

GLOBAL_ACTION_ACCESSIBILITY_BUTTON

Added in API level 31

public static final int GLOBAL_ACTION_ACCESSIBILITY_BUTTON

Action to trigger the Accessibility Button

Constant Value: 11 (0x0000000b)

GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER

Added in API level 31

public static final int GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER

Action to bring up the Accessibility Button's chooser menu

Constant Value: 12 (0x0000000c)

GLOBAL_ACTION_ACCESSIBILITY_SHORTCUT

Added in API level 31

public static final int GLOBAL_ACTION_ACCESSIBILITY_SHORTCUT

Action to trigger the Accessibility Shortcut. This shortcut has a hardware trigger and can be activated by holding down the two volume keys.

Constant Value: 13 (0x0000000d)

GLOBAL_ACTION_BACK

Added in API level 16

public static final int GLOBAL_ACTION_BACK

Action to go back.

Constant Value: 1 (0x00000001)

GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE

Added in API level 31

public static final int GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE

Action to dismiss the notification shade

Constant Value: 15 (0x0000000f)

GLOBAL_ACTION_DPAD_CENTER

Added in API level 33

public static final int GLOBAL_ACTION_DPAD_CENTER

Action to trigger dpad center keyevent.

Constant Value: 20 (0x00000014)

GLOBAL_ACTION_DPAD_DOWN

Added in API level 33

public static final int GLOBAL_ACTION_DPAD_DOWN

Action to trigger dpad down keyevent.

Constant Value: 17 (0x00000011)

GLOBAL_ACTION_DPAD_LEFT

Added in API level 33

public static final int GLOBAL_ACTION_DPAD_LEFT

Action to trigger dpad left keyevent.

Constant Value: 18 (0x00000012)

GLOBAL_ACTION_DPAD_RIGHT

Added in API level 33

public static final int GLOBAL_ACTION_DPAD_RIGHT

Action to trigger dpad right keyevent.

Constant Value: 19 (0x00000013)

GLOBAL_ACTION_DPAD_UP

Added in API level 33

public static final int GLOBAL_ACTION_DPAD_UP

Action to trigger dpad up keyevent.

Constant Value: 16 (0x00000010)

GLOBAL_ACTION_HOME

Added in API level 16

public static final int GLOBAL_ACTION_HOME

Action to go home.

Constant Value: 2 (0x00000002)

GLOBAL_ACTION_KEYCODE_HEADSETHOOK

Added in API level 31

public static final int GLOBAL_ACTION_KEYCODE_HEADSETHOOK

Action to send the KEYCODE_HEADSETHOOK KeyEvent, which is used to answer and hang up calls and play and stop media. Calling takes priority. If there is an incoming call, this action can be used to answer that call, and if there is an ongoing call, to hang up on that call.

Constant Value: 10 (0x0000000a)

GLOBAL_ACTION_LOCK_SCREEN

Added in API level 28

public static final int GLOBAL_ACTION_LOCK_SCREEN

Action to lock the screen

Constant Value: 8 (0x00000008)

GLOBAL_ACTION_NOTIFICATIONS

Added in API level 16

public static final int GLOBAL_ACTION_NOTIFICATIONS

Action to open the notifications.

Constant Value: 4 (0x00000004)

GLOBAL_ACTION_POWER_DIALOG

Added in API level 21

public static final int GLOBAL_ACTION_POWER_DIALOG

Action to open the power long-press dialog.

Constant Value: 6 (0x00000006)

GLOBAL_ACTION_QUICK_SETTINGS

Added in API level 17

public static final int GLOBAL_ACTION_QUICK_SETTINGS

Action to open the quick settings.

Constant Value: 5 (0x00000005)

GLOBAL_ACTION_RECENTS

Added in API level 16

public static final int GLOBAL_ACTION_RECENTS

Action to toggle showing the overview of recent apps. Will fail on platforms that don't show recent apps.

Constant Value: 3 (0x00000003)

GLOBAL_ACTION_TAKE_SCREENSHOT

Added in API level 28

public static final int GLOBAL_ACTION_TAKE_SCREENSHOT

Action to take a screenshot

Constant Value: 9 (0x00000009)

GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN

Added in API level 24

public static final int GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN

Action to toggle docking the current app's window.

Note: It is effective only if it appears in getSystemActions().

Constant Value: 7 (0x00000007)

SERVICE_INTERFACE

Added in API level 4

public static final String SERVICE_INTERFACE

The Intent that must be declared as handled by the service.

Constant Value: "android.accessibilityservice.AccessibilityService"

SERVICE_META_DATA

Added in API level 14

public static final String SERVICE_META_DATA

Name under which an AccessibilityService component publishes information about itself. This meta-data must reference an XML resource containing an <accessibility-service> tag. This is a sample XML file configuring an accessibility service:

 <accessibility-service
     android:accessibilityEventTypes="typeViewClicked|typeViewFocused"
     android:packageNames="foo.bar, foo.baz"
     android:accessibilityFeedbackType="feedbackSpoken"
     android:notificationTimeout="100"
     android:accessibilityFlags="flagDefault"
     android:settingsActivity="foo.bar.TestBackActivity"
     android:canRetrieveWindowContent="true"
     android:canRequestTouchExplorationMode="true"
     . . .
 />

Constant Value: "android.accessibilityservice"

SHOW_MODE_AUTO

Added in API level 24

public static final int SHOW_MODE_AUTO

Allow the system to control when the soft keyboard is shown.

See also:

• AccessibilityService.SoftKeyboardController

Constant Value: 0 (0x00000000)

SHOW_MODE_HIDDEN

Added in API level 24

public static final int SHOW_MODE_HIDDEN

Never show the soft keyboard.

See also:

• AccessibilityService.SoftKeyboardController

Constant Value: 1 (0x00000001)

SHOW_MODE_IGNORE_HARD_KEYBOARD

Added in API level 29

public static final int SHOW_MODE_IGNORE_HARD_KEYBOARD

Allow the soft keyboard to be shown, even if a hard keyboard is connected

See also:

• AccessibilityService.SoftKeyboardController

Constant Value: 2 (0x00000002)

Public constructors

AccessibilityService

public AccessibilityService ()

Public methods

attachAccessibilityOverlayToDisplay

Added in API level 34

public void attachAccessibilityOverlayToDisplay (int displayId, 
                SurfaceControl sc)

Attaches a SurfaceControl containing an accessibility overlay to the specified display. This type of overlay should be used for content that does not need to track the location and size of Views in the currently active app e.g. service configuration or general service UI.

Generally speaking, an accessibility overlay will be a View. To embed the View into a SurfaceControl, create a SurfaceControlViewHost and attach the View using SurfaceControlViewHost.setView(View, int, int). Then obtain the SurfaceControl by calling viewHost.getSurfacePackage().getSurfaceControl().

To remove this overlay and free the associated resources, use new SurfaceControl.Transaction().reparent(sc, null).apply();.

If the specified overlay has already been attached to the specified display this method does nothing. If the specified overlay has already been attached to a previous display this function will transfer the overlay to the new display. Services can attach multiple overlays. Use new SurfaceControl.Transaction().setLayer(sc, layer).apply();. to coordinate the order of the overlays on screen.

Parameters
displayId	int: the display to which the SurfaceControl should be attached.
sc	SurfaceControl: the SurfaceControl containing the overlay content This value cannot be null.

attachAccessibilityOverlayToWindow

Added in API level 34

public void attachAccessibilityOverlayToWindow (int accessibilityWindowId, 
                SurfaceControl sc)

Attaches an accessibility overlay SurfaceControl to the specified window. This method should be used when you want the overlay to move and resize as the parent window moves and resizes.

Generally speaking, an accessibility overlay will be a View. To embed the View into a SurfaceControl, create a SurfaceControlViewHost and attach the View using SurfaceControlViewHost.setView(View, int, int). Then obtain the SurfaceControl by calling viewHost.getSurfacePackage().getSurfaceControl().

To remove this overlay and free the associated resources, use new SurfaceControl.Transaction().reparent(sc, null).apply();.

If the specified overlay has already been attached to the specified window this method does nothing. If the specified overlay has already been attached to a previous window this function will transfer the overlay to the new window. Services can attach multiple overlays. Use new SurfaceControl.Transaction().setLayer(sc, layer).apply();. to coordinate the order of the overlays on screen.

Parameters
accessibilityWindowId	int: The window id, from AccessibilityWindowInfo#getId().
sc	SurfaceControl: the SurfaceControl containing the overlay content This value cannot be null.

clearCache

Added in API level 33

public boolean clearCache ()

Clears the cache.

Returns
boolean	true if the cache was cleared

clearCachedSubtree

Added in API level 33

public boolean clearCachedSubtree (AccessibilityNodeInfo node)

Invalidates node and its subtree in the cache.

Parameters
node	AccessibilityNodeInfo: the node to invalidate. This value cannot be null.

Returns
boolean	true if the subtree rooted at node was invalidated.

createDisplayContext

Added in API level 17

public Context createDisplayContext (Display display)

Returns a new Context object from the current context but with resources adjusted to match the metrics of display. Each call to this method returns a new instance of a context object. Context objects are not shared; however, common state (such as the ClassLoader and other resources for the same configuration) can be shared, so the Context itself is lightweight.

Note: This Context is not expected to be updated with new configuration if the underlying display configuration changes and the cached Resources it returns could be stale. It is suggested to use DisplayManager.DisplayListener to listen for changes and re-create an instance if necessary.

This Context is not a UI context, do not use it to access UI components or obtain a WindowManager instance.

To obtain an instance of WindowManager configured to show windows on the given display, call createWindowContext(int, android.os.Bundle) on the returned display context, then call getSystemService(java.lang.String) or getSystemService(java.lang.Class) on the returned window context.

Parameters
display	Display: The display to which the current context's resources are adjusted. This value cannot be null.

Returns
Context	This value cannot be null.

createWindowContext

Added in API level 30

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.

Below is sample code to attach an existing token to a window context:

 final DisplayManager dm = anyContext.getSystemService(DisplayManager.class);
 final Display primaryDisplay = dm.getDisplay(DEFAULT_DISPLAY);
 final Context windowContext = anyContext.createWindowContext(primaryDisplay,
         TYPE_APPLICATION, null);

 // Get an existing token.
 final IBinder existingToken = activity.getWindow().getAttributes().token;

 // The types used in addView() and createWindowContext() must match.
 final WindowManager.LayoutParams params = new WindowManager.LayoutParams(TYPE_APPLICATION);
 params.token = existingToken;

 // After WindowManager#addView(), the server side will extract the provided token from
 // LayoutParams#token (existingToken in the sample code), and switch to propagate
 // configuration changes from the node associated with the provided token.
 windowContext.getSystemService(WindowManager.class).addView(overlayView, mParams);
 

After Build.VERSION_CODES#S, window context provides the capability to listen to its Configuration changes by calling registerComponentCallbacks(android.content.ComponentCallbacks), while other kinds of Context will register the ComponentCallbacks to its Application context. Note that window context only propagate ComponentCallbacks#onConfigurationChanged(Configuration) callback. ComponentCallbacks#onLowMemory() or other callbacks in ComponentCallbacks2 won't be invoked.

Note that using Application or Service context for UI-related queries may result in layout or continuity issues on devices with variable screen sizes (e.g. foldables) or in multi-window modes, since these non-UI contexts may not reflect the Configuration changes for the visual container.

Parameters
type	int: Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION_STARTING, WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION_PANEL, WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA, WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL, WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR, WindowManager.LayoutParams.TYPE_SEARCH_BAR, WindowManager.LayoutParams.TYPE_PHONE, WindowManager.LayoutParams.TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST, WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY, WindowManager.LayoutParams.TYPE_PRIORITY_PHONE, WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG, WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG, WindowManager.LayoutParams.TYPE_SYSTEM_ERROR, WindowManager.LayoutParams.TYPE_INPUT_METHOD, WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG, WindowManager.LayoutParams.TYPE_WALLPAPER, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, WindowManager.LayoutParams.TYPE_ACCESSIBILITY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options	Bundle: This value may be null.

Returns
Context	This value cannot be null.

createWindowContext

Added in API level 31

public Context createWindowContext (Display display, 
                int type, 
                Bundle options)

Creates a Context for a non-activity window on the given Display.

Similar to createWindowContext(int, android.os.Bundle), but the display is passed in, instead of implicitly using the original Context's Display.

Parameters
display	Display: This value cannot be null.
type	int: Value is WindowManager.LayoutParams.TYPE_BASE_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION_STARTING, WindowManager.LayoutParams.TYPE_DRAWN_APPLICATION, WindowManager.LayoutParams.TYPE_APPLICATION_PANEL, WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA, WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL, WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, WindowManager.LayoutParams.TYPE_STATUS_BAR, WindowManager.LayoutParams.TYPE_SEARCH_BAR, WindowManager.LayoutParams.TYPE_PHONE, WindowManager.LayoutParams.TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, WindowManager.LayoutParams.TYPE_TOAST, WindowManager.LayoutParams.TYPE_SYSTEM_OVERLAY, WindowManager.LayoutParams.TYPE_PRIORITY_PHONE, WindowManager.LayoutParams.TYPE_SYSTEM_DIALOG, WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG, WindowManager.LayoutParams.TYPE_SYSTEM_ERROR, WindowManager.LayoutParams.TYPE_INPUT_METHOD, WindowManager.LayoutParams.TYPE_INPUT_METHOD_DIALOG, WindowManager.LayoutParams.TYPE_WALLPAPER, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_SECURE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_DRAG, android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_SUB_PANEL, android.view.WindowManager.LayoutParams.TYPE_POINTER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR, android.view.WindowManager.LayoutParams.TYPE_VOLUME_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_BOOT_PROGRESS, android.view.WindowManager.LayoutParams.TYPE_INPUT_CONSUMER, android.view.WindowManager.LayoutParams.TYPE_NAVIGATION_BAR_PANEL, android.view.WindowManager.LayoutParams.TYPE_DISPLAY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_MAGNIFICATION_OVERLAY, WindowManager.LayoutParams.TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, WindowManager.LayoutParams.TYPE_ACCESSIBILITY_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION_STARTING, android.view.WindowManager.LayoutParams.TYPE_DOCK_DIVIDER, android.view.WindowManager.LayoutParams.TYPE_QS_DIALOG, android.view.WindowManager.LayoutParams.TYPE_SCREENSHOT, android.view.WindowManager.LayoutParams.TYPE_PRESENTATION, WindowManager.LayoutParams.TYPE_APPLICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_ACCESSIBILITY_MAGNIFICATION_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_NOTIFICATION_SHADE, or android.view.WindowManager.LayoutParams.TYPE_STATUS_BAR_ADDITIONAL
options	Bundle: This value may be null.

Returns
Context	This value cannot be null.

disableSelf

Added in API level 24

public final void disableSelf ()

Disables the service. After calling this method, the service will be disabled and settings will show that it is turned off.

dispatchGesture

Added in API level 24

public final boolean dispatchGesture (GestureDescription gesture, 
                AccessibilityService.GestureResultCallback callback, 
                Handler handler)

Dispatch a gesture to the touch screen. Any gestures currently in progress, whether from the user, this service, or another service, will be cancelled.

The gesture will be dispatched as if it were performed directly on the screen by a user, so the events may be affected by features such as magnification and explore by touch.

Note: In order to dispatch gestures, your service must declare the capability by setting the R.styleable.AccessibilityService_canPerformGestures property in its meta-data. For more information, see SERVICE_META_DATA.

Since many apps do not appropriately support AccessibilityAction#ACTION_CLICK, if this action fails on an element that should be clickable, a service that is not a screen reader may send a tap directly to the element as a fallback. The example below demonstrates this fallback using the gesture dispatch APIs:

     private void tap(PointF point) {
         StrokeDescription tap =  new StrokeDescription(path(point), 0,
         ViewConfiguration.getTapTimeout());
         GestureDescription.Builder builder = new GestureDescription.Builder();
         builder.addStroke(tap);
         dispatchGesture(builder.build(), null, null);
     }

 

Parameters
gesture	GestureDescription: The gesture to dispatch This value cannot be null.
callback	AccessibilityService.GestureResultCallback: The object to call back when the status of the gesture is known. If null, no status is reported.
handler	Handler: The handler on which to call back the callback object. If null, the object is called back on the service's main thread.

Returns
boolean	true if the gesture is dispatched, false if not.

findFocus

Added in API level 21

public AccessibilityNodeInfo findFocus (int focus)

Find the view that has the specified focus type. The search is performed across all windows.

Note: In order to access the windows your service has to declare the capability to retrieve window content by setting the R.styleable.AccessibilityService_canRetrieveWindowContent property in its meta-data. For details refer to SERVICE_META_DATA. Also the service has to opt-in to retrieve the interactive windows by setting the AccessibilityServiceInfo#FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag. Otherwise, the search will be performed only in the active window.

Note: If the view with AccessibilityNodeInfo#FOCUS_INPUT is on an embedded view hierarchy which is embedded in a SurfaceView via SurfaceView.setChildSurfacePackage(SurfacePackage), there is a limitation that this API won't be able to find the node for the view. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the nodes to find the focus.

Parameters
focus	int: The focus to find. One of AccessibilityNodeInfo#FOCUS_INPUT or AccessibilityNodeInfo#FOCUS_ACCESSIBILITY.

Returns
AccessibilityNodeInfo	The node info of the focused view or null.

See also:

• AccessibilityNodeInfo.FOCUS_INPUT
• AccessibilityNodeInfo.FOCUS_ACCESSIBILITY

getAccessibilityButtonController

Added in API level 30

public final AccessibilityButtonController getAccessibilityButtonController (int displayId)

Returns the controller of specified logical display for the accessibility button within the system's navigation area. This instance may be used to query the accessibility button's state and register listeners for interactions with and state changes for the accessibility button when AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON is set.

Note: Not all devices are capable of displaying the accessibility button within a navigation area, and as such, use of this class should be considered only as an optional feature or shortcut on supported device implementations.

Parameters
displayId	int: The logic display id, use Display#DEFAULT_DISPLAY for default display.

Returns
AccessibilityButtonController	the accessibility button controller for this AccessibilityService This value cannot be null.

getAccessibilityButtonController

Added in API level 26

public final AccessibilityButtonController getAccessibilityButtonController ()

Returns the controller for the accessibility button within the system's navigation area. This instance may be used to query the accessibility button's state and register listeners for interactions with and state changes for the accessibility button when AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON is set.

Note: Not all devices are capable of displaying the accessibility button within a navigation area, and as such, use of this class should be considered only as an optional feature or shortcut on supported device implementations.

Returns
AccessibilityButtonController	the accessibility button controller for this AccessibilityService This value cannot be null.

getBrailleDisplayController

Added in API level 35

public final BrailleDisplayController getBrailleDisplayController ()

Returns the BrailleDisplayController which may be used to communicate with refreshable Braille displays that provide USB or Bluetooth Braille display HID support.

Returns
BrailleDisplayController	This value cannot be null.

getFingerprintGestureController

Added in API level 26

public final FingerprintGestureController getFingerprintGestureController ()

Get the controller for fingerprint gestures. This feature requires AccessibilityServiceInfo.CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES. Note: The service must be connected before this method is called.
Requires Manifest.permission.USE_FINGERPRINT

Returns
FingerprintGestureController	The controller for fingerprint gestures, or null if gestures are unavailable.

getInputMethod

Added in API level 33

public final InputMethod getInputMethod ()

Returns the InputMethod instance after the system calls onCreateInputMethod(), which may be used to input text or get editable text selection change notifications. It will return null if the accessibility service doesn't set the AccessibilityServiceInfo#FLAG_INPUT_METHOD_EDITOR flag or the system doesn't call onCreateInputMethod().

Returns
InputMethod	the InputMethod instance

getMagnificationController

Added in API level 24

public final AccessibilityService.MagnificationController getMagnificationController ()

Returns the magnification controller, which may be used to query and modify the state of display magnification.

Note: In order to control magnification, your service must declare the capability by setting the R.styleable.AccessibilityService_canControlMagnification property in its meta-data. For more information, see SERVICE_META_DATA.

Returns
AccessibilityService.MagnificationController	the magnification controller This value cannot be null.

getRootInActiveWindow

Added in API level 16

public AccessibilityNodeInfo getRootInActiveWindow ()

Gets the root node in the currently active window if this service can retrieve window content. The active window is the one that the user is currently touching or the window with input focus, if the user is not touching any window. It could be from any logical display.

Note: In order to access the root node your service has to declare the capability to retrieve window content by setting the R.styleable.AccessibilityService_canRetrieveWindowContent property in its meta-data. For details refer to SERVICE_META_DATA.

Returns
AccessibilityNodeInfo	The root node if this service can retrieve window content.

See also:

• for more explanation about the active window.

getRootInActiveWindow

Added in API level 33

public AccessibilityNodeInfo getRootInActiveWindow (int prefetchingStrategy)

Gets the root node in the currently active window if this service can retrieve window content. The active window is the one that the user is currently touching or the window with input focus, if the user is not touching any window. It could be from any logical display.

Parameters
prefetchingStrategy	int: the prefetching strategy. Value is either 0 or a combination of AccessibilityNodeInfo.FLAG_PREFETCH_ANCESTORS, AccessibilityNodeInfo.FLAG_PREFETCH_SIBLINGS, AccessibilityNodeInfo.FLAG_PREFETCH_DESCENDANTS_HYBRID, AccessibilityNodeInfo.FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST, AccessibilityNodeInfo.FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST, and AccessibilityNodeInfo.FLAG_PREFETCH_UNINTERRUPTIBLE

Returns
AccessibilityNodeInfo	The root node if this service can retrieve window content. This value may be null.

See also:

• getRootInActiveWindow()
• for a description of prefetching.

getServiceInfo

Added in API level 16

public final AccessibilityServiceInfo getServiceInfo ()

Gets the an AccessibilityServiceInfo describing this AccessibilityService. This method is useful if one wants to change some of the dynamically configurable properties at runtime.

Returns
AccessibilityServiceInfo	The accessibility service info.

See also:

• AccessibilityServiceInfo

getSoftKeyboardController

Added in API level 24

public final AccessibilityService.SoftKeyboardController getSoftKeyboardController ()

Returns the soft keyboard controller, which may be used to query and modify the soft keyboard show mode.

Returns
AccessibilityService.SoftKeyboardController	the soft keyboard controller This value cannot be null.

getSystemActions

Added in API level 30

public final List<AccessibilityNodeInfo.AccessibilityAction> getSystemActions ()

Returns a list of system actions available in the system right now.

System actions that correspond to the global action constants will have matching action IDs. For example, an with id GLOBAL_ACTION_BACK will perform the back action.

These actions should be called by performGlobalAction(int).

Returns
List<AccessibilityNodeInfo.AccessibilityAction>	A list of available system actions. This value cannot be null.

getSystemService

Added in API level 4

public Object getSystemService (String name)

Return the handle to a system-level service by name. The class of the returned object varies by the requested name. Currently available names are:

WINDOW_SERVICE ("window")

The top-level window manager in which you can place custom windows. The returned object is a WindowManager. Must only be obtained from a visual context such as Activity or a Context created 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 Android 7, it should only be obtained from an application context, and not from any other derived context to avoid memory leaks within the calling process.

WIFI_AWARE_SERVICE ("wifiaware")

A WifiAwareManager for management of Wi-Fi Aware discovery and connectivity.

WIFI_P2P_SERVICE ("wifip2p")

A WifiP2pManager for management of Wi-Fi Direct connectivity.

INPUT_METHOD_SERVICE ("input_method")

An InputMethodManager for management of input methods.

UI_MODE_SERVICE ("uimode")

An UiModeManager for controlling UI modes.

DOWNLOAD_SERVICE ("download")

A DownloadManager for requesting HTTP downloads

BATTERY_SERVICE ("batterymanager")

A BatteryManager for managing battery state

JOB_SCHEDULER_SERVICE ("taskmanager")

A JobScheduler for managing scheduled tasks

NETWORK_STATS_SERVICE ("netstats")

A NetworkStatsManager for querying network usage statistics.

HARDWARE_PROPERTIES_SERVICE ("hardware_properties")

A HardwarePropertiesManager for accessing hardware properties.

DOMAIN_VERIFICATION_SERVICE ("domain_verification")

A DomainVerificationManager for accessing web domain approval state.

DISPLAY_HASH_SERVICE ("display_hash")

A DisplayHashManager for management of display hashes.

Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)

Note: Instant apps, for which PackageManager#isInstantApp() returns true, don't have access to the following system services: DEVICE_POLICY_SERVICE, FINGERPRINT_SERVICE, KEYGUARD_SERVICE, SHORTCUT_SERVICE, USB_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WIFI_AWARE_SERVICE. For these services this method will return null. Generally, if you are running as an instant app you should always check whether the result of this method is null.

Note: When implementing this method, keep in mind that new services can be added on newer Android releases, so if you're looking for just the explicit names mentioned above, make sure to return null when you don't recognize the name — if you throw a RuntimeException exception instead, your app might break on new Android releases.

Parameters

name

String: Value is Context.POWER_SERVICE, Context.WINDOW_SERVICE, Context.LAYOUT_INFLATER_SERVICE, Context.ACCOUNT_SERVICE, Context.ACTIVITY_SERVICE, Context.ALARM_SERVICE, Context.NOTIFICATION_SERVICE, Context.ACCESSIBILITY_SERVICE, Context.CAPTIONING_SERVICE, Context.KEYGUARD_SERVICE, Context.LOCATION_SERVICE, Context.HEALTHCONNECT_SERVICE, Context.SEARCH_SERVICE, Context.SENSOR_SERVICE, android.content.Context.SENSOR_PRIVACY_SERVICE, Context.STORAGE_SERVICE, Context.STORAGE_STATS_SERVICE, Context.WALLPAPER_SERVICE, Context.VIBRATOR_MANAGER_SERVICE, Context.VIBRATOR_SERVICE, android.content.Context.THREAD_NETWORK_SERVICE, Context.CONNECTIVITY_SERVICE, android.content.Context.PAC_PROXY_SERVICE, android.content.Context.VCN_MANAGEMENT_SERVICE, Context.IPSEC_SERVICE, Context.VPN_MANAGEMENT_SERVICE, android.content.Context.TEST_NETWORK_SERVICE, Context.NETWORK_STATS_SERVICE, Context.WIFI_SERVICE, Context.WIFI_AWARE_SERVICE, Context.WIFI_P2P_SERVICE, android.content.Context.WIFI_SCANNING_SERVICE, Context.WIFI_RTT_RANGING_SERVICE, Context.NSD_SERVICE, Context.AUDIO_SERVICE, android.content.Context.AUDIO_DEVICE_VOLUME_SERVICE, android.content.Context.AUTH_SERVICE, Context.FINGERPRINT_SERVICE, Context.BIOMETRIC_SERVICE, Context.MEDIA_ROUTER_SERVICE, Context.TELEPHONY_SERVICE, Context.TELEPHONY_SUBSCRIPTION_SERVICE, Context.CARRIER_CONFIG_SERVICE, Context.EUICC_SERVICE, Context.TELECOM_SERVICE, Context.CLIPBOARD_SERVICE, Context.INPUT_METHOD_SERVICE, Context.TEXT_SERVICES_MANAGER_SERVICE, Context.TEXT_CLASSIFICATION_SERVICE, Context.APPWIDGET_SERVICE, android.content.Context.REBOOT_READINESS_SERVICE, android.content.Context.ROLLBACK_SERVICE, Context.DROPBOX_SERVICE, Context.DEVICE_POLICY_SERVICE, Context.UI_MODE_SERVICE, Context.DOWNLOAD_SERVICE, Context.NFC_SERVICE, Context.BLUETOOTH_SERVICE, Context.USB_SERVICE, Context.LAUNCHER_APPS_SERVICE, Context.INPUT_SERVICE, Context.DISPLAY_SERVICE, Context.USER_SERVICE, Context.RESTRICTIONS_SERVICE, Context.APP_OPS_SERVICE, Context.ROLE_SERVICE, Context.CAMERA_SERVICE, Context.PRINT_SERVICE, Context.CONSUMER_IR_SERVICE, Context.TV_INTERACTIVE_APP_SERVICE, Context.TV_INPUT_SERVICE, Context.USAGE_STATS_SERVICE, Context.MEDIA_SESSION_SERVICE, Context.MEDIA_COMMUNICATION_SERVICE, Context.BATTERY_SERVICE, Context.JOB_SCHEDULER_SERVICE, Context.PERSISTENT_DATA_BLOCK_SERVICE, Context.MEDIA_PROJECTION_SERVICE, Context.MIDI_SERVICE, android.content.Context.RADIO_SERVICE, Context.HARDWARE_PROPERTIES_SERVICE, Context.SHORTCUT_SERVICE, Context.SYSTEM_HEALTH_SERVICE, Context.COMPANION_DEVICE_SERVICE, Context.VIRTUAL_DEVICE_SERVICE, Context.CROSS_PROFILE_APPS_SERVICE, android.content.Context.PERMISSION_SERVICE, android.content.Context.LIGHTS_SERVICE, Context.LOCALE_SERVICE, android.content.Context.UWB_SERVICE, Context.MEDIA_METRICS_SERVICE, Context.DISPLAY_HASH_SERVICE, Context.CREDENTIAL_SERVICE, Context.DEVICE_LOCK_SERVICE, android.content.Context.VIRTUALIZATION_SERVICE, Context.GRAMMATICAL_INFLECTION_SERVICE, Context.SECURITY_STATE_SERVICE, or Context.CONTACT_KEYS_SERVICE This value cannot be null.

Returns
Object	The service or null if the name does not exist.

getTouchInteractionController

Added in API level 33

public final TouchInteractionController getTouchInteractionController (int displayId)

Returns the touch interaction controller for the specified logical display, which may be used to detect gestures and otherwise control touch interactions. If AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled the controller's methods will have no effect.

Parameters
displayId	int: The logical display id, use Display#DEFAULT_DISPLAY for default display.

Returns
TouchInteractionController	the TouchExploration controller This value cannot be null.

getWindows

Added in API level 21

public List<AccessibilityWindowInfo> getWindows ()

Gets the windows on the screen of the default display. This method returns only the windows that a sighted user can interact with, as opposed to all windows. For example, if there is a modal dialog shown and the user cannot touch anything behind it, then only the modal window will be reported (assuming it is the top one). For convenience the returned windows are ordered in a descending layer order, which is the windows that are on top are reported first. Since the user can always interact with the window that has input focus by typing, the focused window is always returned (even if covered by a modal window).

Note: In order to access the windows your service has to declare the capability to retrieve window content by setting the R.styleable.AccessibilityService_canRetrieveWindowContent property in its meta-data. For details refer to SERVICE_META_DATA. Also the service has to opt-in to retrieve the interactive windows by setting the AccessibilityServiceInfo#FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

Returns
List<AccessibilityWindowInfo>	The windows if there are windows and the service is can retrieve them, otherwise an empty list.

getWindowsOnAllDisplays

Added in API level 30

public final SparseArray<List<AccessibilityWindowInfo>> getWindowsOnAllDisplays ()

Gets the windows on the screen of all displays. This method returns only the windows that a sighted user can interact with, as opposed to all windows. For example, if there is a modal dialog shown and the user cannot touch anything behind it, then only the modal window will be reported (assuming it is the top one). For convenience the returned windows are ordered in a descending layer order, which is the windows that are on top are reported first. Since the user can always interact with the window that has input focus by typing, the focused window is always returned (even if covered by a modal window).

Note: In order to access the windows your service has to declare the capability to retrieve window content by setting the R.styleable.AccessibilityService_canRetrieveWindowContent property in its meta-data. For details refer to SERVICE_META_DATA. Also the service has to opt-in to retrieve the interactive windows by setting the AccessibilityServiceInfo#FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

Returns
SparseArray<List<AccessibilityWindowInfo>>	The windows of all displays if there are windows and the service is can retrieve them, otherwise an empty list. The key of SparseArray is display ID. This value cannot be null.

isCacheEnabled

Added in API level 33

public boolean isCacheEnabled ()

Returns true if the cache is enabled.

Returns
boolean

isNodeInCache

Added in API level 33

public boolean isNodeInCache (AccessibilityNodeInfo node)

Checks if node is in the cache.

Parameters
node	AccessibilityNodeInfo: the node to check. This value cannot be null.

Returns
boolean	true if node is in the cache.

onAccessibilityEvent

Added in API level 4

public abstract void onAccessibilityEvent (AccessibilityEvent event)

Callback for AccessibilityEvents.

Parameters
event	AccessibilityEvent: The new event. This event is owned by the caller and cannot be used after this method returns. Services wishing to use the event after this method returns should make a copy.

onBind

Added in API level 4

public final IBinder onBind (Intent intent)

Implement to return the implementation of the internal accessibility service interface.

Parameters
intent	Intent: The Intent that was used to bind to this service, as given to Context.bindService. Note that any extras that were included with the Intent at that point will not be seen here.

Returns
IBinder	Return an IBinder through which clients can call on to the service.

onCreateInputMethod

Added in API level 33

public InputMethod onCreateInputMethod ()

The default implementation returns our default InputMethod. Subclasses can override it to provide their own customized version. Accessibility services need to set the AccessibilityServiceInfo#FLAG_INPUT_METHOD_EDITOR flag to use input method APIs.

Returns
InputMethod	the InputMethod. This value cannot be null.

onGesture

Added in API level 30

public boolean onGesture (AccessibilityGestureEvent gestureEvent)

Called by the system when the user performs a specific gesture on the specific touch screen.

Note: To receive gestures an accessibility service must request that the device is in touch exploration mode by setting the AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE flag.

Note: The default implementation calls onGesture(int) when the touch screen is default display.

Parameters
gestureEvent	AccessibilityGestureEvent: The information of gesture. This value cannot be null.

Returns
boolean	Whether the gesture was handled.

onInterrupt

Added in API level 4

public abstract void onInterrupt ()

Callback for interrupting the accessibility feedback.

onMotionEvent

Added in API level 34

public void onMotionEvent (MotionEvent event)

Callback that allows an accessibility service to observe generic MotionEvents.

Prefer TouchInteractionController to observe and control touchscreen events, including touch gestures. If this or any enabled service is using AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE then onMotionEvent(MotionEvent) will not receive touchscreen events.

Note: The service must first request to listen to events using AccessibilityServiceInfo#setMotionEventSources. MotionEvents from sources in AccessibilityServiceInfo#getMotionEventSources() are not sent to the rest of the system. To stop listening to events from a given source, call AccessibilityServiceInfo#setMotionEventSources with that source removed.

Parameters
event	MotionEvent: The event to be processed. This value cannot be null.

onSystemActionsChanged

Added in API level 30

public void onSystemActionsChanged ()

This is called when the system action list is changed.

performGlobalAction

Added in API level 16

public final boolean performGlobalAction (int action)

Performs a global action. Such an action can be performed at any moment regardless of the current application or user location in that application. For example going back, going home, opening recents, etc.

Note: The global action ids themselves give no information about the current availability of their corresponding actions. To determine if a global action is available, use getSystemActions()

Parameters
action	int: The action to perform.

Returns
boolean	Whether the action was successfully performed. Perform actions using ids like the id constants referenced below:

See also:

• GLOBAL_ACTION_BACK
• GLOBAL_ACTION_HOME
• GLOBAL_ACTION_NOTIFICATIONS
• GLOBAL_ACTION_RECENTS
• GLOBAL_ACTION_DPAD_UP
• GLOBAL_ACTION_DPAD_DOWN
• GLOBAL_ACTION_DPAD_LEFT
• GLOBAL_ACTION_DPAD_RIGHT
• GLOBAL_ACTION_DPAD_CENTER

setAccessibilityFocusAppearance

Added in API level 31

public void setAccessibilityFocusAppearance (int strokeWidth, 
                int color)

Sets the strokeWidth and color of the accessibility focus rectangle.

Note: This setting persists until this or another active AccessibilityService changes it or the device reboots.

Parameters
strokeWidth	int: The stroke width of the rectangle in pixels. Setting this value to zero results in no focus rectangle being drawn.
color	int: The color of the rectangle.

setAnimationScale

Added in API level 33

public void setAnimationScale (float scale)

Sets the system settings values that control the scaling factor for animations. The scale controls the animation playback speed for animations that respect these settings. Animations that do not respect the settings values will not be affected by this function. A lower scale value results in a faster speed. A value of 0 disables animations entirely. When animations are disabled services receive window change events more quickly which can reduce the potential by confusion by reducing the time during which windows are in transition.

Parameters
scale	float: The scaling factor for all animations.

See also:

• AccessibilityEvent.TYPE_WINDOWS_CHANGED
• AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED
• Settings.Global.WINDOW_ANIMATION_SCALE
• Settings.Global.TRANSITION_ANIMATION_SCALE
• Settings.Global.ANIMATOR_DURATION_SCALE

setCacheEnabled

Added in API level 33

public boolean setCacheEnabled (boolean enabled)

Sets the cache status.

If enabled, enable the cache and prefetching. Otherwise, disable the cache and prefetching. Note: By default the cache is enabled.

Parameters
enabled	boolean: whether to enable or disable the cache.

Returns
boolean	true if the cache and connection are not null, so the cache status is set.

setGestureDetectionPassthroughRegion

Added in API level 30

public void setGestureDetectionPassthroughRegion (int displayId, 
                Region region)

When AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, this function requests that touch interactions starting in the specified region of the screen bypass the gesture detector. There can only be one gesture detection passthrough region per display. Requesting a new gesture detection passthrough region clears the existing one. To disable this passthrough and return to the original behavior, pass in an empty region. When AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled this function has no effect.

Parameters
displayId	int: The display on which to set this region.
region	Region: the region of the screen. This value cannot be null.

setServiceInfo

Added in API level 4

public final void setServiceInfo (AccessibilityServiceInfo info)

Sets the AccessibilityServiceInfo that describes this service.

Note: You can call this method any time but the info will be picked up after the system has bound to this service and when this method is called thereafter.

Parameters
info	AccessibilityServiceInfo: The info.

setTouchExplorationPassthroughRegion

Added in API level 30

public void setTouchExplorationPassthroughRegion (int displayId, 
                Region region)

When AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, this function requests that touch interactions starting in the specified region of the screen bypass the touch explorer and go straight to the view hierarchy. There can only be one touch exploration passthrough region per display. Requesting a new touch explorationpassthrough region clears the existing one. To disable this passthrough and return to the original behavior, pass in an empty region. When AccessibilityServiceInfo.FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled this function has no effect.

Parameters
displayId	int: The display on which to set this region.
region	Region: the region of the screen . This value cannot be null.

takeScreenshot

Added in API level 30

public void takeScreenshot (int displayId, 
                Executor executor, 
                AccessibilityService.TakeScreenshotCallback callback)

Takes a screenshot of the specified display and returns it via an AccessibilityService.ScreenshotResult. You can use Bitmap#wrapHardwareBuffer to construct the bitmap from the ScreenshotResult's payload.

Note: In order to take screenshot your service has to declare the capability to take screenshot by setting the R.styleable.AccessibilityService_canTakeScreenshot property in its meta-data. For details refer to SERVICE_META_DATA.

Parameters
displayId	int: The logic display id, must be Display#DEFAULT_DISPLAY for default display.
executor	Executor: Executor on which to run the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	AccessibilityService.TakeScreenshotCallback: The callback invoked when taking screenshot has succeeded or failed. See TakeScreenshotCallback for details. This value cannot be null.

See also:

• takeScreenshotOfWindow(int, Executor, TakeScreenshotCallback)

takeScreenshotOfWindow

Added in API level 34

public void takeScreenshotOfWindow (int accessibilityWindowId, 
                Executor executor, 
                AccessibilityService.TakeScreenshotCallback callback)

Takes a screenshot of the specified window and returns it via an AccessibilityService.ScreenshotResult. You can use Bitmap#wrapHardwareBuffer to construct the bitmap from the ScreenshotResult's payload.

Note: In order to take screenshots your service has to declare the capability to take screenshot by setting the R.styleable.AccessibilityService_canTakeScreenshot property in its meta-data. For details refer to SERVICE_META_DATA.

Both this method and takeScreenshot(int, Executor, TakeScreenshotCallback) can be used for machine learning-based visual screen understanding. Use takeScreenshotOfWindow if your target window might be visually underneath an accessibility overlay (from your or another accessibility service) in order to capture the window contents without the screenshot being covered by the overlay contents drawn on the screen.

Parameters
accessibilityWindowId	int: The window id, from AccessibilityWindowInfo#getId().
executor	Executor: Executor on which to run the callback. This value cannot be null. Callback and listener events are dispatched through this Executor, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor(). Otherwise, provide an Executor that dispatches to an appropriate thread.
callback	AccessibilityService.TakeScreenshotCallback: The callback invoked when taking screenshot has succeeded or failed. See TakeScreenshotCallback for details. This value cannot be null.

See also:

• takeScreenshot(int, Executor, TakeScreenshotCallback)

Protected methods

onGesture

Added in API level 16
Deprecated in API level 30

protected boolean onGesture (int gestureId)

This method was deprecated in API level 30.
Override onGesture(android.accessibilityservice.AccessibilityGestureEvent) instead.

Called by onGesture(android.accessibilityservice.AccessibilityGestureEvent) when the user performs a specific gesture on the default display. Note: To receive gestures an accessibility service must request that the device is in touch exploration mode by setting the AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE flag.

Parameters
gestureId	int: The unique id of the performed gesture.

Returns
boolean	Whether the gesture was handled.

See also:

• GESTURE_SWIPE_UP
• GESTURE_SWIPE_UP_AND_LEFT
• GESTURE_SWIPE_UP_AND_DOWN
• GESTURE_SWIPE_UP_AND_RIGHT
• GESTURE_SWIPE_DOWN
• GESTURE_SWIPE_DOWN_AND_LEFT
• GESTURE_SWIPE_DOWN_AND_UP
• GESTURE_SWIPE_DOWN_AND_RIGHT
• GESTURE_SWIPE_LEFT
• GESTURE_SWIPE_LEFT_AND_UP
• GESTURE_SWIPE_LEFT_AND_RIGHT
• GESTURE_SWIPE_LEFT_AND_DOWN
• GESTURE_SWIPE_RIGHT
• GESTURE_SWIPE_RIGHT_AND_UP
• GESTURE_SWIPE_RIGHT_AND_LEFT
• GESTURE_SWIPE_RIGHT_AND_DOWN

onKeyEvent

Added in API level 18

protected boolean onKeyEvent (KeyEvent event)

Callback that allows an accessibility service to observe the key events before they are passed to the rest of the system. This means that the events are first delivered here before they are passed to the device policy, the input method, or applications.

Note: It is important that key events are handled in such a way that the event stream that would be passed to the rest of the system is well-formed. For example, handling the down event but not the up event and vice versa would generate an inconsistent event stream.

Note: The key events delivered in this method are copies and modifying them will have no effect on the events that will be passed to the system. This method is intended to perform purely filtering functionality.

Parameters
event	KeyEvent: The event to be processed. This event is owned by the caller and cannot be used after this method returns. Services wishing to use the event after this method returns should make a copy.

Returns
boolean	If true then the event will be consumed and not delivered to applications, otherwise it will be delivered as usual.

onServiceConnected

Added in API level 4

protected void onServiceConnected ()

This method is a part of the AccessibilityService lifecycle and is called after the system has successfully bound to the service. If is convenient to use this method for setting the AccessibilityServiceInfo.

See also:

• AccessibilityServiceInfo
• setServiceInfo(AccessibilityServiceInfo)