Toggle Touch ID Enrollment
Toggle the simulator being enrolled to accept touchId (iOS Simulator only)
Example Usage
// Java
driver.toggleTouchIDEnrollment(true);
# Python
self.driver.toggle_touch_id_enrollment()
// Javascript
// webdriver.io example
driver.toggleTouchIdEnrollment(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
| Language | Support | Documentation |
|---|---|---|
| Java | All | appium.github.io |
| Python | All | github.com |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| PHP | All | github.com |
| C# | All | github.com |
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