AccessibilityNodeInfo

ACTION_ACCESSIBILITY_FOCUS

static val ACTION_ACCESSIBILITY_FOCUS: Int

Action that gives accessibility focus to the node. See AccessibilityAction.ACTION_ACCESSIBILITY_FOCUS

Value: 64

ACTION_ARGUMENT_COLUMN_INT

static val ACTION_ARGUMENT_COLUMN_INT: String

Argument for specifying the collection column to make visible on screen.

Type: int
Actions:

• AccessibilityAction.ACTION_SCROLL_TO_POSITION

Value: "android.view.accessibility.action.ARGUMENT_COLUMN_INT"

ACTION_ARGUMENT_DIRECTION_INT

static val ACTION_ARGUMENT_DIRECTION_INT: String

Argument to represent the direction when using AccessibilityAction.ACTION_SCROLL_IN_DIRECTION.

The value of this argument can be one of:

• View.FOCUS_DOWN
• View.FOCUS_UP
• View.FOCUS_LEFT
• View.FOCUS_RIGHT
• View.FOCUS_FORWARD
• View.FOCUS_BACKWARD

Value: "android.view.accessibility.action.ARGUMENT_DIRECTION_INT"

ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN

static val ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN: String

Argument for whether when moving at granularity to extend the selection or to move it otherwise.

Type: boolean
Actions:

• AccessibilityAction.ACTION_NEXT_AT_MOVEMENT_GRANULARITY
• AccessibilityAction.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

Value: "ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN"

ACTION_ARGUMENT_HTML_ELEMENT_STRING

static val ACTION_ARGUMENT_HTML_ELEMENT_STRING: String

Argument for which HTML element to get moving to the next/previous HTML element.

Type: String
Actions:

• AccessibilityAction.ACTION_NEXT_HTML_ELEMENT
• AccessibilityAction.ACTION_PREVIOUS_HTML_ELEMENT

Value: "ACTION_ARGUMENT_HTML_ELEMENT_STRING"

ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT

static val ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT: String

Argument for which movement granularity to be used when traversing the node text.

Type: int
Actions:

• AccessibilityAction.ACTION_NEXT_AT_MOVEMENT_GRANULARITY
• AccessibilityAction.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

Value: "ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT"

ACTION_ARGUMENT_MOVE_WINDOW_X

static val ACTION_ARGUMENT_MOVE_WINDOW_X: String

Argument for specifying the x coordinate to which to move a window.

Type: int
Actions:

• AccessibilityAction.ACTION_MOVE_WINDOW

Value: "ACTION_ARGUMENT_MOVE_WINDOW_X"

ACTION_ARGUMENT_MOVE_WINDOW_Y

static val ACTION_ARGUMENT_MOVE_WINDOW_Y: String

Argument for specifying the y coordinate to which to move a window.

Type: int
Actions:

• AccessibilityAction.ACTION_MOVE_WINDOW

Value: "ACTION_ARGUMENT_MOVE_WINDOW_Y"

ACTION_ARGUMENT_PRESS_AND_HOLD_DURATION_MILLIS_INT

static val ACTION_ARGUMENT_PRESS_AND_HOLD_DURATION_MILLIS_INT: String

Argument to represent the duration in milliseconds to press and hold a node.

Type: int
Actions:

• AccessibilityAction.ACTION_PRESS_AND_HOLD

Value: "android.view.accessibility.action.ARGUMENT_PRESS_AND_HOLD_DURATION_MILLIS_INT"

ACTION_ARGUMENT_PROGRESS_VALUE

static val ACTION_ARGUMENT_PROGRESS_VALUE: String

Argument for specifying the progress value to set.

Type: float
Actions:

• AccessibilityAction.ACTION_SET_PROGRESS

Value: "android.view.accessibility.action.ARGUMENT_PROGRESS_VALUE"

ACTION_ARGUMENT_ROW_INT

static val ACTION_ARGUMENT_ROW_INT: String

