UiObject2Ext

Added in 2.4.0-alpha05

Kotlin |Java

public final class UiObject2Ext

Summary

Public methods
`static final @NonNull UiObject2`	`onElement( @NonNull UiObject2 receiver, long timeoutMs, long pollIntervalMs, @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block )` Performs a DFS on the accessibility tree starting from the node associated to this `UiObject2` and returns the first node matching the given `block`.
`static final UiObject2`	`onElementOrNull( @NonNull UiObject2 receiver, long timeoutMs, long pollIntervalMs, @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block )` Performs a DFS on the accessibility tree starting from the node associated to this `UiObject2` and returns the first node matching the given `block`.
`static final @NonNull List<@NonNull UiObject2>`	`onElements( @NonNull UiObject2 receiver, long timeoutMs, long pollIntervalMs, @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block )` Performs a DFS on the accessibility tree starting from the node associated to this `UiObject2` and returns all the nodes matching the given `block`.
`static final @NonNull UiObject2`	`scrollToElement( @NonNull UiObject2 receiver, @NonNull Direction direction, long timeoutMs, long pollIntervalMs, @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block )` Keeps scrolling until the given `block` condition is satisfied or until the given `timeoutMs`.
`static final @NonNull UiObject2`	`scrollToElementOrNull( @NonNull UiObject2 receiver, @NonNull Direction direction, long timeoutMs, long pollIntervalMs, @ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block )` Keeps scrolling until the given `block` condition is satisfied or until the given `timeoutMs`.
`static final @NonNull Bitmap`	`takeScreenshot(@NonNull UiObject2 receiver)` Takes a screenshot of the screen that contains the accessibility node associated to this `UiObject2` and cuts only the area covered by it.
`static final @NonNull StableResult`	`waitForStable( @NonNull UiObject2 receiver, long stableTimeoutMs, long stableIntervalMs, long stablePollIntervalMs, boolean requireStableScreenshot )` Waits for the node to become stable.

Public methods

onElement

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Performs a DFS on the accessibility tree starting from the node associated to this UiObject2 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 ElementNotFoundException is thrown. Internally it works searching periodically every pollIntervalMs.

Example:

onElement { textAsString == "Search" }.click()

Parameters
`long timeoutMs`	a timeout to find the element that satisfies the given condition.
`long pollIntervalMs`	an interval to wait before rechecking the accessibility tree for updates.
`@ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block`	a block that specifies a condition on the node to find.

Returns
`@NonNull UiObject2`	a `UiObject2` from a node that matches the given `block` condition.

onElementOrNull

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Performs a DFS on the accessibility tree starting from the node associated to this UiObject2 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:

onElement { textAsString == "Search" }.click()

Parameters
`long timeoutMs`	a timeout to find the element that satisfies the given condition.
`long pollIntervalMs`	an interval to wait before rechecking the accessibility tree for updates.
`@ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block`	a block that specifies a condition on the node to find.

Returns
`UiObject2`	a `UiObject2` from a node that matches the given `block` condition or null.

onElements

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Performs a DFS on the accessibility tree starting from the node associated to this UiObject2 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.onElements { isClass(Button::class.java) }

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.

Parameters
`long timeoutMs`	a timeout to find the element that satisfies the given condition.
`long pollIntervalMs`	an interval to wait before rechecking the accessibility tree for updates.
`@ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block`	a block that specifies a condition on the node to find.

Returns
`@NonNull List<@NonNull UiObject2>`	a list of `UiObject2` from nodes that matches the given `block` condition.

scrollToElement

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Keeps scrolling until the given block condition is satisfied or until the given timeoutMs. Throws a ElementNotFoundException if the condition is not satisfied at the end of the timeout.

Example:

onElement { isScrollable }.scrollToElement(Direction.DOWN) { id == "button" }.click()

Parameters
`@NonNull Direction direction`	the scroll `Direction`.
`long timeoutMs`	a timeout to find the element that satisfies the given condition.
`long pollIntervalMs`	an interval to wait before rechecking the accessibility tree for updates.
`@ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block`	a block that specifies a condition on the node to find.

Returns
`@NonNull UiObject2`	a `UiObject2` that matches the given `block` condition.

scrollToElementOrNull

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Keeps scrolling until the given block condition is satisfied or until the given timeoutMs. Returns null if the condition is not satisfied at the end of the timeout.

Example:

onElement { isScrollable }.scrollToElement(Direction.DOWN) { id == "button" }.click()

Parameters
`@NonNull Direction direction`	the scroll `Direction`.
`long timeoutMs`	a timeout to find the element that satisfies the given condition.
`long pollIntervalMs`	an interval to wait before rechecking the accessibility tree for updates.
`@ExtensionFunctionType @NonNull Function1<@NonNull AccessibilityNodeInfo, @NonNull Boolean> block`	a block that specifies a condition on the node to find.

Returns
`@NonNull UiObject2`	a `UiObject2` that matches the given `block` condition.

takeScreenshot

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

public static final @NonNull Bitmap takeScreenshot(@NonNull UiObject2 receiver)

Takes a screenshot of the screen that contains the accessibility node associated to this UiObject2 and cuts only the area covered by it.

Returns
`@NonNull Bitmap`	a bitmap containing the image of the node associated to this `UiObject2`.

waitForStable

Artifact: androidx.test.uiautomator:uiautomator

View Source

Added in 2.4.0-alpha05

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

Waits for the node 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.

Parameters
`long stableTimeoutMs`	a timeout for the wait operation, to ensure not waiting forever for stability.
`long stableIntervalMs`	the interval during which the node should not be changing, in order to be considered stable.
`long stablePollIntervalMs`	specifies how often the ui should be checked for changes.
`boolean requireStableScreenshot`	specifies if also the bitmap of the node should not change over the specified `stableIntervalMs`. Note that this won't work with elements that change constantly, like a video player.

Returns
`@NonNull StableResult`	a `androidx.test.uiautomator.StableResult` containing the latest acquired element hierarchy and screenshot, and a flag indicating if the node was stable before timeout.