[Live Now] Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Join for FREE! Join TestMu Conference

How to use setSetting method of io.appium.java_client.HasSettings class

Best io.appium code snippet using io.appium.java_client.HasSettings.setSetting

HasAndroidSettings.java

Source:HasAndroidSettings.java

...27     *28     * @param compress ignores unimportant views if true, doesn't ignore otherwise.29     */30    default void ignoreUnimportantViews(Boolean compress) {31        setSetting(Setting.IGNORE_UNIMPORTANT_VIEWS, compress);32    }33    /**34     * invoke {@code setWaitForIdleTimeout} in {@code com.android.uiautomator.core.Configurator}35     *36     * @param timeout A negative value would reset to its default value. Minimum time unit37     *                resolution is one millisecond38     */39    default void configuratorSetWaitForIdleTimeout(Duration timeout) {40        setSetting(Setting.WAIT_FOR_IDLE_TIMEOUT, timeout.toMillis());41    }42    /**43     * invoke {@code setWaitForSelectorTimeout} in {@code com.android.uiautomator.core.Configurator}44     *45     * @param timeout A negative value would reset to its default value. Minimum time unit46     *                resolution is one millisecond47     */48    default void configuratorSetWaitForSelectorTimeout(Duration timeout) {49        setSetting(Setting.WAIT_FOR_SELECTOR_TIMEOUT, timeout.toMillis());50    }51    /**52     * invoke {@code setScrollAcknowledgmentTimeout} in {@code com.android.uiautomator.core.Configurator}53     *54     * @param timeout A negative value would reset to its default value. Minimum time unit55     *                resolution is one millisecond56     */57    default void configuratorSetScrollAcknowledgmentTimeout(Duration timeout) {58        setSetting(Setting.WAIT_SCROLL_ACKNOWLEDGMENT_TIMEOUT, timeout.toMillis());59    }60    /**61     * invoke {@code configuratorSetKeyInjectionDelay} in {@code com.android.uiautomator.core.Configurator}62     *63     * @param delay A negative value would reset to its default value. Minimum time unit64     *              resolution is one millisecond65     */66    default void configuratorSetKeyInjectionDelay(Duration delay) {67        setSetting(Setting.KEY_INJECTION_DELAY, delay.toMillis());68    }69    /**70     * invoke {@code setActionAcknowledgmentTimeout} in {@code com.android.uiautomator.core.Configurator}71     *72     * @param timeout A negative value would reset to its default value. Minimum time unit73     *                resolution is one millisecond74     */75    default void configuratorSetActionAcknowledgmentTimeout(Duration timeout) {76        setSetting(Setting.WAIT_ACTION_ACKNOWLEDGMENT_TIMEOUT, timeout.toMillis());77    }78}...

FindsByImage.java

Source:FindsByImage.java

...21    /**22     * Performs the lookup for a single element by matching its image template23     * to the current full screen shot. This type of locator requires OpenCV libraries24     * and bindings for NodeJS to be installed on the server machine. Lookup options25     * fine-tuning might be done via {@link HasSettings#setSetting(Setting, Object)}.26     *27     * @param b64Template base64-encoded template image string. Supported image formats are the same28     *                    as for OpenCV library.29     * @return The first element that matches the given selector30     * @throws NoSuchElementException when no element is found31     * @see <a href="https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md">32     * The documentation on Image Comparison Features</a>33     * @see <a href="https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js">34     * The settings available for lookup fine-tuning</a>35     * @since Appium 1.8.236     */37    default T findElementByImage(String b64Template) {38        return findElement(MobileSelector.IMAGE.toString(), b64Template);39    }40    /**41     * Performs the lookup for a list of elements by matching them to image template42     * in the current full screen shot. This type of locator requires OpenCV libraries43     * and bindings for NodeJS to be installed on the server machine. Lookup options44     * fine-tuning might be done via {@link HasSettings#setSetting(Setting, Object)}.45     *46     * @param b64Template base64-encoded template image string. Supported image formats are the same47     *                    as for OpenCV library.48     * @return a list of elements that match the given selector or an empty list49     * @see <a href="https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/image-comparison.md">50     * The documentation on Image Comparison Features</a>51     * @see <a href="https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js">52     * The settings available for lookup fine-tuning</a>53     * @since Appium 1.8.254     */55    default List<T> findElementsByImage(String b64Template) {56        return findElements(MobileSelector.IMAGE.toString(), b64Template);57    }58}...

