Added in API level 4

AccessibilityServiceInfo

Kotlin |Java

public class AccessibilityServiceInfo
extends Object implements Parcelable

java.lang.Object
↳	android.accessibilityservice.AccessibilityServiceInfo

This class describes an AccessibilityService. The system notifies an AccessibilityService for AccessibilityEvents according to the information encapsulated in this class.

Developer Guides

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

See also:

Summary

XML attributes
`android:accessibilityEventTypes`	The event types this service would like to receive as specified in `AccessibilityEvent`.
`android:accessibilityFeedbackType`	The feedback types this service provides as specified in `AccessibilityServiceInfo`.
`android:accessibilityFlags`	Additional flags as specified in `AccessibilityServiceInfo`.
`android:canRequestFilterKeyEvents`	Attribute whether the accessibility service wants to be able to request to filter key events.
`android:canRequestTouchExplorationMode`	Attribute whether the accessibility service wants to be able to request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.
`android:canRetrieveWindowContent`	Attribute whether the accessibility service wants to be able to retrieve the active window content.
`android:canTakeScreenshot`	Attribute whether the accessibility service wants to be able to take screenshot.
`android:description`	Description of the accessibility service usage, availability, or limitations (e.g.
`android:interactiveUiTimeout`	A recommended timeout in milliseconds used in `android.view.accessibility.AccessibilityManager.getRecommendedTimeoutMillis(int, int)` to return a suitable value for interactive controls.
`android:intro`	Detailed intro of the accessibility service purpose or behavior.
`android:nonInteractiveUiTimeout`	A recommended timeout in milliseconds used in `android.view.accessibility.AccessibilityManager.getRecommendedTimeoutMillis(int, int)` to return a suitable value for UIs that do not include interactive controls.
`android:notificationTimeout`	The minimal period in milliseconds between two accessibility events of the same type are sent to this service.
`android:packageNames`	Comma separated package names from which this service would like to receive events (leave out for all packages).
`android:settingsActivity`	Fully qualified class name of an activity that allows the user to modify the settings for this service.
`android:summary`	Brief summary of the accessibility service purpose or behavior.
`android:tileService`	Fully qualified class name of `TileService` is associated with this accessibility service for one to one mapping.

Constants
`int`	`CAPABILITY_CAN_CONTROL_MAGNIFICATION` Capability: This accessibility service can control display magnification.
`int`	`CAPABILITY_CAN_PERFORM_GESTURES` Capability: This accessibility service can perform gestures.
`int`	`CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY` This constant was deprecated in API level 26. No longer used
`int`	`CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS` Capability: This accessibility service can request to filter the key event stream.
`int`	`CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES` Capability: This accessibility service can capture gestures from the fingerprint sensor
`int`	`CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION` Capability: This accessibility service can request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.
`int`	`CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT` Capability: This accessibility service can retrieve the active window content.
`int`	`CAPABILITY_CAN_TAKE_SCREENSHOT` Capability: This accessibility service can take screenshot.
`int`	`DEFAULT` If an `AccessibilityService` is the default for a given type.
`int`	`FEEDBACK_ALL_MASK` Mask for all feedback types.
`int`	`FEEDBACK_AUDIBLE` Denotes audible (not spoken) feedback.
`int`	`FEEDBACK_BRAILLE` Denotes braille feedback.
`int`	`FEEDBACK_GENERIC` Denotes generic feedback.
`int`	`FEEDBACK_HAPTIC` Denotes haptic feedback.
`int`	`FEEDBACK_SPOKEN` Denotes spoken feedback.
`int`	`FEEDBACK_VISUAL` Denotes visual feedback.
`int`	`FLAG_ENABLE_ACCESSIBILITY_VOLUME` This flag requests that all audio tracks system-wide with `AudioAttributes.USAGE_ASSISTANCE_ACCESSIBILITY` be controlled by the `AudioManager.STREAM_ACCESSIBILITY` volume.
`int`	`FLAG_INCLUDE_NOT_IMPORTANT_VIEWS` If this flag is set the system will regard views that are not important for accessibility in addition to the ones that are important for accessibility.
`int`	`FLAG_INPUT_METHOD_EDITOR` This flag makes the AccessibilityService an input method editor with a subset of input method editor capabilities: get the `InputConnection` and get text selection change notifications.
`int`	`FLAG_REPORT_VIEW_IDS` This flag requests that the `AccessibilityNodeInfo`s obtained by an `AccessibilityService` contain the id of the source view.
`int`	`FLAG_REQUEST_2_FINGER_PASSTHROUGH` This flag requests that when when `FLAG_REQUEST_MULTI_FINGER_GESTURES` is enabled, two-finger passthrough gestures are re-enabled.
`int`	`FLAG_REQUEST_ACCESSIBILITY_BUTTON` This flag indicates to the system that the accessibility service requests that an accessibility button be shown within the system's navigation area, if available.
`int`	`FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY` This constant was deprecated in API level 26. No longer used
`int`	`FLAG_REQUEST_FILTER_KEY_EVENTS` This flag requests from the system to filter key events.
`int`	`FLAG_REQUEST_FINGERPRINT_GESTURES` This flag requests that all fingerprint gestures be sent to the accessibility service.
`int`	`FLAG_REQUEST_MULTI_FINGER_GESTURES` This flag requests that when when `FLAG_REQUEST_TOUCH_EXPLORATION_MODE` is enabled, multi-finger gestures are also enabled.
`int`	`FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK` This flag requests that accessibility shortcut warning dialog has spoken feedback when dialog is shown.
`int`	`FLAG_REQUEST_TOUCH_EXPLORATION_MODE` This flag requests that the system gets into touch exploration mode.
`int`	`FLAG_RETRIEVE_INTERACTIVE_WINDOWS` This flag indicates to the system that the accessibility service wants to access content of all interactive windows.
`int`	`FLAG_SEND_MOTION_EVENTS` This flag requests that when when `FLAG_REQUEST_TOUCH_EXPLORATION_MODE` is enabled, a service will receive the motion events for each successfully-detected gesture.
`int`	`FLAG_SERVICE_HANDLES_DOUBLE_TAP` This flag requests that when `FLAG_REQUEST_TOUCH_EXPLORATION_MODE` is enabled, double tap and double tap and hold gestures are dispatched to the service rather than being handled by the framework.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<AccessibilityServiceInfo>`	`CREATOR`
`public int`	`eventTypes` The event types an `AccessibilityService` is interested in.
`public int`	`feedbackType` The feedback type an `AccessibilityService` provides.
`public int`	`flags` This field represents a set of flags used for configuring an `AccessibilityService`.
`public long`	`notificationTimeout` The timeout, in milliseconds, after the most recent event of a given type before an `AccessibilityService` is notified.
`public String[]`	`packageNames` The package names an `AccessibilityService` is interested in.

Public constructors
`AccessibilityServiceInfo()` Creates a new instance.

Public methods
`static String`	`capabilityToString(int capability)` Returns the string representation of a capability.
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`static String`	`feedbackTypeToString(int feedbackType)` Returns the string representation of a feedback type.
`static String`	`flagToString(int flag)` Returns the string representation of a flag.
`boolean`	`getCanRetrieveWindowContent()` This method was deprecated in API level 18. Use `getCapabilities()`.
`int`	`getCapabilities()` Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc.
`String`	`getDescription()` This method was deprecated in API level 16. Use `loadDescription(android.content.pm.PackageManager)`.
`String`	`getId()` The accessibility service id.
`int`	`getInteractiveUiTimeoutMillis()` Get the recommended timeout for interactive controls.
`int`	`getMotionEventSources()` Returns the bit mask of `InputDevice` sources that the accessibility service wants to listen to for generic `MotionEvent`s.
`int`	`getNonInteractiveUiTimeoutMillis()` Get the recommended timeout for non-interactive controls.
`ResolveInfo`	`getResolveInfo()` The service `ResolveInfo`.
`String`	`getSettingsActivityName()` The settings activity name.
`String`	`getTileServiceName()` Gets the name of `TileService` is associated with this accessibility service.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isAccessibilityTool()` Indicates if the service is used to assist users with disabilities.
`String`	`loadDescription(PackageManager packageManager)` The localized description of the accessibility service.
`CharSequence`	`loadIntro(PackageManager packageManager)` The localized intro of the accessibility service.
`CharSequence`	`loadSummary(PackageManager packageManager)` The localized summary of the accessibility service.
`void`	`setInteractiveUiTimeoutMillis(int timeout)` Set the recommended time that interactive controls need to remain on the screen to support the user.
`void`	`setMotionEventSources(int motionEventSources)` Sets the bit mask of `InputDevice` sources that the accessibility service wants to listen to for generic `MotionEvent`s.
`void`	`setNonInteractiveUiTimeoutMillis(int timeout)` Set the recommended time that non-interactive controls need to remain on the screen to support the user.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel parcel, int flagz)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