Argument for specifying the collection row to make visible on screen.

Type: int
Actions:

• AccessibilityAction.ACTION_SCROLL_TO_POSITION

Value: "android.view.accessibility.action.ARGUMENT_ROW_INT"

ACTION_ARGUMENT_SCROLL_AMOUNT_FLOAT

static val ACTION_ARGUMENT_SCROLL_AMOUNT_FLOAT: String

Argument to represent the scroll amount as a percent of the visible area of a node, with 1.0F as the default. Values smaller than 1.0F represent a partial scroll of the node, and values larger than 1.0F represent a scroll that extends beyond the currently visible node Rect. Setting this to Float.POSITIVE_INFINITY or to another "too large" value should scroll to the end of the node. Negative values should not be used with this argument.

This argument should be used with the following scroll actions:

• AccessibilityAction.ACTION_SCROLL_FORWARD
• AccessibilityAction.ACTION_SCROLL_BACKWARD
• AccessibilityAction.ACTION_SCROLL_UP
• AccessibilityAction.ACTION_SCROLL_DOWN
• AccessibilityAction.ACTION_SCROLL_LEFT
• AccessibilityAction.ACTION_SCROLL_RIGHT

Example: if a view representing a list of items implements AccessibilityAction.ACTION_SCROLL_FORWARD to scroll forward by an entire screen (one "page"), then passing a value of .25F via this argument should scroll that view only by 1/4th of a screen. Passing a value of 1.50F via this argument should scroll the view by 1 1/2 screens or to end of the node if the node doesn't extend to 1 1/2 screens.

This argument should not be used with the following scroll actions, which don't cleanly conform to granular scroll semantics:

• AccessibilityAction.ACTION_SCROLL_IN_DIRECTION
• AccessibilityAction.ACTION_SCROLL_TO_POSITION

Views that support this argument should set setGranularScrollingSupported(boolean) to true. Clients should use isGranularScrollingSupported() to check if granular scrolling is supported.

Value: "android.view.accessibility.action.ARGUMENT_SCROLL_AMOUNT_FLOAT"

ACTION_ARGUMENT_SELECTION_END_INT

static val ACTION_ARGUMENT_SELECTION_END_INT: String

Argument for specifying the selection end.

Type: int
Actions:

• AccessibilityAction.ACTION_SET_SELECTION

Value: "ACTION_ARGUMENT_SELECTION_END_INT"

ACTION_ARGUMENT_SELECTION_START_INT

static val ACTION_ARGUMENT_SELECTION_START_INT: String

Argument for specifying the selection start.

Type: int
Actions:

• AccessibilityAction.ACTION_SET_SELECTION

Value: "ACTION_ARGUMENT_SELECTION_START_INT"

ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE

static val ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE: String

Argument for specifying the text content to set.

Type: CharSequence
Actions:

• AccessibilityAction.ACTION_SET_TEXT

Value: "ACTION_ARGUMENT_SET_TEXT_CHARSEQUENCE"

ACTION_CLEAR_ACCESSIBILITY_FOCUS

static val ACTION_CLEAR_ACCESSIBILITY_FOCUS: Int

Action that clears accessibility focus of the node. See AccessibilityAction.ACTION_CLEAR_ACCESSIBILITY_FOCUS

Value: 128

ACTION_CLEAR_FOCUS

static val ACTION_CLEAR_FOCUS: Int

Action that clears input focus of the node. See AccessibilityAction.ACTION_CLEAR_FOCUS

Value: 2

ACTION_CLEAR_SELECTION

static val ACTION_CLEAR_SELECTION: Int

Action that deselects the node.

Value: 8

ACTION_CLICK

static val ACTION_CLICK: Int

Action that clicks on the node info.

Value: 16

ACTION_COLLAPSE

static val ACTION_COLLAPSE: Int

Action to collapse an expandable node.

Value: 524288

ACTION_COPY

