This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Hide Keyboard

Hide soft keyboard

Example Usage

driver.hideKeyboard();


self.driver.hide_keyboard()


// webdriver.io example
driver.hideKeyboard();

// wd example
await driver.hideDeviceKeyboard();


# ruby_lib example
hide_keyboard

# ruby_lib_core example
@driver.hide_keyboard


driver.HideKeyboard();

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

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/device/hide_keyboard

URL Parameters

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

JSON Parameters

name type description
strategy string Hide keyboard strategy (optional, UIAutomation only). Available strategies - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'.
key string Key (optional)
keyCode string Key code (optional)
keyName string Key name (optional)

Response

null

See Also