How to use hideKeyboard method of io.appium.java_client.HidesKeyboard class

...247  public byte[] pullFolder(String remotePath) {248    return ((InteractsWithFiles) super.getWrappedDriver()).pullFolder(remotePath);249  }250  @Override251  public void hideKeyboard() {252    ((HidesKeyboard) super.getWrappedDriver()).hideKeyboard();253  }254  @Override255  public String getDeviceTime() {256    return ((HasDeviceTime) super.getWrappedDriver()).getDeviceTime();257  }258  @Override259  public Location location() {260    return ((LocationContext) super.getWrappedDriver()).location();261  }262  @Override263  public void setLocation(Location arg0) {264    ((LocationContext) super.getWrappedDriver()).setLocation(arg0);265  }266  @Override267  public WebElement findElementByAccessibilityId(String using) {268    return ((FindsByAccessibilityId) super.getWrappedDriver()).findElementByAccessibilityId(using);269  }270  @Override271  public List<WebElement> findElementsByAccessibilityId(String using) {272    return ((FindsByAccessibilityId) super.getWrappedDriver()).findElementsByAccessibilityId(using);273  }274  @Override275  public ScreenOrientation getOrientation() {276    return ((Rotatable) super.getWrappedDriver()).getOrientation();277  }278  @Override279  public void rotate(DeviceRotation deviceRotation) {280    ((Rotatable) super.getWrappedDriver()).rotate(deviceRotation);281  }282  @Override283  public DeviceRotation rotation() {284    return ((Rotatable) super.getWrappedDriver()).rotation();285  }286  @Override287  public void rotate(ScreenOrientation screenOrientation) {288    ((Rotatable) super.getWrappedDriver()).rotate(screenOrientation);289  }290  @Override291  public WebDriver context(String name) {292    return ((ContextAware) super.getWrappedDriver()).context(name);293  }294  @Override295  public String getContext() {296    return ((ContextAware) super.getWrappedDriver()).getContext();297  }298  @Override299  public Set<String> getContextHandles() {300    return ((ContextAware) super.getWrappedDriver()).getContextHandles();301  }302  @Override303  public Response execute(String driverCommand, Map parameters) {304    return ((MobileDriver) super.getWrappedDriver()).execute(driverCommand, parameters);305  }306  @Override307  public WebElement findElementByIosUIAutomation(String using) {308    return ((FindsByIosUIAutomation) super.getWrappedDriver()).findElementByIosUIAutomation(using);309  }310  @Override311  public List<WebElement> findElementsByIosUIAutomation(String using) {312    return ((FindsByIosUIAutomation) super.getWrappedDriver()).findElementsByIosUIAutomation(using);313  }314  @Override315  public void hideKeyboard(String keyName) {316    ((HidesKeyboardWithKeyName) super.getWrappedDriver()).hideKeyboard(keyName);317  }318  @Override319  public void hideKeyboard(String strategy, String keyName) {320    ((HidesKeyboardWithKeyName) super.getWrappedDriver()).hideKeyboard(strategy, keyName);321  }322  @Override323  public void shake() {324    ((ShakesDevice) super.getWrappedDriver()).shake();325  }326  @Override327  public WebElement findElementByAndroidUIAutomator(String using) {328    return ((FindsByAndroidUIAutomator) super.getWrappedDriver())329        .findElementByAndroidUIAutomator(using);330  }331  @Override332  public List<WebElement> findElementsByAndroidUIAutomator(String using) {333    return ((FindsByAndroidUIAutomator) super.getWrappedDriver())334        .findElementsByAndroidUIAutomator(using);...

...75        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(false);76        when(webDriverProvider.getUnwrapped(HidesKeyboard.class)).thenReturn(hidesKeyboard);77        keyboardActions.typeTextAndHide(element, TEXT);78        verify(element).sendKeys(TEXT);79        verify(hidesKeyboard).hideKeyboard();80        assertThat(logger.getLoggingEvents(), is(List.of(info("Typing text '{}' into the field", TEXT))));81    }82    @Test83    void shouldTypeTextWithoutKeyboardHidingForNotRealDevice()84    {85        init(false);86        keyboardActions.typeText(element, TEXT);87        verify(element).sendKeys(TEXT);88        verifyNoInteractions(hidesKeyboard);89    }90    @Test91    void shouldClearTextInEmptyElement()92    {93        init(false);94        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);95        enableOnScreenKeyboard(false);96        when(webDriverProvider.getUnwrapped(HidesKeyboard.class)).thenReturn(hidesKeyboard);97        keyboardActions.clearText(element);98        verify(element).clear();99        verify(hidesKeyboard).hideKeyboard();100        assertThat(logger.getLoggingEvents(), is(empty()));101    }102    @Test103    void shouldTypeTextAndHideForIOSRealDevice()104    {105        init(true);106        WebDriver context = mock(WebDriver.class);107        WebElement returnButton = mock(WebElement.class);108        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);109        enableOnScreenKeyboard(true);110        when(webDriverProvider.get()).thenReturn(context);111        when(searchActions.findElements(context, KEYBOARD_RETURN_LOCATOR)).thenReturn(List.of(returnButton));112        keyboardActions.typeTextAndHide(element, TEXT);113        verify(touchActions).tap(returnButton);114        verify(element).sendKeys(TEXT);115    }116    @Test117    void shouldTypeTextAndHideForIOSRealDeviceNoKeyboardFound()118    {119        init(true);120        WebDriver context = mock(WebDriver.class);121        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);122        enableOnScreenKeyboard(true);123        when(webDriverProvider.get()).thenReturn(context);124        when(searchActions.findElements(context, KEYBOARD_RETURN_LOCATOR)).thenReturn(List.of());125        IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,126            () -> keyboardActions.typeTextAndHide(element, TEXT));127        assertEquals("Unable to find a button to close the keyboard", exception.getMessage());128    }129    @Test130    void shouldClearTextButNotCloseKeyboardIfElementIsTypeTextView()131    {132        init(true);133        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);134        enableOnScreenKeyboard(true);135        when(element.getTagName()).thenReturn(XCUIELEMENT_TYPE_TEXT_VIEW);136        keyboardActions.clearText(element);137        verify(element).clear();138        verifyNoInteractions(hidesKeyboard);139        assertThat(logger.getLoggingEvents(), is(List.of(warn("Skip hiding keyboard for {}. Use the tap step to tap"140            + " outside the {} to hide the keyboard", XCUIELEMENT_TYPE_TEXT_VIEW))));141    }142    @Test143    void shouldClearTextAndCloseKeyboardIfElementIsTypeTextViewForSimulator()144    {145        init(false);146        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);147        enableOnScreenKeyboard(true);148        when(webDriverProvider.getUnwrapped(HidesKeyboard.class)).thenReturn(hidesKeyboard);149        when(element.getTagName()).thenReturn(XCUIELEMENT_TYPE_TEXT_VIEW);150        keyboardActions.clearText(element);151        verify(element).clear();152        verify(hidesKeyboard).hideKeyboard();153    }154    @Test155    void shouldTryHideKeyboardIfElementToTypeTextBecamesStale()156    {157        init(true);158        WebDriver context = mock(WebDriver.class);159        WebElement returnButton = mock(WebElement.class);160        when(genericWebDriverManager.isIOSNativeApp()).thenReturn(true);161        enableOnScreenKeyboard(true);162        when(element.getTagName()).thenThrow(new StaleElementReferenceException("Stale"));163        when(webDriverProvider.get()).thenReturn(context);164        when(searchActions.findElements(context, KEYBOARD_RETURN_LOCATOR)).thenReturn(List.of(returnButton));165        keyboardActions.typeTextAndHide(element, TEXT);166        verify(touchActions).tap(returnButton);...

...60     */61    public void typeTextAndHide(WebElement element, String text)62    {63        typeText(element, text);64        hideKeyboard(element);65    }66    /**67     * Type <b>text</b> into the <b>element</b>68     * @param element element to type text, must not be {@code null}69     * @param text text to type into the element, must not be {@code null}70     */71    public void typeText(WebElement element, String text)72    {73        LOGGER.atInfo().addArgument(text).log("Typing text '{}' into the field");74        element.sendKeys(text);75    }76    /**77     * Clear the <b>element</b>'s text78     * <br>79     * The atomic actions performed are:80     * <ol>81     * <li>clear the element's text</li>82     * <li>hide keyboard</li>83     * </ol>84     * @param element element to clear, must not be {@code null}85     */86    public void clearText(WebElement element)87    {88        element.clear();89        hideKeyboard(element);90    }91    private void hideKeyboard(WebElement webElement)92    {93        // 1. https://github.com/appium/WebDriverAgent/blob/master/WebDriverAgentLib/Commands/FBCustomCommands.m#L10794        // 2. The keyboard is not shown in some cases: e.g. when trying to clear an empty field. So we need to check95        // whether the keyboard is shown at first96        if (genericWebDriverManager.isIOSNativeApp() && webDriverProvider.getUnwrapped(HasOnScreenKeyboard.class)97                .isKeyboardShown())98        {99            String tagName = getTagNameSafely(webElement);100            /*101             * Tap on 'Return' doesn't close the keyboard for XCUIElementTypeTextView element, the only way to102             * close the keyboard is to tap on any element outside the text view.103             */104            if (!"XCUIElementTypeTextView".equals(tagName))105            {106                /*107                 * Handle closing the keyboard as it's done in WDA108                 * https://github.com/appium/WebDriverAgent/pull/453/files109                 */110                Locator dismissKeyboardButtonLocator = new Locator(AppiumLocatorType.XPATH,111                        new SearchParameters("(//XCUIElementTypeKeyboard//XCUIElementTypeButton)[last()]",112                                Visibility.VISIBLE, false));113                List<WebElement> buttons = searchActions.findElements(webDriverProvider.get(),114                        dismissKeyboardButtonLocator);115                isTrue(!buttons.isEmpty(), "Unable to find a button to close the keyboard");116                touchActions.tap(buttons.get(0));117                return;118            }119            else if (realDevice)120            {121                LOGGER.atWarn().addArgument(tagName).log("Skip hiding keyboard for {}. Use the tap step to tap"122                        + " outside the {} to hide the keyboard");123                return;124            }125        }126        webDriverProvider.getUnwrapped(HidesKeyboard.class).hideKeyboard();127    }128    private static String getTagNameSafely(WebElement webElement)129    {130        try131        {132            return webElement.getTagName();133        }134        catch (StaleElementReferenceException exception)135        {136            // Swallow exception quietly137            return null;138        }139    }140}...

...74		}75	}76	public void addTargetingParameter(WebElement paramKey, WebElement paramValue, String key, String value)77			throws InterruptedException {78		((HidesKeyboard) driver).hideKeyboard();79		paramKey.sendKeys(key);80		((HidesKeyboard) driver).hideKeyboard();81		paramValue.sendKeys(value);82		((HidesKeyboard) driver).hideKeyboard();83	}84	public void waitForElement(WebElement ele, int timeOutInSeconds) {85		WebDriverWait wait = new WebDriverWait(driver, timeOutInSeconds);86		wait.until(ExpectedConditions.visibilityOf(ele));87	}88}...

