Appium-toggle-touch-id-enrollment

Toggle Touch ID Enrollment

Toggle the simulator being enrolled to accept touchId (iOS Simulator only)
//: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/simulator/toggle-touch-id-enrollment.yml)

Example Usage

// Java
driver.toggleTouchIDEnrollment(true);

# Python
self.driver.toggle_touch_id_enrollment()

// Javascript
// webdriver.io example
driver.toggleEnrollTouchId(true);

// wd example
await driver.toggleTouchIdEnrollment();

# Ruby
# ruby_lib example
toggle_touch_id_enrollment

# ruby_lib_core example
@driver.toggle_touch_id_enrollment

# PHP
// TODO PHP sample

// C#
// TODO C# sample

Description

To enable this feature, the allowTouchIdEnroll desired capability must be set to true. When allowTouchIdEnroll is set to true
the Simulator will be enrolled by default, and the ‘Toggle Touch ID Enrollment’ changes the enrollment state.

This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation None None None
Android UiAutomator2 None None None
Espresso None None None
UiAutomator None None None
Mac Mac None None None
Windows Windows None None None

Appium Clients

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/simulator/toggle_touch_id_enrollment

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
enabled boolean If true, enable, if falsey disable, otherwise toggle (optional)

Response

null

See Also

官方链接为:http://appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment

关闭