This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.
Edit this Doc Is Keyboard Shown
Whether or not the soft keyboard is shown
Example Usage
boolean isKeyboardShown = driver.isKeyboardShown();
driver.is_keyboard_shown()
// webdriver.io example
driver.isKeyboardShown();
// wd example
await driver.isKeyboardShown();
# ruby_lib example
is_keyboard_shown
# ruby_lib_core example
@driver.is_keyboard_shown
// Not supported
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.6.0+ | All |
| 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) | None | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| C# | None |
HTTP API Specifications
Endpoint
GET /session/:session_id/appium/device/is_keyboard_shown
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
JSON Parameters
None
Response
True if the keyboard is shown. (boolean)