UiObject2

public void clear()

Clears this object's text content if it is an editable field.

public void click()

Clicks on this object's center.

public void click(long duration)

Clicks on this object's center for duration milliseconds.

public void click(@NonNull Point point)

Clicks on a point within this object's visible bounds.

public void click(@NonNull Point point, long duration)

Clicks on a point within this object's visible bounds.

public U <U> clickAndWait(@NonNull EventCondition<U> condition, long timeout)

Clicks on this object's center, and waits for a condition to be met.

public U <U> clickAndWait(
    @NonNull Point point,
    @NonNull EventCondition<U> condition,
    long timeout
)

Clicks on a point within this object's visible bounds, and waits for a condition to be met.

public void drag(@NonNull Point dest)

Drags this object to the specified point.

public void drag(@NonNull Point dest, int speed)

Drags this object to the specified point.

public UiObject2 findObject(@NonNull BySelector selector)

Searches all elements under this object and returns the first one to match the selector, or null if no matching objects are found.

public @NonNull List<UiObject2> findObjects(@NonNull BySelector selector)

Searches all elements under this object and returns those that match the selector.

public boolean fling(@NonNull Direction direction)

Performs a fling gesture on this object.

public boolean fling(@NonNull Direction direction, int speed)

Performs a fling gesture on this object.

public @NonNull AccessibilityNodeInfo getAccessibilityNodeInfo()

Returns an up-to-date AccessibilityNodeInfo corresponding to this object's underlying View. Note that this method can be expensive as it wait for the device to be idle and tries multiple time to refresh the AccessibilityNodeInfo.

public String getApplicationPackage()

Returns the package name of the app that this object belongs to.

public int getChildCount()

Returns the number of child elements directly under this object.

public @NonNull List<UiObject2> getChildren()

Returns a collection of the child elements directly under this object.

public String getClassName()

Returns the class name of this object's underlying View.

public String getContentDescription()

Returns this object's content description.

public int getDisplayId()

Returns the ID of the display containing this object.

@RequiresApi(value = 24)
public int getDrawingOrder()

Returns the drawing order (z-index) of this object relative to its siblings. Higher values are drawn last (i.e. above their siblings).

In some cases, the drawing order is essentially simultaneous, so it is possible for two siblings to return the same value. It is also possible that values will be skipped.

@RequiresApi(value = 26)
public @Nullable String getHint()

Returns the hint text of this object, or null if hint text is not preset.

Hint text is displayed when there's no user input text.

public UiObject2 getParent()

Returns this object's parent, or null if it has no parent.

public String getResourceName()

Returns the fully qualified resource name for this object's ID.

public String getText()

Returns this object's text content.

public @NonNull Rect getVisibleBounds()

Returns this object's visible bounds.

public @NonNull Point getVisibleCenter()

Returns a point in the center of this object's visible bounds.

public boolean hasObject(@NonNull BySelector selector)

Returns true if there is a nested element which matches the selector.

public boolean isCheckable()

Returns true if this object is checkable.

public boolean isChecked()

Returns true if this object is checked.

public boolean isClickable()

Returns true if this object is clickable.

public boolean isEnabled()

Returns true if this object is enabled.

public boolean isFocusable()

Returns true if this object is focusable.

public boolean isFocused()

Returns true if this object is focused.

public boolean isLongClickable()

Returns true if this object is long clickable.

public boolean isScrollable()

Returns true if this object is scrollable.

public boolean isSelected()

Returns true if this object is selected.

public void longClick()

Performs a long click on this object's center.

public void pinchClose(float percent)

Performs a pinch close gesture on this object.

public void pinchClose(float percent, int speed)

Performs a pinch close gesture on this object.

public void pinchOpen(float percent)

Performs a pinch open gesture on this object.

public void pinchOpen(float percent, int speed)

Performs a pinch open gesture on this object.

public void recycle()

Recycle this object.

public boolean scroll(@NonNull Direction direction, float percent)

