FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES

public static final int FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES

UiAutomation suppresses 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 Instrumentation.getUiAutomation(int).

Constant Value: 1 (0x00000001)

FLAG_DONT_USE_ACCESSIBILITY

public static final int FLAG_DONT_USE_ACCESSIBILITY

UiAutomation uses the accessibility subsystem by default. This flag provides an option to eliminate the overhead of engaging the accessibility subsystem for tests that do not need to interact with the user interface. Setting this flag disables methods that rely on accessibility. This flag is set when obtaining the UiAutomation from Instrumentation.getUiAutomation(int).

Constant Value: 2 (0x00000002)

ROTATION_FREEZE_0

public static final int ROTATION_FREEZE_0

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

Constant Value: 0 (0x00000000)

ROTATION_FREEZE_180

public static final int ROTATION_FREEZE_180

Rotation constant: Freeze rotation to 180 degrees .

Constant Value: 2 (0x00000002)

ROTATION_FREEZE_270

public static final int ROTATION_FREEZE_270

Rotation constant: Freeze rotation to 270 degrees .

Constant Value: 3 (0x00000003)

ROTATION_FREEZE_90

public static final int ROTATION_FREEZE_90

Rotation constant: Freeze rotation to 90 degrees .

Constant Value: 1 (0x00000001)

ROTATION_FREEZE_CURRENT

public static final int ROTATION_FREEZE_CURRENT

Rotation constant: Freeze rotation to its current state.

Constant Value: -1 (0xffffffff)

ROTATION_UNFREEZE

public static final int ROTATION_UNFREEZE

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

Constant Value: -2 (0xfffffffe)

adoptShellPermissionIdentity

public void adoptShellPermissionIdentity (String... permissions)

Adopt the permission identity of the shell UID only for the provided permissions. This allows you to call APIs protected permissions which normal apps cannot hold but are granted to the shell UID. If you already adopted shell permissions by calling this method, or adoptShellPermissionIdentity() a subsequent call will replace any previous adoption.

Note: This method behave differently from adoptShellPermissionIdentity(). Only the listed permissions will use the shell identity and other permissions will still check against the original UID

adoptShellPermissionIdentity

public void adoptShellPermissionIdentity ()

Adopt the permission identity of the shell UID for all permissions. This allows you to call APIs protected permissions which normal apps cannot hold but are granted to the shell UID. If you already adopted all shell permissions by calling this method or adoptShellPermissionIdentity(String...) a subsequent call will replace any previous adoption. Note that your permission state becomes that of the shell UID and it is not a combination of your and the shell UID permissions.

Note: Calling this method adopts all shell permissions and overrides any subset of adopted permissions via adoptShellPermissionIdentity(String...).

clearCache

public boolean clearCache ()

Clears the accessibility cache.

clearWindowAnimationFrameStats

public void clearWindowAnimationFrameStats ()

This method was deprecated in API level 33.
animation-frames are no-longer used. Use Shared FrameTimeline jank metrics instead.

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

dropShellPermissionIdentity

public void dropShellPermissionIdentity ()

Drop the shell permission identity adopted by a previous call to adoptShellPermissionIdentity(). If you did not adopt the shell permission identity this method would be a no-op.

executeAndWaitForEvent

public 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

public ParcelFileDescriptor executeShellCommand (String command)

Executes a shell command. This method returns 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 returned file descriptor once you are done reading.

executeShellCommandRw

public ParcelFileDescriptor[] executeShellCommandRw (String command)

Executes a shell command. This method returns two file descriptors, one that points to the standard output stream (element at index 0), and one that points to the standard input stream (element at index 1). The command execution is similar to running "adb shell " from a host connected to the device.

Note: It is your responsibility to close the returned file descriptors once you are done reading/writing.

executeShellCommandRwe

public ParcelFileDescriptor[] executeShellCommandRwe (String command)

Executes a shell command. This method returns three file descriptors, one that points to the standard output stream (element at index 0), one that points to the standard input stream (element at index 1), and one points to standard error stream (element at index 2). The command execution is similar to running "adb shell " from a host connected to the device.

Note: It is your responsibility to close the returned file descriptors once you are done reading/writing.

getWindowAnimationFrameStats

public WindowAnimationFrameStats getWindowAnimationFrameStats ()

This method was deprecated in API level 33.
animation-frames are no-longer used.

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

public 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

public List<AccessibilityWindowInfo> getWindows ()

Gets the windows on the screen associated with the UiAutomation context (usually the default display.

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 AccessibilityServiceInfo.FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

getWindowsOnAllDisplays

public SparseArray<List<AccessibilityWindowInfo>> getWindowsOnAllDisplays ()

Gets the windows on the screen of all displays. 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 AccessibilityServiceInfo.FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag.

grantRuntimePermission

public void grantRuntimePermission (String packageName, 
                String permission)

Grants a runtime permission to a package.

grantRuntimePermissionAsUser

public void grantRuntimePermissionAsUser (String packageName, 
                String permission, 
                UserHandle userHandle)

Grants a runtime permission to a package for a user.

injectInputEvent

public boolean injectInputEvent (InputEvent event, 
                boolean sync)

A method for injecting an arbitrary input event. This method waits for all window container animations and surface operations to complete.

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

revokeRuntimePermission

public void revokeRuntimePermission (String packageName, 
                String permission)

Revokes a runtime permission from a package.

revokeRuntimePermissionAsUser

public void revokeRuntimePermissionAsUser (String packageName, 
                String permission, 
                UserHandle userHandle)

Revokes a runtime permission from a package.

setOnAccessibilityEventListener

public void setOnAccessibilityEventListener (UiAutomation.OnAccessibilityEventListener listener)

Sets a callback for observing the stream of AccessibilityEvents. The callbacks are delivered on the main application thread.

setRunAsMonkey

public 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

public void setServiceInfo (AccessibilityServiceInfo info)

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

takeScreenshot

public Bitmap takeScreenshot ()

Takes a screenshot.

takeScreenshot

public Bitmap takeScreenshot (Window window)

Used to capture a screenshot of a Window. This can return null in the following cases: 1. Window content hasn't been layed out. 2. Window doesn't have a valid SurfaceControl 3. An error occurred in SurfaceFlinger when trying to take the screenshot.

toString

public String toString ()

Returns a string representation of the object.

waitForIdle

public 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.