API Docs for: 1.0.0
Show:

FingerprintProcessingService Class

Allows to create enrollment template.

Constructor

FingerprintProcessingService

()

Methods

createEnrollmentTemplateAsync

(
  • samples
)
Promise | FingerprintTemplateCreationResult async

Creates enrollment template from samples list.

Parameters:

  • samples FingerprintSample

    The list of fingerprint samples.

Returns:

Promise | FingerprintTemplateCreationResult:

A promise of the result that returns a FingerprintTemplateCreationResult in case of success.

Example:

// Creates shortcuts to avoid using long reference to and FailureReason below in code.
var FailureReason = buildingLink.connector.services.FailureReason;

var connector = new buildingLink.Connector();

// Defines failure handler for operation with device.
var failureFinperprintReaderOperationHandler = function(failureReason) {
    var failureMessage;
    switch (failureReason) {
        case FailureReason.ServiceNotAvailable:
            failureMessage = "No attached Fingerprint Readers.";
            break;
        case FailureReason.InternalError:
            failureMessage = "Internal error occured.";
            break;
        default:
            throw new Error("failureReason");
    }
    alert(failureMessage);
};

// Stores fingerprint samples.
var samples = [];
var counter = 0;

// Handles SampleCaptured event.
var onSampleCaptured = function(fingerprint) {
    samples.push(fingerprint);
    counter++;
    if (counter === 4) {
        connector.fingerprintReaderService.createEnrollmentTemplateAsync(samples).then(function(templateCreationResult) {
            if (templateCreationResult.isSuccessful) {
                alert("Template created.");
                samples = [];
                counter = 0;
            } else {
                alert("Template creation failed.");
            }
        }, failureFinperprintReaderOperationHandler);
    }
};

var connectionSuccededCallback = function() {
    // Adds listener to SampleCaptured event.
    connector.fingerprintReaderService.addSampleCapturedListener(onSampleCaptured);

    // Starts capturing from fingerprintReaders.
    connector.fingerprintReaderService.startCapturingAsync().then(function () {
        // Handle start capturing.
    }, failureFinperprintReaderOperationHandler);
};

var connectionClosedCallback = function(connectionError) {
    alert("Connection failed."); // Shows connection failure message.
};

connector.activate(connectionSuccededCallback, connectionClosedCallback);

getStatusAsync

() Promise | FingerprintProcessorStatus async

Gets status of fingerprint processor.

Returns:

Promise | FingerprintProcessorStatus:

A promise of the result that returns FingerprintProcessorStatus in case of success.

Example:

// Creates shortcuts to avoid using long references to FingerprintProcessorStatus and FailureReason below in code.
var FingerprintProcessorStatus = buildingLink.connector.services.fingerprinting.FingerprintProcessorStatus;
var FailureReason = buildingLink.connector.services.FailureReason;

var connector = new buildingLink.Connector();

// Defines failure handler for operation with device.
var failureGetFingerprintProcessorStatusHandler = function(failureReason) {
    var failureMessage;
    switch (failureReason) {
        case FailureReason.ServiceNotAvailable:
            failureMessage = "No attached Fingerprint Readers.";
            break;
        case FailureReason.InternalError:
            failureMessage = "Internal error occured.";
            break;
        default:
            throw new Error("failureReason");
    }
    alert(failureMessage);
};

var connectionSuccededCallback = function() {
    // Gets fingerprint processor status.
    connector.fingerprintReaderService.getStatusAsync().then(function (fingerprintProcessorStatus) {
        switch (fingerprintProcessorStatus) {
            case FingerprintProcessorStatus.Available:
                alert("Status: fingerprint processor is available."); // Shows available message.
                break;
            case FingerprintProcessorStatus.InvalidLicense:
                alert("Status: invalid license for fingerprint processor."); // Shows invalid license message.
                break;
            case FingerprintProcessorStatus.Unavailable:
                alert("Status: fingerprint processor is not available"); // Shows not available message.
                break;
            default:
                throw new Error("fingerprintProcessorStatus");
        }
    }, failureGetFingerprintProcessorStatusHandler);
};

var connectionClosedCallback = function(connectionError) {
    alert("Connection failed."); // Shows connection failure message.
};

connector.activate(connectionSuccededCallback, connectionClosedCallback);