HasSettings.java

Source:HasSettings.java

...14 * limitations under the License.15 */16package io.appium.java_client;17import static io.appium.java_client.MobileCommand.getSettingsCommand;18import static io.appium.java_client.MobileCommand.setSettingsCommand;19import org.openqa.selenium.remote.Response;20import java.util.Map;21public interface HasSettings extends ExecutesMethod {22    /**23     * Set a setting for this test session It's probably better to use a24     * convenience function, rather than use this function directly. Try finding25     * the method for the specific setting you want to change.26     *27     * @param setting Setting you wish to set.28     * @param value   Value of the setting.29     * @return        Self instance for chaining.30     */31    default HasSettings setSetting(Setting setting, Object value) {32        return setSetting(setting.toString(), value);33    }34    /**35     * Set a setting for this test session It's probably better to use a36     * convenience function, rather than use this function directly. Try finding37     * the method for the specific setting you want to change.38     *39     * @param settingName Setting name you wish to set.40     * @param value       Value of the setting.41     * @return            Self instance for chaining.42     */43    default HasSettings setSetting(String settingName, Object value) {44        CommandExecutionHelper.execute(this, setSettingsCommand(settingName, value));45        return this;46    }47    /**48     * Get settings stored for this test session It's probably better to use a49     * convenience function, rather than use this function directly. Try finding50     * the method for the specific setting you want to read.51     *52     * @return JsonObject, a straight-up hash of settings.53     */54    @SuppressWarnings("unchecked")55    default Map<String, Object> getSettings() {56        Map.Entry<String, Map<String, ?>> keyValuePair = getSettingsCommand();57        Response response = execute(keyValuePair.getKey(), keyValuePair.getValue());58        return (Map<String, Object>) response.getValue();...

RecordingTest.java

Source:RecordingTest.java

...34                decode);35    }36    @Test37    public void testApp() throws IOException {38        //((HasSettings)driver).setSetting(Setting.IMAGE_MATCH_THRESHOLD, "4.0");39        ((AndroidDriver) driver).sendSMS("555-555-5555", "Your message here!");40        ((HasSettings)driver).setSetting(Setting.FIX_IMAGE_TEMPLATE_SIZE, "true");41        ((HasSettings)driver).setSetting(Setting.IMAGE_ELEMENT_TAP_STRATEGY, "touchActions");42        File file = new File("/Users/saikrisv/Desktop/login.png");43        File refImgFile = Paths.get(file.toURI()).toFile();44        File screenshotAs = driver.getScreenshotAs(OutputType.FILE);45        OccurrenceMatchingResult result = driver46                .findImageOccurrence(screenshotAs, new File("/Users/saikrisv/Desktop/login.png") ,47                        new OccurrenceMatchingOptions()48                        .withEnabledVisualization());49        System.out.println(result.getRect());50        //driver.findElementByImage(s).click();51    }52}...

HasIOSSettings.java

Source:HasIOSSettings.java

...22     * Sets whether Safari/webviews should convert element taps into x/y taps23     * @param enabled turns nativeWebTap on if true, off if false24     */25    default void nativeWebTap(Boolean enabled) {26        setSetting(Setting.NATIVE_WEB_TAP, enabled);27    }28}...

setSetting

Using AI Code Generation

