Represents an object that enables support for user credentials secured by the TouchId mechanism. This functionality is available on selected iOS devices.
The TouchID functionality is active once it has been activated in the device's system settings. Check your system settings and make sure that both Passcode and TouchID functions are active.
The object can be accessed using the launchbox.TouchID reference.
The table below lists all constant values of the TouchID object,
used as failure codes in the onError methods in this API.
| Name | Description |
|---|---|
| PMTouchIdErrorPasscodeNotSet | Denotes that a passcode has not been set. |
| PMTouchIdErrorInvalidCredentials | Denotes that invalid credentials have been provided.. |
| PMTouchIdErrorKeychain | Denotes that the keychain is invalid. |
| PMTouchIdErrorEmptyKeychain | Denotes that the keychain is empty. |
| PMTouchIdErrorInvalidFingerprint | Denotes that an error has occurred during fingerprint verification. |
| PMTouchIdErrorItemExist | Denotes that an item already exists. |
| PMTouchIdErrorCanceledByUser | Denotes that an action has been canceled by the user. |
| Name | Description | Return type |
|---|---|---|
| checkAvailability | Checks whether the TouchId functionality is available and the passcode is set. |
undefined |
| saveCredentials | Saves credentials in the keychain. Does not require authentication. |
undefined |
| getCredentials | Obtains credentials from a TouchID-secured keychain. Can be used to capture a fingerprint. |
undefined |
| deleteCredentials | Deletes credentials from a TouchID-secured keychain. Does not require authentication. |
undefined |