Edit this Doc Update Device Settings

Update the current setting on the device

Example Usage

driver.setSetting(Setting.WAIT_FOR_IDLE_TIMEOUT, Duration.ofSeconds(5));

self.driver.update_settings({"sample": "value"}))

// webdriver.io example
driver.settings({nativeWebTap: true});

// wd example
await driver.updateSettings({nativeWebTap: true});

# ruby_lib example
update_settings(sample: 'value')

# ruby_lib_core example
@driver.update_settings(sample: 'value')

// Not supported
// Not supported

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation 8.0 to 9.3 All All
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.2+ All All
Mac Mac ?+ 1.6.4+ All
Windows Windows 10+ 1.6.0+ All

Appium Clients

Language Support Documentation
Java All appium.github.io
Python None github.com
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby None www.rubydoc.info
PHP None
C# None

HTTP API Specifications

Endpoint

POST /wd/hub/session/:session_id/appium/settings

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
settings array<object> a JSON hash of settings to update, see Settings API.

Response

null

See Also