AccessibilityGestureEvent

public final class AccessibilityGestureEvent
extends Object implements Parcelable

java.lang.Object
   ↳ android.accessibilityservice.AccessibilityGestureEvent


This class describes the gesture event including gesture id and which display it happens on.

Note: Accessibility services setting the AccessibilityServiceInfo.FLAG_REQUEST_TOUCH_EXPLORATION_MODE flag can receive gestures.

Summary

Inherited constants

Fields

public static final Creator<AccessibilityGestureEvent> CREATOR

Public constructors

AccessibilityGestureEvent(int gestureId, int displayId, List<MotionEvent> motionEvents)

Constructs an AccessibilityGestureEvent to be dispatched to an accessibility service.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

static String gestureIdToString(int id)

Returns a string representation of the specified gesture id.

int getDisplayId()

Returns the display id of the received-gesture display, for use with DisplayManager.getDisplay(int).

int getGestureId()

Returns performed gesture id.

List<MotionEvent> getMotionEvents()

Returns the motion events that lead to this gesture.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 30
public static final Creator<AccessibilityGestureEvent> CREATOR

See also:

Public constructors

AccessibilityGestureEvent

Added in API level 30
public AccessibilityGestureEvent (int gestureId, 
                int displayId, 
                List<MotionEvent> motionEvents)

Constructs an AccessibilityGestureEvent to be dispatched to an accessibility service.

Parameters
gestureId int: the id number of the gesture.

displayId int: the display on which this gesture was performed.

motionEvents List: the motion events that lead to this gesture. This value cannot be null.

Public methods

describeContents

Added in API level 30
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

gestureIdToString

Added in API level 31
public static String gestureIdToString (int id)

Returns a string representation of the specified gesture id.

Parameters
id int

Returns
String This value cannot be null.

getDisplayId

Added in API level 30
public int getDisplayId ()

Returns the display id of the received-gesture display, for use with DisplayManager.getDisplay(int).

Returns
int the display id.

getGestureId

Added in API level 30
public int getGestureId ()

Returns performed gesture id.

Returns
int the performed gesture id. Value is AccessibilityService.GESTURE_UNKNOWN, android.accessibilityservice.AccessibilityService.GESTURE_TOUCH_EXPLORATION, AccessibilityService.GESTURE_2_FINGER_SINGLE_TAP, AccessibilityService.GESTURE_2_FINGER_DOUBLE_TAP, AccessibilityService.GESTURE_2_FINGER_DOUBLE_TAP_AND_HOLD, AccessibilityService.GESTURE_2_FINGER_TRIPLE_TAP, AccessibilityService.GESTURE_2_FINGER_TRIPLE_TAP_AND_HOLD, AccessibilityService.GESTURE_3_FINGER_SINGLE_TAP, AccessibilityService.GESTURE_3_FINGER_SINGLE_TAP_AND_HOLD, AccessibilityService.GESTURE_3_FINGER_DOUBLE_TAP, AccessibilityService.GESTURE_3_FINGER_DOUBLE_TAP_AND_HOLD, AccessibilityService.GESTURE_3_FINGER_TRIPLE_TAP, AccessibilityService.GESTURE_3_FINGER_TRIPLE_TAP_AND_HOLD, AccessibilityService.GESTURE_DOUBLE_TAP, AccessibilityService.GESTURE_DOUBLE_TAP_AND_HOLD, AccessibilityService.GESTURE_SWIPE_UP, AccessibilityService.GESTURE_SWIPE_UP_AND_LEFT, AccessibilityService.GESTURE_SWIPE_UP_AND_DOWN, AccessibilityService.GESTURE_SWIPE_UP_AND_RIGHT, AccessibilityService.GESTURE_SWIPE_DOWN, AccessibilityService.GESTURE_SWIPE_DOWN_AND_LEFT, AccessibilityService.GESTURE_SWIPE_DOWN_AND_UP, AccessibilityService.GESTURE_SWIPE_DOWN_AND_RIGHT, AccessibilityService.GESTURE_SWIPE_LEFT, AccessibilityService.GESTURE_SWIPE_LEFT_AND_UP, AccessibilityService.GESTURE_SWIPE_LEFT_AND_RIGHT, AccessibilityService.GESTURE_SWIPE_LEFT_AND_DOWN, AccessibilityService.GESTURE_SWIPE_RIGHT, AccessibilityService.GESTURE_SWIPE_RIGHT_AND_UP, AccessibilityService.GESTURE_SWIPE_RIGHT_AND_LEFT, AccessibilityService.GESTURE_SWIPE_RIGHT_AND_DOWN, AccessibilityService.GESTURE_2_FINGER_SWIPE_DOWN, AccessibilityService.GESTURE_2_FINGER_SWIPE_LEFT, AccessibilityService.GESTURE_2_FINGER_SWIPE_RIGHT, AccessibilityService.GESTURE_2_FINGER_SWIPE_UP, AccessibilityService.GESTURE_3_FINGER_SWIPE_DOWN, AccessibilityService.GESTURE_3_FINGER_SWIPE_LEFT, AccessibilityService.GESTURE_3_FINGER_SWIPE_RIGHT, AccessibilityService.GESTURE_3_FINGER_SWIPE_UP, AccessibilityService.GESTURE_4_FINGER_DOUBLE_TAP, AccessibilityService.GESTURE_4_FINGER_DOUBLE_TAP_AND_HOLD, AccessibilityService.GESTURE_4_FINGER_SINGLE_TAP, AccessibilityService.GESTURE_4_FINGER_SWIPE_DOWN, AccessibilityService.GESTURE_4_FINGER_SWIPE_LEFT, AccessibilityService.GESTURE_4_FINGER_SWIPE_RIGHT, AccessibilityService.GESTURE_4_FINGER_SWIPE_UP, or AccessibilityService.GESTURE_4_FINGER_TRIPLE_TAP

getMotionEvents

Added in API level 31
public List<MotionEvent> getMotionEvents ()

Returns the motion events that lead to this gesture.

Returns
List<MotionEvent> This value cannot be null.

toString

Added in API level 30
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 30
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: This value cannot be null.

flags 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