1package appium.java;2import java.net.MalformedURLException;3import java.net.URL;4import org.openqa.selenium.remote.DesiredCapabilities;5import io.appium.java_client.android.AndroidDriver;6import io.appium.java_client.android.AndroidElement;7import io.appium.java_client.remote.MobileCapabilityType;8public class SetSetting {9	public static void main(String[] args) throws MalformedURLException {10		DesiredCapabilities cap = new DesiredCapabilities();11		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "Redmi");12		cap.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");13		cap.setCapability(MobileCapabilityType.PLATFORM_VERSION, "10.0");14		cap.setCapability(MobileCapabilityType.AUTOMATION_NAME, "UiAutomator2");15		cap.setCapability("appPackage", "com.android.settings");16		cap.setCapability("appActivity", "com.android.settings.Settings");17		cap.setCapability(MobileCapabilityType.NO_RESET, true);

setSetting

Using AI Code Generation

1import io.appium.java_client.AppiumDriver;2import io.appium.java_client.android.AndroidDriver;3import io.appium.java_client.remote.MobileCapabilityType;4import org.openqa.selenium.remote.DesiredCapabilities;5import java.net.URL;6import java.net.MalformedURLException;7import java.util.concurrent.TimeUnit;8public class SetSettingExample {9    private static AppiumDriver driver;10    public static void main(String[] args) {11        try {12            DesiredCapabilities desiredCapabilities = new DesiredCapabilities();13            desiredCapabilities.setCapability("platformName", "Android");14            desiredCapabilities.setCapability("platformVersion", "9.0");15            desiredCapabilities.setCapability("deviceName", "emulator-5554");16            desiredCapabilities.setCapability("appPackage", "io.appium.android.apis");17            desiredCapabilities.setCapability("appActivity", ".ApiDemos");18            desiredCapabilities.setCapability("automationName", "UiAutomator2");19            driver = new AndroidDriver(remoteUrl, desiredCapabilities);20            driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);21            driver.setSetting("ignoreUnimportantViews", true);22            driver.setSetting("ignoreUnimportantViews", false);23        } catch (MalformedURLException e) {24            System.out.println(e.getMessage());25        } finally {26            driver.quit();27        }28    }29}30from appium import webdriver31from appium.webdriver.common.mobileby import MobileBy32from selenium.webdriver.support.ui import WebDriverWait33from selenium.webdriver.support import expected_conditions as EC34from selenium.common.exceptions import TimeoutException35desired_caps = {36}37driver.set_setting("ignoreUnimportantViews", True)38driver.set_setting("ignoreUnimportantViews", False)39driver.quit()

setSetting

Using AI Code Generation

1DesiredCapabilities caps = new DesiredCapabilities();2caps.setCapability("deviceName", "Android Emulator");3caps.setCapability("platformName", "Android");4caps.setCapability("appPackage", "io.appium.android.apis");5caps.setCapability("appActivity", ".view.WebView1");6caps.setCapability("autoGrantPermissions", true);7caps.setCapability("noReset", true);8caps.setCapability("automationName", "UiAutomator2");9caps.setCapability("autoWebview", true);10caps.setCapability("autoWebviewTimeout", 20000);

setSetting

Using AI Code Generation

