How to handle native android keyboard using appium

Hello ,
I am working on app in which i need click on Done button of native android keyboard. But i am unable to click on that

Scenario would be like::

  1. Launch application
  2. click on search bar
  3. Type some text
  4. click on done button of native android keyboard.

Any help in this?

Currently there is one way to do so is sending the key event of the “Enter” key.
You cant get the android keys as element because UI Automator does not detects the buttons of the keyboard.

One Work Around to do exactly what you mentioned is presize tap on the “Done” button, but it won’t be generic.(Avoid it)
Using the key event is the best and recommended way.

Can you check whether button can be pressed using adb command manually?

adb -s input keyevent 84

if that command performs action then appium should work. otherwise issue is something else

Priyank Shah

How can we use the keyevent to type search button. Can you please provide the java appium code

Please help me to enter search button after entering text in a search box of an android application.

Sorry for the late response(turned of the notification for this post by mistake)
Here’s the snippet i’m using

String command = "adb shell input text \""+newData+"\"";
Process result = Runtime.getRuntime().exec(command);

You can mix and mach these commands whatever fulfills your requirements.

@Priyank_Shah I don’t use the integer values i.e. 84 you used. I always pass the string constant android site provided.

adb -s input keyevent KEYCODE_SEARCH

and the key event for the buttons other than the characters don’t work always.
I prefer

1 Like

@pr4bh4sh, why not using dirver.keyevent(84) for KEYCODE_SEARCH. I think it’s very simple way.
WRT “Done” or “OK” key, I don’t see any android keyevents for it link
which really amazes me

Indeed that’s the simplest way.( What i suggested were workaround as the author of this post was looking for the possible way to actually tap on the key, which is not possible for android)

Yes there aren’t any Key code for “Done”, to achieve this i usually send enter’s key code

Thanks for pointing it out.(Updated the answer.)

you mean this one:

public static final int KEYCODE_ENTER

Key code constant: Enter key. Value: 66 (0x00000042)

Is it equal to “Done”/“OK” keys on software keyboard?

No there aren’t any specific key code for Done/OK/Next key. For simulating those we need to send the metastate along with the keycode of “Enter” key.

driver.sendKeyEvent(key, metastate);

For sending the Next/Done key metastate code is 16.

If that not working we can send the KEYCODE_DPAD_DOWN (for Next).
And these are just workaround if the thing are not working as expected.


@pr4bh4sh, I got it. Thanks!

Could you please share your code that works? I am facing the same problem. Thanks!

Sorry @Olivia_Ong for so late answer. If it still hasn’t solved, could you please explain what actual problem did encounter with key codes?

Any help would be appropriated

I need to click or tap on Go/Done button on android s3 device which running 4.3 version

I tried all sorts of option

  1. driver.pressKeyEvent(66) or driver.pressKeyEvent(AndroidKeyCode.ENTER)
  2. Driver.sendKeyEvent(66)
  3. driver.execute(“mobile:keyevent”, “keycode:66”);

I manage to click on all keys except Go/Done button

Appium version - 1.4.13
Java 1.7 appium
Maven - 3.2.0

Can you try sending the key event via adb??

For the Next/Go/Done combination, I use
adb shell input keyevent ‘KEYCODE_TAB’

Hope this helps

1 Like

Thanks Guys for your reply

I tried on my app it does’t work

But, I tried with other apps which are installed on my device

I used command “adb shell input keyevent KEYCODE_ENTER”… It worked

So problem might to with in my app, may be some key event listners are not implemented i think,

@rakesh Are you using below capability ?
capabilities.setCapability("unicodeKeyboard", true);
If not can you try with this capability.

1 Like


capabilities.setCapability(“unicodeKeyboard”, true) did’t worked for me

I asked my developer to add a lister called “OnKeyListener”

finally worked…

refer to this Unable to tap 'search' button on Android softKeyboard
@praveentp009 explained in detail

thanks @praveen

hello rakesh,
please send me your test script