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

  Edit this Doc Toggle Data

Switch the state of data service

Example Usage

driver.toggleData();

# Not supported
// webdriver.io example
driver.toggleData();

// wd example
await driver.toggleData();

# ruby_lib example
toggle_data

# ruby_lib_core example
@driver.toggle_data

// TODO

Description

Switch the state of data service.

(For Android) This API does not work for Android API level 21+ because it requires system or carrier privileged permission, and Android <= 21 does not support granting permissions.

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

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

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/device/toggle_data

URL Parameters

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

JSON Parameters

None

Response

null

See Also