XML attributes

android:accessibilityEventTypes

The event types this service would like to receive as specified in AccessibilityEvent. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
typeAllMask	ffffffff	Receives `AccessibilityEvent.TYPES_ALL_MASK` i.e. all events.
typeAnnouncement	4000	Receives `AccessibilityEvent.TYPE_ANNOUNCEMENT` events.
typeAssistReadingContext	1000000	Receives `AccessibilityEvent.TYPE_ASSIST_READING_CONTEXT` events.
typeContextClicked	800000	Receives `AccessibilityEvent.TYPE_VIEW_CONTEXT_CLICKED` events.
typeGestureDetectionEnd	80000	Receives `AccessibilityEvent.TYPE_GESTURE_DETECTION_END` events.
typeGestureDetectionStart	40000	Receives `AccessibilityEvent.TYPE_GESTURE_DETECTION_START` events.
typeNotificationStateChanged	40	Receives `AccessibilityEvent.TYPE_NOTIFICATION_STATE_CHANGED` events.
typeTouchExplorationGestureEnd	400	Receives `AccessibilityEvent.TYPE_TOUCH_EXPLORATION_GESTURE_END` events.
typeTouchExplorationGestureStart	200	Receives `AccessibilityEvent.TYPE_TOUCH_EXPLORATION_GESTURE_START` events.
typeTouchInteractionEnd	200000	Receives `AccessibilityEvent.TYPE_TOUCH_INTERACTION_END` events.
typeTouchInteractionStart	100000	Receives `AccessibilityEvent.TYPE_TOUCH_INTERACTION_START` events.
typeViewAccessibilityFocusCleared	10000	Receives `AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED` events.
typeViewAccessibilityFocused	8000	Receives `AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED` events.
typeViewClicked	1	Receives `AccessibilityEvent.TYPE_VIEW_CLICKED` events.
typeViewFocused	8	Receives `AccessibilityEvent.TYPE_VIEW_FOCUSED` events.
typeViewHoverEnter	80	Receives `AccessibilityEvent.TYPE_VIEW_HOVER_ENTER` events.
typeViewHoverExit	100	Receives `AccessibilityEvent.TYPE_VIEW_HOVER_EXIT` events.
typeViewLongClicked	2	Receives `AccessibilityEvent.TYPE_VIEW_LONG_CLICKED` events.
typeViewScrolled	1000	Receives `AccessibilityEvent.TYPE_VIEW_SCROLLED` events.
typeViewSelected	4	Receives `AccessibilityEvent.TYPE_VIEW_SELECTED` events.
typeViewTextChanged	10	Receives `AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED` events.
typeViewTextSelectionChanged	2000	Receives `AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED` events.
typeViewTextTraversedAtMovementGranularity	20000	Receives `AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY` events.
typeWindowContentChanged	800	Receives `AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED` events.
typeWindowStateChanged	20	Receives `AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED` events.
typeWindowsChanged	400000	Receives `AccessibilityEvent.TYPE_WINDOWS_CHANGED` events.