Performs a scroll gesture on this object.

public boolean scroll(@NonNull Direction direction, float percent, int speed)

Performs a scroll gesture on this object.

public U <U> scrollUntil(
    @NonNull Direction direction,
    @NonNull Condition<UiObject2, U> condition
)

Perform scroll actions in certain direction until a condition is satisfied or scroll has finished, e.g. to scroll until an object contain certain text is found:

 mScrollableUiObject2.scrollUntil(Direction.DOWN, Until.findObject(By.textContains
("sometext"))); 

public U <U> scrollUntil(
    @NonNull Direction direction,
    @NonNull EventCondition<U> condition
)

Perform scroll actions in certain direction until a condition is satisfied or scroll has finished, e.g. to scroll until a new window has appeared:

 mScrollableUiObject2.scrollUntil(Direction.DOWN, Until.newWindow()); 

public void setGestureMargin(int margin)

Sets the margins used for gestures in pixels.

public void setGestureMarginPercentage(@FloatRange(from = 0.0, to = 0.5) float percent)

Sets the percentage of gestures' margins to avoid touching too close to the edges, e.g. when scrolling up, phone open quick settings instead if gesture is close to the top. The percentage is based on the object's visible size, e.g. to set 20% margins:

mUiObject2.setGestureMarginPercentage(0.2f);

public void setGestureMargins(int left, int top, int right, int bottom)

Sets the margins used for gestures in pixels.

public void setGestureMarginsPercentage(
    @FloatRange(from = 0.0, to = 1.0) float left,
    @FloatRange(from = 0.0, to = 1.0) float top,
    @FloatRange(from = 0.0, to = 1.0) float right,
    @FloatRange(from = 0.0, to = 1.0) float bottom
)

Sets the percentage of gestures' margins to avoid touching too close to the edges, e.g. when scrolling up, phone open quick settings instead if gesture is close to the top. The percentage is based on the object's visible size, e.g. to set 20% bottom margin only:

mUiObject2.setGestureMarginsPercentage(0f, 0f, 0f, 0.2f);

left Float between [0, 1] for left margin

top Float between [0, 1] for top margin

right Float between [0, 1] for right margin

bottom Float between [0, 1] for bottom margin

public void setText(@Nullable String text)

Sets this object's text content if it is an editable field.

public void swipe(@NonNull Direction direction, float percent)

Performs a swipe gesture on this object.

public void swipe(@NonNull Direction direction, float percent, int speed)

Performs a swipe gesture on this object.

public U <U> wait(@NonNull Condition<UiObject2, U> condition, long timeout)

Waits for a condition to be met.

public U <U> wait(@NonNull SearchCondition<U> condition, long timeout)

Waits for a condition to be met.

public U <U> wait(@NonNull UiObject2Condition<U> condition, long timeout)

Waits for a condition to be met.

public final @NonNull UiObject2 UiObject2Ext.onElement(
    @NonNull UiObject2 receiver,
    long timeoutMs,
    long pollIntervalMs,
    @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()

public final UiObject2 UiObject2Ext.onElementOrNull(
    @NonNull UiObject2 receiver,
    long timeoutMs,
    long pollIntervalMs,
    @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()

public final @NonNull List<@NonNull UiObject2> UiObject2Ext.onElements(
    @NonNull UiObject2 receiver,
    long timeoutMs,
    long pollIntervalMs,
    @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.

public final @NonNull UiObject2 UiObject2Ext.scrollToElement(
    @NonNull UiObject2 receiver,
    @NonNull Direction direction,
    long timeoutMs,
    long pollIntervalMs,
    @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()

public final UiObject2 UiObject2Ext.scrollToElementOrNull(
    @NonNull UiObject2 receiver,
    @NonNull Direction direction,
    long timeoutMs,
    long pollIntervalMs,
    @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()

public final @NonNull Bitmap UiObject2Ext.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.

public final @NonNull StableResult UiObject2Ext.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.