TestMu 2025 - The Largest Virtual Software Testing Conference is Back | 50,000+ Attendees

How to use HasSettings class of io.appium.java_client package

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

AndroidDriver.java

Source:AndroidDriver.java

...41 */42public class AndroidDriver<T extends WebElement>43    extends AppiumDriver<T>44    implements PressesKeyCode, HasNetworkConnection, PushesFiles, StartsActivity,45        FindsByAndroidUIAutomator<T>, LocksAndroidDevice, HasSettings, HasDeviceDetails,46            HasSupportedPerformanceDataType {47    private static final String ANDROID_PLATFORM = MobilePlatform.ANDROID;48    /**49     * @param executor is an instance of {@link org.openqa.selenium.remote.HttpCommandExecutor}50     *                 or class that extends it. Default commands or another vendor-specific51     *                 commands may be specified there.52     * @param capabilities take a look53     *                     at {@link org.openqa.selenium.Capabilities}54     */55    public AndroidDriver(AppiumCommandExecutor executor, Capabilities capabilities) {56        super(executor, substituteMobilePlatform(capabilities, ANDROID_PLATFORM));57    }58    /**59     * @param remoteAddress is the address of remotely/locally...

HasAndroidSettings.java

Source:HasAndroidSettings.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client.android;17import io.appium.java_client.HasSettings;18import io.appium.java_client.Setting;19import java.time.Duration;20interface HasAndroidSettings extends HasSettings {21    /**22     * Set the `ignoreUnimportantViews` setting. *Android-only method*.23     * Sets whether Android devices should use `setCompressedLayoutHeirarchy()`24     * which ignores all views which are marked IMPORTANT_FOR_ACCESSIBILITY_NO25     * or IMPORTANT_FOR_ACCESSIBILITY_AUTO (and have been deemed not important26     * by the system), in an attempt to make things less confusing or faster.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}...

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

...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());...

RecordingTest.java

Source:RecordingTest.java

1package com.appium.advacedUsecases;2import com.appium.base.BaseTest;3import io.appium.java_client.HasSettings;4import io.appium.java_client.Setting;5import io.appium.java_client.android.AndroidDriver;6import io.appium.java_client.imagecomparison.OccurrenceMatchingOptions;7import io.appium.java_client.imagecomparison.OccurrenceMatchingResult;8import io.appium.java_client.ios.IOSDriver;9import org.apache.commons.io.FileUtils;10import org.openqa.selenium.OutputType;11import org.testng.annotations.Test;12import java.io.File;13import java.io.IOException;14import java.nio.file.Paths;15import java.util.Base64;16public class RecordingTest extends BaseTest {17    @Test18    public void iOSScreenRecordTest() throws IOException {19        ((IOSDriver)driver).startRecordingScreen();20        String s = ((IOSDriver) driver).stopRecordingScreen();21        byte[] decode = Base64.getDecoder().decode(s);22        FileUtils.writeByteArrayToFile(new File(23            System.getProperty("user.dir")24                +"/sample.mp4"),25                decode);26    }27    @Test28    public void androidScreenRecordTest() throws IOException, InterruptedException {29        ((AndroidDriver)driver).startRecordingScreen();30        Thread.sleep(10000);31        String s = ((AndroidDriver) driver).stopRecordingScreen();32        byte[] decode = Base64.getDecoder().decode(s);33        FileUtils.writeByteArrayToFile(new File(System.getProperty("user.dir")+"/sample.mp4"),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}...

DriverManager.java

Source:DriverManager.java

...5import org.openqa.selenium.WebDriver;6import org.openqa.selenium.remote.CapabilityType;7import org.openqa.selenium.remote.DesiredCapabilities;8import io.appium.java_client.AppiumDriver;9import io.appium.java_client.HasSettings;10import io.appium.java_client.MobileElement;11import io.appium.java_client.Setting;12import io.appium.java_client.remote.MobileCapabilityType;13public class DriverManager {14	private WebDriver driver;15	public WebDriver getDriver() {16		driver = createDriver();17		return driver;18	}19	private WebDriver createDriver() {20		DesiredCapabilities caps = new DesiredCapabilities();21		/*22		 * Local Emulator settings23		 */...

HasIOSSettings.java

Source:HasIOSSettings.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client.ios;17import io.appium.java_client.HasSettings;18import io.appium.java_client.Setting;19interface HasIOSSettings extends HasSettings {20    /**21     * Set the `nativeWebTap` setting. *iOS-only method*.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}...

HasSettings

Using AI Code Generation

1DesiredCapabilities capabilities = new DesiredCapabilities();2capabilities.setCapability("platformName", "Android");3capabilities.setCapability("deviceName", "Android Emulator");4capabilities.setCapability("appPackage", "com.android.calculator2");5capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");6capabilities.setCapability("automationName", "UiAutomator2");7capabilities.setCapability("autoGrantPermissions", "true");8capabilities.setCapability("noReset", "true");9capabilities.setCapability("fullReset", "false");10capabilities.setCapability("unicodeKeyboard", "true");11capabilities.setCapability("resetKeyboard", "true");12capabilities.setCapability("disableAndroidWatchers", "true");13capabilities.setCapability("newCommandTimeout", "3600");14capabilities.setCapability("appWaitDuration", "120000");15capabilities.setCapability("autoAcceptAlerts", "true");16capabilities.setCapability("autoDismissAlerts", "true");17capabilities.setCapability("autoWebview", "true");18capabilities.setCapability("enablePerformanceLogging", "true");19capabilities.setCapability("enableMultiWind

HasSettings

Using AI Code Generation

1import io.appium.java_client.HasSettings;2import io.appium.java_client.android.AndroidDriver;3import io.appium.java_client.remote.MobileCapabilityType;4public class Settings {5    public static void main(String[] args) throws MalformedURLException, InterruptedException {6        DesiredCapabilities dc = new DesiredCapabilities();7        dc.setCapability(MobileCapabilityType.DEVICE_NAME, "emulator-5554");8        dc.setCapability(MobileCapabilityType.APP, "C:\\Users\\Sagar\\Desktop\\ApiDemos-debug.apk");9        Thread.sleep(5000);10        HasSettings setting = (HasSettings) driver;11        setting.updateSettings(ImmutableMap.of("ignoreUnimportantViews", true));12        Thread.sleep(5000);13        driver.quit();14    }15}16from appium import webdriver17from appium.webdriver.common.touch_action import TouchAction18from selenium.common.exceptions import NoSuchElementException19from selenium.common.exceptions import WebDriverException20from selenium.webdriver.common.by import By21from selenium.webdriver.support import expected_conditions as EC22from selenium.webdriver.support.ui import WebDriverWait23from io.appium.java_client import HasSettings24class SettingsTest(unittest.TestCase):25    def setUp(self):26        desired_caps = {}27    def test_settings(self):28        setting = HasSettings(self.driver)29        setting.update_settings({"ignoreUnimportantViews": True})30        self.driver.quit()31    suite = unittest.TestLoader().loadTestsFromTestCase(SettingsTest)32    unittest.TextTestRunner(verbosity=2).run(suite)33  { caps: { platformName: 'Android',

HasSettings

Using AI Code Generation

1import java.net.MalformedURLException;2import java.net.URL;3import java.util.HashMap;4import java.util.Map;5import java.util.concurrent.TimeUnit;6import org.openqa.selenium.remote.DesiredCapabilities;7import io.appium.java_client.android.AndroidDriver;8import io.appium.java_client.remote.MobileCapabilityType;9import io.appium.java_client.remote.MobilePlatform;10public class GetSettings {11public static void main(String[] args) throws MalformedURLException {12DesiredCapabilities capabilities = new DesiredCapabilities();13capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, MobilePlatform.ANDROID);14capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");15capabilities.setCapability(MobileCapabilityType.PLATFORM_VERSION, "4.4.2");16capabilities.setCapability("appPackage", "com.android.calculator2");17capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");

HasSettings

Using AI Code Generation

1import io.appium.java_client.HasSettings;2HasSettings hasSettings = (HasSettings) driver;3hasSettings.setSetting(Setting setting, Object value);4hasSettings = Appium::Driver.new(desired_caps)5hasSettings.set_setting(setting, value)6hasSettings = Appium::WebDriver::Driver.new(desired_caps)7hasSettings.set_setting(setting, value)8import appium9hasSettings = new appium.AppiumDriver(desired_caps)10hasSettings.setSetting(setting, value)11hasSettings = new appium\AppiumDriver(desired_caps)12hasSettings->setSetting(setting, value)13using OpenQA.Selenium.Appium;14HasSettings hasSettings = new AndroidDriver(desired_caps);15hasSettings.SetSetting(setting, value);16import Appium17hasSettings = Appium.AppiumDriver(desired_caps)18hasSettings.setSetting(setting, value)19hasSettings = Appium::Driver->new(desired_caps);

HasSettings

Using AI Code Generation

1package appium;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.remote.MobileCapabilityType;7public class Settings {8	public static void main(String[] args) throws MalformedURLException {9		DesiredCapabilities cap = new DesiredCapabilities();10		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Device");11		cap.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");12		cap.setCapability(MobileCapabilityType.PLATFORM_VERSION, "7.0");13		cap.setCapability(MobileCapabilityType.UDID, "emulator-5554");14		cap.setCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT, 14);15		cap.setCapability(MobileCapabilityType.APP, "/Users/pankaj/Desktop/ApiDemos-debug.apk");

HasSettings

Using AI Code Generation

1import java.net.MalformedURLException;2import java.net.URL;3import java.util.HashMap;4import java.util.Map;5import java.util.concurrent.TimeUnit;6import org.openqa.selenium.By;7import org.openqa.selenium.WebDriver;8import org.openqa.selenium.WebElement;9import org.openqa.selenium.remote.DesiredCapabilities;10import org.openqa.selenium.remote.RemoteWebDriver;11import io.appium.java_client.AppiumDriver;12import io.appium.java_client.HasSettings;13import io.appium.java_client.MobileElement;14import io.appium.java_client.android.AndroidDriver;15import io.appium.java_client.android.AndroidElement;16import io.appium.java_client.android.AndroidKeyCode;17import io.appium.java_client.android.AndroidKeyMetastate;18import io.appium.java_client.android.AndroidTouchAction;19import io.appium.java_client.android.Connection;20import io.appium.java_client.android.HasNetworkConnection;21import io.appium.java_client.android.HasOnScreenKeyboard;22import io.appium.java_client.android.HideKeyboardStrategy;23import io.appium.java_client.android.LocksDevice;24import io.appium.java_client.android.StartsActivity;25import io.appium.java_client.android.nativekey.AndroidKey;26import io.appium.java_client.android.nativekey.KeyEvent;27import io.appium.java_client.android.nativekey.PressesKey;28import io.appium.java_client.android.nativekey.PressesKeyCode;29import io.appium.java_client.android.nativekey.PressesKeyCombo;30import io.appium.java_client.android.nativekey.AndroidKey;31import io.appium.java_client.android.nativekey.KeyEvent;32import io.appium.java_client.android.nativekey.PressesKey;33import io.appium.java_client.android.nativekey.PressesKeyCode;34import io.appium.java_client.android.nativekey.PressesKeyCombo;35import io.appium.java_client.android.nativekey.AndroidKey;36import io.appium.java_client.android.nativekey.KeyEvent;37import io.appium.java_client.android.nativekey.PressesKey;38import io.appium.java_client.android.nativekey.PressesKeyCode;39import io.appium.java_client.android.nativekey.PressesKeyCombo;40import io.appium.java_client.android.nativekey.AndroidKey;41import io.appium.java_client.android.nativekey.KeyEvent;42import io.appium.java_client.android.nativekey.PressesKey;43import io.appium

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.