cordova-plugin-documentreader

0.6.3 • Public • Published

cordova-plugin-documentreader

Cordova plugin for reading and validation of identification documents. Using Regula Document Reader with core DocumentReaderMRZBarcode.framework inside for iOS version.

Install

Install plugn:

cordova plugin add cordova-plugin-documentreader --variable CAMERA_USAGE_DESCRIPTION="To take photo" --save

Usage

You can get trial license for demo application at licensing.regulaforensics.com (regula.license file).

InitializeReader:

DocumentReader.initReader(
    license,
    function (result) {
        // result will contain array of json results.
    },
    function (error) {
        alert(error);
    }
);

ScanDocument:

DocumentReader.scanDocument(
    function (result) {
        // result will contain array of json results.
    },
    function (error) {
        alert(error);
    }
);

How to build demo application

  1. Open terminal inside empty folder and run cordova create testdocumentreader <YOUR_APPLICATION_ID> DocumentReaderTest
  2. Run cd testdocumentreader
  3. Add plugin: cordova plugin add cordova-plugin-documentreader --variable CAMERA_USAGE_DESCRIPTION="To take photo" --save
  4. Add cordova-plugin-file for get license file: cordova plugin add cordova-plugin-file --save
  5. Get trial license for demo application at licensing.regulaforensics.com (regula.license file). When you will create license use <YOUR_APPLICATION_ID> like bundle ID (see the first paragraph).
  6. Put license to www/regula.license.
  7. Put this code inside onDeviceReady method file index.js (path: www/js/index.js) for calling DocumentReader plugin:
onDeviceReady: function() {
    this.receivedEvent('deviceready');

    window.resolveLocalFileSystemURL(
        cordova.file.applicationDirectory + "www/regula.license",
        function (fileEntry) {
            fileEntry.file(function(file) {
                var reader = new FileReader();
                reader.onloadend = function(e) {
                    DocumentReader.initReader(
                        this.result,
                        function (message) {
                            DocumentReader.scanDocument(
                                function (message) {
                                    alert(message);
                                },
                                function (error) {
                                    alert(error);
                                }
                            );
                        },
                        function (error) {
                            alert(error);
                        }
                    );
                }
                reader.readAsArrayBuffer(file);
            });
        }, function(e) {
            console.log("FileSystem Error");
            console.dir(e);
        });
},
  1. Run cordova platform add ios
  2. Run iOS project.

Package Sidebar

Install

npm i cordova-plugin-documentreader

Weekly Downloads

112

Version

0.6.3

License

commercial

Unpacked Size

227 MB

Total Files

51

Last publish

Collaborators

  • regula