UiSelector

UiSelector()

fun checkable(val: Boolean): UiSelector

Set the search criteria to match widgets that are checkable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun checked(val: Boolean): UiSelector

Set the search criteria to match widgets that are currently checked (usually for checkboxes). Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun childSelector(selector: UiSelector): UiSelector

Adds a child UiSelector criteria to this selector. Use this selector to narrow the search scope to child widgets under a specific parent widget.

fun className(className: String): UiSelector

Set the search criteria to match the class property for a widget (for example, "android.widget.Button").

fun <T> className(type: Class<T!>): UiSelector

Set the search criteria to match the class property for a widget (for example, "android.widget.Button").

fun classNameMatches(regex: String): UiSelector

Set the search criteria to match the class property for a widget, using a regular expression.

fun clickable(val: Boolean): UiSelector

Set the search criteria to match widgets that are clickable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun description(desc: String): UiSelector

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must match exactly with the string in your input argument. Matching is case-sensitive.

fun descriptionContains(desc: String): UiSelector

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must contain the string in your input argument. Matching is case-insensitive.

fun descriptionMatches(regex: String): UiSelector

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must match exactly with the string in your input argument.

fun descriptionStartsWith(desc: String): UiSelector

Set the search criteria to match the content-description property for a widget. The content-description is typically used by the Android Accessibility framework to provide an audio prompt for the widget when the widget is selected. The content-description for the widget must start with the string in your input argument. Matching is case-insensitive.

fun enabled(val: Boolean): UiSelector

Set the search criteria to match widgets that are enabled. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun focusable(val: Boolean): UiSelector

Set the search criteria to match widgets that are focusable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun focused(val: Boolean): UiSelector

Set the search criteria to match widgets that have focus. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun fromParent(selector: UiSelector): UiSelector

Adds a child UiSelector criteria to this selector which is used to start search from the parent widget. Use this selector to narrow the search scope to sibling widgets as well all child widgets under a parent.

fun index(index: Int): UiSelector

Set the search criteria to match the widget by its node index in the layout hierarchy. The index value must be 0 or greater. Using the index can be unreliable and should only be used as a last resort for matching. Instead, consider using the instance method.

fun instance(instance: Int): UiSelector

Set the search criteria to match the widget by its instance number. The instance value must be 0 or greater, where the first instance is 0. For example, to simulate a user click on the third image that is enabled in a UI screen, you could specify a a search criteria where the instance is 2, the className matches the image widget class, and enabled is true. The code would look like this: new UiSelector().className("android.widget.ImageView") .enabled(true).instance(2);

fun longClickable(val: Boolean): UiSelector

Set the search criteria to match widgets that are long-clickable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun packageName(name: String): UiSelector

Set the search criteria to match the package name of the application that contains the widget.

fun packageNameMatches(regex: String): UiSelector

Set the search criteria to match the package name of the application that contains the widget.

fun resourceId(id: String): UiSelector

Set the search criteria to match the given resource ID.

fun resourceIdMatches(regex: String): UiSelector

Set the search criteria to match the resource ID of the widget, using a regular expression.

fun scrollable(val: Boolean): UiSelector

Set the search criteria to match widgets that are scrollable. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun selected(val: Boolean): UiSelector

Set the search criteria to match widgets that are currently selected. Typically, using this search criteria alone is not useful. You should also include additional criteria, such as text, content-description, or the class name for a widget. If no other search criteria is specified, and there is more than one matching widget, the first widget in the tree is selected.

fun text(text: String): UiSelector

Set the search criteria to match the visible text displayed in a widget (for example, the text label to launch an app). The text for the element must match exactly with the string in your input argument. Matching is case-sensitive.

fun textContains(text: String): UiSelector

Set the search criteria to match the visible text in a widget where the visible text must contain the string in your input argument. The matching is case-sensitive.

fun textMatches(regex: String): UiSelector

Set the search criteria to match the visible text displayed in a layout element, using a regular expression. The text in the widget must match exactly with the string in your input argument.

fun textStartsWith(text: String): UiSelector

Set the search criteria to match visible text in a widget that is prefixed by the text parameter. The matching is case-insensitive.

fun toString(): String!

protected fun cloneSelector(): UiSelector