static val ACTION_COPY: Int

Action to copy the current selection to the clipboard.

Value: 16384

ACTION_CUT

static val ACTION_CUT: Int

Action to cut the current selection and place it to the clipboard.

Value: 65536

ACTION_DISMISS

static val ACTION_DISMISS: Int

Action to dismiss a dismissable node.

Value: 1048576

ACTION_EXPAND

static val ACTION_EXPAND: Int

Action to expand an expandable node.

Value: 262144

ACTION_FOCUS

static val ACTION_FOCUS: Int

Action that gives input focus to the node. See AccessibilityAction.ACTION_FOCUS

Value: 1

ACTION_LONG_CLICK

static val ACTION_LONG_CLICK: Int

Action that long clicks on the node.

It does not support coordinate information for anchoring.

Value: 32

ACTION_NEXT_AT_MOVEMENT_GRANULARITY

static val ACTION_NEXT_AT_MOVEMENT_GRANULARITY: Int

Action that requests to go to the next entity in this node's text at a given movement granularity. For example, move to the next character, word, etc.

Arguments: ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT<, ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the previous character and do not extend selection.

<p><code> Bundle arguments = new Bundle(); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT, AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER); arguments.putBoolean(AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN, false); info.performAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY, arguments); </code></p>

Value: 256

ACTION_NEXT_HTML_ELEMENT

static val ACTION_NEXT_HTML_ELEMENT: Int

Action to move to the next HTML element of a given type. For example, move to the BUTTON, INPUT, TABLE, etc.

Arguments: ACTION_ARGUMENT_HTML_ELEMENT_STRING
Example:

<p><code> Bundle arguments = new Bundle(); arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON"); info.performAction(AccessibilityNodeInfo.ACTION_NEXT_HTML_ELEMENT, arguments); </code></p>

Value: 1024

ACTION_PASTE

static val ACTION_PASTE: Int

Action to paste the current clipboard content.

Value: 32768

ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY

static val ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: Int

Action that requests to go to the previous entity in this node's text at a given movement granularity. For example, move to the next character, word, etc.

Arguments: ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT<, ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN
Example: Move to the next character and do not extend selection.

<p><code> Bundle arguments = new Bundle(); arguments.putInt(AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT, AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER); arguments.putBoolean(AccessibilityNodeInfo.ACTION_ARGUMENT_EXTEND_SELECTION_BOOLEAN, false); info.performAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY, arguments); </code></p>

Value: 512

ACTION_PREVIOUS_HTML_ELEMENT

static val ACTION_PREVIOUS_HTML_ELEMENT: Int

Action to move to the previous HTML element of a given type. For example, move to the BUTTON, INPUT, TABLE, etc.

Arguments: ACTION_ARGUMENT_HTML_ELEMENT_STRING
Example:

<p><code> Bundle arguments = new Bundle(); arguments.putString(AccessibilityNodeInfo.ACTION_ARGUMENT_HTML_ELEMENT_STRING, "BUTTON"); info.performAction(AccessibilityNodeInfo.ACTION_PREVIOUS_HTML_ELEMENT, arguments); </code></p>

Value: 2048

ACTION_SCROLL_BACKWARD

static val ACTION_SCROLL_BACKWARD: Int

Action to scroll the node content backward.

Value: 8192

ACTION_SCROLL_FORWARD

static val ACTION_SCROLL_FORWARD: Int

Action to scroll the node content forward.

Value: 4096

ACTION_SELECT

static val ACTION_SELECT: Int

Action that selects the node.

Value: 4

ACTION_SET_SELECTION

static val ACTION_SET_SELECTION: Int

Action to set the selection. Performing this action with no arguments clears the selection.

Value: 131072

ACTION_SET_TEXT

static val ACTION_SET_TEXT: Int

Action that sets the text of the node. Performing the action without argument, using null or empty CharSequence will clear the text. This action will also put the cursor at the end of text.

Value: 2097152

