Added in API level 4

AccessibilityService


abstract class AccessibilityService : Service
kotlin.Any
   ↳ 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.

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:

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:

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

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

Feedback types

Summary

Nested classes
abstract

Class used to report status of dispatched gestures

Used to control and query the state of display magnification.

Can be used to construct a bitmap of the screenshot or any other operations for AccessibilityService#takeScreenshot API.

Used to control, query, and listen for changes to the soft keyboard show mode.

abstract

Interface used to report status of taking screenshot.

Constants
static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

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

static Int

The user has performed an unrecognized gesture on the touch screen.

static Int

Action to show Launcher's all apps.

static Int

Action to trigger the Accessibility Button

static Int

Action to bring up the Accessibility Button's chooser menu

static Int

Action to trigger the Accessibility Shortcut.

static Int

Action to go back.

static Int

Action to dismiss the notification shade

static Int

Action to trigger dpad center keyevent.

static Int

Action to trigger dpad down keyevent.

static Int

Action to trigger dpad left keyevent.

static Int

Action to trigger dpad right keyevent.

static Int

Action to trigger dpad up keyevent.

static Int

Action to go home.

static Int

Action to send the KEYCODE_HEADSETHOOK KeyEvent, which is used to answer and hang up calls and play and stop media.

static Int

Action to lock the screen

static Int

Action to open the notifications.

static Int

Action to open the power long-press dialog.

static Int

Action to open the quick settings.

static Int

Action to toggle showing the overview of recent apps.

static Int

Action to take a screenshot

static Int

Action to toggle docking the current app's window.

static String

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

static String

Name under which an AccessibilityService component publishes information about itself.

static Int

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

static Int

Never show the soft keyboard.

static Int

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

Inherited constants
Public constructors

Public methods
open Unit

Attaches a android.view.SurfaceControl containing an accessibility overlay to the specified display.

open Unit

Attaches an accessibility overlay android.view.SurfaceControl to the specified window.

open Boolean

Clears the cache.

open Boolean

Invalidates node and its subtree in the cache.

open Context

Returns a new Context object from the current context but with resources adjusted to match the metrics of display.

open Context
createWindowContext(type: Int, options: Bundle?)

Creates a Context for a non-activity window.

open Context
createWindowContext(display: Display, type: Int, options: Bundle?)

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

Unit

Disables the service.

Boolean

Dispatch a gesture to the touch screen.

open AccessibilityNodeInfo!
findFocus(focus: Int)

Find the view that has the specified focus type.

AccessibilityButtonController

Returns the controller for the accessibility button within the system's navigation area.

AccessibilityButtonController

Returns the controller of specified logical display for the accessibility button within the system's navigation area.

BrailleDisplayController

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

FingerprintGestureController

Get the controller for fingerprint gestures.

InputMethod?

Returns the InputMethod instance after the system calls onCreateInputMethod(), which may be used to input text or get editable text selection change notifications.

AccessibilityService.MagnificationController

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

open AccessibilityNodeInfo!

Gets the root node in the currently active window if this service can retrieve window content.

open AccessibilityNodeInfo?
getRootInActiveWindow(prefetchingStrategy: Int)

Gets the root node in the currently active window if this service can retrieve window content.

AccessibilityServiceInfo!

Gets the an AccessibilityServiceInfo describing this AccessibilityService.

AccessibilityService.SoftKeyboardController

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

MutableList<AccessibilityNodeInfo.AccessibilityAction!>

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

open Any!

Return the handle to a system-level service by name.

TouchInteractionController

Returns the touch interaction controller for the specified logical display, which may be used to detect gestures and otherwise control touch interactions.

open MutableList<AccessibilityWindowInfo!>!

Gets the windows on the screen of the default display.

SparseArray<MutableList<AccessibilityWindowInfo!>!>

Gets the windows on the screen of all displays.

open Boolean

Returns true if the cache is enabled.

open Boolean

Checks if node is in the cache.

abstract Unit

Callback for android.view.accessibility.AccessibilityEvents.

IBinder?
onBind(intent: Intent!)

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

open InputMethod

The default implementation returns our default InputMethod.

open Boolean

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

abstract Unit

Callback for interrupting the accessibility feedback.

open Unit

Callback that allows an accessibility service to observe generic MotionEvents.

open Unit

This is called when the system action list is changed.

Boolean

Performs a global action.

open Unit
setAccessibilityFocusAppearance(strokeWidth: Int, color: Int)

Sets the strokeWidth and color of the accessibility focus rectangle.

open Unit

Sets the system settings values that control the scaling factor for animations.

