This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Lock
Lock the device
Example Usage
driver.lockDevice();
self.driver.lock();
// webdriver.io example
driver.lock();
// wd example
await driver.lock();
# ruby_lib example
lock
lock(5) # lock 5 seconds
# ruby_lib_core example
@driver.lock
@driver.lock(5) # lock 5 seconds
driver.Lock(); // Supported by IOSDriver & AndroidDriver
Support
Appium Server
Platform | Driver | Platform Versions | Appium Version | Driver Version |
---|---|---|---|---|
iOS | XCUITest | None | None | None |
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 | None | None | None |
Windows | Windows | 10+ | 1.6.0+ | All |
Appium Clients
Language | Support | Documentation |
---|---|---|
Java | All | appium.github.io |
Python | All | appium.github.io |
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/lock
URL Parameters
name | description |
---|---|
session_id | ID of the session to route the command to |
JSON Parameters
name | type | description |
---|---|---|
seconds | number |
How long to lock the screen (iOS only). |
Response
null