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

Appium driver for iOS using XCUITest for backend

import type { XCUITestDriver } from '../driver';
export interface VoiceOverSpeechResult {
    utterance: string | null;
}
export interface VoiceOverEnabledResult {
    enabled: boolean;
}
/**
 * Enables VoiceOver on the device under test.
 *
 * @since iOS/tvOS 27
 */
export declare function mobileEnableVoiceOver(this: XCUITestDriver): Promise<void>;
/**
 * Disables VoiceOver on the device under test.
 *
 * @since iOS/tvOS 27
 */
export declare function mobileDisableVoiceOver(this: XCUITestDriver): Promise<void>;
/**
 * Returns whether VoiceOver is currently enabled.
 *
 * @since iOS/tvOS 27
 */
export declare function mobileIsVoiceOverEnabled(this: XCUITestDriver): Promise<VoiceOverEnabledResult>;
/**
 * Moves VoiceOver focus in the given direction.
 *
 * @since iOS/tvOS 27
 * @param direction - One of `forward`, `backward`, `in` (iOS only), or `out` (iOS only).
 * @returns The utterance spoken after the move, or `null`.
 */
export declare function mobileVoiceOverMove(this: XCUITestDriver, direction: string): Promise<VoiceOverSpeechResult>;
/**
 * Returns the current VoiceOver utterance without moving focus.
 *
 * @since iOS/tvOS 27
 */
export declare function mobileVoiceOverCurrentSpeech(this: XCUITestDriver): Promise<VoiceOverSpeechResult>;
//# sourceMappingURL=voiceover.d.ts.map