UiAutomation

FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES

int FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES

UiAutomation supresses accessibility services by default. This flag specifies that existing accessibility services should continue to run, and that new ones may start. This flag is set when obtaining the UiAutomation from getUiAutomation(int).

Constant Value: 1 (0x00000001)

ROTATION_FREEZE_0

int ROTATION_FREEZE_0

Rotation constant: Freeze rotation to 0 degrees (natural orientation)

Constant Value: 0 (0x00000000)

ROTATION_FREEZE_180

int ROTATION_FREEZE_180

Rotation constant: Freeze rotation to 180 degrees .

Constant Value: 2 (0x00000002)

ROTATION_FREEZE_270

int ROTATION_FREEZE_270

Rotation constant: Freeze rotation to 270 degrees .

Constant Value: 3 (0x00000003)

ROTATION_FREEZE_90

int ROTATION_FREEZE_90

Rotation constant: Freeze rotation to 90 degrees .

Constant Value: 1 (0x00000001)

ROTATION_FREEZE_CURRENT

int ROTATION_FREEZE_CURRENT

Rotation constant: Freeze rotation to its current state.

Constant Value: -1 (0xffffffff)

ROTATION_UNFREEZE

int ROTATION_UNFREEZE

Rotation constant: Unfreeze rotation (rotating the device changes its rotation state).

Constant Value: -2 (0xfffffffe)

clearWindowAnimationFrameStats

void clearWindowAnimationFrameStats ()

Clears the window animation rendering statistics. These statistics contain information about the most recently rendered window animation frames, i.e. for window transition animations.

clearWindowContentFrameStats

boolean clearWindowContentFrameStats (int windowId)

Clears the frame statistics for the content of a given window. These statistics contain information about the most recently rendered content frames.

executeAndWaitForEvent

AccessibilityEvent executeAndWaitForEvent (Runnable command, 
                UiAutomation.AccessibilityEventFilter filter, 
                long timeoutMillis)

Executes a command and waits for a specific accessibility event up to a given wait timeout. To detect a sequence of events one can implement a filter that keeps track of seen events of the expected sequence and returns true after the last event of that sequence is received.

Note: It is caller's responsibility to recycle the returned event.

executeShellCommand

ParcelFileDescriptor executeShellCommand (String command)

Executes a shell command. This method returs a file descriptor that points to the standard output stream. The command execution is similar to running "adb shell " from a host connected to the device.

Note: It is your responsibility to close the retunred file descriptor once you are done reading.

findFocus

AccessibilityNodeInfo findFocus (int focus)

Find the view that has the specified focus type. The search is performed across all windows.

Note: In order to access the windows you have to opt-in to retrieve the interactive windows by setting the FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag. Otherwise, the search will be performed only in the active window.

getRootInActiveWindow

AccessibilityNodeInfo getRootInActiveWindow ()

Gets the root AccessibilityNodeInfo in the active window.

getServiceInfo

AccessibilityServiceInfo getServiceInfo ()

Gets the an AccessibilityServiceInfo describing this UiAutomation. This method is useful if one wants to change some of the dynamically configurable properties at runtime.

getWindowAnimationFrameStats

WindowAnimationFrameStats getWindowAnimationFrameStats ()

Gets the window animation frame statistics. These statistics contain information about the most recently rendered window animation frames, i.e. for window transition animations.

A typical usage requires clearing the window animation frame statistics via clearWindowAnimationFrameStats() followed by an interaction that causes a window transition which uses a window animation and finally getting the window animation frame statistics by calling this method.

 // Start with a clean slate.
 uiAutimation.clearWindowAnimationFrameStats();

 // Do stuff to trigger a window transition.

 // Get the frame statistics.
 WindowAnimationFrameStats stats = uiAutomation.getWindowAnimationFrameStats();
 

getWindowContentFrameStats

WindowContentFrameStats getWindowContentFrameStats (int windowId)

Gets the frame statistics for a given window. These statistics contain information about the most recently rendered content frames.

A typical usage requires clearing the window frame statistics via clearWindowContentFrameStats(int) followed by an interaction with the UI and finally getting the window frame statistics via calling this method.

 // Assume we have at least one window.
 final int windowId = getWindows().get(0).getId();

 // Start with a clean slate.
 uiAutimation.clearWindowContentFrameStats(windowId);

 // Do stuff with the UI.

 // Get the frame statistics.
 WindowContentFrameStats stats = uiAutomation.getWindowContentFrameStats(windowId);
 

getWindows

List<AccessibilityWindowInfo> getWindows ()

Gets the windows on the screen. This method returns only the windows that a sighted user can interact with, as opposed to all windows. For example, if there is a modal dialog shown and the user cannot touch anything behind it, then only the modal window will be reported (assuming it is the top one). For convenience the returned windows are ordered in a descending layer order, which is the windows that are higher in the Z-order are reported first.

Note: In order to access the windows you have to opt-in to retrieve the interactive windows by setting the FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

injectInputEvent

boolean injectInputEvent (InputEvent event, 
                boolean sync)

A method for injecting an arbitrary input event.

Note: It is caller's responsibility to recycle the event.

performGlobalAction

boolean performGlobalAction (int action)

Performs a global action. Such an action can be performed at any moment regardless of the current application or user location in that application. For example going back, going home, opening recents, etc.

setOnAccessibilityEventListener

void setOnAccessibilityEventListener (UiAutomation.OnAccessibilityEventListener listener)

Sets a callback for observing the stream of AccessibilityEvents.

setRotation

boolean setRotation (int rotation)

Sets the device rotation. A client can freeze the rotation in desired state or freeze the rotation to its current state or unfreeze the rotation (rotating the device changes its rotation state).

setRunAsMonkey

void setRunAsMonkey (boolean enable)

Sets whether this UiAutomation to run in a "monkey" mode. Applications can query whether they are executed in a "monkey" mode, i.e. run by a test framework, and avoid doing potentially undesirable actions such as calling 911 or posting on public forums etc.

setServiceInfo

void setServiceInfo (AccessibilityServiceInfo info)

Sets the AccessibilityServiceInfo that describes how this UiAutomation will be handled by the platform accessibility layer.

takeScreenshot

Bitmap takeScreenshot ()

Takes a screenshot.

waitForIdle

void waitForIdle (long idleTimeoutMillis, 
                long globalTimeoutMillis)

Waits for the accessibility event stream to become idle, which is not to have received an accessibility event within idleTimeoutMillis. The total time spent to wait for an idle accessibility event stream is bounded by the globalTimeoutMillis.