android:accessibilityFeedbackType

The feedback types this service provides as specified in AccessibilityServiceInfo. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
feedbackAllMask	ffffffff	Provides `AccessibilityServiceInfo.FEEDBACK_ALL_MASK` feedback.
feedbackAudible	4	Provides `AccessibilityServiceInfo.FEEDBACK_AUDIBLE` feedback.
feedbackGeneric	10	Provides `AccessibilityServiceInfo.FEEDBACK_GENERIC` feedback.
feedbackHaptic	2	Provides `AccessibilityServiceInfo.FEEDBACK_HAPTIC` feedback.
feedbackSpoken	1	Provides `AccessibilityServiceInfo.FEEDBACK_SPOKEN` feedback.
feedbackVisual	8	Provides `AccessibilityServiceInfo.FEEDBACK_VISUAL` feedback.

android:accessibilityFlags

Additional flags as specified in AccessibilityServiceInfo. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
flagDefault	1	Has flag `AccessibilityServiceInfo.DEFAULT`.
flagEnableAccessibilityVolume	80	Has flag `AccessibilityServiceInfo.FLAG_ENABLE_ACCESSIBILITY_VOLUME`.
flagIncludeNotImportantViews	2	Has flag `AccessibilityServiceInfo.FLAG_INCLUDE_NOT_IMPORTANT_VIEWS`.
flagInputMethodEditor	8000	Has flag `AccessibilityServiceInfo.FLAG_INPUT_METHOD_EDITOR`.
flagReportViewIds	10	Has flag `AccessibilityServiceInfo.FLAG_REPORT_VIEW_IDS`.
flagRequestAccessibilityButton	100	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_ACCESSIBILITY_BUTTON`.
flagRequestEnhancedWebAccessibility	8	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY`. Not used by the framework.
flagRequestFilterKeyEvents	20	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_FILTER_KEY_EVENTS`.
flagRequestFingerprintGestures	200	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_FINGERPRINT_GESTURES`.
flagRequestMultiFingerGestures	1000	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_MULTI_FINGER_GESTURES`.
flagRequestShortcutWarningDialogSpokenFeedback	400	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK`.
flagRequestTouchExplorationMode	4	Has flag `AccessibilityServiceInfo.FLAG_REQUEST_TOUCH_EXPLORATION_MODE`.
flagRetrieveInteractiveWindows	40	Has flag `AccessibilityServiceInfo.FLAG_RETRIEVE_INTERACTIVE_WINDOWS`.
flagSendMotionEvents	4000
flagServiceHandlesDoubleTap	800	Has flag `AccessibilityServiceInfo.FLAG_SERVICE_HANDLES_DOUBLE_TAP`.

android:canRequestFilterKeyEvents

Attribute whether the accessibility service wants to be able to request to filter key events.

Required to allow setting the #AccessibilityServiceInfo#FLAG_REQUEST_FILTER_KEY_EVENTS flag.

May be a boolean value, such as "true" or "false".

android:canRequestTouchExplorationMode

