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

  Edit this Doc Press Key Code

Press a particular key on an Android Device

Example Usage

driver.pressKeyCode(AndroidKeyCode.SPACE, AndroidKeyMetastate.META_SHIFT_ON);


self.driver.press_keycode(10);


// webdriver.io example
driver.pressKeyCode(10);

// wd example
await driver.pressKeycode(10);


# ruby_lib example
press_keycode(10)

# ruby_lib_core example
@driver.press_keycode(10)


driver.PressKeyCode(WindowsKeyCode.Windows);

Description

See https://developer.android.com/reference/android/view/KeyEvent.html for reference of available Android key code values

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
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/press_keycode

URL Parameters

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

JSON Parameters

name type description
keycode number Key code pressed on the device. See Key Event.
metastate number Metastate for the keypress. See Key Event.
flags number Flags for the keypress. See Key Event.

Response

null

See Also