open Boolean

Sets the cache status.

open Unit

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.

Unit

Sets the AccessibilityServiceInfo that describes this service.

open Unit

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.

open Unit

Takes a screenshot of the specified display and returns it via an AccessibilityService.ScreenshotResult.

open Unit
takeScreenshotOfWindow(accessibilityWindowId: Int, executor: Executor, callback: AccessibilityService.TakeScreenshotCallback)

Takes a screenshot of the specified window and returns it via an AccessibilityService.ScreenshotResult.

Protected methods
open Boolean
onGesture(gestureId: Int)

Called by onGesture(android.accessibilityservice.AccessibilityGestureEvent) when the user performs a specific gesture on the default display.

open Boolean

Callback that allows an accessibility service to observe the key events before they are passed to the rest of the system.

open Unit

This method is a part of the AccessibilityService lifecycle and is called after the system has successfully bound to the service.

Inherited functions

Constants

ERROR_TAKE_SCREENSHOT_INTERNAL_ERROR

Added in API level 30
static val ERROR_TAKE_SCREENSHOT_INTERNAL_ERROR: Int

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

Value: 1

ERROR_TAKE_SCREENSHOT_INTERVAL_TIME_SHORT

Added in API level 30
static val ERROR_TAKE_SCREENSHOT_INTERVAL_TIME_SHORT: Int

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

Value: 3

ERROR_TAKE_SCREENSHOT_INVALID_DISPLAY

Added in API level 30
static val ERROR_TAKE_SCREENSHOT_INVALID_DISPLAY: Int

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

Value: 4

ERROR_TAKE_SCREENSHOT_INVALID_WINDOW

Added in API level 34
static val ERROR_TAKE_SCREENSHOT_INVALID_WINDOW: Int

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

Value: 5

ERROR_TAKE_SCREENSHOT_NO_ACCESSIBILITY_ACCESS

Added in API level 30
static val ERROR_TAKE_SCREENSHOT_NO_ACCESSIBILITY_ACCESS: Int

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

Value: 2

ERROR_TAKE_SCREENSHOT_SECURE_WINDOW

Added in API level 34
static val ERROR_TAKE_SCREENSHOT_SECURE_WINDOW: Int

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

Value: 6

GESTURE_2_FINGER_DOUBLE_TAP

Added in API level 30
static val GESTURE_2_FINGER_DOUBLE_TAP: Int

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

Value: 20

GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30
static val GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD: Int

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

Value: 40

GESTURE_2_FINGER_SINGLE_TAP

Added in API level 30
static val GESTURE_2_FINGER_SINGLE_TAP: Int

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

Value: 19

GESTURE_2_FINGER_SWIPE_DOWN

Added in API level 30
static val GESTURE_2_FINGER_SWIPE_DOWN: Int

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

Value: 26

GESTURE_2_FINGER_SWIPE_LEFT

Added in API level 30
static val GESTURE_2_FINGER_SWIPE_LEFT: Int

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

Value: 27

GESTURE_2_FINGER_SWIPE_RIGHT

Added in API level 30
static val GESTURE_2_FINGER_SWIPE_RIGHT: Int

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

Value: 28

GESTURE_2_FINGER_SWIPE_UP

Added in API level 30
static val GESTURE_2_FINGER_SWIPE_UP: Int

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

Value: 25

GESTURE_2_FINGER_TRIPLE_TAP

Added in API level 30
static val GESTURE_2_FINGER_TRIPLE_TAP: Int

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

Value: 21

GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD

Added in API level 31
static val GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD: Int

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

Value: 43

GESTURE_3_FINGER_DOUBLE_TAP

Added in API level 30
static val GESTURE_3_FINGER_DOUBLE_TAP: Int

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

Value: 23

GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30
static val GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD: Int

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

Value: 41

GESTURE_3_FINGER_SINGLE_TAP

Added in API level 30
static val GESTURE_3_FINGER_SINGLE_TAP: Int

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

Value: 22

GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD

Added in API level 31
static val GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD: Int

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

Value: 44

GESTURE_3_FINGER_SWIPE_DOWN

Added in API level 30
static val GESTURE_3_FINGER_SWIPE_DOWN: Int

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

Value: 30

GESTURE_3_FINGER_SWIPE_LEFT

Added in API level 30
static val GESTURE_3_FINGER_SWIPE_LEFT: Int

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

Value: 31

GESTURE_3_FINGER_SWIPE_RIGHT

Added in API level 30
static val GESTURE_3_FINGER_SWIPE_RIGHT: Int

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

Value: 32

