# Print output for @column tags ?>
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 AccessibilityEvent
s 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.
For more information about creating AccessibilityServices, read the Accessibility developer guide.
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()
.
An accessibility is declared as any other service in an AndroidManifest.xml, but it must do two things:
Intent
.
Manifest.permission.BIND_ACCESSIBILITY_SERVICE
permission to
ensure that only the system can bind to it.
<service android:name=".MyAccessibilityService" android:permission="android.permission.BIND_ACCESSIBILITY_SERVICE"> <intent-filter> <action android:name="android.accessibilityservice.AccessibilityService" /> </intent-filter> . . . </service>
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:
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
>
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
.
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.
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.
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
AccessibilityServiceInfo#FEEDBACK_AUDIBLE
AccessibilityServiceInfo#FEEDBACK_HAPTIC
AccessibilityServiceInfo#FEEDBACK_AUDIBLE
AccessibilityServiceInfo#FEEDBACK_VISUAL
AccessibilityServiceInfo#FEEDBACK_GENERIC
AccessibilityServiceInfo#FEEDBACK_BRAILLE
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
|
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_NO_ACCESSIBILITY_ACCESS
The status of taking screenshot is failure and the reason is no accessibility access. |
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 an down and left gesture on the touch screen. |
int |
GESTURE_SWIPE_DOWN_AND_RIGHT
The user has performed an 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_HOME
Action to go home. |
int |
GLOBAL_ACTION_KEYCODE_HEADSETHOOK
Action to send the KEYCODE_HEADSETHOOK KeyEvent, which is used to answer/hang up calls and play/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 |
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 |
---|
Public constructors | |
---|---|
AccessibilityService()
|
Public methods | |
---|---|
Context
|
createDisplayContext(Display display)
Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display. |
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
FingerprintGestureController
|
getFingerprintGestureController()
Get the controller for fingerprint gestures. |
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. |
final
AccessibilityServiceInfo
|
getServiceInfo()
Gets the an |
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. |
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. |
abstract
void
|
onAccessibilityEvent(AccessibilityEvent event)
Callback for |
final
IBinder
|
onBind(Intent intent)
Implement to return the implementation of the internal accessibility service interface. |
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
|
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
|
setGestureDetectionPassthroughRegion(int displayId, Region region)
When |
final
void
|
setServiceInfo(AccessibilityServiceInfo info)
Sets the |
void
|
setTouchExplorationPassthroughRegion(int displayId, Region region)
When |
void
|
takeScreenshot(int displayId, Executor executor, AccessibilityService.TakeScreenshotCallback callback)
Takes a screenshot of the specified display and returns it via an
|
Protected methods | |
---|---|
boolean
|
onGesture(int gestureId)
This method is deprecated.
Override |
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 |
Inherited methods | |
---|---|
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
public static final int GESTURE_DOUBLE_TAP
The user has performed a double tap gesture on the touch screen.
Constant Value: 17 (0x00000011)
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)
public static final int GESTURE_SWIPE_DOWN
The user has performed a swipe down gesture on the touch screen.
Constant Value: 2 (0x00000002)
public static final int GESTURE_SWIPE_DOWN_AND_LEFT
The user has performed an down and left gesture on the touch screen.
Constant Value: 15 (0x0000000f)
public static final int GESTURE_SWIPE_DOWN_AND_RIGHT
The user has performed an down and right gesture on the touch screen.
Constant Value: 16 (0x00000010)
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)
public static final int GESTURE_SWIPE_LEFT
The user has performed a swipe left gesture on the touch screen.
Constant Value: 3 (0x00000003)
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)
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)
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)
public static final int GESTURE_SWIPE_RIGHT
The user has performed a swipe right gesture on the touch screen.
Constant Value: 4 (0x00000004)
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)
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)
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)
public static final int GESTURE_SWIPE_UP
The user has performed a swipe up gesture on the touch screen.
Constant Value: 1 (0x00000001)
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)
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)
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)
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)
public static final int GLOBAL_ACTION_ACCESSIBILITY_ALL_APPS
Action to show Launcher's all apps.
Constant Value: 14 (0x0000000e)
public static final int GLOBAL_ACTION_ACCESSIBILITY_BUTTON
Action to trigger the Accessibility Button
Constant Value: 11 (0x0000000b)
public static final int GLOBAL_ACTION_ACCESSIBILITY_BUTTON_CHOOSER
Action to bring up the Accessibility Button's chooser menu
Constant Value: 12 (0x0000000c)
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)
public static final int GLOBAL_ACTION_BACK
Action to go back.
Constant Value: 1 (0x00000001)
public static final int GLOBAL_ACTION_DISMISS_NOTIFICATION_SHADE
Action to dismiss the notification shade
Constant Value: 15 (0x0000000f)
public static final int GLOBAL_ACTION_HOME
Action to go home.
Constant Value: 2 (0x00000002)
public static final int GLOBAL_ACTION_KEYCODE_HEADSETHOOK
Action to send the KEYCODE_HEADSETHOOK KeyEvent, which is used to answer/hang up calls and play/stop media
Constant Value: 10 (0x0000000a)
public static final int GLOBAL_ACTION_LOCK_SCREEN
Action to lock the screen
Constant Value: 8 (0x00000008)
public static final int GLOBAL_ACTION_NOTIFICATIONS
Action to open the notifications.
Constant Value: 4 (0x00000004)
public static final int GLOBAL_ACTION_POWER_DIALOG
Action to open the power long-press dialog.
Constant Value: 6 (0x00000006)
public static final int GLOBAL_ACTION_QUICK_SETTINGS
Action to open the quick settings.
Constant Value: 5 (0x00000005)
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)
public static final int GLOBAL_ACTION_TAKE_SCREENSHOT
Action to take a screenshot
Constant Value: 9 (0x00000009)
public static final int GLOBAL_ACTION_TOGGLE_SPLIT_SCREEN
Action to toggle docking the current app's window
Constant Value: 7 (0x00000007)
public static final String SERVICE_INTERFACE
The Intent
that must be declared as handled by the service.
Constant Value: "android.accessibilityservice.AccessibilityService"
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
<
tag. This is a sample XML file configuring an accessibility service:
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"
public static final int SHOW_MODE_AUTO
Allow the system to control when the soft keyboard is shown.
Constant Value: 0 (0x00000000)
public static final int SHOW_MODE_HIDDEN
Never show the soft keyboard.
Constant Value: 1 (0x00000001)
public static final int SHOW_MODE_IGNORE_HARD_KEYBOARD
Allow the soft keyboard to be shown, even if a hard keyboard is connected
Constant Value: 2 (0x00000002)
public AccessibilityService ()
public Context createDisplayContext (Display display)
Return a new Context object for the current Context but whose resources
are adjusted to match the metrics of the given Display. Each call to this method
returns a new instance of a Context object; Context objects are not
shared, however common state (ClassLoader, other Resources for the
same configuration) may be so the Context itself can be fairly lightweight.
To obtain an instance of a WindowManager
(see getSystemService(java.lang.String)
) that
is configured to show windows on the given display call
createWindowContext(int, android.os.Bundle)
on the returned display Context or use an
Activity
.
Note that invoking #createDisplayContext(Display) from an UI context is not regarded
as an UI context. In other words, it is not suggested to access UI components (such as
obtain a WindowManager
by getSystemService(java.lang.String)
)
from the context created from #createDisplayContext(Display).
Parameters | |
---|---|
display |
Display : A Display object specifying the display for whose metrics the
Context's resources should be tailored.
This value cannot be null . |
Returns | |
---|---|
Context |
A Context for the display. |
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.
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
.
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.
This value may be null . |
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.
This value may be null . |
Returns | |
---|---|
boolean |
true if the gesture is dispatched, false if not. |
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
, 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. |
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 . |
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 . |
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. |
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 . |
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.
The currently active window is defined as the window that most recently fired one
of the following events:
AccessibilityEvent#TYPE_WINDOW_STATE_CHANGED
,
AccessibilityEvent#TYPE_VIEW_HOVER_ENTER
,
AccessibilityEvent#TYPE_VIEW_HOVER_EXIT
.
In other words, the last window shown that also has input focus.
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. |
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:
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 . |
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 . |
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")
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")
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")
ActivityManager
for interacting with the
global activity state of the system.
WALLPAPER_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")
PowerManager
for controlling power
management.
ALARM_SERVICE
("alarm")
AlarmManager
for receiving intents at the
time of your choosing.
NOTIFICATION_SERVICE
("notification")
NotificationManager
for informing the user
of background events.
KEYGUARD_SERVICE
("keyguard")
KeyguardManager
for controlling keyguard.
LOCATION_SERVICE
("location")
LocationManager
for controlling location
(e.g., GPS) updates.
SEARCH_SERVICE
("search")
SearchManager
for handling search.
VIBRATOR_MANAGER_SERVICE
("vibrator_manager")
VibratorManager
for accessing the device vibrators, interacting
with individual ones and playing synchronized effects on multiple vibrators.
VIBRATOR_SERVICE
("vibrator")
Vibrator
for interacting with the vibrator hardware.
CONNECTIVITY_SERVICE
("connectivity")
ConnectivityManager
for
handling management of network connections.
IPSEC_SERVICE
("ipsec")
IpSecManager
for managing IPSec on
sockets and networks.
WIFI_SERVICE
("wifi")
WifiManager
for management of Wi-Fi
connectivity. On releases before NYC, it should only be obtained from an application
context, and not from any other derived context to avoid memory leaks within the calling
process.
WIFI_AWARE_SERVICE
("wifiaware")
WifiAwareManager
for management of
Wi-Fi Aware discovery and connectivity.
WIFI_P2P_SERVICE
("wifip2p")
WifiP2pManager
for management of
Wi-Fi Direct connectivity.
INPUT_METHOD_SERVICE
("input_method")
InputMethodManager
for management of input methods.
UI_MODE_SERVICE
("uimode")
UiModeManager
for controlling UI modes.
DOWNLOAD_SERVICE
("download")
DownloadManager
for requesting HTTP downloads
BATTERY_SERVICE
("batterymanager")
BatteryManager
for managing battery state
JOB_SCHEDULER_SERVICE
("taskmanager")
JobScheduler
for managing scheduled tasks
NETWORK_STATS_SERVICE
("netstats")
NetworkStatsManager
for querying network
usage statistics.
HARDWARE_PROPERTIES_SERVICE
("hardware_properties")
HardwarePropertiesManager
for accessing hardware properties.
DOMAIN_VERIFICATION_SERVICE
("domain_verification")
DomainVerificationManager
for accessing
web domain approval state.
Note: System services obtained via this API may be closely associated with the Context in which they are obtained from. In general, do not share the service objects between various different contexts (Activities, Applications, Services, Providers, etc.)
Note: Instant apps, for which PackageManager#isInstantApp()
returns true,
don't have access to the following system services: DEVICE_POLICY_SERVICE
,
FINGERPRINT_SERVICE
, KEYGUARD_SERVICE
, SHORTCUT_SERVICE
,
USB_SERVICE
, WALLPAPER_SERVICE
, WIFI_P2P_SERVICE
,
WIFI_SERVICE
, WIFI_AWARE_SERVICE
. For these services this method will
return null
. Generally, if you are running as an instant app you should always
check whether the result of this method is null
.
Note: When implementing this method, keep in mind that new services can be added on newer
Android releases, so if you're looking for just the explicit names mentioned above, make sure
to return null
when you don't recognize the name — if you throw a
RuntimeException
exception instead, you're app might break on new Android releases.
Returns | |
---|---|
Object |
The service or null if the name does not exist. |
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. |
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 . |
public abstract void onAccessibilityEvent (AccessibilityEvent event)
Callback for AccessibilityEvent
s.
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. |
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. |
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. |
public abstract void onInterrupt ()
Callback for interrupting the accessibility feedback.
public void onSystemActionsChanged ()
This is called when the system action list is changed.
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. |
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. |
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 . |
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. |
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 . |
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() .
To dispatch events through a shared thread pool, you can use
AsyncTask#THREAD_POOL_EXECUTOR . |
callback |
AccessibilityService.TakeScreenshotCallback : The callback invoked when taking screenshot has succeeded or failed.
See TakeScreenshotCallback for details.
This value cannot be null . |
protected boolean onGesture (int gestureId)
This method is 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. |
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
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. |
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
.