EXTRA_DATA_RENDERING_INFO_KEY

static val EXTRA_DATA_RENDERING_INFO_KEY: String

Key used to request extra data for the rendering information. The key requests that a AccessibilityNodeInfo.ExtraRenderingInfo be added to this info. This request is made with refreshWithExtraData(java.lang.String,android.os.Bundle) without argument.

The data can be retrieved from the ExtraRenderingInfo returned by getExtraRenderingInfo() using ExtraRenderingInfo.getLayoutSize, ExtraRenderingInfo.getTextSizeInPx() and ExtraRenderingInfo.getTextSizeUnit(). For layout params, it is supported by both TextView and ViewGroup. For text size and unit, it is only supported by TextView.

Value: "android.view.accessibility.extra.DATA_RENDERING_INFO_KEY"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH

static val EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH: String

Integer argument specifying the end index of the requested text location data. Must be positive and no larger than EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH.

Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH

static val EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_MAX_LENGTH: Int

The maximum allowed length of the requested text location data.

Value: 20000

EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX

static val EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX: String

Integer argument specifying the start index of the requested text location data. Must be valid inside the CharSequence returned by getText().

Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX"

EXTRA_DATA_TEXT_CHARACTER_LOCATION_KEY

static val EXTRA_DATA_TEXT_CHARACTER_LOCATION_KEY: String

Key used to request and locate extra data for text character location. This key requests that an array of android.graphics.RectFs be added to the extras. This request is made with refreshWithExtraData(java.lang.String,android.os.Bundle). The arguments taken by this request are two integers: EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_START_INDEX and EXTRA_DATA_TEXT_CHARACTER_LOCATION_ARG_LENGTH. The starting index must be valid inside the CharSequence returned by getText(), and the length must be positive.

The data can be retrieved from the Bundle returned by getExtras() using this string as a key for Bundle.getParcelableArray(String, Class). The android.graphics.RectF will be null for characters that either do not exist or are off the screen.