GESTURE_3_FINGER_SWIPE_UP

Added in API level 30
static val GESTURE_3_FINGER_SWIPE_UP: Int

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

Value: 29

GESTURE_3_FINGER_TRIPLE_TAP

Added in API level 30
static val GESTURE_3_FINGER_TRIPLE_TAP: Int

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

Value: 24

GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD

Added in API level 31
static val GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD: Int

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

Value: 45

GESTURE_4_FINGER_DOUBLE_TAP

Added in API level 30
static val GESTURE_4_FINGER_DOUBLE_TAP: Int

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

Value: 38

GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD

Added in API level 30
static val GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD: Int

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

Value: 42

GESTURE_4_FINGER_SINGLE_TAP

Added in API level 30
static val GESTURE_4_FINGER_SINGLE_TAP: Int

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

Value: 37

GESTURE_4_FINGER_SWIPE_DOWN

Added in API level 30
static val GESTURE_4_FINGER_SWIPE_DOWN: Int

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

Value: 34

GESTURE_4_FINGER_SWIPE_LEFT

Added in API level 30
static val GESTURE_4_FINGER_SWIPE_LEFT: Int

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

Value: 35

GESTURE_4_FINGER_SWIPE_RIGHT

Added in API level 30
static val GESTURE_4_FINGER_SWIPE_RIGHT: Int

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

Value: 36

GESTURE_4_FINGER_SWIPE_UP

Added in API level 30
static val GESTURE_4_FINGER_SWIPE_UP: Int

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

Value: 33

GESTURE_4_FINGER_TRIPLE_TAP

Added in API level 30
static val GESTURE_4_FINGER_TRIPLE_TAP: Int

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

Value: 39

GESTURE_DOUBLE_TAP

Added in API level 30
static val GESTURE_DOUBLE_TAP: Int

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

Value: 17

GESTURE_DOUBLE_TAP_AND_HOLD

Added in API level 30
static val GESTURE_DOUBLE_TAP_AND_HOLD: Int

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

Value: 18

GESTURE_SWIPE_DOWN

Added in API level 16
static val GESTURE_SWIPE_DOWN: Int

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

Value: 2

GESTURE_SWIPE_DOWN_AND_LEFT

Added in API level 16
static val GESTURE_SWIPE_DOWN_AND_LEFT: Int

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

Value: 15

GESTURE_SWIPE_DOWN_AND_RIGHT

Added in API level 16
static val GESTURE_SWIPE_DOWN_AND_RIGHT: Int

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

Value: 16

GESTURE_SWIPE_DOWN_AND_UP

Added in API level 16
static val GESTURE_SWIPE_DOWN_AND_UP: Int

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

Value: 8

GESTURE_SWIPE_LEFT

Added in API level 16
static val GESTURE_SWIPE_LEFT: Int

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

Value: 3

GESTURE_SWIPE_LEFT_AND_DOWN

Added in API level 16
static val GESTURE_SWIPE_LEFT_AND_DOWN: Int

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

Value: 10

GESTURE_SWIPE_LEFT_AND_RIGHT

Added in API level 16
static val GESTURE_SWIPE_LEFT_AND_RIGHT: Int

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

Value: 5

GESTURE_SWIPE_LEFT_AND_UP

Added in API level 16
static val GESTURE_SWIPE_LEFT_AND_UP: Int

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

Value: 9

GESTURE_SWIPE_RIGHT

Added in API level 16
static val GESTURE_SWIPE_RIGHT: Int

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

Value: 4

GESTURE_SWIPE_RIGHT_AND_DOWN

Added in API level 16
static val GESTURE_SWIPE_RIGHT_AND_DOWN: Int

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

Value: 12

GESTURE_SWIPE_RIGHT_AND_LEFT

Added in API level 16
static val GESTURE_SWIPE_RIGHT_AND_LEFT: Int

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

Value: 6

GESTURE_SWIPE_RIGHT_AND_UP

Added in API level 16
static val GESTURE_SWIPE_RIGHT_AND_UP: Int

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

Value: 11

GESTURE_SWIPE_UP

Added in API level 16
static val GESTURE_SWIPE_UP: Int

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

Value: 1

GESTURE_SWIPE_UP_AND_DOWN

Added in API level 16
static val GESTURE_SWIPE_UP_AND_DOWN: Int

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

Value: 7

GESTURE_SWIPE_UP_AND_LEFT

Added in API level 16
static val GESTURE_SWIPE_UP_AND_LEFT: Int

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

Value: 13

GESTURE_SWIPE_UP_AND_RIGHT

