Press Key Code

Press a particular key on the device

Example Usage

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

self.driver.press_keycode(10);

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



// Not supported
@driver.press_keycode(10)

// TODO C# sample

// TODO PHP sample

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.2+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python All github.com
Javascript (WebdriverIO) All webdriver.io
Javascript (WD) All
Ruby All www.rubydoc.info
PHP All github.com
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

Response

null

See Also