...10public class MobileKeyboard extends Keyboard {11    public static boolean isKeyboardShown() {12        return executeDriverMethod(HasOnScreenKeyboard.class, HasOnScreenKeyboard::isKeyboardShown);13    }14    public static void hideKeyboard() {15        executeDriverMethod(HidesKeyboard.class, HidesKeyboard::hideKeyboard);16    }17    // next two methods are for IosDriver only18    public static void hideKeyboard(String keyName) {19        executeDriverMethod(HidesKeyboardWithKeyName.class,20                (HidesKeyboardWithKeyName driver) -> driver.hideKeyboard(keyName));21    }22    public static void hideKeyboard(String strategy, String keyName) {23        executeDriverMethod(HidesKeyboardWithKeyName.class,24                (HidesKeyboardWithKeyName driver) -> driver.hideKeyboard(strategy, keyName));25    }26    // next two methods are for AndroidDriver only27    public static void pressKey(AndroidKey key) {28        KeyEvent keyEvent = new KeyEvent(key);29        executeDriverMethod(PressesKey.class,30                (PressesKey driver) -> driver.pressKey(keyEvent));31    }32    public static void longPressKey(AndroidKey key) {33        KeyEvent keyEvent = new KeyEvent(key);34        executeDriverMethod(PressesKey.class,35                (PressesKey driver) -> driver.longPressKey(keyEvent));36    }37}...

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package io.appium.java_client;17import static io.appium.java_client.MobileCommand.hideKeyboardCommand;18public interface HidesKeyboardWithKeyName extends HidesKeyboard {19    /**20     * Hides the keyboard by pressing the button specified by keyName if it is21     * showing.22     *23     * @param keyName The button pressed by the mobile driver to attempt hiding the24     *                keyboard.25     */26    default void hideKeyboard(String keyName) {27        CommandExecutionHelper.execute(this, hideKeyboardCommand(keyName));28    }29    /**30     * Hides the keyboard if it is showing. Hiding the keyboard often31     * depends on the way an app is implemented, no single strategy always32     * works.33     *34     * @param strategy HideKeyboardStrategy.35     * @param keyName  a String, representing the text displayed on the button of the36     *                 keyboard you want to press. For example: "Done".37     */38    default void hideKeyboard(String strategy, String keyName) {39        CommandExecutionHelper.execute(this, hideKeyboardCommand(strategy, keyName));40    }41}...

...26    /**27     * Hides the keyboard if it is showing.28     * On iOS, there are multiple strategies for hiding the keyboard.29     * Defaults to the "tapOutside" strategy (taps outside the keyboard).30     * Switch to using hideKeyboard(HideKeyboardStrategy.PRESS_KEY, "Done") if this doesn't work.31     */32    default void hideKeyboard() {33        execute(HIDE_KEYBOARD);34    }35    /*36        Gets device date and time for both iOS(Supports only real device) and Android devices37     */38    default String getDeviceTime() {39        Response response = execute(GET_DEVICE_TIME);40        return response.getValue().toString();41    }42}...