Added in API level 16
static val GESTURE_SWIPE_UP_AND_RIGHT: Int

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

Value: 14

GESTURE_UNKNOWN

Added in API level 31
static val GESTURE_UNKNOWN: Int

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

Value: 0

GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS

Added in API level 31
static val GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS: Int

Action to show Launcher's all apps.

Value: 14

GLOBAL_ACTION_ACCESSIBILITY_BUTTON

Added in API level 31
static val GLOBAL_ACTION_ACCESSIBILITY_BUTTON: Int

Action to trigger the Accessibility Button

Value: 11

GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER

Added in API level 31
static val GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER: Int

Action to bring up the Accessibility Button's chooser menu

Value: 12

GLOBAL_ACTION_ACCESSIBILITY_SHORTCUT

Added in API level 31
static val GLOBAL_ACTION_ACCESSIBILITY_SHORTCUT: Int

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

Value: 13

GLOBAL_ACTION_BACK

Added in API level 16
static val GLOBAL_ACTION_BACK: Int

Action to go back.

Value: 1

GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE

Added in API level 31
static val GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE: Int

Action to dismiss the notification shade

Value: 15

GLOBAL_ACTION_DPAD_CENTER

Added in API level 33
static val GLOBAL_ACTION_DPAD_CENTER: Int

Action to trigger dpad center keyevent.

Value: 20

GLOBAL_ACTION_DPAD_DOWN

Added in API level 33
static val GLOBAL_ACTION_DPAD_DOWN: Int

Action to trigger dpad down keyevent.

Value: 17

GLOBAL_ACTION_DPAD_LEFT

Added in API level 33
static val GLOBAL_ACTION_DPAD_LEFT: Int

Action to trigger dpad left keyevent.

Value: 18

GLOBAL_ACTION_DPAD_RIGHT

Added in API level 33
static val GLOBAL_ACTION_DPAD_RIGHT: Int

Action to trigger dpad right keyevent.

Value: 19

GLOBAL_ACTION_DPAD_UP

Added in API level 33
static val GLOBAL_ACTION_DPAD_UP: Int

Action to trigger dpad up keyevent.

Value: 16

GLOBAL_ACTION_HOME

Added in API level 16
static val GLOBAL_ACTION_HOME: Int

Action to go home.

Value: 2

GLOBAL_ACTION_KEYCODE_HEADSETHOOK

Added in API level 31
static val GLOBAL_ACTION_KEYCODE_HEADSETHOOK: Int

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.

Value: 10

GLOBAL_ACTION_LOCK_SCREEN

Added in API level 28
static val GLOBAL_ACTION_LOCK_SCREEN: Int

Action to lock the screen

Value: 8

GLOBAL_ACTION_NOTIFICATIONS

Added in API level 16
static val GLOBAL_ACTION_NOTIFICATIONS: Int

Action to open the notifications.

Value: 4

GLOBAL_ACTION_POWER_DIALOG

Added in API level 21
static val GLOBAL_ACTION_POWER_DIALOG: Int

Action to open the power long-press dialog.

Value: 6

GLOBAL_ACTION_QUICK_SETTINGS

Added in API level 17
static val GLOBAL_ACTION_QUICK_SETTINGS: Int

Action to open the quick settings.

Value: 5

GLOBAL_ACTION_RECENTS

Added in API level 16
static val GLOBAL_ACTION_RECENTS: Int

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

Value: 3

GLOBAL_ACTION_TAKE_SCREENSHOT

Added in API level 28
static val GLOBAL_ACTION_TAKE_SCREENSHOT: Int

Action to take a screenshot

Value: 9

GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN

Added in API level 24
static val GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN: Int

Action to toggle docking the current app's window.

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

Value: 7

SERVICE_INTERFACE

Added in API level 4
static val SERVICE_INTERFACE: String

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

Value: "android.accessibilityservice.AccessibilityService"

SERVICE_META_DATA

Added in API level 14
static val SERVICE_META_DATA: String

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"
      . . .
  />

Value: "android.accessibilityservice"

SHOW_MODE_AUTO

Added in API level 24
static val SHOW_MODE_AUTO: Int

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

Value: 0

SHOW_MODE_HIDDEN

Added in API level 24
static val SHOW_MODE_HIDDEN: Int

Never show the soft keyboard.

Value: 1

SHOW_MODE_IGNORE_HARD_KEYBOARD

Added in API level 29
static val SHOW_MODE_IGNORE_HARD_KEYBOARD: Int

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

Value: 2

Public constructors

AccessibilityService

AccessibilityService()

