Is Keyboard Shown

Whether or not the soft keyboard is shown

Example Usage

boolean isKeyboardShown = driver.isKeyboardShown();

# Not supported
// Not supported


// wd example
await driver.isKeyboardShown();

@driver.is_keyboard_shown

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

HTTP API Specifications

Endpoint

GET /wd/hub/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)

See Also