Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use custom method of io.appium.java_client.AppiumBy class

Best io.appium code snippet using io.appium.java_client.AppiumBy.custom

MobileBy.java

Source:MobileBy.java

...136    public static By image(final String b64Template) {137        return new ByImage(b64Template);138    }139    /**140     * This type of locator requires the use of the 'customFindModules' capability and a141     * separately-installed element finding plugin.142     *143     * @deprecated Use {@link AppiumBy#custom(String)} instead.144     * @param selector selector to pass to the custom element finding plugin145     * @return an instance of {@link ByCustom}146     * @since Appium 1.9.2147     */148    @Deprecated149    public static By custom(final String selector) {150        return new ByCustom(selector);151    }152    /**153     * Refer to https://developer.android.com/training/testing/ui-automator154     *155     * @deprecated Use {@link AppiumBy.ByAndroidUIAutomator} instead.156     */157    @Deprecated158    public static class ByAndroidUIAutomator extends AppiumBy.ByAndroidUIAutomator {159        public ByAndroidUIAutomator(String uiautomatorText) {160            super(uiautomatorText);161        }162        @Override public String toString() {163            return "By.AndroidUIAutomator: " + getRemoteParameters().value();164        }165    }166    /**167     * About Android accessibility168     * https://developer.android.com/intl/ru/training/accessibility/accessible-app.html169     * About iOS accessibility170     * https://developer.apple.com/library/ios/documentation/UIKit/Reference/171     * UIAccessibilityIdentification_Protocol/index.html172     * @deprecated Use {@link AppiumBy.ByAccessibilityId} instead.173     */174    @Deprecated175    public static class ByAccessibilityId extends AppiumBy.ByAccessibilityId {176        public ByAccessibilityId(String accessibilityId) {177            super(accessibilityId);178        }179        @Override public String toString() {180            return "By.AccessibilityId: " + getRemoteParameters().value();181        }182    }183    /**184     * This locator strategy is available in XCUITest Driver mode.185     * See <a href="https://github.com/facebookarchive/WebDriverAgent/wiki/Class-Chain-Queries-Construction-Rules">186     * the documentation</a> for more details187     * @deprecated Use {@link AppiumBy.ByIosClassChain} instead.188     */189    @Deprecated190    public static class ByIosClassChain extends AppiumBy.ByIosClassChain {191        protected ByIosClassChain(String locatorString) {192            super(locatorString);193        }194        @Override public String toString() {195            return "By.IosClassChain: " + getRemoteParameters().value();196        }197    }198    /**199     * This locator strategy is only available in Espresso Driver mode.200     * See <a href="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector/">201     * the documentation</a> for more details202     * @deprecated Use {@link AppiumBy.ByAndroidDataMatcher} instead.203     */204    @Deprecated205    public static class ByAndroidDataMatcher extends AppiumBy.ByAndroidDataMatcher {206        protected ByAndroidDataMatcher(String locatorString) {207            super(locatorString);208        }209        @Override public String toString() {210            return "By.AndroidDataMatcher: " + getRemoteParameters().value();211        }212    }213    /**214     * This locator strategy is only available in Espresso Driver mode.215     * See <a href="http://appium.io/docs/en/writing-running-appium/android/espresso-datamatcher-selector/">216     * the documentation</a> for more details217     * @deprecated Use {@link AppiumBy.ByAndroidViewMatcher} instead.218     */219    @Deprecated220    public static class ByAndroidViewMatcher extends AppiumBy.ByAndroidViewMatcher {221        protected ByAndroidViewMatcher(String locatorString) {222            super(locatorString);223        }224        @Override public String toString() {225            return "By.AndroidViewMatcher: " + getRemoteParameters().value();226        }227    }228    /**229     * This locator strategy is available in XCUITest Driver mode.230     * @deprecated Use {@link AppiumBy.ByIosNsPredicate} instead.231     */232    @Deprecated233    public static class ByIosNsPredicate extends AppiumBy.ByIosNsPredicate {234        protected ByIosNsPredicate(String locatorString) {235            super(locatorString);236        }237        @Override public String toString() {238            return "By.IosNsPredicate: " + getRemoteParameters().value();239        }240    }241    /**242     * The Windows UIAutomation selector.243     * @deprecated Not supported on the server side.244     */245    @Deprecated246    public static class ByWindowsAutomation extends MobileBy implements Serializable {247        protected ByWindowsAutomation(String locatorString) {248            super("-windows uiautomation", locatorString, "windowsAutomation");249        }250        @Override public String toString() {251            return "By.windowsAutomation: " + getRemoteParameters().value();252        }253    }254    /**255     * This locator strategy is available only if OpenCV libraries and256     * NodeJS bindings are installed on the server machine.257     * @deprecated Use {@link AppiumBy.ByImage} instead.258     */259    @Deprecated260    public static class ByImage extends AppiumBy.ByImage {261        protected ByImage(String b64Template) {262            super(b64Template);263        }264        @Override public String toString() {265            return "By.Image: " + getRemoteParameters().value();266        }267    }268    /**269     * This type of locator requires the use of the 'customFindModules' capability and a270     * separately-installed element finding plugin.271     * @deprecated Use {@link AppiumBy.ByCustom} instead.272     */273    @Deprecated274    public static class ByCustom extends AppiumBy.ByCustom {275        protected ByCustom(String selector) {276            super(selector);277        }278        @Override public String toString() {279            return "By.Custom: " + getRemoteParameters().value();280        }281    }282    /**283     * This locator strategy is available in Espresso Driver mode....

AppiumBy.java

Source:AppiumBy.java

...115    public static By name(final String selector) {116        return new ByName(selector);117    }118    /**119     * This type of locator requires the use of the 'customFindModules' capability and a120     * separately-installed element finding plugin.121     *122     * @param selector selector to pass to the custom element finding plugin123     * @return an instance of {@link ByCustom}124     * @since Appium 1.9.2125     */126    public static By custom(final String selector) {127        return new ByCustom(selector);128    }129    /**130     * This locator strategy is available only if OpenCV libraries and131     * NodeJS bindings are installed on the server machine.132     *133     * @see <a href="https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md">134     * The documentation on Image Comparison Features</a>135     * @see <a href="https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js">136     * The settings available for lookup fine-tuning</a>137     * @since Appium 1.8.2138     * @param b64Template base64-encoded template image string. Supported image formats are the same139     *                    as for OpenCV library.140     * @return an instance of {@link ByImage}141     */142    public static By image(final String b64Template) {143        return new ByImage(b64Template);144    }145    /**146     * This locator strategy is available in XCUITest Driver mode.147     * @param iOSClassChainString is a valid class chain locator string.148     *                            See <a href="https://github.com/facebookarchive/WebDriverAgent/wiki/Class-Chain-Queries-Construction-Rules">149     *                            the documentation</a> for more details150     * @return an instance of {@link AppiumBy.ByIosClassChain}151     */152    public static By iOSClassChain(final String iOSClassChainString) {153        return new ByIosClassChain(iOSClassChainString);154    }155    /**156     * This locator strategy is available in XCUITest Driver mode.157     * @param iOSNsPredicateString is an iOS NsPredicate String158     * @return an instance of {@link AppiumBy.ByIosNsPredicate}159     */160    public static By iOSNsPredicateString(final String iOSNsPredicateString) {161        return new ByIosNsPredicate(iOSNsPredicateString);162    }163    public static class ByAccessibilityId extends AppiumBy implements Serializable {164        public ByAccessibilityId(String accessibilityId) {165            super("accessibility id", accessibilityId, "accessibilityId");166        }167    }168    public static class ByAndroidDataMatcher extends AppiumBy implements Serializable {169        protected ByAndroidDataMatcher(String locatorString) {170            super("-android datamatcher", locatorString, "androidDataMatcher");171        }172    }173    public static class ByAndroidUIAutomator extends AppiumBy implements Serializable {174        public ByAndroidUIAutomator(String uiautomatorText) {175            super("-android uiautomator", uiautomatorText, "androidUIAutomator");176        }177    }178    public static class ByAndroidViewMatcher extends AppiumBy implements Serializable {179        protected ByAndroidViewMatcher(String locatorString) {180            super("-android viewmatcher", locatorString, "androidViewMatcher");181        }182    }183    public static class ByAndroidViewTag extends AppiumBy implements Serializable {184        public ByAndroidViewTag(String tag) {185            super("-android viewtag", tag, "androidViewTag");186        }187    }188    public static class ById extends AppiumBy implements Serializable {189        protected ById(String selector) {190            super("id", selector, "id");191        }192    }193    public static class ByName extends AppiumBy implements Serializable {194        protected ByName(String selector) {195            super("name", selector, "name");196        }197    }198    public static class ByClassName extends AppiumBy implements Serializable {199        protected ByClassName(String selector) {200            super("class name", selector, "className");201        }202    }203    public static class ByCustom extends AppiumBy implements Serializable {204        protected ByCustom(String selector) {205            super("-custom", selector, "custom");206        }207    }208    public static class ByImage extends AppiumBy implements Serializable {209        protected ByImage(String b64Template) {210            super("-image", b64Template, "image");211        }212    }213    public static class ByIosClassChain extends AppiumBy implements Serializable {214        protected ByIosClassChain(String locatorString) {215            super("-ios class chain", locatorString, "iOSClassChain");216        }217    }218    public static class ByIosNsPredicate extends AppiumBy implements Serializable {219        protected ByIosNsPredicate(String locatorString) {...

SleepTimerPage.java

Source:SleepTimerPage.java

...5import utilities.PageHelper;6public class SleepTimerPage extends PageHelper {7    By sleepTimerSheet = By.id("bottom_sheet");8    By titleText = AppiumBy.androidUIAutomator("new UiSelector().text(\"MINUTER SOVTIMER\")");9    By custom = By.id("edt_custom_duration");10    By minimize = By.id("btn_cancel");11    public SleepTimerPage(AndroidDriver driver) { super(driver); }12    public boolean sleepTimerTextDisplayed(){return waitForElementToAppear(sleepTimerSheet).isDisplayed()13            && waitForElementToAppear(titleText).isDisplayed();}14    public void clickOff() { baseForScrolling("Av").click(); }15    public void clickFive() { baseForScrolling("5").click(); }16    public void clickTen() { baseForScrolling("10").click(); }17    public void clickTwenty() { baseForScrolling("20").click(); }18    public void clickThirty() { baseForScrolling("30").click(); }19    public void clickFortyFive() { baseForScrolling("45").click(); }20    public void clickSixty() { baseForScrolling("60").click(); }21    public void clickCustom(String minutes) {22        /*WebElement element = driver.findElement(AppiumBy.androidUIAutomator("new UiScrollable(" +23                "new UiSelector().scrollable(true).className(\"androidx.recyclerview.widget.RecyclerView\"))" +24                ".setAsHorizontalList().scrollIntoView(new UiSelector().className(\"android.widget.TextView\")" +25                ".text(\"Annat\"))"));*/26        WebElement element = driver.findElement(AppiumBy.androidUIAutomator("new UiScrollable(" +27                "new UiSelector().scrollable(true)).setAsHorizontalList().scrollToEnd(5)"));28        if (!element.getText().equals("Annat")) {29            driver.findElement(AppiumBy.androidUIAutomator("new UiScrollable(new UiSelector()" +30                    ".scrollable(true)).setAsHorizontalList().scrollToEnd(1)"));31        }32        driver.findElement(custom).sendKeys(minutes);33        //driver.executeScript("mobile: performEditorAction", ImmutableMap.of("action", "Check"));34    }35    public void clickMinimize() { driver.findElement(minimize).click(); }36    public WebElement baseForScrolling(String sleepTimer) {37        WebElement element = driver.findElement(AppiumBy.androidUIAutomator("new UiScrollable(" +38                "new UiSelector().scrollable(true).className(\"androidx.recyclerview.widget.RecyclerView\"))" +39                ".setAsHorizontalList().scrollIntoView(new UiSelector().className(\"android.widget.TextView\")" +40                ".text(\"" + sleepTimer + "\"))"));41        if (!element.getText().equals(sleepTimer)) {42            element.findElement(By.xpath("//android.widget.TextView[@text='" + sleepTimer + "']")).click();43        }44        return element;45    }46    public void assertOneMinuteSleepTimer() {...

CalculatorWindow.java

Source:CalculatorWindow.java

1package tests.applications.windowsApp;2import aquality.selenium.core.elements.ElementState;3import io.appium.java_client.AppiumBy;4import org.openqa.selenium.By;5import tests.elements.factory.CustomElement;6public class CalculatorWindow {7    private CalculatorWindow(){8    }9    public static By getWindowLocator() {10        return By.xpath("//Window");11    }12    public static CustomElement getWindowLabel() {13        return new CustomElement(getWindowLocator(), "Window", ElementState.DISPLAYED);14    }15    public static CustomElement getWindowByXPathLabel() {16        return new CustomElement(By.xpath("//Window"), "Window", ElementState.DISPLAYED);17    }18    public static By getOneButtonLoc() {19        return By.name("1");20    }21    public static CustomElement getOneButton() {22        return new CustomElement(getOneButtonLoc(), "1", ElementState.DISPLAYED);23    }24    public static By getTwoButtonLoc() {25        return By.name("2");26    }27    public static By getPlusButtonLoc() {28        return By.name("+");29    }30    public static By getEqualsButtonLoc() {31        return By.name("=");32    }33    public static By getEqualsButtonByXPath() {34        return By.xpath("//*[@Name='=']");35    }36    public static By getRelativeXPathLocator() {37        return By.xpath("//*[@Name='=']");38    }39    public static By getDottedXPathLocator() {40        return By.xpath("//*[@Name='=']/parent::Window");41    }42    public static By getTagXpathLocator() {43        return By.xpath("//Button");44    }45    public static By getResultsLabelLoc() {46        return AppiumBy.accessibilityId("48");47    }48    public static CustomElement getLeftValueTextBox() {49        return new CustomElement(AppiumBy.xpath("//*[@AutomationId='50']"), "Left value", ElementState.DISPLAYED);50    }51}...

custom

Using AI Code Generation

1import io.appium.java_client.AppiumBy;2import io.appium.java_client.MobileElement;3import io.appium.java_client.android.AndroidDriver;4import io.appium.java_client.android.AndroidElement;5import io.appium.java_client.android.AndroidKeyCode;6import io.appium.java_client.android.AndroidKeyMetastate;7import io.appium.java_client.android.AndroidTouchAction;8import io.appium.java_client.android.Connection;9import io.appium.java_client.android.GsmCallActions;10import io.appium.java_client.android.StartsActivity;11import io.appium.java_client.android.connection.ConnectionStateBuilder;12import io.appium.java_client.android.nativekey.AndroidKey;13import io.appium.java_client.android.nativekey.KeyEvent;14import io.appium.java_client.android.nativekey.PressesKey;15import io.appium.java_client.android.nativekey.PressesKeyCode;16import io.appium.java_client.android.nativekey.android.AndroidKeySender;17import io.appium.java_client.android.nativekey.android.AndroidKeySymbol;18import io.appium.java_client.android.nativekey.internal.PressesKeyActions;19import io.appium.java_client.android.nativekey.internal.PressesKeyCodeActions;20import io.appium.java_client.android.nativekey.internal.ReturnsKeySender;21import io.appium.java_client.android.nativekey.internal.ReturnsPressesKey;22import io.appium.java_client.android.nativekey.internal.ReturnsPressesKeyCode;23import io.appium.java_client.android.nativekey.internal.ReturnsToKeyCode;24import io.appium.java_client.android.nativekey.internal.ReturnsToKeySymbol;25import io.appium.java_client.android.nativekey.internal.ToKeyCode;26import io.appium.java_client.android.nativekey.internal.ToKeySymbol;27import io.appium.java_client.android.nativekey.internal.ToPressesKeyCode;28import io.appium.java_client.android.nativekey.internal.ToPressesKey;29import io.appium.java_client.android.nativekey.internal.ToReturnsKeyCode;30import io.appium.java_client.android.nativekey.internal.ToReturnsKey;31import io.appium.java_client.android.nativekey.internal.ToReturnsPressesKeyCode;32import io.appium.java_client.android.nativekey.internal.ToReturnsPressesKey;33import io.appium.java_client.android.nativekey.internal.ToToKeyCode;34import io.appium.java_client.android.nativekey.internal.ToToKeySymbol;35import io.appium.java_client.android.nativekey.internal.ToToPressesKeyCode;36import io.appium.java_client.android.nativekey.internal.ToToPressesKey;37import io.appium.java_client.android.nativekey.internal.ToToReturnsKeyCode;38import io.app

custom

Using AI Code Generation

1AppiumDriver driver = new AndroidDriver();2WebElement element = driver.findElement(new AppiumBy.ByAndroidUIAutomator("new UiSelector().text(\"Appium\")"));3AppiumDriver driver = new AndroidDriver();4WebElement element = driver.findElement(new AppiumBy.ByIosUIAutomation("new UiSelector().text(\"Appium\")"));5AppiumDriver driver = new AndroidDriver();6WebElement element = driver.findElement(new AppiumBy.ByWindowsUIAutomation("new UiSelector().text(\"Appium\")"));7AppiumDriver driver = new AndroidDriver();8WebElement element = driver.findElement(new AppiumBy.ByAccessibilityId("new UiSelector().text(\"Appium\")"));9AppiumDriver driver = new AndroidDriver();10WebElement element = driver.findElement(new AppiumBy.ByImage("new UiSelector().text(\"Appium\")"));11AppiumDriver driver = new AndroidDriver();12WebElement element = driver.findElement(new AppiumBy.ByCustom("new UiSelector().text(\"Appium\")"));13AppiumDriver driver = new AndroidDriver();14WebElement element = driver.findElement(new AppiumBy.ByIosNsPredicate("new UiSelector().text(\"Appium\")"));15AppiumDriver driver = new AndroidDriver();16WebElement element = driver.findElement(new AppiumBy.ByIosClassChain("new UiSelector().text(\"Appium\")"));17AppiumDriver driver = new AndroidDriver();18WebElement element = driver.findElement(new AppiumBy.ByIosUIAutomation("new UiSelector().text(\"Appium\")"));

custom

Using AI Code Generation

1MobileElement element = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/nameField\")");2element.sendKeys("Hello");3MobileElement element1 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/radioFemale\")");4element1.click();5MobileElement element2 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/btnLetsShop\")");6element2.click();7MobileElement element3 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/appbar_btn_cart\")");8element3.click();9MobileElement element4 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/productPrice\")");10String price1 = element4.getText();11System.out.println("price1: " + price1);12MobileElement element5 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/totalAmountLbl\")");13String totalAmount = element5.getText();14System.out.println("totalAmount: " + totalAmount);15MobileElement element6 = driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/btnProceed\")");16element6.click();17driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/checkbox\")").click();18driver.findElementByAndroidUIAutomator("new UiSelector().resourceId(\"com.androidsample.generalstore:id/btnProceed\")").click();19driver.findElementByAndroidUIAutomator("new UiSelector().className(\"android.widget.EditText\")").sendKeys("Hello");20driver.hideKeyboard();21driver.findElementByAndroidUIAutomator("new UiSelector().text(\"Select Country\")").click();22driver.findElementByAndroidUIAutomator("new UiSelector().text(\"India\")").click();

custom

Using AI Code Generation

1AppiumBy appiumBy = new AppiumBy();2driver.findElement(by).click();3AppiumBy appiumBy = new AppiumBy();4driver.findElement(by).click();5AppiumBy appiumBy = new AppiumBy();6driver.findElement(by).click();7AppiumBy appiumBy = new AppiumBy();8driver.findElement(by).click();9AppiumBy appiumBy = new AppiumBy();10driver.findElement(by).click();11AppiumBy appiumBy = new AppiumBy();12driver.findElement(by).click();13AppiumBy appiumBy = new AppiumBy();14driver.findElement(by).click();15AppiumBy appiumBy = new AppiumBy();16driver.findElement(by).click();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.