---
name: Is Keyboard Shown
short_description: Whether or not the soft keyboard is shown

example_usage:
  java:
    |
      boolean isKeyboardShown = driver.isKeyboardShown();
  ruby:
    |
      @driver.is_keyboard_shown

client_docs:
  java: "http://appium.github.io/java-client/io/appium/java_client/android/HasDeviceDetails.html#isKeyboardShown--"
  ruby: "http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Device#is_keyboard_shown-instance_method"

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

# Information about the HTTP endpoints
endpoint:
  url: /wd/hub/session/:session_id/appium/device/is_keyboard_shown
  method: 'GET'
  url_parameters:
    - name: session_id
      description: ID of the session to route the command to
  response:
    - type: boolean
      description: True if the keyboard is shown.

# 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#L384