toggleEnrollTouchId

Toggle Touch ID enrollment on iOS Simulator.

note

This command requires the allowTouchIdEnroll capability to be set to true in the session. It is only supported on iOS Simulator. When enabled is not provided, it defaults to true.

Usage

await browser.toggleEnrollTouchId(enabled)

Parameters

Name	Type	Details
enabled optional	boolean	Whether to enable (true) or disable (false) Touch ID enrollment. Defaults to true.

Example

toggleEnrollTouchId.js

it('should toggle Touch ID enrollment', async () => {
    // Enable Touch ID enrollment
    await browser.toggleEnrollTouchId(true)
    // Disable Touch ID enrollment
    await browser.toggleEnrollTouchId(false)
})

Support

Supported platforms: iOS

note

Refer to the official Appium driver documentation to see which driver versions support this command.