...18public interface HidesKeyboard extends ExecutesMethod {19    /**20     * Hides the keyboard if it is showing.21     */22    default void hideKeyboard() {23        execute(HIDE_KEYBOARD);24    }25}...

1import org.openqa.selenium.By;2import org.openqa.selenium.WebDriver;3import org.openqa.selenium.WebElement;4import org.openqa.selenium.remote.DesiredCapabilities;5import org.openqa.selenium.support.ui.ExpectedConditions;6import org.openqa.selenium.support.ui.WebDriverWait;7import org.testng.annotations.AfterTest;8import org.testng.annotations.BeforeTest;9import org.testng.annotations.Test;10import io.appium.java_client.MobileElement;11import io.appium.java_client.android.AndroidDriver;12import io.appium.java_client.android.AndroidKeyCode;13import io.appium.java_client.remote.MobileCapabilityType;14public class Keyboard {15	WebDriver driver;16	public void setUp() throws Exception{17		DesiredCapabilities capabilities = new DesiredCapabilities();18		capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android");19		capabilities.setCapability("platformName", "Android");20		capabilities.setCapability("platformVersion", "4.4.4");21		capabilities.setCapability("appPackage", "com.android.calculator2");22		capabilities.setCapability("appActivity", "com.android.calculator2.Calculator");23		driver = new AndroidDriver<WebElement>(capabilities);24	}25	public void test(){26		driver.findElement(By.id("com.android.calculator2:id/digit_5")).click();27		driver.findElement(By.id("com.android.calculator2:id/digit_7")).click();28		driver.findElement(By.id("com.android.calculator2:id/digit_9")).click();29		driver.findElement(By.id("com.android.calculator2:id/digit_0")).click();30		driver.findElement(By.id("com.android.calculator2:id/digit_5")).click();31		driver.findElement(By.id("com.android.calculator2:id/digit_7")).click();32		driver.findElement(By.id("com.android.calculator2:id/digit_9")).click();33		driver.findElement(By.id("com.android.calculator2:id/digit_0")).click();34		driver.findElement(By.id("com.android.calculator2:id/digit_5")).click();35		driver.findElement(By.id

1package appium;2import java.net.MalformedURLException;3import java.net.URL;4import org.openqa.selenium.By;5import org.openqa.selenium.WebDriver;6import org.openqa.selenium.WebElement;7import org.openqa.selenium.remote.DesiredCapabilities;8import org.openqa.selenium.support.ui.ExpectedConditions;9import org.openqa.selenium.support.ui.WebDriverWait;10import io.appium.java_client.AppiumDriver;11import io.appium.java_client.HidesKeyboard;12import io.appium.java_client.android.AndroidDriver;13import io.appium.java_client.android.AndroidKeyCode;14public class AppiumTest {15	public static void main(String[] args) throws MalformedURLException, InterruptedException {16		DesiredCapabilities capabilities = new DesiredCapabilities();17		capabilities.setCapability("deviceName", "Nexus 5");18		capabilities.setCapability("platformName", "Android");19		capabilities.setCapability("platformVersion", "6.0.1");20		capabilities.setCapability("appPackage", "com.android.contacts");21		capabilities.setCapability("appActivity", "com.android.contacts.activities.PeopleActivity");

1HidesKeyboard hidesKeyboard = (HidesKeyboard) driver;2hidesKeyboard.hideKeyboard();3AndroidDriver androidDriver = (AndroidDriver) driver;4androidDriver.hideKeyboard();5IOSDriver iosDriver = (IOSDriver) driver;6iosDriver.hideKeyboard();7MobileDriver mobileDriver = (MobileDriver) driver;8mobileDriver.hideKeyboard();9AppiumDriver appiumDriver = (AppiumDriver) driver;10appiumDriver.hideKeyboard();11AppiumCommandExecutor appiumCommandExecutor = (AppiumCommandExecutor) driver.getCommandExecutor();12appiumCommandExecutor.hideKeyboard();13AppiumResponse appiumResponse = (AppiumResponse) driver.executeScript("mobile: hideKeyboard");14appiumResponse.hideKeyboard();15AppiumCommand appiumCommand = (AppiumCommand) driver.executeScript("mobile: hideKeyboard");16appiumCommand.hideKeyboard();17RemoteWebDriver remoteWebDriver = (RemoteWebDriver) driver;18remoteWebDriver.hideKeyboard();19RemoteWebElement remoteWebElement = (RemoteWebElement) driver.findElement(By.id("id"));20remoteWebElement.hideKeyboard();21RemoteExecuteMethod remoteExecuteMethod = (RemoteExecuteMethod) driver;22remoteExecuteMethod.hideKeyboard();23RemoteTouchScreen remoteTouchScreen = (RemoteTouchScreen) driver.getTouch();24remoteTouchScreen.hideKeyboard();25RemoteKeyboard remoteKeyboard = (RemoteKeyboard) driver.getKeyboard();26remoteKeyboard.hideKeyboard();

1driver.hideKeyboard();2driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done");3driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done", "Done");4driver.hideKeyboard();5driver.hideKeyboard("Done");6driver.hideKeyboard("Done", "Done");7driver.hideKeyboard();8driver.hideKeyboard("Done");9driver.hideKeyboard("Done", "Done");10driver.hideKeyboard();11driver.hideKeyboard("Done");12driver.hideKeyboard("Done", "Done");13driver.hideKeyboard();14driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done");15driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done", "Done");16driver.hideKeyboard();17driver.hideKeyboard("Done");18driver.hideKeyboard("Done", "Done");19driver.hideKeyboard();20driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done");21driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done", "Done");22driver.hideKeyboard();23driver.hideKeyboard("Done");24driver.hideKeyboard("Done", "Done");25driver.hideKeyboard();26driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done");27driver.hideKeyboard(HidesKeyboardStrategy.PRESS_KEY, "Done", "Done");28driver.hideKeyboard();29driver.hideKeyboard("Done");30driver.hideKeyboard("Done", "Done");

1AppiumDriver driver = new AndroidDriver();2HidesKeyboard keyboard = (HidesKeyboard) driver;3keyboard.hideKeyboard();4var driver = new AndroidDriver();5var keyboard = new HidesKeyboard(driver);6keyboard.hideKeyboard();7driver = AndroidDriver()8keyboard = HidesKeyboard(driver)9keyboard.hideKeyboard()10driver = AndroidDriver()11keyboard = HidesKeyboard(driver)12keyboard.hideKeyboard()13$driver = new AndroidDriver();14$keyboard = new HidesKeyboard($driver);15$keyboard->hideKeyboard();16driver = AndroidDriver()17keyboard = HidesKeyboard(driver)18keyboard.hideKeyboard()19AppiumDriver driver = new AndroidDriver();20HidesKeyboard keyboard = (HidesKeyboard) driver;21keyboard.hideKeyboard();

1import io.appium.java_client.AppiumDriver;2import io.appium.java_client.android.AndroidDriver;3import io.appium.java_client.android.AndroidKeyCode;4import io.appium.java_client.ios.IOSDriver;5import io.appium.java_client.ios.IOSElement;6import io.appium.java_client.remote.MobileCapabilityType;7import io.appium.java_client.service.local.AppiumDriverLocalService;8import io.appium.java_client.service.local.AppiumServiceBuilder;9import io.appium.java_client.service.local.flags.GeneralServerFlag;10import java.io.File;11import java.io.IOException;12import java.net.MalformedURLException;13import java.net.URL;14import java.util.concurrent.TimeUnit;15import org.openqa.selenium.By;16import org.openqa.selenium.Keys;17import org.openqa.selenium.Platform;18import org.openqa.selenium.WebDriver;19import org.openqa.selenium.WebElement;20import org.openqa.selenium.remote.DesiredCapabilities;21import org.testng.annotations.AfterMethod;22import org.testng.annotations.BeforeMethod;23import org.testng.annotations.Test;24public class AppiumTest {25	AppiumDriver<WebElement> driver;26	AppiumDriverLocalService service;27	public void setUp() throws IOException28	{29		service = AppiumDriverLocalService.buildService(new AppiumServiceBuilder()30		.usingDriverExecutable(new File("C:\\Program Files (x86)\\Appium\\node.exe"))31		.withAppiumJS(new File("C:\\Program Files (x86)\\Appium\\node_modules\\appium\\bin\\appium.js"))32		.withLogFile(new File("C:\\Users\\Srinivas\\Desktop\\Appium\\AppiumLogs\\logs.txt")));33		service.start();34		DesiredCapabilities cap = new DesiredCapabilities();35		cap.setCapability(MobileCapabilityType.PLATFORM_NAME, Platform.ANDROID);36		cap.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");37		cap.setCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT, "100");38		cap.setCapability(MobileCapabilityType.BROWSER_NAME, "Chrome");

1package appium;2import io.appium.java_client.ios.IOSDriver;3import io.appium.java_client.remote.MobileCapabilityType;4import io.appium.java_client.service.local.AppiumDriverLocalService;5import org.openqa.selenium.remote.DesiredCapabilities;6import java.net.MalformedURLException;7import java.net.URL;8public class HideKeyboard {9    public static void main(String[] args) throws MalformedURLException, InterruptedException {10        AppiumDriverLocalService service = AppiumDriverLocalService.buildDefaultService();11        service.start();12        DesiredCapabilities capabilities = new DesiredCapabilities();13        capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "iPhone 6");14        capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, "iOS");15        capabilities.setCapability(MobileCapabilityType.PLATFORM_VERSION, "10.2");16        capabilities.setCapability(MobileCapabilityType.APP, "/Users/username/Desktop/Calculator.app");