Public methods

attachAccessibilityOverlayToDisplay

Added in API level 34
open fun attachAccessibilityOverlayToDisplay(
    displayId: Int,
    sc: SurfaceControl
): Unit

Attaches a android.view.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 android.view.View. To embed the View into a android.view.SurfaceControl, create a and attach the View using android.view.SurfaceControlViewHost#setView. 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
open fun attachAccessibilityOverlayToWindow(
    accessibilityWindowId: Int,
    sc: SurfaceControl
): Unit

Attaches an accessibility overlay android.view.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 android.view.View. To embed the View into a android.view.SurfaceControl, create a and attach the View using android.view.SurfaceControlViewHost#setView. 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
open fun clearCache(): Boolean

Clears the cache.

Return
Boolean true if the cache was cleared

clearCachedSubtree

Added in API level 33
open fun clearCachedSubtree(node: AccessibilityNodeInfo): Boolean

Invalidates node and its subtree in the cache.

Parameters
node AccessibilityNodeInfo: the node to invalidate. This value cannot be null.
Return
Boolean true if the subtree rooted at node was invalidated.

createDisplayContext

Added in API level 17
open fun createDisplayContext(display: Display): Context

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 android.hardware.display.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.
Return
Context This value cannot be null.

createWindowContext

Added in API level 30
open fun createWindowContext(
    type: Int,
    options: Bundle?
): Context

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 android.view.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 android.view.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. Note that window context only propagate ComponentCallbacks#onConfigurationChanged(Configuration) callback. ComponentCallbacks#onLowMemory() or other callbacks in ComponentCallbacks2 won't be invoked.

Note that using android.app.Application or android.app.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 android.view.WindowManager.LayoutParams#TYPE_BASE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_STARTING, android.view.WindowManager.LayoutParams#TYPE_DRAWN_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_MEDIA, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_STATUS_BAR, android.view.WindowManager.LayoutParams#TYPE_SEARCH_BAR, android.view.WindowManager.LayoutParams#TYPE_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, android.view.WindowManager.LayoutParams#TYPE_TOAST, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIORITY_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_DIALOG, android.view.WindowManager.LayoutParams#TYPE_KEYGUARD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ERROR, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD_DIALOG, android.view.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, android.view.WindowManager.LayoutParams#TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, android.view.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, android.view.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.
Return
Context This value cannot be null.
Exceptions
java.lang.UnsupportedOperationException if this Context does not attach to a display, such as Application or Service.

createWindowContext

Added in API level 31
open fun createWindowContext(
    display: Display,
    type: Int,
    options: Bundle?
): Context

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 android.view.WindowManager.LayoutParams#TYPE_BASE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_STARTING, android.view.WindowManager.LayoutParams#TYPE_DRAWN_APPLICATION, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_MEDIA, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_APPLICATION_ATTACHED_DIALOG, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY, android.view.WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL, android.view.WindowManager.LayoutParams#TYPE_STATUS_BAR, android.view.WindowManager.LayoutParams#TYPE_SEARCH_BAR, android.view.WindowManager.LayoutParams#TYPE_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ALERT, android.view.WindowManager.LayoutParams.TYPE_KEYGUARD, android.view.WindowManager.LayoutParams#TYPE_TOAST, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_OVERLAY, android.view.WindowManager.LayoutParams#TYPE_PRIORITY_PHONE, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_DIALOG, android.view.WindowManager.LayoutParams#TYPE_KEYGUARD_DIALOG, android.view.WindowManager.LayoutParams#TYPE_SYSTEM_ERROR, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD, android.view.WindowManager.LayoutParams#TYPE_INPUT_METHOD_DIALOG, android.view.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, android.view.WindowManager.LayoutParams#TYPE_PRIVATE_PRESENTATION, android.view.WindowManager.LayoutParams.TYPE_VOICE_INTERACTION, android.view.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, android.view.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.
Return
Context This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the Display is null.

disableSelf

Added in API level 24
fun disableSelf(): Unit

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
fun dispatchGesture(
    gesture: GestureDescription,
    callback: AccessibilityService.GestureResultCallback?,
    handler: Handler?
): Boolean

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 android.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:

<code>
      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);
      }
 </code>
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.
Return
Boolean true if the gesture is dispatched, false if not.

findFocus

Added in API level 21
open fun findFocus(focus: Int): AccessibilityNodeInfo!

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 android.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 android.view.SurfaceView via android.view.SurfaceView#setChildSurfacePackage, 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.
Return
AccessibilityNodeInfo! The node info of the focused view or null.

getAccessibilityButtonController

