alvarheras / cordova-plugin-fingerprint-aio

Cordova Plugin for fingerprint sensors with Android and iOS support

Cordova Plugin Fingerprint All-In-One

A ndroid and IO s

This plugin is an attempt to provide a single interface for accessing fingerprint hardware on both Android 6+ and iOS.

There are some great cordova plugins out there that make use of the fingerprint APIs provided by Android and iOS. But I could not find a project which supports both platforms (correct me if I am wrong). I decided to take their native code and bundle it together in one plugin.

Features

• Check if fingerprint scanner is available
• Fingerprint authentication
• ngCordova support - Pull request
• Ionic Native support - Pull request

Platforms

• Android
• iOS - XCode 8 required, plugin uses Swift 3

How to use

---

Tutorial about using this plugin with Ionic thanks to Paul Halliday

Examples

ngCordova Example

Ionic Native Example

---

Install

Install from NPM

cordova plugin add cordova-plugin-fingerprint-aio --save

or use this Github repo

Check if fingerprint authentication is available

Fingerprint.isAvailable(isAvailableSuccess, isAvailableError);

    function isAvailableSuccess(result) {
      alert("Fingerprint available");
    }

    function isAvailableError(message) {
      alert(message);
    }

Show authentication dialogue

Fingerprint.show({
      clientId: "Fingerprint-Demo",
      clientSecret: "password" //Only necessary for Android
    }, successCallback, errorCallback);

    function successCallback(){
      alert("Authentication successfull");
    }

    function errorCallback(err){
      alert("Authentication invalid " + err);
    }

Optional parameters

disableBackup: If true remove backup option on authentication dialogue for Android. Default false.

Thanks to the authors of the original fingerprint plugin:

Android

iOS

License

• Project and iOS source -> MIT
• Android source -> MIT and Apache 2.0