AccessibilityServiceInfoCompat

class AccessibilityServiceInfoCompat
kotlin.Any
   ↳ androidx.core.accessibilityservice.AccessibilityServiceInfoCompat

Helper for accessing features in AccessibilityServiceInfo.

Summary

Constants
static Int

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

static Int

Capability: This accessibility service can request enhanced web accessibility enhancements.

static Int

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

static Int

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

static Int

Mask for all feedback types.

static Int

Denotes braille feedback.

static Int

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.

static Int

This flag requests that the AccessibilityNodeInfos obtained by an AccessibilityService contain the id of the source view.

static Int

This flag requests from the system to enable web accessibility enhancing extensions.

static Int

This flag requests from the system to filter key events.

static Int

This flag requests that the system gets into touch exploration mode.

Public methods
static String
capabilityToString(capability: Int)

Returns the string representation of a capability.

static String
feedbackTypeToString(feedbackType: Int)

Returns the string representation of a feedback type.

static String?

Returns the string representation of a flag.

static Int

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

static String?
loadDescription(@NonNull info: AccessibilityServiceInfo, @NonNull packageManager: PackageManager)

The localized description of the accessibility service.

Constants

CAPABILITY_CAN_FILTER_KEY_EVENTS

static val CAPABILITY_CAN_FILTER_KEY_EVENTS: Int

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

Value: 0x00000008

CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY

static val CAPABILITY_CAN_REQUEST_ENHANCED_WEB_ACCESSIBILITY: Int

Capability: This accessibility service can request enhanced web accessibility enhancements. For example, installing scripts to make app content more accessible.

Value: 0x00000004

CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION

static val CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION: Int

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

Value: 0x00000002

CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT

static val CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT: Int

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

Value: 0x00000001

FEEDBACK_BRAILLE

static val FEEDBACK_BRAILLE: Int

Denotes braille feedback.

Value: 0x0000020

FLAG_INCLUDE_NOT_IMPORTANT_VIEWS

static val FLAG_INCLUDE_NOT_IMPORTANT_VIEWS: Int

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 both reported while querying the window content and also the accessibility service will receive accessibility events from them.

Note: For accessibility services targeting API version Build.VERSION_CODES#JELLY_BEAN 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 API version lower than Build.VERSION_CODES#JELLY_BEAN 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 mangers used to achieve the grid configuration are not important, rather it is important that there are nine evenly distributed elements.

Value: 0x0000002

FLAG_REPORT_VIEW_IDS

static val FLAG_REPORT_VIEW_IDS: Int

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.

Value: 0x00000010

FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY

static val FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY: Int

This flag requests from the system to enable web accessibility enhancing extensions. Such extensions aim to provide improved accessibility support for content presented in a android.webkit.WebView. An example of such an extension is injecting JavaScript from a secure source. The system will enable enhanced web accessibility 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 have enhanced web accessibility enabled since there may be another enabled service that requested it.

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

Value: 0x00000008

FLAG_REQUEST_FILTER_KEY_EVENTS

static val FLAG_REQUEST_FILTER_KEY_EVENTS: Int

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. Setting this flag does not guarantee that this service will filter key events since only one service can do so at any given time. This avoids user confusion due to behavior change in case different key filtering services are enabled. If there is already another key filtering service enabled, this one will not receive key events.

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

Value: 0x00000020

FLAG_REQUEST_TOUCH_EXPLORATION_MODE

static val FLAG_REQUEST_TOUCH_EXPLORATION_MODE: Int

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 API version higher than Build.VERSION_CODES#JELLY_BEAN_MR1 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 {@value AccessibilityService#SERVICE_META_DATA}.

Services targeting API version equal to or lower than Build.VERSION_CODES#JELLY_BEAN_MR1 will work normally, i.e. the first time they are run, if this flag is specified, a dialog is shown to the user to confirm enabling explore by touch.

Value: 0x0000004

Public methods

capabilityToString

@NonNull static fun capabilityToString(capability: Int): String

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.
Return
String: The string representation.

feedbackTypeToString

@NonNull static fun feedbackTypeToString(feedbackType: Int): String

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

Parameters
feedbackType Int: The feedback type.
Return
String: The string representation.

flagToString

@Nullable static fun flagToString(flag: Int): String?

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

Parameters
flag Int: The flag.
Return
String?: The string representation.

getCapabilities

static fun getCapabilities(@NonNull info: AccessibilityServiceInfo): Int

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

Parameters
info AccessibilityServiceInfo: The service info whose capabilities to get.
Return
Int: The capability bit mask.

loadDescription

@Nullable static fun loadDescription(@NonNull info: AccessibilityServiceInfo, @NonNull packageManager: PackageManager): String?

The localized description of the accessibility service.

Statically set from meta-data.

Parameters
info AccessibilityServiceInfo: The service info of interest
packageManager AccessibilityServiceInfo: The current package manager
Return
String?: The localized description.