Added in API level 26
fun getAccessibilityButtonController(): AccessibilityButtonController

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.

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

getAccessibilityButtonController

Added in API level 30
fun getAccessibilityButtonController(displayId: Int): AccessibilityButtonController

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.
Return
AccessibilityButtonController the accessibility button controller for this AccessibilityService This value cannot be null.

getBrailleDisplayController

Added in API level 35
fun getBrailleDisplayController(): BrailleDisplayController

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

Return
BrailleDisplayController This value cannot be null.

getFingerprintGestureController

Added in API level 26
fun getFingerprintGestureController(): FingerprintGestureController

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

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

getInputMethod

Added in API level 33
fun getInputMethod(): InputMethod?

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().

Return
InputMethod? the InputMethod instance

getMagnificationController

Added in API level 24
fun getMagnificationController(): AccessibilityService.MagnificationController

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 android.R.styleable#AccessibilityService_canControlMagnification property in its meta-data. For more information, see SERVICE_META_DATA.

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

getRootInActiveWindow

Added in API level 16
open fun getRootInActiveWindow(): AccessibilityNodeInfo!

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 android.R.styleable#AccessibilityService_canRetrieveWindowContent property in its meta-data. For details refer to SERVICE_META_DATA.

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

getRootInActiveWindow

Added in API level 33
open fun getRootInActiveWindow(prefetchingStrategy: Int): AccessibilityNodeInfo?

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 android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_ANCESTORS, android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_SIBLINGS, android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_DESCENDANTS_HYBRID, android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST, android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST, and android.view.accessibility.AccessibilityNodeInfo#FLAG_PREFETCH_UNINTERRUPTIBLE
Return
AccessibilityNodeInfo? The root node if this service can retrieve window content. This value may be null.

getServiceInfo

Added in API level 16
fun getServiceInfo(): AccessibilityServiceInfo!

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

Return
AccessibilityServiceInfo! The accessibility service info.

getSoftKeyboardController

Added in API level 24
fun getSoftKeyboardController(): AccessibilityService.SoftKeyboardController

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

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

getSystemActions

Added in API level 30
fun getSystemActions(): MutableList<AccessibilityNodeInfo.AccessibilityAction!>

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.

Return
MutableList<AccessibilityNodeInfo.AccessibilityAction!> A list of available system actions. This value cannot be null.

getSystemService

