Edit this Doc Press Key Code

Press a particular key on an Android Device

Example Usage

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


// webdriver.io example

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

# ruby_lib example

# ruby_lib_core example

// TODO C# sample

// TODO PHP sample


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


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

HTTP API Specifications


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.



See Also