* 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. *
*/ public static final int FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1 << 1; /** * 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 * {@link android.R.attr#canRequestTouchExplorationMode * 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 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 android.R.styleable#AccessibilityService_canRequestTouchExplorationMode */ public static final int FLAG_REQUEST_TOUCH_EXPLORATION_MODE = 1 << 2; /** * @deprecated No longer used */ @Deprecated public static final int FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY = 1 << 3; /** * This flag requests that the {@link AccessibilityNodeInfo}s obtained * by an {@link 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. */ public static final int FLAG_REPORT_VIEW_IDS = 1 << 4; /** * 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 {@link android.R.attr * #canRequestFilterKeyEvents 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}. *
* @see android.R.styleable#AccessibilityService_canRequestFilterKeyEvents */ public static final int FLAG_REQUEST_FILTER_KEY_EVENTS = 1 << 5; /** * 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 * {@link android.view.accessibility.AccessibilityEvent#TYPE_WINDOWS_CHANGED} * events, calling AccessibilityService{@link AccessibilityService#getWindows() * AccessibilityService.getWindows()} will return an empty list, and {@link * AccessibilityNodeInfo#getWindow() 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 * {@link android.R.attr#canRetrieveWindowContent canRetrieveWindowContent} 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}. *
* @see android.R.styleable#AccessibilityService_canRetrieveWindowContent */ public static final int FLAG_RETRIEVE_INTERACTIVE_WINDOWS = 1 << 6; /** * This flag requests that all audio tracks system-wide with * {@link android.media.AudioAttributes#USAGE_ASSISTANCE_ACCESSIBILITY} be controlled by the * {@link android.media.AudioManager#STREAM_ACCESSIBILITY} volume. */ public static final int FLAG_ENABLE_ACCESSIBILITY_VOLUME = 1 << 7; /** * 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 * {@link Build.VERSION_CODES#Q API 29}, this flag must be specified in the * accessibility service metadata file. Otherwise, it will be ignored. *
*/ public static final int FLAG_REQUEST_ACCESSIBILITY_BUTTON = 1 << 8; /** * 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 * {@link android.R.attr#canRequestFingerprintGestures} 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}. *
* * @see android.R.styleable#AccessibilityService_canRequestFingerprintGestures * @see AccessibilityService#getFingerprintGestureController() */ public static final int FLAG_REQUEST_FINGERPRINT_GESTURES = 1 << 9; /** * This flag requests that accessibility shortcut warning dialog has spoken feedback when * dialog is shown. */ public static final int FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK = 1 << 10; /** * This flag requests that when {@link #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 {@link #FLAG_REQUEST_TOUCH_EXPLORATION_MODE} is disabled this * flag has no effect. * * @see #FLAG_REQUEST_TOUCH_EXPLORATION_MODE */ public static final int FLAG_SERVICE_HANDLES_DOUBLE_TAP = 1 << 11; /** * This flag requests that when when {@link #FLAG_REQUEST_TOUCH_EXPLORATION_MODE} is enabled, * multi-finger gestures are also enabled. As a consequence, two-finger bypass gestures will be * disabled. If {@link #FLAG_REQUEST_TOUCH_EXPLORATION_MODE} is disabled this flag has no * effect. * * @see #FLAG_REQUEST_TOUCH_EXPLORATION_MODE */ public static final int FLAG_REQUEST_MULTI_FINGER_GESTURES = 1 << 12; /** * This flag requests that when when {@link #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 {@link * #FLAG_REQUEST_MULTI_FINGER_GESTURES} is disabled this flag has no effect. * * @see #FLAG_REQUEST_TOUCH_EXPLORATION_MODE */ public static final int FLAG_REQUEST_2_FINGER_PASSTHROUGH = 1 << 13; /** * This flag requests that when when {@link #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 {@link * #FLAG_REQUEST_TOUCH_EXPLORATION_MODE} is disabled this flag has no effect. * * @see #FLAG_REQUEST_TOUCH_EXPLORATION_MODE */ public static final int FLAG_SEND_MOTION_EVENTS = 1 << 14; /** * This flag makes the AccessibilityService an input method editor with a subset of input * method editor capabilities: get the {@link android.view.inputmethod.InputConnection} and get * text selection change notifications. * * @see AccessibilityService#getInputMethod() */ public static final int FLAG_INPUT_METHOD_EDITOR = 1 << 15; /** {@hide} */ public static final int FLAG_FORCE_DIRECT_BOOT_AWARE = 1 << 16; /** * The event types an {@link AccessibilityService} is interested in. ** Can be dynamically set at runtime. *
* @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_LONG_CLICKED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_FOCUSED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_SELECTED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_TEXT_CHANGED * @see android.view.accessibility.AccessibilityEvent#TYPE_WINDOW_STATE_CHANGED * @see android.view.accessibility.AccessibilityEvent#TYPE_NOTIFICATION_STATE_CHANGED * @see android.view.accessibility.AccessibilityEvent#TYPE_TOUCH_EXPLORATION_GESTURE_START * @see android.view.accessibility.AccessibilityEvent#TYPE_TOUCH_EXPLORATION_GESTURE_END * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_EXIT * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_SCROLLED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_TEXT_SELECTION_CHANGED * @see android.view.accessibility.AccessibilityEvent#TYPE_WINDOW_CONTENT_CHANGED * @see android.view.accessibility.AccessibilityEvent#TYPE_TOUCH_INTERACTION_START * @see android.view.accessibility.AccessibilityEvent#TYPE_TOUCH_INTERACTION_END * @see android.view.accessibility.AccessibilityEvent#TYPE_ANNOUNCEMENT * @see android.view.accessibility.AccessibilityEvent#TYPE_GESTURE_DETECTION_START * @see android.view.accessibility.AccessibilityEvent#TYPE_GESTURE_DETECTION_END * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_ACCESSIBILITY_FOCUSED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED * @see android.view.accessibility.AccessibilityEvent#TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY * @see android.view.accessibility.AccessibilityEvent#TYPE_WINDOWS_CHANGED */ public int eventTypes; /** * The package names an {@link AccessibilityService} is interested in. Setting * tonull is equivalent to all packages.
* * Can be dynamically set at runtime. *
*/ public String[] packageNames; /** @hide */ @IntDef(flag = true, prefix = { "FEEDBACK_" }, value = { FEEDBACK_AUDIBLE, FEEDBACK_GENERIC, FEEDBACK_HAPTIC, FEEDBACK_SPOKEN, FEEDBACK_VISUAL, FEEDBACK_BRAILLE }) @Retention(RetentionPolicy.SOURCE) public @interface FeedbackType {} /** * The feedback type an {@link AccessibilityService} provides. ** Can be dynamically set at runtime. *
* @see #FEEDBACK_AUDIBLE * @see #FEEDBACK_GENERIC * @see #FEEDBACK_HAPTIC * @see #FEEDBACK_SPOKEN * @see #FEEDBACK_VISUAL * @see #FEEDBACK_BRAILLE */ @FeedbackType public int feedbackType; /** * The timeout, in milliseconds, after the most recent event of a given type before an * {@link 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. */ public long notificationTimeout; /** * This field represents a set of flags used for configuring an * {@link AccessibilityService}. *
* Can be dynamically set at runtime. *
** Note: Accessibility services with targetSdkVersion greater than * {@link Build.VERSION_CODES#Q API 29} cannot dynamically set the * {@link #FLAG_REQUEST_ACCESSIBILITY_BUTTON} at runtime. It must be specified in the * accessibility service metadata file. *
* @see #DEFAULT * @see #FLAG_INCLUDE_NOT_IMPORTANT_VIEWS * @see #FLAG_REQUEST_TOUCH_EXPLORATION_MODE * @see #FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY * @see #FLAG_REQUEST_FILTER_KEY_EVENTS * @see #FLAG_REPORT_VIEW_IDS * @see #FLAG_RETRIEVE_INTERACTIVE_WINDOWS * @see #FLAG_ENABLE_ACCESSIBILITY_VOLUME * @see #FLAG_REQUEST_ACCESSIBILITY_BUTTON * @see #FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK * @see #FLAG_INPUT_METHOD_EDITOR */ public int flags; /** * Whether or not the service has crashed and is awaiting restart. Only valid from {@link * android.view.accessibility.AccessibilityManager#getInstalledAccessibilityServiceList()}, * because that is populated from the internal list of running services. * * @hide */ public boolean crashed; /** * A recommended timeout in milliseconds for non-interactive controls. */ private int mNonInteractiveUiTimeout; /** * A recommended timeout in milliseconds for interactive controls. */ private int mInteractiveUiTimeout; /** * The component name the accessibility service. */ @NonNull private ComponentName mComponentName; /** * The Service that implements this accessibility service component. */ private ResolveInfo mResolveInfo; /** * The accessibility service setting activity's name, used by the system * settings to launch the setting activity of this accessibility service. */ private String mSettingsActivityName; /** * The name of {@link android.service.quicksettings.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 {@link android.service.quicksettings.TileService}. */ private String mTileServiceName; /** * Bit mask with capabilities of this service. */ private int mCapabilities; /** * Resource id of the summary of the accessibility service. */ private int mSummaryResId; /** * Non-localized summary of the accessibility service. */ private String mNonLocalizedSummary; /** * Resource id of the intro of the accessibility service. */ private int mIntroResId; /** * Resource id of the description of the accessibility service. */ private int mDescriptionResId; /** * Non localized description of the accessibility service. */ private String mNonLocalizedDescription; /** * For accessibility services targeting APIs greater than {@link Build.VERSION_CODES#Q API 29}, * {@link #FLAG_REQUEST_ACCESSIBILITY_BUTTON} must be specified in the accessibility service * metadata file. Otherwise, it will be ignored. */ @ChangeId @EnabledAfter(targetSdkVersion = android.os.Build.VERSION_CODES.Q) private static final long REQUEST_ACCESSIBILITY_BUTTON_CHANGE = 136293963L; /** * Resource id of the animated image of the accessibility service. */ private int mAnimatedImageRes; /** * Resource id of the html description of the accessibility service. */ private int mHtmlDescriptionRes; /** * Whether the service is for accessibility. * * @hide */ private boolean mIsAccessibilityTool = false; /** * {@link InputDevice} sources which may send {@link android.view.MotionEvent}s. * @see #setMotionEventSources(int) * @hide */ @IntDef(flag = true, prefix = { "SOURCE_" }, value = { 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, InputDevice.SOURCE_TOUCHSCREEN }) @Retention(RetentionPolicy.SOURCE) public @interface MotionEventSources {} /** * The bit mask of {@link android.view.InputDevice} sources that the accessibility * service wants to listen to for generic {@link android.view.MotionEvent}s. */ @MotionEventSources private int mMotionEventSources = 0; private int mObservedMotionEventSources = 0; // Default values for each dynamic property // LINT.IfChange(dynamic_property_defaults) private final DynamicPropertyDefaults mDynamicPropertyDefaults; private static class DynamicPropertyDefaults { private final int mEventTypesDefault; private final List* Note: A11y services targeting APIs > Q, it cannot update flagRequestAccessibilityButton * dynamically. *
* * @param platformCompat The platform compat service to check the compatibility change. * @param other The info from which to update the properties. * * @hide */ // LINT.IfChange(dynamic_property_update) public void updateDynamicallyConfigurableProperties(IPlatformCompat platformCompat, AccessibilityServiceInfo other) { if (isRequestAccessibilityButtonChangeEnabled(platformCompat)) { other.flags &= ~FLAG_REQUEST_ACCESSIBILITY_BUTTON; other.flags |= (flags & FLAG_REQUEST_ACCESSIBILITY_BUTTON); } eventTypes = other.eventTypes; packageNames = other.packageNames; feedbackType = other.feedbackType; notificationTimeout = other.notificationTimeout; mNonInteractiveUiTimeout = other.mNonInteractiveUiTimeout; mInteractiveUiTimeout = other.mInteractiveUiTimeout; flags = other.flags; mMotionEventSources = other.mMotionEventSources; if (Flags.motionEventObserving()) { setObservedMotionEventSources(other.mObservedMotionEventSources); } // NOTE: Ensure that only properties that are safe to be modified by the service itself // are included here (regardless of hidden setters, etc.). } // LINT.ThenChange(:dynamic_property_defaults) private boolean isRequestAccessibilityButtonChangeEnabled(IPlatformCompat platformCompat) { if (mResolveInfo == null) { return true; } try { if (platformCompat != null) { return platformCompat.isChangeEnabled(REQUEST_ACCESSIBILITY_BUTTON_CHANGE, mResolveInfo.serviceInfo.applicationInfo); } } catch (RemoteException ignore) { } return mResolveInfo.serviceInfo.applicationInfo.targetSdkVersion > Build.VERSION_CODES.Q; } /** * @hide */ public void setComponentName(@NonNull ComponentName component) { mComponentName = component; } /** * @hide */ public void setResolveInfo(@NonNull ResolveInfo resolveInfo) { mResolveInfo = resolveInfo; } /** * @hide */ @TestApi @NonNull public ComponentName getComponentName() { return mComponentName; } /** * The accessibility service id. ** Generated by the system. *
* @return The id (or {@code null} if the component is not set yet). */ public String getId() { return mComponentName == null ? null : mComponentName.flattenToShortString(); } /** * The service {@link ResolveInfo}. ** Generated by the system. *
* @return The info. */ public ResolveInfo getResolveInfo() { return mResolveInfo; } /** * The settings activity name. ** Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return The settings activity name. */ public String getSettingsActivityName() { return mSettingsActivityName; } /** * Gets the name of {@link android.service.quicksettings.TileService} is associated with * this accessibility service. * * @return The name of {@link android.service.quicksettings.TileService}. */ @Nullable public String getTileServiceName() { return mTileServiceName; } /** * Gets the animated image resource id. * * @return The animated image resource id. * * @hide */ public int getAnimatedImageRes() { return mAnimatedImageRes; } /** * The animated image drawable. ** Image can not exceed the screen size. * Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return The animated image drawable, or null if the resource is invalid or the image * exceed the screen size. * * @hide */ @Nullable public Drawable loadAnimatedImage(@NonNull Context context) { if (mAnimatedImageRes == /* invalid */ 0) { return null; } return loadSafeAnimatedImage(context, mResolveInfo.serviceInfo.applicationInfo, mAnimatedImageRes); } /** * Whether this service can retrieve the current window's content. ** Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return True if window content can be retrieved. * * @deprecated Use {@link #getCapabilities()}. */ public boolean getCanRetrieveWindowContent() { return (mCapabilities & CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT) != 0; } /** * Returns the bit mask of capabilities this accessibility service has such as * being able to retrieve the active window content, etc. * * @return The capability bit mask. * * @see #CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT * @see #CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION * @see #CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS * @see #CAPABILITY_CAN_CONTROL_MAGNIFICATION * @see #CAPABILITY_CAN_PERFORM_GESTURES * @see #CAPABILITY_CAN_TAKE_SCREENSHOT */ public int getCapabilities() { return mCapabilities; } /** * Sets the bit mask of capabilities this accessibility service has such as * being able to retrieve the active window content, etc. * * @param capabilities The capability bit mask. * * @see #CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT * @see #CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION * @see #CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS * @see #CAPABILITY_CAN_CONTROL_MAGNIFICATION * @see #CAPABILITY_CAN_PERFORM_GESTURES * @see #CAPABILITY_CAN_TAKE_SCREENSHOT * * @hide */ @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553) public void setCapabilities(int capabilities) { mCapabilities = capabilities; } /** * Returns the bit mask of {@link android.view.InputDevice} sources that the accessibility * service wants to listen to for generic {@link android.view.MotionEvent}s. */ @MotionEventSources public int getMotionEventSources() { return mMotionEventSources; } /** * Sets the bit mask of {@link android.view.InputDevice} sources that the accessibility * service wants to listen to for generic {@link android.view.MotionEvent}s. * ** Including an {@link android.view.InputDevice} source that does not send * {@link android.view.MotionEvent}s is effectively a no-op for that source, since you will * not receive any events from that source. *
* ** See {@link android.view.InputDevice} for complete source definitions. * Many input devices send {@link android.view.InputEvent}s from more than one type of source so * you may need to include multiple {@link android.view.MotionEvent} sources here, in addition * to using {@link AccessibilityService#onKeyEvent} to listen to {@link android.view.KeyEvent}s. *
* ** Note: {@link android.view.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. *
* * @param motionEventSources A bit mask of {@link android.view.InputDevice} sources. * @see AccessibilityService#onMotionEvent */ public void setMotionEventSources(@MotionEventSources int motionEventSources) { mMotionEventSources = motionEventSources; mObservedMotionEventSources = 0; } /** * Sets the bit mask of {@link android.view.InputDevice} sources that the accessibility service * wants to observe generic {@link android.view.MotionEvent}s from if it has already requested * to listen to them using {@link #setMotionEventSources(int)}. Events from these sources will * be sent to the rest of the input pipeline without being consumed by accessibility services. * This service will still be able to see them. * *Note: you will need to call this function every time you call {@link * #setMotionEventSources(int)}. Calling {@link #setMotionEventSources(int)} clears the list of * observed motion event sources for this service. * *
Note: {@link android.view.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. * *
Including an {@link android.view.InputDevice} source that does not send {@link * android.view.MotionEvent}s is effectively a no-op for that source, since you will not receive * any events from that source. * *
Note: Calling this function with a source that has not been listened to * using {@link #setMotionEventSources(int)} will throw an exception. * * @see AccessibilityService#onMotionEvent * @see #MotionEventSources * @see #setMotionEventSources(int) * @hide */ @FlaggedApi(Flags.FLAG_MOTION_EVENT_OBSERVING) @TestApi public void setObservedMotionEventSources(int observedMotionEventSources) { // Confirm that any sources requested here have already been requested for listening. if ((observedMotionEventSources & ~mMotionEventSources) != 0) { String message = String.format( "Requested motion event sources for listening = 0x%x but requested" + " motion event sources for observing = 0x%x.", mMotionEventSources, observedMotionEventSources); throw new IllegalArgumentException(message); } mObservedMotionEventSources = observedMotionEventSources; } /** * Returns the bit mask of {@link android.view.InputDevice} sources that the accessibility * service wants to observe generic {@link android.view.MotionEvent}s from if it has already * requested to listen to them using {@link #setMotionEventSources(int)}. Events from these * sources will be sent to the rest of the input pipeline without being consumed by * accessibility services. This service will still be able to see them. * * @hide */ @FlaggedApi(Flags.FLAG_MOTION_EVENT_OBSERVING) @MotionEventSources @TestApi public int getObservedMotionEventSources() { return mObservedMotionEventSources; } /** * The localized summary of the accessibility service. * *
Statically set from {@link AccessibilityService#SERVICE_META_DATA * meta-data}. * * @return The localized summary if available, and {@code null} if a summary has not been * provided. */ public CharSequence loadSummary(PackageManager packageManager) { if (mSummaryResId == 0) { return mNonLocalizedSummary; } ServiceInfo serviceInfo = mResolveInfo.serviceInfo; CharSequence summary = packageManager.getText(serviceInfo.packageName, mSummaryResId, serviceInfo.applicationInfo); if (summary != null) { return summary.toString().trim(); } return null; } /** * The localized intro of the accessibility service. *
* Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return The localized intro if available, and {@code null} if a intro * has not been provided. */ @Nullable public CharSequence loadIntro(@NonNull PackageManager packageManager) { if (mIntroResId == /* invalid */ 0) { return null; } ServiceInfo serviceInfo = mResolveInfo.serviceInfo; CharSequence intro = packageManager.getText(serviceInfo.packageName, mIntroResId, serviceInfo.applicationInfo); if (intro != null) { return intro.toString().trim(); } return null; } /** * Gets the non-localized description of the accessibility service. ** Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return The description. * * @deprecated Use {@link #loadDescription(PackageManager)}. */ public String getDescription() { return mNonLocalizedDescription; } /** * The localized description of the accessibility service. ** Statically set from * {@link AccessibilityService#SERVICE_META_DATA meta-data}. *
* @return The localized description. */ public String loadDescription(PackageManager packageManager) { if (mDescriptionResId == 0) { return mNonLocalizedDescription; } ServiceInfo serviceInfo = mResolveInfo.serviceInfo; CharSequence description = packageManager.getText(serviceInfo.packageName, mDescriptionResId, serviceInfo.applicationInfo); if (description != null) { return description.toString().trim(); } return null; } /** * The localized and restricted html description of the accessibility service. *
* Filters the tag which do not meet the custom specification and the tag.
* Statically set from
* {@link AccessibilityService#SERVICE_META_DATA meta-data}.
*
* This value can be dynamically set at runtime by * {@link AccessibilityService#setServiceInfo(AccessibilityServiceInfo)}. *
* * @param timeout The timeout in milliseconds. * * @see android.R.styleable#AccessibilityService_nonInteractiveUiTimeout */ public void setNonInteractiveUiTimeoutMillis(@IntRange(from = 0) int timeout) { mNonInteractiveUiTimeout = timeout; } /** * Get the recommended timeout for non-interactive controls. * * @return The timeout in milliseconds. * * @see #setNonInteractiveUiTimeoutMillis(int) */ public int getNonInteractiveUiTimeoutMillis() { return mNonInteractiveUiTimeout; } /** * 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 * {@link AccessibilityService#setServiceInfo(AccessibilityServiceInfo)}. *
* * @param timeout The timeout in milliseconds. * * @see android.R.styleable#AccessibilityService_interactiveUiTimeout */ public void setInteractiveUiTimeoutMillis(@IntRange(from = 0) int timeout) { mInteractiveUiTimeout = timeout; } /** * Get the recommended timeout for interactive controls. * * @return The timeout in milliseconds. * * @see #setInteractiveUiTimeoutMillis(int) */ public int getInteractiveUiTimeoutMillis() { return mInteractiveUiTimeout; } /** {@hide} */ public boolean isDirectBootAware() { return ((flags & FLAG_FORCE_DIRECT_BOOT_AWARE) != 0) || mResolveInfo.serviceInfo.directBootAware; } /** * Sets whether the service is used to assist users with disabilities. * ** This property is normally provided in the service's {@link #mResolveInfo ResolveInfo}. *
* ** This method is helpful for unit testing. However, this property is not dynamically * configurable by a standard {@link AccessibilityService} so it's not possible to update the * copy held by the system with this method. *
* * @hide */ @SystemApi public void setAccessibilityTool(boolean isAccessibilityTool) { mIsAccessibilityTool = isAccessibilityTool; } /** * Indicates if the service is used to assist users with disabilities. * * @return {@code true} if the property is set to true. */ public boolean isAccessibilityTool() { return mIsAccessibilityTool; } /** * {@inheritDoc} */ public int describeContents() { return 0; } /** @hide */ public final boolean isWithinParcelableSize() { final Parcel parcel = Parcel.obtain(); writeToParcel(parcel, 0); final boolean result = parcel.dataSize() <= IBinder.MAX_IPC_SIZE; parcel.recycle(); return result; } public void writeToParcel(Parcel parcel, int flagz) { parcel.writeInt(eventTypes); parcel.writeStringArray(packageNames); parcel.writeInt(feedbackType); parcel.writeLong(notificationTimeout); parcel.writeInt(mNonInteractiveUiTimeout); parcel.writeInt(mInteractiveUiTimeout); parcel.writeInt(flags); parcel.writeInt(crashed ? 1 : 0); parcel.writeParcelable(mComponentName, flagz); parcel.writeParcelable(mResolveInfo, 0); parcel.writeString(mSettingsActivityName); parcel.writeInt(mCapabilities); parcel.writeInt(mSummaryResId); parcel.writeString(mNonLocalizedSummary); parcel.writeInt(mDescriptionResId); parcel.writeInt(mAnimatedImageRes); parcel.writeInt(mHtmlDescriptionRes); parcel.writeString(mNonLocalizedDescription); parcel.writeBoolean(mIsAccessibilityTool); parcel.writeString(mTileServiceName); parcel.writeInt(mIntroResId); parcel.writeInt(mMotionEventSources); parcel.writeInt(mObservedMotionEventSources); } private void initFromParcel(Parcel parcel) { eventTypes = parcel.readInt(); packageNames = parcel.readStringArray(); feedbackType = parcel.readInt(); notificationTimeout = parcel.readLong(); mNonInteractiveUiTimeout = parcel.readInt(); mInteractiveUiTimeout = parcel.readInt(); flags = parcel.readInt(); crashed = parcel.readInt() != 0; mComponentName = parcel.readParcelable(this.getClass().getClassLoader(), android.content.ComponentName.class); mResolveInfo = parcel.readParcelable(null, android.content.pm.ResolveInfo.class); mSettingsActivityName = parcel.readString(); mCapabilities = parcel.readInt(); mSummaryResId = parcel.readInt(); mNonLocalizedSummary = parcel.readString(); mDescriptionResId = parcel.readInt(); mAnimatedImageRes = parcel.readInt(); mHtmlDescriptionRes = parcel.readInt(); mNonLocalizedDescription = parcel.readString(); mIsAccessibilityTool = parcel.readBoolean(); mTileServiceName = parcel.readString(); mIntroResId = parcel.readInt(); mMotionEventSources = parcel.readInt(); // use the setter here because it throws an exception for invalid values. setObservedMotionEventSources(parcel.readInt()); } @Override public int hashCode() { return 31 * 1 + ((mComponentName == null) ? 0 : mComponentName.hashCode()); } @Override public boolean equals(@Nullable Object obj) { if (this == obj) { return true; } if (obj == null) { return false; } if (getClass() != obj.getClass()) { return false; } AccessibilityServiceInfo other = (AccessibilityServiceInfo) obj; if (mComponentName == null) { if (other.mComponentName != null) { return false; } } else if (!mComponentName.equals(other.mComponentName)) { return false; } return true; } @Override public String toString() { StringBuilder stringBuilder = new StringBuilder(); appendEventTypes(stringBuilder, eventTypes); stringBuilder.append(", "); appendPackageNames(stringBuilder, packageNames); stringBuilder.append(", "); appendFeedbackTypes(stringBuilder, feedbackType); stringBuilder.append(", "); stringBuilder.append("notificationTimeout: ").append(notificationTimeout); stringBuilder.append(", "); stringBuilder.append("nonInteractiveUiTimeout: ").append(mNonInteractiveUiTimeout); stringBuilder.append(", "); stringBuilder.append("interactiveUiTimeout: ").append(mInteractiveUiTimeout); stringBuilder.append(", "); appendFlags(stringBuilder, flags); stringBuilder.append(", "); stringBuilder.append("id: ").append(getId()); stringBuilder.append(", "); stringBuilder.append("resolveInfo: ").append(mResolveInfo); stringBuilder.append(", "); stringBuilder.append("settingsActivityName: ").append(mSettingsActivityName); stringBuilder.append(", "); stringBuilder.append("tileServiceName: ").append(mTileServiceName); stringBuilder.append(", "); stringBuilder.append("summary: ").append(mNonLocalizedSummary); stringBuilder.append(", "); stringBuilder.append("isAccessibilityTool: ").append(mIsAccessibilityTool); stringBuilder.append(", "); appendCapabilities(stringBuilder, mCapabilities); return stringBuilder.toString(); } private static void appendFeedbackTypes(StringBuilder stringBuilder, @FeedbackType int feedbackTypes) { stringBuilder.append("feedbackTypes:"); stringBuilder.append("["); while (feedbackTypes != 0) { final int feedbackTypeBit = (1 << Integer.numberOfTrailingZeros(feedbackTypes)); stringBuilder.append(feedbackTypeToString(feedbackTypeBit)); feedbackTypes &= ~feedbackTypeBit; if (feedbackTypes != 0) { stringBuilder.append(", "); } } stringBuilder.append("]"); } private static void appendPackageNames(StringBuilder stringBuilder, String[] packageNames) { stringBuilder.append("packageNames:"); stringBuilder.append("["); if (packageNames != null) { final int packageNameCount = packageNames.length; for (int i = 0; i < packageNameCount; i++) { stringBuilder.append(packageNames[i]); if (i < packageNameCount - 1) { stringBuilder.append(", "); } } } stringBuilder.append("]"); } private static void appendEventTypes(StringBuilder stringBuilder, int eventTypes) { stringBuilder.append("eventTypes:"); stringBuilder.append("["); while (eventTypes != 0) { final int eventTypeBit = (1 << Integer.numberOfTrailingZeros(eventTypes)); stringBuilder.append(AccessibilityEvent.eventTypeToString(eventTypeBit)); eventTypes &= ~eventTypeBit; if (eventTypes != 0) { stringBuilder.append(", "); } } stringBuilder.append("]"); } private static void appendFlags(StringBuilder stringBuilder, int flags) { stringBuilder.append("flags:"); stringBuilder.append("["); while (flags != 0) { final int flagBit = (1 << Integer.numberOfTrailingZeros(flags)); stringBuilder.append(flagToString(flagBit)); flags &= ~flagBit; if (flags != 0) { stringBuilder.append(", "); } } stringBuilder.append("]"); } private static void appendCapabilities(StringBuilder stringBuilder, int capabilities) { stringBuilder.append("capabilities:"); stringBuilder.append("["); while (capabilities != 0) { final int capabilityBit = (1 << Integer.numberOfTrailingZeros(capabilities)); stringBuilder.append(capabilityToString(capabilityBit)); capabilities &= ~capabilityBit; if (capabilities != 0) { stringBuilder.append(", "); } } stringBuilder.append("]"); } /** * Returns the string representation of a feedback type. For example, * {@link #FEEDBACK_SPOKEN} is represented by the string FEEDBACK_SPOKEN. * * @param feedbackType The feedback type. * @return The string representation. */ public static String feedbackTypeToString(int feedbackType) { StringBuilder builder = new StringBuilder(); builder.append("["); while (feedbackType != 0) { final int feedbackTypeFlag = 1 << Integer.numberOfTrailingZeros(feedbackType); feedbackType &= ~feedbackTypeFlag; switch (feedbackTypeFlag) { case FEEDBACK_AUDIBLE: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_AUDIBLE"); break; case FEEDBACK_HAPTIC: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_HAPTIC"); break; case FEEDBACK_GENERIC: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_GENERIC"); break; case FEEDBACK_SPOKEN: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_SPOKEN"); break; case FEEDBACK_VISUAL: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_VISUAL"); break; case FEEDBACK_BRAILLE: if (builder.length() > 1) { builder.append(", "); } builder.append("FEEDBACK_BRAILLE"); break; } } builder.append("]"); return builder.toString(); } /** * Returns the string representation of a flag. For example, * {@link #DEFAULT} is represented by the string DEFAULT. * * @param flag The flag. * @return The string representation. */ public static String flagToString(int flag) { switch (flag) { case DEFAULT: return "DEFAULT"; case FLAG_INCLUDE_NOT_IMPORTANT_VIEWS: return "FLAG_INCLUDE_NOT_IMPORTANT_VIEWS"; case FLAG_REQUEST_TOUCH_EXPLORATION_MODE: return "FLAG_REQUEST_TOUCH_EXPLORATION_MODE"; case FLAG_SERVICE_HANDLES_DOUBLE_TAP: return "FLAG_SERVICE_HANDLES_DOUBLE_TAP"; case FLAG_REQUEST_MULTI_FINGER_GESTURES: return "FLAG_REQUEST_MULTI_FINGER_GESTURES"; case FLAG_REQUEST_2_FINGER_PASSTHROUGH: return "FLAG_REQUEST_2_FINGER_PASSTHROUGH"; case FLAG_SEND_MOTION_EVENTS: return "FLAG_SEND_MOTION_EVENTS"; case FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY: return "FLAG_REQUEST_ENHANCED_WEB_ACCESSIBILITY"; case FLAG_REPORT_VIEW_IDS: return "FLAG_REPORT_VIEW_IDS"; case FLAG_REQUEST_FILTER_KEY_EVENTS: return "FLAG_REQUEST_FILTER_KEY_EVENTS"; case FLAG_RETRIEVE_INTERACTIVE_WINDOWS: return "FLAG_RETRIEVE_INTERACTIVE_WINDOWS"; case FLAG_ENABLE_ACCESSIBILITY_VOLUME: return "FLAG_ENABLE_ACCESSIBILITY_VOLUME"; case FLAG_REQUEST_ACCESSIBILITY_BUTTON: return "FLAG_REQUEST_ACCESSIBILITY_BUTTON"; case FLAG_REQUEST_FINGERPRINT_GESTURES: return "FLAG_REQUEST_FINGERPRINT_GESTURES"; case FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK: return "FLAG_REQUEST_SHORTCUT_WARNING_DIALOG_SPOKEN_FEEDBACK"; case FLAG_INPUT_METHOD_EDITOR: return "FLAG_INPUT_METHOD_EDITOR"; default: return null; } } /** * Returns the string representation of a capability. For example, * {@link #CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT} is represented * by the string CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT. * * @param capability The capability. * @return The string representation. */ public static String capabilityToString(int capability) { switch (capability) { case CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT: return "CAPABILITY_CAN_RETRIEVE_WINDOW_CONTENT"; case CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION: return "CAPABILITY_CAN_REQUEST_TOUCH_EXPLORATION"; case CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS: return "CAPABILITY_CAN_REQUEST_FILTER_KEY_EVENTS"; case CAPABILITY_CAN_CONTROL_MAGNIFICATION: return "CAPABILITY_CAN_CONTROL_MAGNIFICATION"; case CAPABILITY_CAN_PERFORM_GESTURES: return "CAPABILITY_CAN_PERFORM_GESTURES"; case CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES: return "CAPABILITY_CAN_REQUEST_FINGERPRINT_GESTURES"; case CAPABILITY_CAN_TAKE_SCREENSHOT: return "CAPABILITY_CAN_TAKE_SCREENSHOT"; default: return "UNKNOWN"; } } /** * @hide * @return The list of {@link CapabilityInfo} objects. * @deprecated The version that takes a context works better. */ public List