Attribute whether the accessibility service wants to be able to request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.

Required to allow setting the #AccessibilityServiceInfo#FLAG_REQUEST_TOUCH_EXPLORATION_MODE flag.

May be a boolean value, such as "true" or "false".

android:canRetrieveWindowContent

Attribute whether the accessibility service wants to be able to retrieve the active window content. This setting cannot be changed at runtime.

Required to allow setting the #AccessibilityServiceInfo#FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

May be a boolean value, such as "true" or "false".

android:canTakeScreenshot

Attribute whether the accessibility service wants to be able to take screenshot.

May be a boolean value, such as "true" or "false".

android:description

Description of the accessibility service usage, availability, or limitations (e.g. isn't supported by all apps).

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:interactiveUiTimeout

A recommended timeout in milliseconds used in android.view.accessibility.AccessibilityManager.getRecommendedTimeoutMillis(int, int) to return a suitable value for interactive controls. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

May be an integer value, such as "100".

android:intro

Detailed intro of the accessibility service purpose or behavior.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:nonInteractiveUiTimeout

A recommended timeout in milliseconds used in android.view.accessibility.AccessibilityManager.getRecommendedTimeoutMillis(int, int) to return a suitable value for UIs that do not include interactive controls. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

May be an integer value, such as "100".

android:notificationTimeout

The minimal period in milliseconds between two accessibility events of the same type are sent to this service. This setting can be changed at runtime by calling android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

May be an integer value, such as "100".

android:packageNames

Comma separated package names from which this service would like to receive events (leave out for all packages). android.accessibilityservice.AccessibilityService.setServiceInfo(android.accessibilityservice.AccessibilityServiceInfo).

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:settingsActivity

Fully qualified class name of an activity that allows the user to modify the settings for this service. This setting cannot be changed at runtime.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:summary

Brief summary of the accessibility service purpose or behavior.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:tileService

Fully qualified class name of TileService is associated with this accessibility service for one to one mapping. It is used by system settings to remind users this accessibility service has a TileService.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

Constants

CAPABILITY_CAN_CONTROL_MAGNIFICATION

Added in API level 24

public static final int CAPABILITY_CAN_CONTROL_MAGNIFICATION

Capability: This accessibility service can control display magnification.

See also:

R.styleable.AccessibilityService_canControlMagnification

Constant Value: 16 (0x00000010)

CAPABILITY_CAN_PERFORM_GESTURES

Added in API level 24

public static final int CAPABILITY_CAN_PERFORM_GESTURES

Capability: This accessibility service can perform gestures.

See also:

R.styleable.AccessibilityService_canPerformGestures

Constant Value: 32 (0x00000020)

CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY

Added in API level 18
Deprecated in API level 26

public static final int CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY

This constant was deprecated in API level 26.
No longer used

Constant Value: 4 (0x00000004)

CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS

Added in API level 18

public static final int CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS

Capability: This accessibility service can request to filter the key event stream.

See also:

R.styleable.AccessibilityService_canRequestFilterKeyEvents

Constant Value: 8 (0x00000008)

CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES

Added in API level 26

public static final int CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES

Capability: This accessibility service can capture gestures from the fingerprint sensor

See also:

R.styleable.AccessibilityService_canRequestFingerprintGestures

Constant Value: 64 (0x00000040)

CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION

Added in API level 18

public static final int CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION

Capability: This accessibility service can request touch exploration mode in which touched items are spoken aloud and the UI can be explored via gestures.

See also:

R.styleable.AccessibilityService_canRequestTouchExplorationMode

Constant Value: 2 (0x00000002)

CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT

Added in API level 18

public static final int CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT

Capability: This accessibility service can retrieve the active window content.

See also:

R.styleable.AccessibilityService_canRetrieveWindowContent

Constant Value: 1 (0x00000001)

CAPABILITY_CAN_TAKE_SCREENSHOT

Added in API level 30

public static final int CAPABILITY_CAN_TAKE_SCREENSHOT

Capability: This accessibility service can take screenshot.

See also:

R.styleable.AccessibilityService_canTakeScreenshot

Constant Value: 128 (0x00000080)

DEFAULT

Added in API level 4

public static final int DEFAULT

If an AccessibilityService is the default for a given type. Default service is invoked only if no package specific one exists. In case of more than one package specific service only the earlier registered is notified.

Constant Value: 1 (0x00000001)

FEEDBACK_ALL_MASK

Added in API level 14

public static final int FEEDBACK_ALL_MASK

Mask for all feedback types.

See also:

Constant Value: -1 (0xffffffff)

FEEDBACK_AUDIBLE

Added in API level 4

public static final int FEEDBACK_AUDIBLE

Denotes audible (not spoken) feedback.

Constant Value: 4 (0x00000004)

FEEDBACK_BRAILLE

Added in API level 17

public static final int FEEDBACK_BRAILLE

Denotes braille feedback.

Constant Value: 32 (0x00000020)

FEEDBACK_GENERIC

Added in API level 4

public static final int FEEDBACK_GENERIC

Denotes generic feedback.

Constant Value: 16 (0x00000010)

FEEDBACK_HAPTIC

Added in API level 4

public static final int FEEDBACK_HAPTIC

Denotes haptic feedback.

Constant Value: 2 (0x00000002)

FEEDBACK_SPOKEN

Added in API level 4

public static final int FEEDBACK_SPOKEN

Denotes spoken feedback.

Constant Value: 1 (0x00000001)

FEEDBACK_VISUAL

Added in API level 4

public static final int FEEDBACK_VISUAL

Denotes visual feedback.

Constant Value: 8 (0x00000008)

FLAG_ENABLE_ACCESSIBILITY_VOLUME

Added in API level 26

public static final int FLAG_ENABLE_ACCESSIBILITY_VOLUME

This flag requests that all audio tracks system-wide with AudioAttributes.USAGE_ASSISTANCE_ACCESSIBILITY be controlled by the AudioManager.STREAM_ACCESSIBILITY volume.

Constant Value: 128 (0x00000080)

FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

Added in API level 16

public static final int FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

If this flag is set the system will regard views that are not important for accessibility in addition to the ones that are important for accessibility. That is, views that are marked as not important for accessibility via View#IMPORTANT_FOR_ACCESSIBILITY_NO or View#IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS and views that are marked as potentially important for accessibility via View#IMPORTANT_FOR_ACCESSIBILITY_AUTO for which the system has determined that are not important for accessibility, are reported while querying the window content and also the accessibility service will receive accessibility events from them.

Note: For accessibility services targeting Android 4.1 (API level 16) or higher, this flag has to be explicitly set for the system to regard views that are not important for accessibility. For accessibility services targeting Android 4.0.4 (API level 15) or lower, this flag is ignored and all views are regarded for accessibility purposes.

Usually views not important for accessibility are layout managers that do not react to user actions, do not draw any content, and do not have any special semantics in the context of the screen content. For example, a three by three grid can be implemented as three horizontal linear layouts and one vertical, or three vertical linear layouts and one horizontal, or one grid layout, etc. In this context, the actual layout managers used to achieve the grid configuration are not important; rather it is important that there are nine evenly distributed elements.

Constant Value: 2 (0x00000002)

FLAG_INPUT_METHOD_EDITOR

Added in API level 33

public static final int FLAG_INPUT_METHOD_EDITOR

This flag makes the AccessibilityService an input method editor with a subset of input method editor capabilities: get the InputConnection and get text selection change notifications.

See also:

AccessibilityService.getInputMethod()

Constant Value: 32768 (0x00008000)

FLAG_REPORT_VIEW_IDS

Added in API level 18

public static final int FLAG_REPORT_VIEW_IDS

This flag requests that the AccessibilityNodeInfos obtained by an AccessibilityService contain the id of the source view. The source view id will be a fully qualified resource name of the form "package:id/name", for example "foo.bar:id/my_list", and it is useful for UI test automation. This flag is not set by default.

Constant Value: 16 (0x00000010)

FLAG_REQUEST_2_FINGER_PASSTHROUGH

Added in API level 31

public static final int FLAG_REQUEST_2_FINGER_PASSTHROUGH

This flag requests that when when FLAG_REQUEST_MULTI_FINGER_GESTURES is enabled, two-finger passthrough gestures are re-enabled. Two-finger swipe gestures are not detected, but instead passed through as one-finger gestures. In addition, three-finger swipes from the bottom of the screen are not detected, and instead are passed through unchanged. If FLAG_REQUEST_MULTI_FINGER_GESTURES is disabled this flag has no effect.

See also:

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

Constant Value: 8192 (0x00002000)

FLAG_REQUEST_ACCESSIBILITY_BUTTON

Added in API level 26

public static final int FLAG_REQUEST_ACCESSIBILITY_BUTTON

This flag indicates to the system that the accessibility service requests that an accessibility button be shown within the system's navigation area, if available.

Note: For accessibility services targeting APIs greater than API 29, this flag must be specified in the accessibility service metadata file. Otherwise, it will be ignored.

Constant Value: 256 (0x00000100)

FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY

Added in API level 18
Deprecated in API level 26

public static final int FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY

This constant was deprecated in API level 26.
No longer used

Constant Value: 8 (0x00000008)

FLAG_REQUEST_FILTER_KEY_EVENTS

Added in API level 18

public static final int FLAG_REQUEST_FILTER_KEY_EVENTS

This flag requests from the system to filter key events. If this flag is set the accessibility service will receive the key events before applications allowing it implement global shortcuts.

Services that want to set this flag have to declare this capability in their meta-data by setting the attribute #canRequestFilterKeyEvents canRequestFilterKeyEvents to true, otherwise this flag will be ignored. For how to declare the meta-data of a service refer to android.accessibilityservice.AccessibilityService.SERVICE_META_DATA AccessibilityService.SERVICE_META_DATA.

See also:

R.styleable.AccessibilityService_canRequestFilterKeyEvents

Constant Value: 32 (0x00000020)

FLAG_REQUEST_FINGERPRINT_GESTURES

Added in API level 26

public static final int FLAG_REQUEST_FINGERPRINT_GESTURES

This flag requests that all fingerprint gestures be sent to the accessibility service.

Services that want to set this flag have to declare the capability to retrieve window content in their meta-data by setting the attribute R.attr.canRequestFingerprintGestures to true, otherwise this flag will be ignored. For how to declare the meta-data of a service refer to android.accessibilityservice.AccessibilityService.SERVICE_META_DATA AccessibilityService.SERVICE_META_DATA.

See also:

Constant Value: 512 (0x00000200)

FLAG_REQUEST_MULTI_FINGER_GESTURES

Added in API level 30

public static final int FLAG_REQUEST_MULTI_FINGER_GESTURES

This flag requests that when when FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, multi-finger gestures are also enabled. As a consequence, two-finger bypass gestures will be disabled. If FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled this flag has no effect.

See also:

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

Constant Value: 4096 (0x00001000)

FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK

Added in API level 29

public static final int FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK

This flag requests that accessibility shortcut warning dialog has spoken feedback when dialog is shown.

Constant Value: 1024 (0x00000400)

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

Added in API level 16

public static final int FLAG_REQUEST_TOUCH_EXPLORATION_MODE

This flag requests that the system gets into touch exploration mode. In this mode a single finger moving on the screen behaves as a mouse pointer hovering over the user interface. The system will also detect certain gestures performed on the touch screen and notify this service. The system will enable touch exploration mode if there is at least one accessibility service that has this flag set. Hence, clearing this flag does not guarantee that the device will not be in touch exploration mode since there may be another enabled service that requested it.

For accessibility services targeting Android 4.3 (API level 18) or higher that want to set this flag have to declare this capability in their meta-data by setting the attribute canRequestTouchExplorationMode to true. Otherwise, this flag will be ignored. For how to declare the meta-data of a service refer to android.accessibilityservice.AccessibilityService.SERVICE_META_DATA AccessibilityService.SERVICE_META_DATA.

Services targeting Android 4.2.2 (API level 17) or lower will work normally. In other words, the first time they are run, if this flag is specified, a dialog is shown to the user to confirm enabling explore by touch.

See also:

R.styleable.AccessibilityService_canRequestTouchExplorationMode

Constant Value: 4 (0x00000004)

FLAG_RETRIEVE_INTERACTIVE_WINDOWS

Added in API level 21

public static final int FLAG_RETRIEVE_INTERACTIVE_WINDOWS

This flag indicates to the system that the accessibility service wants to access content of all interactive windows. An interactive window is a window that has input focus or can be touched by a sighted user when explore by touch is not enabled. If this flag is not set your service will not receive AccessibilityEvent.TYPE_WINDOWS_CHANGED events, calling AccessibilityServiceAccessibilityService.getWindows() will return an empty list, and AccessibilityNodeInfo.getWindow() will return null.

Services that want to set this flag have to declare the capability to retrieve window content in their meta-data by setting the attribute canRetrieveWindowContent to true, otherwise this flag will be ignored. For how to declare the meta-data of a service refer to android.accessibilityservice.AccessibilityService.SERVICE_META_DATA AccessibilityService.SERVICE_META_DATA.

See also:

R.styleable.AccessibilityService_canRetrieveWindowContent

Constant Value: 64 (0x00000040)

FLAG_SEND_MOTION_EVENTS

Added in API level 31

public static final int FLAG_SEND_MOTION_EVENTS

This flag requests that when when FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, a service will receive the motion events for each successfully-detected gesture. The service will also receive an AccessibilityGestureEvent of type GESTURE_INVALID for each cancelled gesture along with its motion events. A service will receive a gesture of type GESTURE_PASSTHROUGH and accompanying motion events for every passthrough gesture that does not start gesture detection. This information can be used to collect instances of improper gesture detection behavior and relay that information to framework developers. If FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled this flag has no effect.

See also:

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

Constant Value: 16384 (0x00004000)

FLAG_SERVICE_HANDLES_DOUBLE_TAP

Added in API level 30

public static final int FLAG_SERVICE_HANDLES_DOUBLE_TAP

This flag requests that when FLAG_REQUEST_TOUCH_EXPLORATION_MODE is enabled, double tap and double tap and hold gestures are dispatched to the service rather than being handled by the framework. If FLAG_REQUEST_TOUCH_EXPLORATION_MODE is disabled this flag has no effect.

See also:

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

Constant Value: 2048 (0x00000800)

Fields

CREATOR

Added in API level 4

public static final Creator<AccessibilityServiceInfo> CREATOR

See also:

Parcelable.Creator

eventTypes

Added in API level 4

public int eventTypes

The event types an AccessibilityService is interested in.

Can be dynamically set at runtime.

See also:

feedbackType

Added in API level 4

public int feedbackType

The feedback type an AccessibilityService provides.

Can be dynamically set at runtime.

Value is either 0 or a combination of FEEDBACK_AUDIBLE, FEEDBACK_GENERIC, FEEDBACK_HAPTIC, FEEDBACK_SPOKEN, FEEDBACK_VISUAL, and FEEDBACK_BRAILLE

See also:

flags

Added in API level 4

public int flags

This field represents a set of flags used for configuring an AccessibilityService.

Can be dynamically set at runtime.

Note: Accessibility services with targetSdkVersion greater than API 29 cannot dynamically set the FLAG_REQUEST_ACCESSIBILITY_BUTTON at runtime. It must be specified in the accessibility service metadata file.

See also:

notificationTimeout

Added in API level 4

public long notificationTimeout

The timeout, in milliseconds, after the most recent event of a given type before an AccessibilityService is notified.

Can be dynamically set at runtime.

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.

packageNames

Added in API level 4

public String[] packageNames

The package names an AccessibilityService is interested in. Setting to null is equivalent to all packages.

Can be dynamically set at runtime.

Public constructors

AccessibilityServiceInfo

Added in API level 4

public AccessibilityServiceInfo ()

Creates a new instance.

Public methods

capabilityToString

Added in API level 18

public static String capabilityToString (int capability)

Returns the string representation of a capability. For example, CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT is represented by the string CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT.

Parameters
`capability`	`int`: The capability.

Returns
`String`	The string representation.

describeContents

Added in API level 4

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 4

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

feedbackTypeToString

Added in API level 14

public static String feedbackTypeToString (int feedbackType)

Returns the string representation of a feedback type. For example, FEEDBACK_SPOKEN is represented by the string FEEDBACK_SPOKEN.

Parameters
`feedbackType`	`int`: The feedback type.

Returns
`String`	The string representation.

flagToString

Added in API level 14

public static String flagToString (int flag)

Returns the string representation of a flag. For example, DEFAULT is represented by the string DEFAULT.

Parameters
`flag`	`int`: The flag.

Returns
`String`	The string representation.

getCanRetrieveWindowContent

Added in API level 14
Deprecated in API level 18

public boolean getCanRetrieveWindowContent ()

This method was deprecated in API level 18.
Use getCapabilities().

Whether this service can retrieve the current window's content.

Statically set from meta-data.

Returns
`boolean`	True if window content can be retrieved.

getCapabilities

Added in API level 18

public int getCapabilities ()

Returns the bit mask of capabilities this accessibility service has such as being able to retrieve the active window content, etc.

Returns
`int`	The capability bit mask.

See also:

getDescription

Added in API level 14
Deprecated in API level 16

public String getDescription ()

This method was deprecated in API level 16.
Use loadDescription(android.content.pm.PackageManager).

Gets the non-localized description of the accessibility service.

Statically set from meta-data.

Returns
`String`	The description.

getId

Added in API level 14

public String getId ()

The accessibility service id.

Generated by the system.

Returns
`String`	The id (or `null` if the component is not set yet).

getInteractiveUiTimeoutMillis

Added in API level 29

public int getInteractiveUiTimeoutMillis ()

Get the recommended timeout for interactive controls.

Returns
`int`	The timeout in milliseconds.

See also:

setInteractiveUiTimeoutMillis(int)

getMotionEventSources

Added in API level 34

public int getMotionEventSources ()

Returns the bit mask of InputDevice sources that the accessibility service wants to listen to for generic MotionEvents.

Returns

Returns
`int`	Value is either `0` or a combination of `InputDevice.SOURCE_MOUSE`, `InputDevice.SOURCE_STYLUS`, `InputDevice.SOURCE_BLUETOOTH_STYLUS`, `InputDevice.SOURCE_TRACKBALL`, `InputDevice.SOURCE_MOUSE_RELATIVE`, `InputDevice.SOURCE_TOUCHPAD`, `InputDevice.SOURCE_TOUCH_NAVIGATION`, `InputDevice.SOURCE_ROTARY_ENCODER`, `InputDevice.SOURCE_JOYSTICK`, `InputDevice.SOURCE_SENSOR`, and `InputDevice.SOURCE_TOUCHSCREEN`

int

Value is either 0 or a combination of InputDevice.SOURCE_MOUSE, InputDevice.SOURCE_STYLUS, InputDevice.SOURCE_BLUETOOTH_STYLUS, InputDevice.SOURCE_TRACKBALL, InputDevice.SOURCE_MOUSE_RELATIVE, InputDevice.SOURCE_TOUCHPAD, InputDevice.SOURCE_TOUCH_NAVIGATION, InputDevice.SOURCE_ROTARY_ENCODER, InputDevice.SOURCE_JOYSTICK, InputDevice.SOURCE_SENSOR, and InputDevice.SOURCE_TOUCHSCREEN

getNonInteractiveUiTimeoutMillis

Added in API level 29

public int getNonInteractiveUiTimeoutMillis ()

Get the recommended timeout for non-interactive controls.

Returns
`int`	The timeout in milliseconds.

See also:

setNonInteractiveUiTimeoutMillis(int)

getResolveInfo

Added in API level 14

public ResolveInfo getResolveInfo ()

The service ResolveInfo.

Generated by the system.

Returns
`ResolveInfo`	The info.

getSettingsActivityName

Added in API level 14

public String getSettingsActivityName ()

The settings activity name.

Statically set from meta-data.

Returns
`String`	The settings activity name.

getTileServiceName

Added in API level 33

public String getTileServiceName ()

Gets the name of TileService is associated with this accessibility service.

Returns
`String`	The name of `TileService`. This value may be `null`.

hashCode

Added in API level 4

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.

isAccessibilityTool

Added in API level 31

public boolean isAccessibilityTool ()

Indicates if the service is used to assist users with disabilities.

Returns
`boolean`	`true` if the property is set to true.

loadDescription

Added in API level 16

public String loadDescription (PackageManager packageManager)

The localized description of the accessibility service.

Statically set from meta-data.

Parameters
`packageManager`	`PackageManager`

Returns
`String`	The localized description.

loadIntro

Added in API level 33

public CharSequence loadIntro (PackageManager packageManager)

The localized intro of the accessibility service.

Statically set from meta-data.

Parameters
`packageManager`	`PackageManager`: This value cannot be `null`.

Returns
`CharSequence`	The localized intro if available, and `null` if a intro has not been provided.

loadSummary

Added in API level 26

public CharSequence loadSummary (PackageManager packageManager)

The localized summary of the accessibility service.

Statically set from meta-data.

Parameters
`packageManager`	`PackageManager`

Returns
`CharSequence`	The localized summary if available, and `null` if a summary has not been provided.

setInteractiveUiTimeoutMillis

Added in API level 29

public void setInteractiveUiTimeoutMillis (int timeout)

Set the recommended time that interactive controls need to remain on the screen to support the user.

This value can be dynamically set at runtime by AccessibilityService#setServiceInfo(AccessibilityServiceInfo).

Parameters
`timeout`	`int`: The timeout in milliseconds. Value is 0 or greater

See also:

R.styleable.AccessibilityService_interactiveUiTimeout

setMotionEventSources

Added in API level 34

public void setMotionEventSources (int motionEventSources)

Sets the bit mask of InputDevice sources that the accessibility service wants to listen to for generic MotionEvents.

Including an InputDevice source that does not send MotionEvents is effectively a no-op for that source, since you will not receive any events from that source.

See InputDevice for complete source definitions. Many input devices send InputEvents from more than one type of source so you may need to include multiple MotionEvent sources here, in addition to using AccessibilityService#onKeyEvent to listen to KeyEvents.

Note: InputDevice sources contain source class bits that complicate bitwise flag removal operations. To remove a specific source you should rebuild the entire value using bitwise OR operations on the individual source constants.

Parameters

Parameters
`motionEventSources`	`int`: A bit mask of `InputDevice` sources. Value is either `0` or a combination of `InputDevice.SOURCE_MOUSE`, `InputDevice.SOURCE_STYLUS`, `InputDevice.SOURCE_BLUETOOTH_STYLUS`, `InputDevice.SOURCE_TRACKBALL`, `InputDevice.SOURCE_MOUSE_RELATIVE`, `InputDevice.SOURCE_TOUCHPAD`, `InputDevice.SOURCE_TOUCH_NAVIGATION`, `InputDevice.SOURCE_ROTARY_ENCODER`, `InputDevice.SOURCE_JOYSTICK`, `InputDevice.SOURCE_SENSOR`, and `InputDevice.SOURCE_TOUCHSCREEN`

motionEventSources

int: A bit mask of InputDevice sources. Value is either 0 or a combination of InputDevice.SOURCE_MOUSE, InputDevice.SOURCE_STYLUS, InputDevice.SOURCE_BLUETOOTH_STYLUS, InputDevice.SOURCE_TRACKBALL, InputDevice.SOURCE_MOUSE_RELATIVE, InputDevice.SOURCE_TOUCHPAD, InputDevice.SOURCE_TOUCH_NAVIGATION, InputDevice.SOURCE_ROTARY_ENCODER, InputDevice.SOURCE_JOYSTICK, InputDevice.SOURCE_SENSOR, and InputDevice.SOURCE_TOUCHSCREEN

See also:

AccessibilityService.onMotionEvent(MotionEvent)

setNonInteractiveUiTimeoutMillis

Added in API level 29

public void setNonInteractiveUiTimeoutMillis (int timeout)

Set the recommended time that non-interactive controls need to remain on the screen to support the user.

This value can be dynamically set at runtime by AccessibilityService#setServiceInfo(AccessibilityServiceInfo).

Parameters
`timeout`	`int`: The timeout in milliseconds. Value is 0 or greater

See also:

R.styleable.AccessibilityService_nonInteractiveUiTimeout

toString

Added in API level 4

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 4

public void writeToParcel (Parcel parcel, 
                int flagz)

Flatten this object in to a Parcel.

Parameters
`parcel`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flagz`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES