appium-android-driver/build/lib/commands/ime.d.ts

Android UiAutomator and Chrome support for Appium

import type { AndroidDriver } from '../driver';
/**
 * Checks if an IME (Input Method Editor) is activated.
 *
 * @returns Promise that resolves to `true` (IME is always activated on Android devices).
 */
export declare function isIMEActivated(this: AndroidDriver): Promise<boolean>;
/**
 * Gets the list of available IME engines.
 *
 * @returns Promise that resolves to an array of IME engine identifiers.
 */
export declare function availableIMEEngines(this: AndroidDriver): Promise<string[]>;
/**
 * Gets the currently active IME engine.
 *
 * @returns Promise that resolves to the active IME engine identifier.
 */
export declare function getActiveIMEEngine(this: AndroidDriver): Promise<string>;
/**
 * Activates an IME engine.
 *
 * @param imeId The IME engine identifier to activate.
 * @returns Promise that resolves when the IME is activated.
 * @throws {errors.IMENotAvailableError} If the IME is not available.
 */
export declare function activateIMEEngine(this: AndroidDriver, imeId: string): Promise<void>;
/**
 * Deactivates the currently active IME engine.
 *
 * @returns Promise that resolves when the IME is deactivated.
 */
export declare function deactivateIMEEngine(this: AndroidDriver): Promise<void>;
/**
 * Enables or disables stylus handwriting input method.
 * The default value depends on the device.
 * It requires set_stylus_handwriting secure setting to be supported by the device
 * because some environments (e.g. cloud vendors) might not allow to change this setting.
 * @param enabled Whether to enable or disable stylus handwriting input method.
 */
export declare function setStylusHandwriting(this: AndroidDriver, enabled: boolean): Promise<void>;
//# sourceMappingURL=ime.d.ts.map