UiAutomation

FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES

static val FLAG_DONT_SUPPRESS_ACCESSIBILITY_SERVICES: Int

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

Value: 1

FLAG_DONT_USE_ACCESSIBILITY

static val FLAG_DONT_USE_ACCESSIBILITY: Int

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

Value: 2

ROTATION_FREEZE_0

static val ROTATION_FREEZE_0: Int

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

Value: 0

ROTATION_FREEZE_180

static val ROTATION_FREEZE_180: Int

Rotation constant: Freeze rotation to 180 degrees .

Value: 2

ROTATION_FREEZE_270

static val ROTATION_FREEZE_270: Int

Rotation constant: Freeze rotation to 270 degrees .

Value: 3

ROTATION_FREEZE_90

static val ROTATION_FREEZE_90: Int

Rotation constant: Freeze rotation to 90 degrees .

Value: 1

ROTATION_FREEZE_CURRENT

static val ROTATION_FREEZE_CURRENT: Int

Rotation constant: Freeze rotation to its current state.

Value: -1

ROTATION_UNFREEZE

static val ROTATION_UNFREEZE: Int

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

Value: -2

adoptShellPermissionIdentity

fun adoptShellPermissionIdentity(): Unit

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(java.lang.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(java.lang.String...).

adoptShellPermissionIdentity

fun adoptShellPermissionIdentity(vararg permissions: String!): Unit

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

clearCache

fun clearCache(): Boolean

Clears the accessibility cache.

clearWindowAnimationFrameStats

fun clearWindowAnimationFrameStats(): Unit

Deprecated: 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.

clearWindowContentFrameStats

fun clearWindowContentFrameStats(windowId: Int): Boolean

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

dropShellPermissionIdentity

fun dropShellPermissionIdentity(): Unit

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

fun executeAndWaitForEvent(
    command: Runnable!, 
    filter: UiAutomation.AccessibilityEventFilter!, 
    timeoutMillis: Long
): AccessibilityEvent!

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

fun executeShellCommand(command: String!): ParcelFileDescriptor!

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

fun executeShellCommandRw(command: String): Array<ParcelFileDescriptor!>

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

fun executeShellCommandRwe(command: String): Array<ParcelFileDescriptor!>

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.

findFocus

fun findFocus(focus: Int): AccessibilityNodeInfo!

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 AccessibilityServiceInfo#FLAG_RETRIEVE_INTERACTIVE_WINDOWS flag. Otherwise, the search will be performed only in the active window.

getRootInActiveWindow

fun getRootInActiveWindow(): AccessibilityNodeInfo!

Gets the root AccessibilityNodeInfo in the active window.

getServiceInfo

fun getServiceInfo(): AccessibilityServiceInfo!

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

fun getWindowAnimationFrameStats(): WindowAnimationFrameStats!

Deprecated: 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

fun getWindowContentFrameStats(windowId: Int): WindowContentFrameStats!

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);
  

getWindowsOnAllDisplays

fun getWindowsOnAllDisplays(): SparseArray<MutableList<AccessibilityWindowInfo!>!>

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

fun grantRuntimePermission(
    packageName: String!, 
    permission: String!
): Unit

Grants a runtime permission to a package.

grantRuntimePermissionAsUser

fun grantRuntimePermissionAsUser(
    packageName: String!, 
    permission: String!, 
    userHandle: UserHandle!
): Unit

Grants a runtime permission to a package for a user.

injectInputEvent

fun injectInputEvent(
    event: InputEvent!, 
    sync: Boolean
): Boolean

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.

performGlobalAction

fun performGlobalAction(action: Int): Boolean

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.

revokeRuntimePermission

fun revokeRuntimePermission(
    packageName: String!, 
    permission: String!
): Unit

Revokes a runtime permission from a package.

revokeRuntimePermissionAsUser

fun revokeRuntimePermissionAsUser(
    packageName: String!, 
    permission: String!, 
    userHandle: UserHandle!
): Unit

Revokes a runtime permission from a package.

setAnimationScale

fun setAnimationScale(scale: Float): Unit

Sets the system settings values that control the scaling factor for animations. The scale controls the animation playback speed for animations that respect these settings. Animations that do not respect the settings values will not be affected by this function. A lower scale value results in a faster speed. A value of 0 disables animations entirely. When animations are disabled services receive window change events more quickly which can reduce the potential by confusion by reducing the time during which windows are in transition.

setOnAccessibilityEventListener

fun setOnAccessibilityEventListener(listener: UiAutomation.OnAccessibilityEventListener!): Unit

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

setRotation

fun setRotation(rotation: Int): Boolean

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

fun setRunAsMonkey(enable: Boolean): Unit

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

fun setServiceInfo(info: AccessibilityServiceInfo!): Unit

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

takeScreenshot

fun takeScreenshot(): Bitmap!

Takes a screenshot.

takeScreenshot

fun takeScreenshot(window: Window): Bitmap?

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

fun toString(): String

waitForIdle

fun waitForIdle(
    idleTimeoutMillis: Long, 
    globalTimeoutMillis: Long
): Unit

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.