UiDeviceExt

public static final @NonNull AccessibilityWindowInfo activeWindow(@NonNull UiDevice receiver)

Returns the active window.

public static final @NonNull UiObject2 onView(
    @NonNull UiDevice receiver,
    long timeoutMs,
    long pollIntervalMs,
    @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block
)

Performs a DFS on the accessibility tree starting from the root node in the active window and returns the first node matching the given block. The node is returned as an UiObject2 that allows interacting with it. If the requested node doesn't exist, a ViewNotFoundException is thrown. Internally it works searching periodically every pollIntervalMs.

Example:

uiDevice.onView { textAsString == "Search" }.click()

public static final UiObject2 onViewOrNull(
    @NonNull UiDevice receiver,
    long timeoutMs,
    long pollIntervalMs,
    @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block
)

Performs a DFS on the accessibility tree starting from the root node in the active window and returns the first node matching the given block. The node is returned as an UiObject2 that allows interacting with it. If the requested node doesn't exist, null is returned. Internally it works searching periodically every pollIntervalMs.

Example:

uiDevice.onView { textAsString == "Search" }.click()

public static final @NonNull List<@NonNull UiObject2> onViews(
    @NonNull UiDevice receiver,
    long timeoutMs,
    long pollIntervalMs,
    @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block
)

Performs a DFS on the accessibility tree starting from this node and returns all the nodes matching the given block. This method stops waiting as soon as a single node with the given condition is returned. The nodes returned are UiObject2 that allow interacting with them. Internally it works searching periodically every pollIntervalMs.

Example:

node.onViews { className == Button::class.java.name }

If multiple nodes are expected but they appear at different times, it's recommended to call androidx.test.uiautomator.waitForStable before, to ensure any operation is complete.

public static final void pressDelete(@NonNull UiDevice receiver, int count)

Similar to type but presses the delete key for the given count times.

public static final void type(@NonNull UiDevice receiver, @NonNull String text)

Types the given text string simulating key press through Instrumentation.sendKeySync. This is similar to tapping the keys on a virtual keyboard and will trigger the same listeners in the target app, as opposed to AccessibilityNodeInfo.setText that programmaticaly sets the given text in the target node.

public static final boolean waitForAppToBeVisible(
    @NonNull UiDevice receiver,
    @NonNull String appPackageName,
    long timeoutMs
)

Waits for an application to become visible. Note that internally it checks if an accessibility node with the given appPackageName exists in the accessibility tree.

public static final @NonNull AccessibilityNodeInfo waitForRootInActiveWindow(
    @NonNull UiDevice receiver,
    long timeoutMs,
    long sleepIntervalMs,
    boolean clearCache
)

Waits for the root node to become available in this window.

public static final @NonNull StableResult waitForStableInActiveWindow(
    @NonNull UiDevice receiver,
    long stableTimeoutMs,
    long stableIntervalMs,
    long stablePollIntervalMs,
    boolean requireStableScreenshot
)

Waits for the root node of the active window to become stable.

A node is considered stable when it and its descendants have not changed over an interval of time. Optionally also the node image can be checked. Internally it works checking periodically that the internal properties of the node have not changed.

public static final @NonNull List<@NonNull AccessibilityWindowInfo> windows(@NonNull UiDevice receiver)

Returns all the windows on all the displays.