1import io.appium.java_client.android.AndroidDriver;2import io.appium.java_client.remote.MobileCapabilityType;3import org.openqa.selenium.remote.DesiredCapabilities;4import java.net.URL;5import java.net.MalformedURLException;6public class setSetting {7public static void main(String[] args) throws MalformedURLException {8DesiredCapabilities caps = new DesiredCapabilities();9caps.setCapability("deviceName", "Pixel 2");10caps.setCapability("platformName", "Android");11caps.setCapability("appPackage", "io.appium.android.apis");12caps.setCapability("appActivity", ".view.WebView1");13caps.setCapability("automationName", "UiAutomator2");14caps.setCapability(MobileCapabilityType.AUTOMATION_NAME, "UiAutomator2");15caps.setCapability("noReset", true);16caps.setCapability("noSign", true);17caps.setCapability("skipUnlock", true);18caps.setCapability("skipLogcatCapture", true);19caps.setCapability("skipDeviceInitialization", true);

setSetting

Using AI Code Generation

1package io.appium.java_client.android;2import java.net.URL;3import java.util.HashMap;4import java.util.Map;5import org.openqa.selenium.remote.DesiredCapabilities;6import io.appium.java_client.android.AndroidDriver;7import io.appium.java_client.remote.AndroidMobileCapabilityType;8import io.appium.java_client.remote.MobileCapabilityType;9import io.appium.java_client.remote.MobilePlatform;10public class SetSettingDemo {11    public static void main(String[] args) throws Exception {12        DesiredCapabilities caps = new DesiredCapabilities();13        caps.setCapability(MobileCapabilityType.DEVICE_NAME, "Pixel 4 Emulator");14        caps.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);15        caps.setCapability(MobileCapabilityType.UDID, "emulator-5554");16        caps.setCapability(AndroidMobileCapabilityType.APP_PACKAGE, "io.appium.android.apis");17        caps.setCapability(AndroidMobileCapabilityType.APP_ACTIVITY, ".ApiDemos");

setSetting

Using AI Code Generation

1package com.appium;2import java.net.MalformedURLException;3import java.net.URL;4import java.util.HashMap;5import java.util.Map;6import java.util.concurrent.TimeUnit;7import org.openqa.selenium.remote.DesiredCapabilities;8import io.appium.java_client.MobileElement;9import io.appium.java_client.android.AndroidDriver;10public class SetSetting {11	public static void main(String[] args) throws MalformedURLException {12		DesiredCapabilities capabilities = new DesiredCapabilities();13		capabilities.setCapability("deviceName", "Android Emulator");14		capabilities.setCapability("platformName", "Android");15		capabilities.setCapability("platformVersion", "8.1");16		capabilities.setCapability("appPackage", "io.appium.android.apis");17		capabilities.setCapability("appActivity", "io.appium.android.apis.ApiDemos");

setSetting

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 java.net.MalformedURLException;5import java.net.URL;6import org.openqa.selenium.remote.DesiredCapabilities;7public class SetSetting {8public static void main(String[] args) throws MalformedURLException {9DesiredCapabilities cap = new DesiredCapabilities();10cap.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");11cap.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");12cap.setCapability(MobileCapabilityType.PLATFORM_VERSION, "8.0");13cap.setCapability(MobileCapabilityType.AUTOMATION_NAME, "UiAutomator2");14cap.setCapability("appPackage", "io.appium.android.apis");15cap.setCapability("appActivity", "io.appium.android.apis.ApiDemos");16cap.setCapability("noReset", "true");

setSetting

Using AI Code Generation

1package appium;2import java.net.MalformedURLException;3import java.net.URL;4import java.util.HashMap;5import java.util.Map;6import org.openqa.selenium.remote.DesiredCapabilities;7import io.appium.java_client.android.AndroidDriver;8import io.appium.java_client.remote.MobileCapabilityType;9public class AppiumSettings {10	public static void main(String[] args) throws MalformedURLException, InterruptedException {11		DesiredCapabilities cap = new DesiredCapabilities();12		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "emulator-5554");13		cap.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");14		cap.setCapability(MobileCapabilityType.PLATFORM_VERSION, "8.0");15		cap.setCapability(MobileCapabilityType.AUTOMATION_NAME, "uiautomator2");16		cap.setCapability(MobileCapabilityType.APP, "C:\\Users\\Dell\\Downloads\\ApiDemos-debug.apk");

setSetting

Using AI Code Generation

1package com.test.appium;2import java.net.MalformedURLException;3import java.net.URL;4import java.util.HashMap;5import java.util.Map;6import org.openqa.selenium.By;7import org.openqa.selenium.remote.DesiredCapabilities;8import io.appium.java_client.android.AndroidDriver;9import io.appium.java_client.remote.MobileCapabilityType;10public class SetDeviceLanguage {11    public static void main(String[] args) throws MalformedURLException {12        DesiredCapabilities capabilities = new DesiredCapabilities();13        capabilities.setCapability("deviceName", "emulator-5554");14        capabilities.setCapability(MobileCapabilityType.BROWSER_NAME, "Android");15        capabilities.setCapability(MobileCapabilityType.VERSION, "7.0");16        capabilities.setCapability("platformName", "Android");17        capabilities.setCapability("appPackage", "com.android.calculator2");18        capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");

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.