---
name: Is Device Locked
short_description: Check whether the device is locked or not
  
example_usage:
  java:
    |
      boolean isLocked = driver.isLocked();
  javascript_wd:
    |
      let isLocked = await driver.isLocked();

  javascript_wdio:
    |
      driver.isLocked();
  ruby:
    |
      @driver.device_locked?
  php:
    |
      // TODO PHP sample
  csharp:
    |
      // TODO C# sample

client_docs:
  java: "http://appium.github.io/java-client/io/appium/java_client/android/LocksAndroidDevice.html#isLocked--"
  javascript_wdio: "http://webdriver.io/api/mobile/isLocked.html"
  javascript_wd: "https://github.com/admc/wd/blob/master/lib/commands.js#L2407"
  ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#device_locked%3F-instance_method"
  php: "https://github.com/appium/php-client/" # TODO PHP documentation link
  csharp: "https://github.com/appium/appium-dotnet-driver/" # TODO Dotnet documentation link

# Driver support by platform
driver_support:
  ios:
    xcuitest: false
    uiautomation: false
  android:
    uiautomator2: true
    uiautomator: true
  mac:
    mac: false # TODO Confirm this that mouse movements
  windows:
    windows: true # TODO Confirm this
client_support:
  java: true
  python: true
  ruby: true
  php: true
  csharp: true
  javascript_wd: true
  javascript_wdio: true
  

# Information about the HTTP endpoints
endpoint:
  url: /session/:session_id/appium/device/is_locked
  method: POST
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  response:
    - type: boolean
      description: True if the device is locked, false if not

# Links to specifications. Should link to at least one specification
specifications:
  jsonwp: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L313