UiObject

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

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 first sets focus at the start edge of the field. The method then simulates a long-press to select the existing text, and deletes the selected text. If a "Select-All" option is displayed, the method will automatically attempt to use it to ensure full text selection. Note that it is possible that not all the text in the field is selected; for example, if the text contains separators such as spaces, slashes, at symbol etc. Also, not all editable fields support the long-press functionality.

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

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:

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

Clicks the bottom and right corner of the UI element

Clicks the top and left corner of the UI element

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.

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.

Check if view exists. This methods performs a waitForExists(long) 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(long).

Returns the view's bounds property. See getVisibleBounds()

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

Counts the child views immediately under the present UiObject.

Retrieves the className property of the UI element.

Reads the content_desc property of the UI element

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

Reads the view's package property

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

Reads the text property of the UI element

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

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

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

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

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

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

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

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

Check if the view's scrollable property is currently true

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

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

Long clicks bottom and right corner of the UI element

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

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 MotionEvent.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;

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

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

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.

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 first simulates a click() on editable field to set focus. The method then clears the field's contents and 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.

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(int)
• scrollToEnd(int)
• scrollBackward()
• scrollForward()

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(int)
• scrollToEnd(int)
• scrollBackward()
• scrollForward()

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(int)
• scrollToEnd(int)
• scrollBackward()
• scrollForward()

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

• scrollToBeginning(int)
• scrollToEnd(int)
• scrollBackward()
• scrollForward()

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.

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.

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