Unlock

Unlock the device

Example Usage

// Java
driver.lockDevice();
driver.unlockDevice();

# Python
self.driver.lock();
self.driver.unlock();

// Javascript
// webdriver.io example
driver.lock()
  .unlock();



[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
// wd example
await driver.lock();
await driver.unlock();

# Ruby
# ruby_lib example
unlock


[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/interactions/unlock.yml)
# ruby_lib_core example
@driver.unlock

# PHP
// TODO PHP sample

// C#
// TODO C# sample

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.2+ 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
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
PHP All github.com
C# All github.com

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/device/unlock

URL Parameters

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

JSON Parameters

None

Response

null

See Also