appium-xcuitest-driver/build/lib/commands/keyboard.d.ts

Appium driver for iOS using XCUITest for backend

import type { XCUITestDriver } from '../driver';
import type { KeyboardKey } from './types';
/**
 * Hides the keyboard.
 *
 * @deprecated
 */
export declare function hideKeyboard(this: XCUITestDriver, strategy?: string, ...possibleKeys: string[]): Promise<boolean>;
/**
 * Hides the keyboard using the specified key names.
 *
 * @param keys - Array of key names to use for dismissing the keyboard
 */
export declare function mobileHideKeyboard(this: XCUITestDriver, keys?: string[]): Promise<void>;
/**
 * Checks whether the keyboard is currently shown.
 *
 * @returns `true` if the keyboard is shown, `false` otherwise
 */
export declare function isKeyboardShown(this: XCUITestDriver): Promise<boolean>;
/**
 * Send keys to the given element or to the application under test.
 * This API is not supported on tvOS
 *
 * @since Xcode 15/iOS 17
 * @param keys - Array of keys to type.
 * Each item could either be a string, that represents a key itself (see
 * https://developer.apple.com/documentation/xctest/xcuielement/1500604-typekey?language=objc
 * and https://developer.apple.com/documentation/xctest/xcuikeyboardkey?language=objc)
 * or a dictionary, if the key should also be entered with modifiers.
 * @param elementId - UUID of the element to send keys to.
 * If the element is not provided then the keys will be sent to the current application.
 */
export declare function mobileKeys(this: XCUITestDriver, keys: (KeyboardKey | string)[], elementId?: string | null): Promise<void>;
//# sourceMappingURL=keyboard.d.ts.map