io.appium.java_client

Interface HidesKeyboardWithKeyName

All Superinterfaces:

CanRememberExtensionPresence, ExecutesMethod, HidesKeyboard

All Known Implementing Classes:

IOSDriver

public interface HidesKeyboardWithKeyName
extends HidesKeyboard

Method Summary

Modifier and Type	Method and Description
default void	hideKeyboard(java.lang.String keyName) Hides the keyboard by pressing the button specified by keyName if it is showing.
default void	hideKeyboard(java.lang.String strategy, java.lang.String keyName) Deprecated. This API is deprecated and will be removed in the future.

Methods inherited from interface io.appium.java_client.HidesKeyboard

hideKeyboard

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

Methods inherited from interface io.appium.java_client.CanRememberExtensionPresence

assertExtensionExists, markExtensionAbsence

Method Detail

hideKeyboard

default void hideKeyboard(java.lang.String keyName)

Hides the keyboard by pressing the button specified by keyName if it is showing. If the on-screen keyboard does not have any dedicated button that hides it then an error is going to be thrown. In such case you must emulate same actions an app user would do to hide the keyboard. See the documentation for 'mobile: hideKeyboard' extension for more details.

Parameters:

keyName - The button pressed by the mobile driver to attempt hiding the keyboard.

hideKeyboard

@Deprecated
default void hideKeyboard(java.lang.String strategy,
                                      java.lang.String keyName)

Deprecated. This API is deprecated and will be removed in the future.

Hides the keyboard if it is showing. Hiding the keyboard often depends on the way an app is implemented, no single strategy always works.

Parameters:

strategy - HideKeyboardStrategy.

keyName - a String, representing the text displayed on the button of the keyboard you want to press. For example: "Done".