@christian-bromann/webdriverio/lib/protocol/hideDeviceKeyboard.js

A nodejs bindings implementation for selenium 2.0/webdriver

/**
 *
 * Hide the keyboard.
 *
 * <example>
    :hideKeyboardDefaultSync.js
    browser.hideDeviceKeyboard() // taps outside to hide keyboard

    :hideKeyboardWithTapSync.js
    browser.hideDeviceKeyboard('tapOutside')

    :hideKeyboardDoneSync.js
    browser.hideDeviceKeyboard('pressKey', 'Done')
 * </example>
 *
 * @param {String} strategy  desired strategy to close keyboard ('tapOutside' or 'pressKey')
 *
 * @see  https://github.com/appium/appium/blob/master/docs/en/appium-bindings.md#hide-keyboard-ios-only
 * @type mobile
 * @for ios, android
 *
 */

let hideDeviceKeyboard = function (strategy = 'tapOutside', key) {
    let args = { strategy }

    if (key) {
        args.key = key
    }

    return this.requestHandler.create({
        path: '/session/:sessionId/appium/device/hide_keyboard',
        method: 'POST'
    }, args)
}

export default hideDeviceKeyboard