This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Is Device Locked
Check whether the device is locked or not
Example Usage
boolean isLocked = driver.isDeviceLocked();
self.driver.is_locked()
// webdriver.io example
driver.isLocked();
// wd example
let isLocked = await driver.isLocked();
# ruby_lib example
device_locked?
# ruby_lib_core example
@driver.device_locked?
bool isLocked = driver.IsLocked(); // Supported by IOSDriver & AndroidDriver
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 | 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/is_locked
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
None
Response
True if the device is locked, false if not (boolean)