BySelector

fun checkable(isCheckable: Boolean): BySelector

Sets the search criteria to match elements that are checkable or not checkable.

fun checked(isChecked: Boolean): BySelector

Sets the search criteria to match elements that are checked or unchecked.

fun clazz(className: Pattern): BySelector

Sets the class name criteria for matching. A UI element will be considered a match if its full class name matches the classNamePattern and all other criteria for this selector are met.

fun clazz(className: String): BySelector

Sets the class name criteria for matching. A UI element will be considered a match if its class name exactly matches the className parameter and all other criteria for this selector are met. If className starts with a period, it is assumed to be in the android.widget package.

fun clazz(clazz: Class): BySelector

Sets the class name criteria for matching. A UI element will be considered a match if its class name matches clazz and all other criteria for this selector are met.

fun clazz(packageName: String, className: String): BySelector

Sets the class name criteria for matching. A UI element will be considered a match if its package and class name exactly match the packageName and className parameters and all other criteria for this selector are met.

fun clickable(isClickable: Boolean): BySelector

Sets the search criteria to match elements that are clickable or not clickable.

fun depth(exactDepth: Int): BySelector

Sets the search criteria to match elements that are at a certain depth.

fun depth(min: Int, max: Int): BySelector

Sets the search criteria to match elements that are in a range of depths.

fun desc(contentDescription: Pattern): BySelector

Sets the content description criteria for matching. A UI element will be considered a match if its content description matches the contentDescriptionPattern and all other criteria for this selector are met.

fun desc(contentDescription: String): BySelector

Sets the content description criteria for matching. A UI element will be considered a match if its content description exactly matches the contentDescription parameter and all other criteria for this selector are met.

fun descContains(substring: String): BySelector

Sets the content description criteria for matching. A UI element will be considered a match if its content description contains the substring parameter and all other criteria for this selector are met.

fun descEndsWith(suffix: String): BySelector

Sets the content description criteria for matching. A UI element will be considered a match if its content description ends with the suffix parameter and all other criteria for this selector are met.

fun descStartsWith(prefix: String): BySelector

Sets the content description criteria for matching. A UI element will be considered a match if its content description starts with the prefix parameter and all other criteria for this selector are met.

@RequiresApi(value = 30)
fun displayId(displayId: Int): BySelector

Adds a display ID selector criteria for matching. A UI element will be considered a match if it is within the display with the ID of displayId and all other criteria for this selector are met.

fun enabled(isEnabled: Boolean): BySelector

Sets the search criteria to match elements that are enabled or disabled.

fun focusable(isFocusable: Boolean): BySelector

Sets the search criteria to match elements that are focusable or not focusable.

fun focused(isFocused: Boolean): BySelector

Sets the search criteria to match elements that are focused or unfocused.

fun hasAncestor(ancestorSelector: BySelector): BySelector

Adds an ancestor selector criteria for matching. A UI element will be considered a match if it has an ancestor element which matches the ancestorSelector and all other criteria for this selector are met.

fun hasAncestor(
    ancestorSelector: BySelector,
    maxAncestorDistance: @IntRange(from = 1) Int
): BySelector

Adds an ancestor selector criteria for matching. A UI element will be considered a match if it has an ancestor element which matches the ancestorSelector and all other criteria for this selector are met.

fun hasChild(childSelector: BySelector): BySelector

Adds a child selector criteria for matching. A UI element will be considered a match if it has a child element (direct descendant) which matches the childSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all childSelectors.

fun hasDescendant(descendantSelector: BySelector): BySelector

Adds a descendant selector criteria for matching. A UI element will be considered a match if it has a descendant element which matches the descendantSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all descendantSelectors.

fun hasDescendant(descendantSelector: BySelector, maxDepth: Int): BySelector

Adds a descendant selector criteria for matching. A UI element will be considered a match if it has a descendant element which matches the descendantSelector and all other criteria for this selector are met. If specified more than once, matches must be found for all descendantSelectors.

fun hasParent(parentSelector: BySelector): BySelector

Adds a parent selector criteria for matching. A UI element will be considered a match if it has a parent element (direct ancestor) which matches the parentSelector and all other criteria for this selector are met.

@RequiresApi(value = 26)
fun hint(hintValue: Pattern): BySelector

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value matches the hintValuePattern and all other criteria for this selector are met.

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

@RequiresApi(value = 26)
fun hint(hintValue: String): BySelector

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value exactly matches the hintValue parameter and all other criteria for this selector are met.

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

@RequiresApi(value = 26)
fun hintContains(substring: String): BySelector

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value contains the substring parameter and all other criteria for this selector are met.

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

@RequiresApi(value = 26)
fun hintEndsWith(suffix: String): BySelector

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value ends with the suffix parameter and all other criteria for this selector are met.

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

@RequiresApi(value = 26)
fun hintStartsWith(prefix: String): BySelector

Sets the hint value criteria for matching. A UI element will be considered a match if its hint value starts with the prefix parameter and all other criteria for this selector are met.

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

fun longClickable(isLongClickable: Boolean): BySelector

Sets the search criteria to match elements that are long clickable or not long clickable.

fun maxDepth(max: Int): BySelector

Sets the search criteria to match elements that are no more than a certain depth.

fun minDepth(min: Int): BySelector

Sets the search criteria to match elements that are at least a certain depth.

fun pkg(applicationPackage: Pattern): BySelector

Sets the package name criteria for matching. A UI element will be considered a match if its application package name matches the applicationPackagePattern and all other criteria for this selector are met.

fun pkg(applicationPackage: String): BySelector

Sets the application package name criteria for matching. A UI element will be considered a match if its application package name exactly matches the applicationPackage parameter and all other criteria for this selector are met.

fun res(resourceName: Pattern): BySelector

Sets the resource name criteria for matching. A UI element will be considered a match if its resource name matches the resourceNamePattern and all other criteria for this selector are met.

fun res(resourceName: String): BySelector

Sets the resource name criteria for matching. A UI element will be considered a match if its resource name exactly matches the resourceName parameter and all other criteria for this selector are met.

fun res(resourcePackage: String, resourceId: String): BySelector

Sets the resource name criteria for matching. A UI element will be considered a match if its resource package and resource id exactly match the resourcePackage and resourceId parameters and all other criteria for this selector are met.

fun scrollable(isScrollable: Boolean): BySelector

Sets the search criteria to match elements that are scrollable or not scrollable.

fun selected(isSelected: Boolean): BySelector

Sets the search criteria to match elements that are selected or not selected.

fun text(textValue: Pattern): BySelector

Sets the text value criteria for matching. A UI element will be considered a match if its text value matches the textValuePattern and all other criteria for this selector are met.

fun text(textValue: String): BySelector

Sets the text value criteria for matching. A UI element will be considered a match if its text value exactly matches the textValue parameter and all other criteria for this selector are met.

fun textContains(substring: String): BySelector

Sets the text value criteria for matching. A UI element will be considered a match if its text value contains the substring parameter and all other criteria for this selector are met.

fun textEndsWith(suffix: String): BySelector

Sets the text value criteria for matching. A UI element will be considered a match if its text value ends with the suffix parameter and all other criteria for this selector are met.

fun textStartsWith(prefix: String): BySelector

Sets the text value criteria for matching. A UI element will be considered a match if its text value starts with the prefix parameter and all other criteria for this selector are met.

fun toString(): String!

Returns a String representation of this BySelector. The format is "BySelector [=' ... ]". Each criteria is listed as a key-value pair where the key is the name of the criteria expressed in all caps (e.g. CLAZZ, RES, etc).