TouchID

Improve this doc

$ ionic plugin add cordova-plugin-touch-id

Repo: https://github.com/EddyVerbruggen/cordova-plugin-touch-id

Scan the fingerprint of a user with the TouchID sensor.

Requires Cordova plugin: cordova-plugin-touch-id. For more info, please see the TouchID plugin docs.

Error Codes

The plugin will reject for various reasons. Your app will most likely need to respond to the cases differently.

Here is a list of some of the error codes:

• -1 - Fingerprint scan failed more than 3 times
• -2 or -128 - User tapped the 'Cancel' button
• -3 - User tapped the 'Enter Passcode' or 'Enter Password' button
• -4 - The scan was cancelled by the system (Home button for example)
• -6 - TouchID is not Available
• -8 - TouchID is locked out from too many tries

Usage

import {TouchID} from 'ionic-native';

Static Methods

verifyFingerprint(message)

Show TouchID dialog and wait for a fingerprint scan. If user taps ‘Enter Password’ button, brings up standard system passcode screen.

verifyFingerprintWithCustomPasswordFallback(message)

Show TouchID dialog and wait for a fingerprint scan. If user taps ‘Enter Password’ button, rejects with code ‘-3’ (see above).

verifyFingerprintWithCustomPasswordFallbackAndEnterPasswordLabel(message, enterPasswordLabel)

Show TouchID dialog with custom ‘Enter Password’ message and wait for a fingerprint scan. If user taps ‘Enter Password’ button, rejects with code ‘-3’ (see above).

Instance Methods

isAvailable()

Whether TouchID is available or not.