UiObject

public UiObject(UiSelector selector)

Constructs a UiObject to represent a view that matches the specified selector criteria.

public void clearTextField()

Clears the existing text contents in an editable field. The UiSelector of this object must reference a UI element that is editable. When you call this method, the method sets focus on the editable field, selects all of its existing content, and clears it by sending a DELETE key press

public boolean click()

Performs a click at the center of the visible bounds of the UI element represented by this UiObject.

public boolean clickAndWaitForNewWindow()

Waits for window transitions that would typically take longer than the usual default timeouts. See clickAndWaitForNewWindow

public boolean clickAndWaitForNewWindow(long timeout)

Performs a click at the center of the visible bounds of the UI element represented by this UiObject and waits for window transitions. This method differ from click only in that this method waits for a a new window transition as a result of the click. Some examples of a window transition:

• launching a new activity
• bringing up a pop-up menu
• bringing up a dialog

public boolean clickBottomRight()

Clicks the bottom and right corner of the UI element

public boolean clickTopLeft()

Clicks the top and left corner of the UI element

public boolean dragTo(@NonNull UiObject destObj, int steps)

Drags this object to a destination UiObject. The number of steps specified in your input parameter can influence the drag speed, and varying speeds may impact the results. Consider evaluating different speeds when using this method in your tests.

public boolean dragTo(int destX, int destY, int steps)

Drags this object to arbitrary coordinates. The number of steps specified in your input parameter can influence the drag speed, and varying speeds may impact the results. Consider evaluating different speeds when using this method in your tests.

public boolean exists()

Check if view exists. This methods performs a waitForExists with zero timeout. This basically returns immediately whether the view represented by this UiObject exists or not. If you need to wait longer for this view, then see waitForExists.

public @NonNull Rect getBounds()

Returns the view's bounds property. See getVisibleBounds

public @NonNull UiObject getChild(@NonNull UiSelector selector)

Creates a new UiObject for a child view that is under the present UiObject.

public int getChildCount()

Counts the child views immediately under the present UiObject.

public @NonNull String getClassName()

Retrieves the className property of the UI element.

public @NonNull String getContentDescription()

Reads the content_desc property of the UI element

public @NonNull UiObject getFromParent(@NonNull UiSelector selector)

Creates a new UiObject for a sibling view or a child of the sibling view, relative to the present UiObject.

public @NonNull String getPackageName()

Reads the view's package property

public final @NonNull UiSelector getSelector()

Debugging helper. A test can dump the properties of a selector as a string to its logs if needed. getSelector().toString();

public @NonNull String getText()

Reads the text property of the UI element

public @NonNull Rect getVisibleBounds()

Returns the visible bounds of the view. If a portion of the view is visible, only the bounds of the visible portion are reported.

public boolean isCheckable()

Checks if the UI element's checkable property is currently true.

public boolean isChecked()

Check if the UI element's checked property is currently true

public boolean isClickable()

Checks if the UI element's clickable property is currently true.

public boolean isEnabled()

Checks if the UI element's enabled property is currently true.

public boolean isFocusable()

Check if the UI element's focusable property is currently true.

public boolean isFocused()

Check if the UI element's focused property is currently true

public boolean isLongClickable()

Check if the view's long-clickable property is currently true

public boolean isScrollable()

Check if the view's scrollable property is currently true

public boolean isSelected()

Checks if the UI element's selected property is currently true.

public boolean longClick()

Long clicks the center of the visible bounds of the UI element

public boolean longClickBottomRight()

Long clicks bottom and right corner of the UI element

public boolean longClickTopLeft()

Long clicks on the top and left corner of the UI element

public boolean performMultiPointerGesture(
    @NonNull MotionEvent.PointerCoords[][] touches
)

Performs a multi-touch gesture. You must specify touch coordinates for at least 2 pointers. Each pointer must have all of its touch steps defined in an array of PointerCoords. You can use this method to specify complex gestures, like circles and irregular shapes, where each pointer may take a different path. To create a single point on a pointer's touch path: PointerCoords p = new PointerCoords(); p.x = stepX; p.y = stepY; p.pressure = 1; p.size = 1;

public boolean performTwoPointerGesture(
    @NonNull Point startPoint1,
    @NonNull Point startPoint2,
    @NonNull Point endPoint1,
    @NonNull Point endPoint2,
    int steps
)

Generates a two-pointer gesture with arbitrary starting and ending points.

public boolean pinchIn(int percent, int steps)

Performs a two-pointer gesture, where each pointer moves diagonally toward the other, from the edges to the center of this UiObject .

public boolean pinchOut(int percent, int steps)

Performs a two-pointer gesture, where each pointer moves diagonally opposite across the other, from the center out towards the edges of the this UiObject.

public boolean setText(@Nullable String text)

Sets the text in an editable field, after clearing the field's content.

The UiSelector selector of this object must reference a UI element that is editable.

When you call this method, the method sets focus on the editable field, clears its existing content, then injects your specified text into the field.

If you want to capture the original contents of the field, call getText first. You can then modify the text and use this method to update the field.

Improvements: Post API Level 19 (KitKat release), the underlying implementation is updated to a dedicated set text accessibility action, and it also now supports Unicode.

public boolean swipeDown(int steps)

Performs the swipe down action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

• scrollToBeginning
• scrollToEnd
• scrollBackward
• scrollForward

public boolean swipeLeft(int steps)

Performs the swipe left action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

• scrollToBeginning
• scrollToEnd
• scrollBackward
• scrollForward

public boolean swipeRight(int steps)

Performs the swipe right action on the UiObject. The swipe gesture can be performed over any surface. The targeted UI element does not need to be scrollable. See also:

• scrollToBeginning
• scrollToEnd
• scrollBackward
• scrollForward

public boolean swipeUp(int steps)

Performs the swipe up action on the UiObject. See also:

• scrollToBeginning
• scrollToEnd
• scrollBackward
• scrollForward

public boolean waitForExists(long timeout)

Waits a specified length of time for a view to become visible. This method waits until the view becomes visible on the display, or until the timeout has elapsed. You can use this method in situations where the content that you want to select is not immediately displayed.

public boolean waitUntilGone(long timeout)

Waits a specified length of time for a view to become undetectable. This method waits until a view is no longer matchable, or until the timeout has elapsed. A view becomes undetectable when the UiSelector of the object is unable to find a match because the element has either changed its state or is no longer displayed. You can use this method when attempting to wait for some long operation to compete, such as downloading a large file or connecting to a remote server.

protected @Nullable AccessibilityNodeInfo findAccessibilityNodeInfo(long timeout)

Finds a matching UI element in the accessibility hierarchy, by using the selector for this UiObject.