This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Retrieve Device Settings
Retrieve the current settings on the device
Example Usage
Map<String, Object> settings = driver.getSettings();
self.driver.get_settings()
// webdriver.io example
let settings = driver.getSettings();
// wd example
await driver.settings();
# ruby_lib example
get_settings
# ruby_lib_core example
@driver.get_settings
@driver.settings.get
driver.Settings
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.3+ | 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 | appium.github.io |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | None | www.rubydoc.info |
| C# | None | github.com |
HTTP API Specifications
Endpoint
GET /session/:session_id/appium/settings
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
None
Response
a JSON hash of all the currently specified settings, see Settings API. (array<object>)