Added in API level 4
open fun getSystemService(name: String): Any!

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 android.view.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 android.view.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 android.app.ActivityManager for interacting with the global activity state of the system.
WALLPAPER_SERVICE ("wallpaper")
A android.service.wallpaper.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 android.os.PowerManager for controlling power management.
ALARM_SERVICE ("alarm")
A android.app.AlarmManager for receiving intents at the time of your choosing.
NOTIFICATION_SERVICE ("notification")
A android.app.NotificationManager for informing the user of background events.
KEYGUARD_SERVICE ("keyguard")
A android.app.KeyguardManager for controlling keyguard.
LOCATION_SERVICE ("location")
A android.location.LocationManager for controlling location (e.g., GPS) updates.
SEARCH_SERVICE ("search")
A android.app.SearchManager for handling search.
VIBRATOR_MANAGER_SERVICE ("vibrator_manager")
A android.os.VibratorManager for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
VIBRATOR_SERVICE ("vibrator")
A android.os.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 android.app.UiModeManager for controlling UI modes.
DOWNLOAD_SERVICE ("download")
A android.app.DownloadManager for requesting HTTP downloads
BATTERY_SERVICE ("batterymanager")
A android.os.BatteryManager for managing battery state
JOB_SCHEDULER_SERVICE ("taskmanager")
A android.app.job.JobScheduler for managing scheduled tasks
NETWORK_STATS_SERVICE ("netstats")
A NetworkStatsManager for querying network usage statistics.
HARDWARE_PROPERTIES_SERVICE ("hardware_properties")
A android.os.HardwarePropertiesManager for accessing hardware properties.
DOMAIN_VERIFICATION_SERVICE ("domain_verification")
A android.content.pm.verify.domain.DomainVerificationManager for accessing web domain approval state.
DISPLAY_HASH_SERVICE ("display_hash")
A android.view.displayhash.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 android.content.Context#POWER_SERVICE, android.content.Context#WINDOW_SERVICE, android.content.Context#LAYOUT_INFLATER_SERVICE, android.content.Context#ACCOUNT_SERVICE, android.content.Context#ACTIVITY_SERVICE, android.content.Context#ALARM_SERVICE, android.content.Context#NOTIFICATION_SERVICE, android.content.Context#ACCESSIBILITY_SERVICE, android.content.Context#CAPTIONING_SERVICE, android.content.Context#KEYGUARD_SERVICE, android.content.Context#LOCATION_SERVICE, android.content.Context#HEALTHCONNECT_SERVICE, android.content.Context#SEARCH_SERVICE, android.content.Context#SENSOR_SERVICE, android.content.Context.SENSOR_PRIVACY_SERVICE, android.content.Context#STORAGE_SERVICE, android.content.Context#STORAGE_STATS_SERVICE, android.content.Context#WALLPAPER_SERVICE, android.content.Context#VIBRATOR_MANAGER_SERVICE, android.content.Context#VIBRATOR_SERVICE, android.content.Context.THREAD_NETWORK_SERVICE, android.content.Context#CONNECTIVITY_SERVICE, android.content.Context.PAC_PROXY_SERVICE, android.content.Context.VCN_MANAGEMENT_SERVICE, android.content.Context#IPSEC_SERVICE, android.content.Context#VPN_MANAGEMENT_SERVICE, android.content.Context.TEST_NETWORK_SERVICE, android.content.Context#NETWORK_STATS_SERVICE, android.content.Context#WIFI_SERVICE, android.content.Context#WIFI_AWARE_SERVICE, android.content.Context#WIFI_P2P_SERVICE, android.content.Context.WIFI_SCANNING_SERVICE, android.content.Context#WIFI_RTT_RANGING_SERVICE, android.content.Context#NSD_SERVICE, android.content.Context#AUDIO_SERVICE, android.content.Context.AUDIO_DEVICE_VOLUME_SERVICE, android.content.Context.AUTH_SERVICE, android.content.Context#FINGERPRINT_SERVICE, android.content.Context#BIOMETRIC_SERVICE, android.content.Context#MEDIA_ROUTER_SERVICE, android.content.Context#TELEPHONY_SERVICE, android.content.Context#TELEPHONY_SUBSCRIPTION_SERVICE, android.content.Context#CARRIER_CONFIG_SERVICE, android.content.Context#EUICC_SERVICE, android.content.Context#TELECOM_SERVICE, android.content.Context#CLIPBOARD_SERVICE, android.content.Context#INPUT_METHOD_SERVICE, android.content.Context#TEXT_SERVICES_MANAGER_SERVICE, android.content.Context#TEXT_CLASSIFICATION_SERVICE, android.content.Context#APPWIDGET_SERVICE, android.content.Context.REBOOT_READINESS_SERVICE, android.content.Context.ROLLBACK_SERVICE, android.content.Context#DROPBOX_SERVICE, android.content.Context#DEVICE_POLICY_SERVICE, android.content.Context#UI_MODE_SERVICE, android.content.Context#DOWNLOAD_SERVICE, android.content.Context#NFC_SERVICE, android.content.Context#BLUETOOTH_SERVICE, android.content.Context#USB_SERVICE, android.content.Context#LAUNCHER_APPS_SERVICE, android.content.Context#INPUT_SERVICE, android.content.Context#DISPLAY_SERVICE, android.content.Context#USER_SERVICE, android.content.Context#RESTRICTIONS_SERVICE, android.content.Context#APP_OPS_SERVICE, android.content.Context#ROLE_SERVICE, android.content.Context#CAMERA_SERVICE, android.content.Context#PRINT_SERVICE, android.content.Context#CONSUMER_IR_SERVICE, android.content.Context#TV_INTERACTIVE_APP_SERVICE, android.content.Context#TV_INPUT_SERVICE, android.content.Context#USAGE_STATS_SERVICE, android.content.Context#MEDIA_SESSION_SERVICE, android.content.Context#MEDIA_COMMUNICATION_SERVICE, android.content.Context#BATTERY_SERVICE, android.content.Context#JOB_SCHEDULER_SERVICE, android.content.Context#PERSISTENT_DATA_BLOCK_SERVICE, android.content.Context#MEDIA_PROJECTION_SERVICE, android.content.Context#MIDI_SERVICE, android.content.Context.RADIO_SERVICE, android.content.Context#HARDWARE_PROPERTIES_SERVICE, android.content.Context#SHORTCUT_SERVICE, android.content.Context#SYSTEM_HEALTH_SERVICE, android.content.Context#COMPANION_DEVICE_SERVICE, android.content.Context#VIRTUAL_DEVICE_SERVICE, android.content.Context#CROSS_PROFILE_APPS_SERVICE, android.content.Context.PERMISSION_SERVICE, android.content.Context.LIGHTS_SERVICE, android.content.Context#LOCALE_SERVICE, android.content.Context.UWB_SERVICE, android.content.Context#MEDIA_METRICS_SERVICE, android.content.Context#DISPLAY_HASH_SERVICE, android.content.Context#CREDENTIAL_SERVICE, android.content.Context#DEVICE_LOCK_SERVICE, android.content.Context.VIRTUALIZATION_SERVICE, android.content.Context#GRAMMATICAL_INFLECTION_SERVICE, android.content.Context#SECURITY_STATE_SERVICE, or android.content.Context#CONTACT_KEYS_SERVICE This value cannot be null.
Return
Any! The service or null if the name does not exist.