Note that character locations returned are modified by changes in display magnification. {@see #refreshWithExtraData(String, Bundle)}

Value: "android.view.accessibility.extra.DATA_TEXT_CHARACTER_LOCATION_KEY"

FLAG_PREFETCH_ANCESTORS

static val FLAG_PREFETCH_ANCESTORS: Int

Prefetching strategy that prefetches the ancestors of the requested node.

Ancestors will be prefetched before siblings and descendants.

Value: 1

FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST

static val FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST: Int

Prefetching strategy that prefetches the descendants of the requested node breadth-first.

This must not be combined with FLAG_PREFETCH_DESCENDANTS_HYBRID or FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Value: 16

FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST

static val FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST: Int

Prefetching strategy that prefetches the descendants of the requested node depth-first.

This must not be combined with FLAG_PREFETCH_DESCENDANTS_HYBRID or FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Value: 8

FLAG_PREFETCH_DESCENDANTS_HYBRID

static val FLAG_PREFETCH_DESCENDANTS_HYBRID: Int

Prefetching strategy that prefetches the descendants in a hybrid depth first and breadth first approach.

The children of the root node is prefetched before recursing on the children. This must not be combined with FLAG_PREFETCH_DESCENDANTS_DEPTH_FIRST or FLAG_PREFETCH_DESCENDANTS_BREADTH_FIRST or this will trigger an IllegalArgumentException.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Value: 4

FLAG_PREFETCH_SIBLINGS

static val FLAG_PREFETCH_SIBLINGS: Int

Prefetching strategy that prefetches the siblings of the requested node.

To avoid disconnected trees, this flag will also prefetch the parent. Siblings will be prefetched before descendants.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Value: 2

FLAG_PREFETCH_UNINTERRUPTIBLE

static val FLAG_PREFETCH_UNINTERRUPTIBLE: Int

Prefetching flag that specifies prefetching should not be interrupted by a request to retrieve a node or perform an action on a node.

See FLAG_PREFETCH_ANCESTORS for information on where these flags can be used.

Value: 32

FOCUS_ACCESSIBILITY

static val FOCUS_ACCESSIBILITY: Int

The accessibility focus.

Value: 2

FOCUS_INPUT

static val FOCUS_INPUT: Int

The input focus.

Value: 1

MAX_NUMBER_OF_PREFETCHED_NODES

static val MAX_NUMBER_OF_PREFETCHED_NODES: Int

Maximum batch size of prefetched nodes for a request.

Value: 50

MOVEMENT_GRANULARITY_CHARACTER

static val MOVEMENT_GRANULARITY_CHARACTER: Int

Movement granularity bit for traversing the text of a node by character.

Value: 1

MOVEMENT_GRANULARITY_LINE

static val MOVEMENT_GRANULARITY_LINE: Int

Movement granularity bit for traversing the text of a node by line.

Value: 4

MOVEMENT_GRANULARITY_PAGE

static val MOVEMENT_GRANULARITY_PAGE: Int

Movement granularity bit for traversing the text of a node by page.

Value: 16

MOVEMENT_GRANULARITY_PARAGRAPH

static val MOVEMENT_GRANULARITY_PARAGRAPH: Int

Movement granularity bit for traversing the text of a node by paragraph.

Value: 8

MOVEMENT_GRANULARITY_WORD

static val MOVEMENT_GRANULARITY_WORD: Int

Movement granularity bit for traversing the text of a node by word.

Value: 2

AccessibilityNodeInfo

AccessibilityNodeInfo()

Creates a new AccessibilityNodeInfo.

AccessibilityNodeInfo

AccessibilityNodeInfo(info: AccessibilityNodeInfo)

Copy constructor. Creates a new AccessibilityNodeInfo, and this new instance is initialized from the given info.

AccessibilityNodeInfo

AccessibilityNodeInfo(source: View)

Creates a new AccessibilityNodeInfo with the given source.

AccessibilityNodeInfo

AccessibilityNodeInfo(
    root: View, 
    virtualDescendantId: Int)

Creates a new AccessibilityNodeInfo with the given source.

addAction

open fun addAction(action: AccessibilityNodeInfo.AccessibilityAction!): Unit

Adds an action that can be performed on the node.

To add a standard action use the static constants on AccessibilityAction. To add a custom action create a new AccessibilityAction by passing in a resource id from your application as the action id and an optional label that describes the action. To override one of the standard actions use as the action id of a standard action id such as ACTION_CLICK and an optional label that describes the action.

Use androidx.core.view.ViewCompat#addAccessibilityAction(View, CharSequence, * AccessibilityViewCommand) to register an action directly on the view.

Note: Cannot be called from an android.accessibilityservice.AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

addAction

open fun addAction(action: Int): Unit

Deprecated: This has been deprecated for addAction(android.view.accessibility.AccessibilityNodeInfo.AccessibilityAction)

Adds an action that can be performed on the node.

Note: Cannot be called from an android.accessibilityservice.AccessibilityService. This class is made immutable before being delivered to an AccessibilityService.

addChild

open fun addChild(child: View!): Unit

Adds a child.

Note: Cannot be called from an android.accessibilityservice.AccessibilityService. This class is made immutable before being delivered to an AccessibilityService. Note that a view cannot be made its own child.

addChild

open fun addChild(
    root: View!, 
    virtualDescendantId: Int
): Unit

Adds a virtual child which is a descendant of the given root. If virtualDescendantId is View.NO_ID the root is added as a child.

A virtual descendant is an imaginary View that is reported as a part of the view hierarchy for accessibility purposes. This enables custom views that draw complex content to report them selves as a tree of virtual views, thus conveying their logical structure. Note that a view cannot be made its own child.

canOpenPopup

open fun canOpenPopup(): Boolean

Gets if this node opens a popup or a dialog.

describeContents

open fun describeContents(): Int

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.

equals

open fun equals(other: Any?): Boolean

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.

findAccessibilityNodeInfosByText

open fun findAccessibilityNodeInfosByText(text: String!): MutableList<AccessibilityNodeInfo!>!

Finds AccessibilityNodeInfos by text. The match is case insensitive containment. The search is relative to this info i.e. this info is the root of the traversed tree.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

findAccessibilityNodeInfosByViewId

open fun findAccessibilityNodeInfosByViewId(viewId: String): MutableList<AccessibilityNodeInfo!>!

Finds AccessibilityNodeInfos by the fully qualified view id's resource name where a fully qualified id is of the from "package:id/id_resource_name". For example, if the target application's package is "foo.bar" and the id resource name is "baz", the fully qualified resource id is "foo.bar:id/baz".

Note: The primary usage of this API is for UI test automation and in order to report the fully qualified view id if an AccessibilityNodeInfo the client has to set the AccessibilityServiceInfo.FLAG_REPORT_VIEW_IDS flag when configuring the android.accessibilityservice.AccessibilityService.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

findFocus

open fun findFocus(focus: Int): AccessibilityNodeInfo!

Find the view that has the specified focus type. The search starts from the view represented by this node info.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node. Or, use AccessibilityService.findFocus(int) for FOCUS_ACCESSIBILITY only since it has no such limitation.

focusSearch

open fun focusSearch(direction: Int): AccessibilityNodeInfo!

Searches for the nearest view in the specified direction that can take the input focus.

Note: If this view hierarchy has a SurfaceView embedding another view hierarchy via SurfaceView.setChildSurfacePackage, there is a limitation that this API won't be able to find the node for the view in the specified direction on the embedded view hierarchy. It's because views don't know about the embedded hierarchies. Instead, you could traverse all the children to find the node.

getActionList

open fun getActionList(): MutableList<AccessibilityNodeInfo.AccessibilityAction!>!

Gets the actions that can be performed on the node.

getActions

open fun getActions(): Int

Deprecated: Use getActionList().

Gets the actions that can be performed on the node.

getAvailableExtraData

open fun getAvailableExtraData(): MutableList<String!>!

Get the extra data available for this node.

Some data that is useful for some accessibility services is expensive to compute, and would place undue overhead on apps to compute all the time. That data can be requested with refreshWithExtraData(java.lang.String,android.os.Bundle).

getBoundsInParent

open fun getBoundsInParent(outBounds: Rect!): Unit

Deprecated: Use getBoundsInScreen(android.graphics.Rect) instead.

Gets the node bounds in the viewParent's coordinates. getParent() does not represent the source's viewParent. Instead it represents the result of View.getParentForAccessibility(), which returns the closest ancestor where View.isImportantForAccessibility() is true. So this method is not reliable.

When magnification is enabled, the bounds in parent are also scaled up by magnification scale. For example, it returns Rect(20, 20, 200, 200) for original bounds Rect(10, 10, 100, 100), when the magnification scale is 2.

getBoundsInScreen

open fun getBoundsInScreen(outBounds: Rect!): Unit

Gets the node bounds in screen coordinates.

When magnification is enabled, the bounds in screen are scaled up by magnification scale and the positions are also adjusted according to the offset of magnification viewport. For example, it returns Rect(-180, -180, 0, 0) for original bounds Rect(10, 10, 100, 100), when the magnification scale is 2 and offsets for X and Y are both 200.

getBoundsInWindow

open fun getBoundsInWindow(outBounds: Rect): Unit

Gets the node bounds in window coordinates.

The node bounds returned are not scaled by magnification.

getChild

open fun getChild(index: Int): AccessibilityNodeInfo!

Get the child at given index.

getChild

open fun getChild(
    index: Int, 
    prefetchingStrategy: Int
): AccessibilityNodeInfo?

Get the child at given index.

See getParent(int) for a description of prefetching.

getChildCount

open fun getChildCount(): Int

Gets the number of children.

getClassName

open fun getClassName(): CharSequence!

Gets the class this node comes from.

getCollectionInfo

open fun getCollectionInfo(): AccessibilityNodeInfo.CollectionInfo!

Gets the collection info if the node is a collection. A collection child is always a collection item.

getCollectionItemInfo

open fun getCollectionItemInfo(): AccessibilityNodeInfo.CollectionItemInfo!

Gets the collection item info if the node is a collection item. A collection item is always a child of a collection.

getContainerTitle

open fun getContainerTitle(): CharSequence?

Returns the container title.

getContentDescription

open fun getContentDescription(): CharSequence!

Gets the content description of this node.

getDrawingOrder

open fun getDrawingOrder(): Int

Get the drawing order of the view corresponding it this node.

Drawing order is determined only within the node's parent, so this index is only relative to its siblings.

In some cases, the drawing order is essentially simultaneous, so it is possible for two siblings to return the same value. It is also possible that values will be skipped.

getError

open fun getError(): CharSequence!

Gets the error text of this node.

getExtraRenderingInfo

open fun getExtraRenderingInfo(): AccessibilityNodeInfo.ExtraRenderingInfo?

Gets the extra rendering info if the node is meant to be refreshed with extra data to examine rendering related accessibility issues.

getExtras

open fun getExtras(): Bundle!

Gets an optional bundle with extra data. The bundle is lazily created and never null.

Note: It is recommended to use the package name of your application as a prefix for the keys to avoid collisions which may confuse an accessibility service if the same key has different meaning when emitted from different applications.

getHintText

open fun getHintText(): CharSequence!

Gets the hint text of this node. Only applies to nodes where text can be entered.

getInputType

open fun getInputType(): Int

Gets the input type of the source as defined by InputType.

getLabeledBy

open fun getLabeledBy(): AccessibilityNodeInfo!

Deprecated: Use getLabeledByList() instead.

Gets the node info which serves as the label of the view represented by this info for accessibility purposes.

getLiveRegion

open fun getLiveRegion(): Int

Gets the node's live region mode.

A live region is a node that contains information that is important for the user and when it changes the user should be notified. For example, a Snackbar that displays a confirmation notification should be marked as a live region with mode View.ACCESSIBILITY_LIVE_REGION_POLITE.

It is the responsibility of the accessibility service to monitor AccessibilityEvent.TYPE_WINDOW_CONTENT_CHANGED events indicating changes to live region nodes and their children.

getMaxTextLength

open fun getMaxTextLength(): Int

Returns the maximum text length for this node.

getMinDurationBetweenContentChanges

open fun getMinDurationBetweenContentChanges(): Duration

Gets the minimum time duration between two content change events.

getMovementGranularities

open fun getMovementGranularities(): Int

Gets the movement granularities for traversing the text of this node.

getPackageName

open fun getPackageName(): CharSequence!

Gets the package this node comes from.

getPaneTitle

open fun getPaneTitle(): CharSequence?

Get the title of the pane represented by this node.

getParent

open fun getParent(): AccessibilityNodeInfo!

Gets the parent.

getParent

open fun getParent(prefetchingStrategy: Int): AccessibilityNodeInfo?

Gets the parent.

Use prefetchingStrategy to determine the types of nodes prefetched from the app if the requested node is not in the cache and must be retrieved by the app. The default strategy for getParent() is a combination of ancestor and sibling strategies. The app will prefetch until all nodes fulfilling the strategies are fetched, another node request is sent, or the maximum prefetch batch size of MAX_NUMBER_OF_PREFETCHED_NODES nodes is reached. To prevent interruption by another request and to force prefetching of the max batch size, use AccessibilityNodeInfo.FLAG_PREFETCH_UNINTERRUPTIBLE.

getRangeInfo

open fun getRangeInfo(): AccessibilityNodeInfo.RangeInfo!

Gets the range info if this node is a range.

getStateDescription

open fun getStateDescription(): CharSequence?

Get the state description of this node.

getText

open fun getText(): CharSequence!

Gets the text of this node.

Note: If the text contains ClickableSpans or URLSpans, these spans will have been replaced with ones whose ClickableSpan.onClick(View) can be called from an AccessibilityService. When called from a service, the View argument is ignored and the corresponding span will be found on the view that this AccessibilityNodeInfo represents and called with that view as its argument.

This treatment of ClickableSpans means that the text returned from this method may different slightly one passed to setText(java.lang.CharSequence), although they will be equivalent according to TextUtils.equals(CharSequence, CharSequence). The ClickableSpan.onClick(View) of any spans, however, will generally not work outside of an accessibility service.

getTextSelectionEnd

open fun getTextSelectionEnd(): Int

Gets the text selection end if text is selected.

If no text is selected, both this method and AccessibilityNodeInfo.getTextSelectionStart() return the same value: the current location of the cursor.

getTextSelectionStart

open fun getTextSelectionStart(): Int

Gets the text selection start or the cursor position.

If no text is selected, both this method and AccessibilityNodeInfo.getTextSelectionEnd() return the same value: the current location of the cursor.

getTooltipText

open fun getTooltipText(): CharSequence?

Gets the tooltip text of this node.

getTouchDelegateInfo

open fun getTouchDelegateInfo(): AccessibilityNodeInfo.TouchDelegateInfo?

Get the TouchDelegateInfo for touch delegate behavior with the represented view. It is possible for the same node to be pointed to by several regions. Use TouchDelegateInfo.getRegionAt(int) to get touch delegate target Region, and TouchDelegateInfo.getTargetForRegion(Region) for AccessibilityNodeInfo from the given region.

getTraversalAfter

open fun getTraversalAfter(): AccessibilityNodeInfo!

Gets the node after which this one is visited in accessibility traversal. A screen-reader must visit the content of the other node before the content of this one.

getTraversalBefore

open fun getTraversalBefore(): AccessibilityNodeInfo!

Gets the node before which this one is visited during traversal. A screen-reader must visit the content of this node before the content of the one it precedes.

getUniqueId

open fun getUniqueId(): String?

Gets the unique id of the node.

getViewIdResourceName

open fun getViewIdResourceName(): String!

Gets the fully qualified resource name of the source view's id.

Note: The primary usage of this API is for UI test automation and in order to report the source view id of an AccessibilityNodeInfo the client has to set the AccessibilityServiceInfo.FLAG_REPORT_VIEW_IDS flag when configuring the android.accessibilityservice.AccessibilityService.

getWindow

open fun getWindow(): AccessibilityWindowInfo!

Gets the window to which this node belongs.

getWindowId

open fun getWindowId(): Int

Gets the id of the window from which the info comes from.

hasRequestInitialAccessibilityFocus

open fun hasRequestInitialAccessibilityFocus(): Boolean

Gets whether the node has setRequestInitialAccessibilityFocus.

hashCode

open fun hashCode(): Int

isAccessibilityDataSensitive

open fun isAccessibilityDataSensitive(): Boolean

Gets if the node's accessibility data is considered sensitive.

isAccessibilityFocused

open fun isAccessibilityFocused(): Boolean

Gets whether this node is accessibility focused.

This is distinct from isFocused(), which is used to track system focus. See ACTION_ACCESSIBILITY_FOCUS for details.

isCheckable

open fun isCheckable(): Boolean

Gets whether this node is checkable.

isChecked

open fun isChecked(): Boolean

Deprecated: Use getChecked() instead.

Gets whether this node is checked. This is only meaningful when isCheckable() returns true.

isClickable

open fun isClickable(): Boolean

Gets whether this node is clickable.

isContentInvalid

open fun isContentInvalid(): Boolean

Gets if the content of this node is invalid. For example, a date is not well-formed.