This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Update Device Settings

Update the current setting on the device

Example Usage

driver.setSetting(Setting.WAIT_FOR_IDLE_TIMEOUT, 5000);

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

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

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

# ruby_lib example
update_settings({'nativeWebTap' => true, 'allowInvisibleElements' => true})

# ruby_lib_core example
@driver.update_settings({'nativeWebTap' => true, 'allowInvisibleElements' => true})
@driver.settings.update({'nativeWebTap' => true, 'allowInvisibleElements' => true})
@driver.settings = {'nativeWebTap' => true, 'allowInvisibleElements' => true}

driver.Settings = new Dictionary<string, object>() {
    [AutomatorSetting.KeyInjectionDelay] = 1500,
    ["nativeWebTap"] = true


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
Python All
Javascript (WebdriverIO) All
Javascript (WD) All
Ruby All
C# All

HTTP API Specifications


POST /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.



See Also