Class: GrabbaFingerprint

Members

ImageType

Properties:

preferences :GrabbaFingerprintPreferences

Type:

• GrabbaFingerprintPreferences

preferences :GrabbaProxcardPreferences

Type:

• GrabbaProxcardPreferences

TemplateType

Properties:

UserMessageType

Properties:

Methods

abort(onError)

Parameters:

Example

//A button to abort the current fingerprint operation.
<button onclick="grabba.fingerprint.abort(onError)">Abort fingerprint operation</button>

clearFingerprintDatabase(onError)

Parameters:

Example

//A button which clears the local fingerprint database
 <button onclick="grabba.fingerprint.clearFingerprintDatabase(onError)">Clear database</button>

compareTemplates(onSuccess, onError, inputTemplate, Array, templateTypeInt)

Parameters:

Example

//A function that store the return value.
var successMatch = function (result) {
//result is the return value of the position in the template list where the matched is successful
$("#fingerprintInfo2").text(result);
};

convertImageToBase64(onSuccess, onError, image)

Parameters:

See:

• GrabbaFingerprint#registerCallback

Example

//Display the image data after receiving it in a fingerprint callback
 var fingerprintCallbacks = {
     templateDataEvent: function(template) {
     },
     imageDataEvent: function(image) {
         grabba.fingerprint.convertImageToBase64(fingerprintDecoderCallback, onError, image);
     },
     userMessageEvent: function(message, number, total){
     }
 };

 //Callback used in the image data event to set the fingerprint image to a document element.
 var fingerprintDecoderCallback = function (imageBase64){
         document.getElementById("fingerprintImage").src = imageBase64;
 };

enrolFingerprint(onError, templateTypeInt, imageTypeInt, numAcquisitions, numFingers)

Parameters:

See:

• GrabbaFingerprint#TemplateType
• GrabbaFingerprint#ImageType

Example

//A button which captures a fingerprint template (Sagem Uncompressed Template) and an image without compression.
<button onclick="grabba.fingerprint.enrolFingerprint(onError, grabba.fingerprint.TemplateType.PK_MAT, grabba.fingerprint.ImageType.IMG_NO_COMPRESSION, 1, 1)">Capture fingerprint</button>

enrolFingerprintToDatabase(onError, templateTypeInt, imageTypeInt, numFingers, userID, userData)

Parameters:

See:

• GrabbaFingerprint#TemplateType
• GrabbaFingerprint#ImageType

Example

//A button which enrols a user, tester, with the data 0x01, 0x02, 0x03 and requests a fingerprint template (Sagem Uncompressed Template) in the process.
<button onclick="grabba.fingerprint.enrolFingerprintToDatabase(onError, grabba.fingerprint.TemplateType.PK_MAT, grabba.fingerprint.ImageType.IMG_PREVIEW, 1, 'tester', [1, 2, 3])">Enrol To Local Database</button>

identifyFingerprint(onError)

Parameters:

Example

//A button which starts an identify fingerprint in the local database process.
<button onclick="grabba.fingerprint.identifyFingerprint(onError)">Identify in local database</button>

isSupported(onSuccess, onError)

Parameters:

Example

//Button to check if the connected Grabba supports fingerprinting functionality.
 <button onclick="grabba.fingerprint.isSupported(function(supported){
 alert('Grabba fingerprint supported is ' + supported);
 },
 function(errorString) {
     alert('on error ' + errorString);
 });">Is fingerprint supported?</button>

registerCallback(callback, onError)

Parameters:

Example

//Callbacks to alert the user of the template data type, display the image and user message text.
 var fingerprintCallbacks = {
     templateDataEvent: function(template) {
         alert('Template data event \n' + 'Template type: ' + template.type);
     },
     imageDataEvent: function(image) {
         grabba.fingerprint.convertImageToBase64(fingerprintDecoderCallback, onError, image);
     },
     userMessageEvent: function(message, number, total){
         document.getElementById("fingerprintMessage").innerHTML = message.text;
     }
 };

 //Callback used in the image data event to set the fingerprint image to a document element.
 var fingerprintDecoderCallback = function (imageBase64){
         document.getElementById("fingerprintImage").src = imageBase64;
 };

resetFingerprintDatabase(onError)

Parameters:

Example

//A button which resets the local database
 <button onclick="grabba.fingerprint.resetFingerprintDatabase(onError)">Reset database</button>

verifyFingerprint(onError, templateData, templateTypeInt)

Parameters:

Example

//Callback used to verify a fingerprint template after receiving it in the templateDataEvent
     var fingerprintCallbacks = {
         templateDataEvent: function(template) {
         grabba.fingerprint.verifyFingerprint(onError, template.data, template.typeInt);
     },
     imageDataEvent: function(image) {
     },
     userMessageEvent: function(message, number, total, userRecord){
     }
 };