getTouchInteractionController

Added in API level 33
fun getTouchInteractionController(displayId: Int): TouchInteractionController

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.
Return
TouchInteractionController the TouchExploration controller This value cannot be null.

getWindows

Added in API level 21
open fun getWindows(): MutableList<AccessibilityWindowInfo!>!

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

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

getWindowsOnAllDisplays

Added in API level 30
fun getWindowsOnAllDisplays(): SparseArray<MutableList<AccessibilityWindowInfo!>!>

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

Return
SparseArray<MutableList<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
open fun isCacheEnabled(): Boolean

Returns true if the cache is enabled.

isNodeInCache

Added in API level 33
open fun isNodeInCache(node: AccessibilityNodeInfo): Boolean

Checks if node is in the cache.

Parameters
node AccessibilityNodeInfo: the node to check. This value cannot be null.
Return
Boolean true if node is in the cache.

onAccessibilityEvent

Added in API level 4
abstract fun onAccessibilityEvent(event: AccessibilityEvent!): Unit

Callback for android.view.accessibility.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
fun onBind(intent: Intent!): IBinder?

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 android.content.Context#bindService. Note that any extras that were included with the Intent at that point will not be seen here.
Return
IBinder? Return an IBinder through which clients can call on to the service.

onCreateInputMethod

Added in API level 33
open fun onCreateInputMethod(): InputMethod

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.

Return
InputMethod the InputMethod. This value cannot be null.

onGesture

Added in API level 30
open fun onGesture(gestureEvent: AccessibilityGestureEvent): Boolean

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.
Return
Boolean Whether the gesture was handled.

onInterrupt

Added in API level 4
abstract fun onInterrupt(): Unit

Callback for interrupting the accessibility feedback.

onMotionEvent

Added in API level 34
open fun onMotionEvent(event: MotionEvent): Unit

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 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
open fun onSystemActionsChanged(): Unit

This is called when the system action list is changed.

performGlobalAction

Added in API level 16
fun performGlobalAction(action: Int): Boolean

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.
Return
Boolean Whether the action was successfully performed. Perform actions using ids like the id constants referenced below:

setAccessibilityFocusAppearance

Added in API level 31
open fun setAccessibilityFocusAppearance(
    strokeWidth: Int,
    color: Int
): Unit

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
open fun setAnimationScale(scale: Float): Unit

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.

setCacheEnabled

Added in API level 33
open fun setCacheEnabled(enabled: Boolean): Boolean

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.
Return
Boolean true if the cache and connection are not null, so the cache status is set.

setGestureDetectionPassthroughRegion

Added in API level 30
open fun setGestureDetectionPassthroughRegion(
    displayId: Int,
    region: Region
): Unit

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
fun setServiceInfo(info: AccessibilityServiceInfo!): Unit

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
open fun setTouchExplorationPassthroughRegion(
    displayId: Int,
    region: Region
): Unit

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 android.accessibilityservice.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
open fun takeScreenshot(
    displayId: Int,
    executor: Executor,
    callback: AccessibilityService.TakeScreenshotCallback
): Unit

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

takeScreenshotOfWindow

Added in API level 34
open fun takeScreenshotOfWindow(
    accessibilityWindowId: Int,
    executor: Executor,
    callback: AccessibilityService.TakeScreenshotCallback
): Unit

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 android.R.styleable#AccessibilityService_canTakeScreenshot property in its meta-data. For details refer to SERVICE_META_DATA.

Both this method and takeScreenshot 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

Protected methods

onGesture

Added in API level 16
Deprecated in API level 30
protected open fun onGesture(gestureId: Int): Boolean

Deprecated: 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.
Return
Boolean Whether the gesture was handled.

onKeyEvent

Added in API level 18
protected open fun onKeyEvent(event: KeyEvent!): Boolean

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.
Return
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 open fun onServiceConnected(): Unit

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.