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

Appium driver for iOS using XCUITest for backend

import type { XCUITestDriver } from '../driver';
import type { BiometricFeature } from './types';
/**
 * Enrolls biometric authentication on a simulated device.
 *
 * @param isEnabled - Whether to enable/disable biometric enrollment.
 * @throws If enrollment fails or the device is not a Simulator.
 * @group Simulator Only
 */
export declare function mobileEnrollBiometric(this: XCUITestDriver, isEnabled?: boolean): Promise<void>;
/**
 * Emulates biometric match or non-match event on a simulated device.
 *
 * The biometric feature is expected to be already enrolled via {@linkcode mobileEnrollBiometric|mobile: enrollBiometric} before executing this.
 *
 * @param type - The biometric feature name.
 * @param match - If `true`, simulate biometric match. If `false`, simulate biometric non-match.
 * @throws If matching fails or the device is not a Simulator.
 * @group Simulator Only
 */
export declare function mobileSendBiometricMatch(this: XCUITestDriver, type?: BiometricFeature, match?: boolean): Promise<void>;
/**
 * Checks whether the biometric feature is currently enrolled on a simulated device.
 *
 * @returns `true` if biometric is enrolled.
 * @throws If the detection fails or the device is not a Simulator.
 * @group Simulator Only
 */
export declare function mobileIsBiometricEnrolled(this: XCUITestDriver): Promise<boolean>;
//# sourceMappingURL=biometric.d.ts.map