UiObject

UiObject(selector: UiSelector!)

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

fun clearTextField(): Unit

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

fun click(): Boolean

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

fun clickAndWaitForNewWindow(): Boolean

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

fun clickAndWaitForNewWindow(timeout: Long): Boolean

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

fun clickBottomRight(): Boolean

Clicks the bottom and right corner of the UI element

fun clickTopLeft(): Boolean

Clicks the top and left corner of the UI element

fun dragTo(destObj: UiObject, steps: Int): Boolean

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.

fun dragTo(destX: Int, destY: Int, steps: Int): Boolean

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.

fun exists(): Boolean

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.

fun getBounds(): Rect

Returns the view's bounds property. See getVisibleBounds

fun getChild(selector: UiSelector): UiObject

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

fun getChildCount(): Int

Counts the child views immediately under the present UiObject.

fun getClassName(): String

Retrieves the className property of the UI element.

fun getContentDescription(): String

Reads the content_desc property of the UI element

fun getFromParent(selector: UiSelector): UiObject

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

fun getPackageName(): String

Reads the view's package property

fun getSelector(): UiSelector

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

fun getText(): String

Reads the text property of the UI element

fun getVisibleBounds(): Rect

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

fun isCheckable(): Boolean

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

fun isChecked(): Boolean

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

fun isClickable(): Boolean

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

fun isEnabled(): Boolean

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

fun isFocusable(): Boolean

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

fun isFocused(): Boolean

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

fun isLongClickable(): Boolean

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

fun isScrollable(): Boolean

Check if the view's scrollable property is currently true

fun isSelected(): Boolean

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

fun longClick(): Boolean

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

fun longClickBottomRight(): Boolean

Long clicks bottom and right corner of the UI element

fun longClickTopLeft(): Boolean

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

fun performMultiPointerGesture(
    touches: Array<Array<MotionEvent.PointerCoords!>!>
): Boolean

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;

fun performTwoPointerGesture(
    startPoint1: Point,
    startPoint2: Point,
    endPoint1: Point,
    endPoint2: Point,
    steps: Int
): Boolean

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

fun pinchIn(percent: Int, steps: Int): Boolean

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

fun pinchOut(percent: Int, steps: Int): Boolean

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.

fun setText(text: String?): Boolean

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.

fun swipeDown(steps: Int): Boolean

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

fun swipeLeft(steps: Int): Boolean

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

fun swipeRight(steps: Int): Boolean

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

fun swipeUp(steps: Int): Boolean

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

• scrollToBeginning
• scrollToEnd
• scrollBackward
• scrollForward

fun waitForExists(timeout: Long): Boolean

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.

fun waitUntilGone(timeout: Long): Boolean

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 fun findAccessibilityNodeInfo(timeout: Long): AccessibilityNodeInfo?

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