io.appium.java_client

Class MobileBy

java.lang.Object

org.openqa.selenium.By

io.appium.java_client.MobileBy

Direct Known Subclasses:

MobileBy.ByAccessibilityId, MobileBy.ByAndroidDataMatcher, MobileBy.ByAndroidUIAutomator, MobileBy.ByAndroidViewTag, MobileBy.ByCustom, MobileBy.ByImage, MobileBy.ByIosClassChain, MobileBy.ByIosNsPredicate, MobileBy.ByWindowsAutomation

public abstract class MobileBy
extends org.openqa.selenium.By

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MobileBy.ByAccessibilityId
static class	MobileBy.ByAndroidDataMatcher
static class	MobileBy.ByAndroidUIAutomator
static class	MobileBy.ByAndroidViewTag
static class	MobileBy.ByCustom
static class	MobileBy.ByImage
static class	MobileBy.ByIosClassChain
static class	MobileBy.ByIosNsPredicate
static class	MobileBy.ByWindowsAutomation

Nested classes/interfaces inherited from class org.openqa.selenium.By

org.openqa.selenium.By.ByClassName, org.openqa.selenium.By.ByCssSelector, org.openqa.selenium.By.ById, org.openqa.selenium.By.ByLinkText, org.openqa.selenium.By.ByName, org.openqa.selenium.By.ByPartialLinkText, org.openqa.selenium.By.ByTagName, org.openqa.selenium.By.ByXPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MobileBy(MobileSelector selector, java.lang.String locatorString)

Method Summary

Modifier and Type	Method and Description
static org.openqa.selenium.By	AccessibilityId(java.lang.String accessibilityId) About Android accessibility https://developer.android.com/intl/ru/training/accessibility/accessible-app.html About iOS accessibility https://developer.apple.com/library/ios/documentation/UIKit/Reference/ UIAccessibilityIdentification_Protocol/index.html
static org.openqa.selenium.By	androidDataMatcher(java.lang.String dataMatcherString) This locator strategy is only available in Espresso Driver mode.
static org.openqa.selenium.By	AndroidUIAutomator(java.lang.String uiautomatorText) Read http://developer.android.com/intl/ru/tools/testing-support-library/ index.html#uia-apis
static org.openqa.selenium.By	AndroidViewTag(java.lang.String tag) This locator strategy is available in Espresso Driver mode.
static org.openqa.selenium.By	custom(java.lang.String selector) This type of locator requires the use of the 'customFindModules' capability and a separately-installed element finding plugin.
WebElement	findElement(SearchContext context)
java.util.List<WebElement>	findElements(SearchContext context)
static org.openqa.selenium.By	image(java.lang.String b64Template) This locator strategy is available only if OpenCV libraries and NodeJS bindings are installed on the server machine.
static org.openqa.selenium.By	iOSClassChain(java.lang.String iOSClassChainString) This locator strategy is available in XCUITest Driver mode.
static org.openqa.selenium.By	iOSNsPredicateString(java.lang.String iOSNsPredicateString) This locator strategy is available in XCUITest Driver mode.
static org.openqa.selenium.By	windowsAutomation(java.lang.String windowsAutomation)

Methods inherited from class org.openqa.selenium.By

className, cssSelector, equals, hashCode, id, linkText, name, partialLinkText, tagName, toString, xpath

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MobileBy

protected MobileBy(MobileSelector selector,
                   java.lang.String locatorString)

Method Detail

findElements

public java.util.List<WebElement> findElements(SearchContext context)

Specified by:

findElements in class org.openqa.selenium.By

findElement

public WebElement findElement(SearchContext context)

Overrides:

findElement in class org.openqa.selenium.By

AndroidUIAutomator

public static org.openqa.selenium.By AndroidUIAutomator(java.lang.String uiautomatorText)

Read http://developer.android.com/intl/ru/tools/testing-support-library/ index.html#uia-apis

Parameters:

uiautomatorText - is Android UIAutomator string

Returns:

an instance of MobileBy.ByAndroidUIAutomator

AccessibilityId

public static org.openqa.selenium.By AccessibilityId(java.lang.String accessibilityId)

About Android accessibility https://developer.android.com/intl/ru/training/accessibility/accessible-app.html About iOS accessibility https://developer.apple.com/library/ios/documentation/UIKit/Reference/ UIAccessibilityIdentification_Protocol/index.html

Parameters:

accessibilityId - id is a convenient UI automation accessibility Id.

Returns:

an instance of MobileBy.ByAndroidUIAutomator

iOSClassChain

public static org.openqa.selenium.By iOSClassChain(java.lang.String iOSClassChainString)

This locator strategy is available in XCUITest Driver mode.

Parameters:

iOSClassChainString - is a valid class chain locator string. See the documentation for more details

Returns:

an instance of MobileBy.ByIosClassChain

androidDataMatcher

public static org.openqa.selenium.By androidDataMatcher(java.lang.String dataMatcherString)

This locator strategy is only available in Espresso Driver mode.

Parameters:

dataMatcherString - is a valid class chain locator string. See the documentation for more details

Returns:

an instance of MobileBy.ByAndroidDataMatcher

iOSNsPredicateString

public static org.openqa.selenium.By iOSNsPredicateString(java.lang.String iOSNsPredicateString)

This locator strategy is available in XCUITest Driver mode.

Parameters:

iOSNsPredicateString - is an an iOS NsPredicate String

Returns:

an instance of MobileBy.ByIosNsPredicate

windowsAutomation

public static org.openqa.selenium.By windowsAutomation(java.lang.String windowsAutomation)

AndroidViewTag

public static org.openqa.selenium.By AndroidViewTag(java.lang.String tag)

This locator strategy is available in Espresso Driver mode.

Parameters:

tag - is an view tag string

Returns:

an instance of MobileBy.ByAndroidViewTag

Since:

Appium 1.8.2 beta

image

public static org.openqa.selenium.By image(java.lang.String b64Template)

This locator strategy is available only if OpenCV libraries and NodeJS bindings are installed on the server machine.

Parameters:

b64Template - base64-encoded template image string. Supported image formats are the same as for OpenCV library.

Returns:

an instance of MobileBy.ByImage

Since:

Appium 1.8.2

See Also:

The documentation on Image Comparison Features, The settings available for lookup fine-tuning

custom

public static org.openqa.selenium.By custom(java.lang.String selector)

This type of locator requires the use of the 'customFindModules' capability and a separately-installed element finding plugin.

Parameters:

selector - selector to pass to the custom element finding plugin

Returns:

an instance of MobileBy.ByCustom

Since:

Appium 1.9.2