How to use CapabilityHelpers class of io.appium.java_client.internal package

Best io.appium code snippet using io.appium.java_client.internal.CapabilityHelpers

AppiumFieldDecorator.java

Source:AppiumFieldDecorator.java

...20import static java.time.Duration.ofSeconds;21import com.google.common.collect.ImmutableList;22import io.appium.java_client.MobileElement;23import io.appium.java_client.android.AndroidElement;24import io.appium.java_client.internal.CapabilityHelpers;25import io.appium.java_client.ios.IOSElement;26import io.appium.java_client.pagefactory.bys.ContentType;27import io.appium.java_client.pagefactory.locator.CacheableLocator;28import io.appium.java_client.remote.MobileCapabilityType;29import io.appium.java_client.windows.WindowsElement;30import org.openqa.selenium.Capabilities;31import org.openqa.selenium.HasCapabilities;32import org.openqa.selenium.SearchContext;33import org.openqa.selenium.WebDriver;34import org.openqa.selenium.WebElement;35import org.openqa.selenium.remote.CapabilityType;36import org.openqa.selenium.remote.RemoteWebElement;37import org.openqa.selenium.support.pagefactory.DefaultFieldDecorator;38import org.openqa.selenium.support.pagefactory.ElementLocator;39import org.openqa.selenium.support.pagefactory.FieldDecorator;40import java.lang.reflect.Constructor;41import java.lang.reflect.Field;42import java.lang.reflect.ParameterizedType;43import java.lang.reflect.Type;44import java.lang.reflect.TypeVariable;45import java.time.Duration;46import java.util.ArrayList;47import java.util.Arrays;48import java.util.Collections;49import java.util.List;50import java.util.Map;51/**52 * Default decorator for use with PageFactory. Will decorate 1) all of the53 * WebElement fields and 2) List of WebElement that have54 * {@literal @AndroidFindBy}, {@literal @AndroidFindBys}, or55 * {@literal @iOSFindBy/@iOSFindBys} annotation with a proxy that locates the56 * elements using the passed in ElementLocatorFactory.57 * Please pay attention: fields of {@link WebElement}, {@link RemoteWebElement},58 * {@link MobileElement}, {@link AndroidElement} and {@link IOSElement} are allowed59 * to use with this decorator60 */61public class AppiumFieldDecorator implements FieldDecorator {62    private static final List<Class<? extends WebElement>> availableElementClasses = ImmutableList.of(WebElement.class,63            RemoteWebElement.class, MobileElement.class, AndroidElement.class,64            IOSElement.class, WindowsElement.class);65    public static final Duration DEFAULT_WAITING_TIMEOUT = ofSeconds(1);66    private final WebDriver webDriver;67    private final DefaultFieldDecorator defaultElementFieldDecoracor;68    private final AppiumElementLocatorFactory widgetLocatorFactory;69    private final String platform;70    private final String automation;71    private final Duration duration;72    /**73     * Creates field decorator based on {@link SearchContext} and timeout {@code duration}.74     *75     * @param context  is an instance of {@link SearchContext}76     *                 It may be the instance of {@link WebDriver} or {@link WebElement} or77     *                 {@link Widget} or some other user's extension/implementation.78     * @param duration is a desired duration of the waiting for an element presence.79     */80    public AppiumFieldDecorator(SearchContext context, Duration duration) {81        this.webDriver = unpackWebDriverFromSearchContext(context);82        if (this.webDriver instanceof HasCapabilities) {83            Capabilities caps = ((HasCapabilities) this.webDriver).getCapabilities();84            this.platform = CapabilityHelpers.getCapability(caps, CapabilityType.PLATFORM_NAME, String.class);85            this.automation = CapabilityHelpers.getCapability(caps, MobileCapabilityType.AUTOMATION_NAME, String.class);86        } else {87            this.platform = null;88            this.automation = null;89        }90        this.duration = duration;91        defaultElementFieldDecoracor = new DefaultFieldDecorator(92                new AppiumElementLocatorFactory(context, duration,93                        new DefaultElementByBuilder(platform, automation))) {94            @Override95            protected WebElement proxyForLocator(ClassLoader ignored, ElementLocator locator) {96                return proxyForAnElement(locator);97            }98            @Override99            @SuppressWarnings("unchecked")...

AIFieldDecorator.java

Source:AIFieldDecorator.java

...19import org.openqa.selenium.support.pagefactory.ElementLocator;20import com.google.common.collect.ImmutableList;21import io.appium.java_client.MobileElement;22import io.appium.java_client.android.AndroidElement;23import io.appium.java_client.internal.CapabilityHelpers;24import io.appium.java_client.ios.IOSElement;25import io.appium.java_client.pagefactory.AppiumFieldDecorator;26import io.appium.java_client.windows.WindowsElement;27public class AIFieldDecorator extends AppiumFieldDecorator {28	29    private static final List<Class<? extends WebElement>> availableElementClasses = ImmutableList.of(WebElement.class,30            RemoteWebElement.class, MobileElement.class, AndroidElement.class,31            IOSElement.class, WindowsElement.class);32	private final DefaultFieldDecorator fieldDecorator;33	private WebDriver webDriver;34    private final String platform;35    private final String automation;36    37    public AIFieldDecorator(SearchContext context) {38        this(context, DEFAULT_WAITING_TIMEOUT);39    }40    public AIFieldDecorator(SearchContext context, Duration duration) {41    	super(context, duration);42    	43    	this.webDriver = (WebDriver) context;44    	45        if (this.webDriver instanceof HasCapabilities) {46            Capabilities caps = ((HasCapabilities) this.webDriver).getCapabilities();47            this.platform = CapabilityHelpers.getCapability(caps, "platformName", String.class);48            this.automation = CapabilityHelpers.getCapability(caps, "automationName", String.class);49        } else {50            this.platform = null;51            this.automation = null;52        }53    	54    	// The magic inside the brackets is overriding proxyForLocator and proxyForListLocator methods of DefaultFieldDecorator class55		fieldDecorator = new DefaultFieldDecorator(new AIElementLocatorFactory(context))  {56            @Override57            protected WebElement proxyForLocator(ClassLoader ignored, ElementLocator locator) {58                AIElementInterceptor elementInterceptor = new AIElementInterceptor(locator, webDriver);59                return getEnhancedProxy(getElementClass(platform, automation), elementInterceptor);60            }61            @Override62            @SuppressWarnings("unchecked")...

CommonMethodsFunction.java

Source:CommonMethodsFunction.java

...13	import io.appium.java_client.AppiumDriver;14	import io.appium.java_client.FindsByAndroidUIAutomator;15	import io.appium.java_client.MobileElement;16	import io.appium.java_client.TouchAction;17	import io.appium.java_client.internal.CapabilityHelpers;18	import io.appium.java_client.touch.WaitOptions;19	import io.appium.java_client.touch.offset.PointOption;2021	public class CommonMethodsFunction extends CapabilityHelpers{22		23		/**24		 * 25		 * @param text26		 * @param driver27		 * @throws MalformedURLException28		 * @throws InterruptedException29		 */30		public void scrollToText(String text, AppiumDriver<MobileElement> driver)31				throws MalformedURLException, InterruptedException {32		    	 MobileElement el = (MobileElement) ((FindsByAndroidUIAutomator) driver)33						    .findElementByAndroidUIAutomator("new UiScrollable("34						        + "new UiSelector().scrollable(true)).scrollIntoView("                      35						        + "new UiSelector().textContains(\""+text+"\"));");
...

JsonToMobileElementConverter.java

Source:JsonToMobileElementConverter.java

...39    public JsonToMobileElementConverter(RemoteWebDriver driver) {40        super(driver);41        this.driver = driver;42        Capabilities caps = driver.getCapabilities();43        this.platform = CapabilityHelpers.getCapability(caps, CapabilityType.PLATFORM_NAME, String.class);44        this.automation = CapabilityHelpers.getCapability(caps, MobileCapabilityType.AUTOMATION_NAME, String.class);45    }46    @Override47    public Object apply(Object result) {48        Object toBeReturned = result;49        if (toBeReturned instanceof RemoteWebElement) {50            toBeReturned = newRemoteWebElement();51            ((RemoteWebElement) toBeReturned).setId(((RemoteWebElement) result).getId());52        }53        return super.apply(toBeReturned);54    }55    @Override56    protected RemoteWebElement newRemoteWebElement() {57        Class<? extends RemoteWebElement> target;58        target = getElementClass(platform, automation);...

JsonToAndroidElementConverter.java

Source:JsonToAndroidElementConverter.java

1package io.perfeccionista.framework.pagefactory.dispatcher.driver;2import io.appium.java_client.android.AndroidElement;3import io.appium.java_client.internal.CapabilityHelpers;4import org.openqa.selenium.Capabilities;5import org.openqa.selenium.WebDriverException;6import org.openqa.selenium.remote.RemoteWebDriver;7import org.openqa.selenium.remote.RemoteWebElement;8import org.openqa.selenium.remote.internal.JsonToWebElementConverter;9import java.lang.reflect.Constructor;10import java.util.Optional;11import static io.appium.java_client.internal.ElementMap.getElementClass;12public class JsonToAndroidElementConverter extends JsonToWebElementConverter {13    protected final RemoteWebDriver driver;14    private final String platform;15    private final String automation;16    /**17     * Creates a new instance based on {@code driver} and object with session details.18     *19     * @param driver an instance of {@link RemoteWebDriver} subclass20     */21    public JsonToAndroidElementConverter(RemoteWebDriver driver) {22        super(driver);23        this.driver = driver;24        Capabilities caps = driver.getCapabilities();25        this.platform = CapabilityHelpers.getCapability(caps, "platformName", String.class);26        this.automation = CapabilityHelpers.getCapability(caps, "automationName", String.class);27    }28    @Override29    public Object apply(Object result) {30        Object toBeReturned = result;31        if (toBeReturned instanceof RemoteWebElement) {32            toBeReturned = newRemoteWebElement();33            ((RemoteWebElement) toBeReturned).setId(((RemoteWebElement) result).getId());34        }35        return super.apply(toBeReturned);36    }37    @Override38    protected RemoteWebElement newRemoteWebElement() {39        Class<? extends RemoteWebElement> target;40        if ("espresso".equalsIgnoreCase(Optional.ofNullable(platform).orElse(automation).trim())) {...

LoginPage.java

Source:LoginPage.java

1package models.pages;2import io.appium.java_client.AppiumDriver;3import io.appium.java_client.MobileBy;4import io.appium.java_client.MobileElement;5import io.appium.java_client.internal.CapabilityHelpers;6import io.appium.java_client.pagefactory.AndroidBy;7import io.appium.java_client.pagefactory.AndroidFindBy;8import io.appium.java_client.pagefactory.AppiumFieldDecorator;9import io.appium.java_client.pagefactory.iOSXCUITFindBy;10import models.components.global.BottomNavigationComponent;11import org.openqa.selenium.By;12import org.openqa.selenium.Capabilities;13import org.openqa.selenium.support.PageFactory;14import java.time.Duration;15import java.util.Map;16public class LoginPage {17    private final AppiumDriver<MobileElement> appiumDriver;18    private static final By usernameSel = MobileBy.AccessibilityId("input-email");19    private static final By passwordSel = MobileBy.AccessibilityId("input-password");20    private static final By loginBtnSel = MobileBy.AccessibilityId("button-LOGIN");21    @AndroidFindBy(id = "android:id/alertTitle")22    @iOSXCUITFindBy(iOSNsPredicate = "label == \"Success\"")23    private MobileElement msgTitleElem;24    public LoginPage(AppiumDriver<MobileElement> appiumDriver) {25        this.appiumDriver = appiumDriver;26        PageFactory.initElements(new AppiumFieldDecorator(appiumDriver, Duration.ofSeconds(10)), this);27    }28    // Return found element(s)29    private MobileElement usernameElem(){30        return appiumDriver.findElement(usernameSel);31    }32    public LoginPage inputUsername(String userName){33        usernameElem().sendKeys(userName);34        return this;35    }36    public LoginPage inputPassword(String password){37        appiumDriver.findElement(passwordSel).sendKeys(password);38        return this;39    }40    public void clickOnLoginBtn(){41        appiumDriver.findElement(loginBtnSel).click();42    }43    public String loginMsgText(){44        Capabilities caps = this.appiumDriver.getCapabilities();45        String platform = CapabilityHelpers.getCapability(caps, "platformName", String.class);46        System.out.println("PLATFORM : " + platform);47        return msgTitleElem.getText();48    }49    public BottomNavigationComponent bottomNavigationComponent(){50        return new BottomNavigationComponent(appiumDriver);51    }52}...

SupportsAndroidInstallTimeoutOption.java

Source:SupportsAndroidInstallTimeoutOption.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client.android.options.app;17import io.appium.java_client.internal.CapabilityHelpers;18import io.appium.java_client.remote.options.BaseOptions;19import io.appium.java_client.remote.options.CanSetCapability;20import org.openqa.selenium.Capabilities;21import java.time.Duration;22import java.util.Optional;23import static io.appium.java_client.internal.CapabilityHelpers.toDuration;24public interface SupportsAndroidInstallTimeoutOption<T extends BaseOptions<T>> extends25        Capabilities, CanSetCapability<T> {26    String ANDROID_INSTALL_TIMEOUT_OPTION = "androidInstallTimeout";27    /**28     * Maximum amount of time to wait until the application under test is installed.29     * 90000 ms by default30     *31     * @param installTimeout App install timeout.32     * @return self instance for chaining.33     */34    default T setAndroidInstallTimeout(Duration installTimeout) {35        return amend(ANDROID_INSTALL_TIMEOUT_OPTION, installTimeout.toMillis());36    }37    /**38     * Get maximum amount of time to wait until the application under test is installed.39     *40     * @return Timeout value.41     */42    default Optional<Duration> getAndroidInstallTimeout() {43        return Optional.ofNullable(44                CapabilityHelpers.toDuration(getCapability(ANDROID_INSTALL_TIMEOUT_OPTION))45        );46    }47}...

LoginDialogComponent.java

Source:LoginDialogComponent.java

1package models.components.authentication;2import io.appium.java_client.AppiumDriver;3import io.appium.java_client.MobileBy;4import io.appium.java_client.MobileElement;5import io.appium.java_client.internal.CapabilityHelpers;6import io.appium.java_client.pagefactory.AppiumFieldDecorator;7import io.appium.java_client.pagefactory.AndroidFindBy;8import io.appium.java_client.pagefactory.iOSXCUITFindBy;9import org.openqa.selenium.By;10import org.openqa.selenium.Capabilities;11import org.openqa.selenium.HasCapabilities;12import org.openqa.selenium.WebElement;13import org.openqa.selenium.support.PageFactory;14import java.time.Duration;15public class LoginDialogComponent {16    private final AppiumDriver<MobileElement> appiumDriver;17    private static final By okBtnSel = MobileBy.AccessibilityId("OK");18    @AndroidFindBy(id = "android:id/alertTitle")19    @iOSXCUITFindBy(iOSNsPredicate = "label == \"Success\"")20    private MobileElement msgTitle;21    @AndroidFindBy(id = "android:id/button1")22    @iOSXCUITFindBy(accessibility = "OK")23    private MobileElement okBtn;24    public LoginDialogComponent(AppiumDriver<MobileElement> appiumDriver) {25        this.appiumDriver = appiumDriver;26        PageFactory.initElements(new AppiumFieldDecorator(appiumDriver, Duration.ofSeconds(10)), this);27    }28    public String msgTitle(){29        return msgTitle.getText();30    }31    public void clickOnOKBtn(){32        Capabilities caps = this.appiumDriver.getCapabilities();33        String platform = CapabilityHelpers.getCapability(caps, "platformName", String.class);34        if(platform.equalsIgnoreCase("ios")) okBtn.click();35        okBtn.click();36    }37}...

CapabilityHelpers

Using AI Code Generation

1import io.appium.java_client.internal.CapabilityHelpers;2import io.appium.java_client.AppiumDriver;3import org.openqa.selenium.remote.DesiredCapabilities;4import java.net.URL;5import java.net.MalformedURLException;6public class AppiumTest {7public static AppiumDriver driver;8public static DesiredCapabilities capabilities;9public static void main(String[] args) {10capabilities = DesiredCapabilities.iphone();11capabilities.setCapability("deviceName", "iPhone 6");12capabilities.setCapability("platformName", "iOS");13capabilities.setCapability("platformVersion", "9.3");14capabilities.setCapability("app", "/Users/username/Desktop/UICatalog.app");15capabilities.setCapability("automationName", "XCUITest");16capabilities.setCapability("appiumVersion", "1.5.3");17capabilities.setCapability("deviceOrientation", "portrait");

CapabilityHelpers

Using AI Code Generation

1import io.appium.java_client.internal.CapabilityHelpers;2import org.openqa.selenium.remote.CapabilityType;3import org.openqa.selenium.remote.DesiredCapabilities;4import io.appium.java_client.AppiumDriver;5import io.appium.java_client.android.AndroidDriver;6import java.net.URL;7import java.net.MalformedURLException;8public class AppiumTest {9    AppiumDriver driver;10    DesiredCapabilities capabilities;11    URL url;12    public void setUp() throws MalformedURLException {13        capabilities = new DesiredCapabilities();14        capabilities.setCapability("deviceName", "Android Emulator");15        capabilities.setCapability("platformName", "Android");16        capabilities.setCapability("platformVersion", "7.1.1");17        capabilities.setCapability("appPackage", "com.example.android.contactmanager");18        capabilities.setCapability("appActivity", ".ContactManager");

CapabilityHelpers

Using AI Code Generation

1DesiredCapabilities capabilities = new DesiredCapabilities();2capabilities.setCapability(CapabilityType.PLATFORM_NAME, "Android");3capabilities.setCapability(CapabilityType.PLATFORM_VERSION, "4.4");4capabilities.setCapability(CapabilityType.BROWSER_NAME, "Chrome");5capabilities.setCapability(CapabilityType.VERSION, "4.4");6capabilities.setCapability(CapabilityType.DEVICE_NAME, "Android Emulator");7capabilities.setCapability(CapabilityType.APP, "C:\\Users\\Downloads\\myapp.apk");8capabilities.setCapability(CapabilityType.NEW_COMMAND_TIMEOUT, "60");9capabilities.setCapability(CapabilityType.ROTATABLE, true);10capabilities.setCapability(CapabilityType.TAKES_SCREENSHOT, true);11capabilities.setCapability(CapabilityType.UNEXPECTED_ALERT_BEHAVIOUR, "accept");12capabilities.setCapability(CapabilityType.HAS_NATIVE_EVENTS, true);13capabilities.setCapability(CapabilityType.SUPPORTS_APPLICATION_CACHE, true);14capabilities.setCapability(CapabilityType.SUPPORTS_JAVASCRIPT, true);15capabilities.setCapability(CapabilityType.SUPPORTS_LOCATION_CONTEXT, true);16capabilities.setCapability(CapabilityType.SUPPORTS_WEB_STORAGE, true);17capabilities.setCapability(CapabilityType.TAKES_SCREENSHOT, true);18capabilities.setCapability(CapabilityType.UNEXPECTED_ALERT_BEHAVIOUR, "accept");19capabilities.setCapability(CapabilityType.UNHANDLED_PROMPT_BEHAVIOUR, "accept");20DesiredCapabilities capabilities = new DesiredCapabilities();21capabilities.setCapability(CapabilityType.PLATFORM_NAME, "Android");22capabilities.setCapability(CapabilityType.PLATFORM_VERSION, "4.4");23capabilities.setCapability(CapabilityType.BROWSER_NAME, "Chrome");24capabilities.setCapability(CapabilityType.VERSION, "4.4");25capabilities.setCapability(CapabilityType.DEVICE_NAME, "Android Emulator");26capabilities.setCapability(CapabilityType.APP, "C:\\Users\\Downloads\\myapp.apk");27capabilities.setCapability(CapabilityType.NEW_COMMAND_TIMEOUT, "60");28capabilities.setCapability(CapabilityType.ROTATABLE, true);29capabilities.setCapability(CapabilityType.TAKES_SCREENSHOT, true);30capabilities.setCapability(CapabilityType.UNEXPECTED_ALERT_BEHAVIOUR, "accept");31capabilities.setCapability(CapabilityType.HAS_NATIVE_EVENTS, true);

CapabilityHelpers

Using AI Code Generation

1import io.appium.java_client.android.AndroidDriver;2import io.appium.java_client.android.AndroidElement;3import io.appium.java_client.remote.MobileCapabilityType;4import io.appium.java_client.remote.AndroidMobileCapabilityType;5import io.appium.java_client.remote.MobilePlatform;6import io.appium.java_client.service.local.AppiumDriverLocalService;7import io.appium.java_client.service.local.AppiumServiceBuilder;8import io.appium.java_client.service.local.flags.GeneralServerFlag;9import io.appium.java_client.service.local.flags.ServerArgument;10import java.io.File;11import java.net.URL;12import org.openqa.selenium.remote.DesiredCapabilities;13public class appium {14	public static void main(String[] args) throws Exception {15		String appiumServerPath = "C:\\Program Files (x86)\\Appium\\node_modules\\appium\\bin\\appium.js";16		String appPath = "C:\\Users\\Sudheer\\Desktop\\Appium\\ApiDemos-debug.apk";17		String appiumLogPath = "C:\\Users\\Sudheer\\Desktop\\Appium\\appium.log";18		AppiumServiceBuilder appiumBuilder = new AppiumServiceBuilder();19		appiumBuilder.withAppiumJS(new File(appiumServerPath));20		appiumBuilder.withLogFile(new File(appiumLogPath));21		appiumBuilder.withArgument(GeneralServerFlag.LOCAL_TIMEZONE);22		appiumBuilder.withArgument(GeneralServerFlag.LOG_LEVEL,"error");23		AppiumDriverLocalService appiumService = AppiumDriverLocalService.buildService(appiumBuilder);24		appiumService.start();25		DesiredCapabilities cap = new DesiredCapabilities();26		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Device");

CapabilityHelpers

Using AI Code Generation

1import io.appium.java_client.internal.CapabilityHelpers;2String value = CapabilityHelpers.getCapabilityValue(desiredCapabilities, "udid");3CapabilityHelpers.setCapabilityValue(desiredCapabilities, "udid", "1234567890");4CapabilityHelpers.removeCapability(desiredCapabilities, "udid");5CapabilityHelpers.isCapabilityPresent(desiredCapabilities, "udid");6String value = CapabilityHelpers.getCapabilityValue(desiredCapabilities, "udid");7CapabilityHelpers.setCapabilityValue(desiredCapabilities, "udid", "1234567890");8CapabilityHelpers.removeCapability(desiredCapabilities, "udid");9CapabilityHelpers.isCapabilityPresent(desiredCapabilities, "udid");10import io.appium.java_client.internal.CapabilityHelpers;11String value = CapabilityHelpers.getCapabilityValue(desiredCapabilities, "udid");12CapabilityHelpers.setCapabilityValue(desiredCapabilities, "udid", "1234567890");13CapabilityHelpers.removeCapability(desiredCapabilities, "udid");14CapabilityHelpers.isCapabilityPresent(desiredCapabilities, "udid");15import io.appium.java_client.internal.CapabilityHelpers;16String value = CapabilityHelpers.getCapabilityValue(desiredCapabilities, "udid");17CapabilityHelpers.setCapabilityValue(desiredCapabilities, "udid", "1234567890");18CapabilityHelpers.removeCapability(desiredCapabilities, "udid");19CapabilityHelpers.isCapabilityPresent(desiredCapabilities, "udid");20import io.appium.java_client.internal.Cap

CapabilityHelpers

Using AI Code Generation

1public class AppiumTest {2	static AppiumDriver<MobileElement> driver;3	static DesiredCapabilities cap;4	static URL url;5	static AndroidDriver<MobileElement> androidDriver;6	static CapabilityHelpers capabilityHelpers;7	static WebDriverWait wait;8	static TouchAction action;9	static WaitOptions waitOptions;10	static AndroidElement androidElement;11	static By by;12	static WebElement webElement;13	static Point point;14	static Dimension dimension;

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.