API Docs for: 1.0.0
Show:

SignaturePadService Class

Uses

Provides information about the signature pad device, allows to start/stop a signature capturing and to clear signed signature.

Constructor

SignaturePadService

()

Methods

addAvailabilityChangedListener

(
  • handler
)
Void

Inherited from DeviceService:

Adds listeners to AvailabilityChanged event.

Parameters:

  • handler Function

    A function that handles the event. The function that has a single parameter of boolean type and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles AvailabilityChanged event.
var onAvailabilityChanged = function(isAvailable) {
    alert("Service availability changed: " + isAvailable);
};

var connectionSuccededCallback = function() {
    // Adds listener to AvailabilityChanged event for any service: connector.barcodeScanService.addAvailabilityChangedListener(), connector.fingerprintReaderService.addAvailabilityChangedListener().
    connector.idCardScanService.addAvailabilityChangedListener(onAvailabilityChanged);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addSelectedSignaturePadChangedListener

(
  • handler
)
Void

Adds listeners to SelectedSignaturePadChanged event.

Parameters:

  • handler Function

    A function that handles the event. The function that has a single parameter of type Device and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles SelectedSignaturePadChanged event.
var onSelectedSignaturePadChanged = function(signaturePad) {
    var alertMessage;
    if (signaturePad) {
        alertMessage = "Selected signature pad changed: " + signaturePad.modelName;
    } else {
        alertMessage = "Selected signature pad changed.";
    }

    alert(alertMessage);
};

var connectionSuccededCallback = function() {
    // Adds listeners to SelectedSignaturePadChanged event.
    connector.signaturePadService.addSelectedSignaturePadChangedListener(onSelectedSignaturePadChanged);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addSignatureCapturingCompletedListener

(
  • handler
)
Void

Adds listeners to SignatureCapturingCompleted event.

Parameters:

  • handler Function

    A function that will handle the event. The function that has no parameters and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles SignatureCapturingCompleted event.
var onSignatureCapturingCompleted = function() {
    alert("Signature capturing completed.");
};

var connectionSuccededCallback = function() {
    // Adds listener to SignatureCapturingCompleted event.
    connector.signaturePadService.addSignatureCapturingCompletedListener(onSignatureCapturingCompleted);

    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789");

    // Stops signature capturing in 10 seconds.
    setTimeout(function (){
        connector.signaturePadService.stopCapturingAsync();
    }, 10000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addSignatureCapturingListener

(
  • handler
)
Void

Adds listeners to SignatureCapturing event.

Parameters:

  • handler Function

    A function that will handle the event. The function that has a single parameter of type Signature and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Prepares canvas to display signature from signature pad. It is supposed that HTML contains the following element: <canvas id="cnvSignature"></canvas>
var canvas = document.getElementById("cnvSignature");
var image = new Image();
image.onload = function () {
    canvas.width = image.width;
    canvas.height = image.height;
    var context = canvas.getContext("2d");
    context.drawImage(image, 0, 0, canvas.width, canvas.height);
};
image.onerror = function (stuff) {
    console.log("Img Onerror:", stuff);
};

// Handles SignatureCapturing event.
var onSignatureCapturing = function(signatureCapturingResult) {
    image.src = "data:image/png;base64," + signatureCapturingResult.signature;
};

var connectionSuccededCallback = function() {
    // Adds listener to SignatureCapturing event.
    connector.signaturePadService.addSignatureCapturingListener(onSignatureCapturing);

    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789");
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

clearSignaturePadAsync

() Promise | Boolean async

Clear selected signature pad.

Returns:

Promise | Boolean:

A promise of the result.

Example:

// Creates a shortcut to avoid using long references to FailureReason below in code.
var FailureReason = buildingLink.connector.services.FailureReason;

var connector = new buildingLink.Connector();

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

// Adds clicked listener to button "Clear Signature". It is supposed that HTML contains the following element: <button id="btnClearSignature">Clear Signature</button>
var clearSignatureButton = document.getElementById("btnClearSignature");
clearSignatureButton.addEventListener("click", function () {
    connector.signaturePadService.clearSignaturePadAsync().then(function() {
        alert("Signature Pad cleared.");
    }, failureHandler);
});

var connectionSuccededCallback = function() {
    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789").then(function (result) {
        // Handle StartSignatureCapturingResult
    }, failureHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

getIsAvailableAsync

() Promise | Boolean async

Inherited from DeviceService:

Allows to determine whether device is available.

Returns:

Promise | Boolean:

A promise of the result that returns true if device is available or false otherwise in case of success.

Example:

var connector = new buildingLink.Connector();

var connectionSuccededCallback = function() {
    // Gets whether device service is available or no. This method is common for all services and can be used like: connector.autoDialerService.getIsAvailableAsync(), connector.fingerprintReaderService.getIsAvailableAsync(), etc.
    connector.webCameraService.getIsAvailableAsync().then(function (isAvailable) {
        if (isAvailable) {
            alert("Service is available.");
        } else {
            alert("Service is not available.");
        }
    });
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

getSelectedSignaturePadAsync

() Promise | Device async

Gets selected signature pad device.

Returns:

Promise | Device:

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

Example:

// Creates a shortcut to avoid using long references to FailureReason below in code.
var FailureReason = buildingLink.connector.services.FailureReason;

var connector = new buildingLink.Connector();

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

var connectionSuccededCallback = function() {
    // Gets selected signature pad device.
    connector.signaturePadService.getSelectedSignaturePadAsync().then(function (signaturePad) {
        alert("Signature Pad name: " + signaturePad.name + "\n" + "Signature Pad model name: " + signaturePad.modelName); // Shows signature pad name and model.
    }, failureGetSelectedSignaturePadHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeAvailabilityChangedListener

(
  • handler
)
Void

Inherited from DeviceService:

Removes listeners from AvailabilityChanged event.

Parameters:

  • handler Function

    A function that handles the event. The function that has a single parameter of boolean type and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles AvailabilityChanged event.
var onAvailabilityChanged = function(isAvailable) {
    alert("Service availability changed: " + isAvailable);
};

var connectionSuccededCallback = function() {
    // Adds listener to AvailabilityChanged event for any service: connector.signaturePadService.addAvailabilityChangedListener(), connector.autoDialerService.addAvailabilityChangedListener().
    connector.idCardScanService.addAvailabilityChangedListener(onAvailabilityChanged);

    // Removes AvailabilityChanged listener in 5 seconds for any service: connector.signaturePadService.removeAvailabilityChangedListener(), connector.autoDialerService.removeAvailabilityChangedListener().
    setTimeout(function (){
        connector.idCardScanService.removeAvailabilityChangedListener(onAvailabilityChanged);
        alert("AvailabilityChanged listener."); // Observe that notifications will be stopped after this alert.
    }, 5000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeSelectedSignaturePadChangedListener

(
  • handler
)
Void

Removes listeners to SelectedSignaturePadChanged event.

Parameters:

  • handler Function

    A function that handles the event. The function that has a single parameter of type Device and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles SelectedSignaturePadChanged event.
var onSelectedSignaturePadChanged = function(signaturePad) {
    alert("Selected signature pad changed.");
};

var connectionSuccededCallback = function() {
    // Adds listeners to SelectedSignaturePadChanged event.
    connector.signaturePadService.addSelectedSignaturePadChangedListener(onSelectedSignaturePadChanged);

    // Removes SelectedSignaturePadChanged listener in 5 seconds.
    setTimeout(function (){
        connector.signaturePadService.removeSelectedSignaturePadChangedListener(onSelectedSignaturePadChanged);
    }, 5000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeSignatureCapturingCompletedListener

(
  • handler
)
Void

Removes listeners to SignatureCapturingCompleted event.

Parameters:

  • handler Function

    A function that handles the event. The function that has no parameters and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles SignatureCapturingCompleted event.
var onSignatureCapturingCompleted = function() {
    alert("Signature capturing completed.");
};

var connectionSuccededCallback = function() {
    // Adds listener to SignatureCapturingCompleted event.
    connector.signaturePadService.addSignatureCapturingCompletedListener(onSignatureCapturingCompleted);

    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789");

    // Stops signature capturing from selected signature pad and removes SignatureCapturingCompleted listener in 10 seconds.
    setTimeout(function (){
        connector.signaturePadService.removeSignatureCapturingCompletedListener(onSignatureCapturingCompleted);
        alert("SignatureCapturingCompleted listener removed.");
        connector.signaturePadService.stopCapturingAsync();
    }, 10000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeSignatureCapturingListener

(
  • handler
)
Void

Removes listeners to SignatureCapturing event.

Parameters:

  • handler Function

    A function that handles the event. The function that has a single parameter of type Signature and does not return a value.

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles SignatureCapturing event.
var onSignatureCapturing = function(signatureCapturingResult) {
    console.log("Capturing.");
};

var connectionSuccededCallback = function() {
    // Adds listener to SignatureCapturing event.
    connector.signaturePadService.addSignatureCapturingListener(onSignatureCapturing);

    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789");

    // Stops signature capturing from selected signature pad and removes SignatureCapturing listener in 10 seconds.
    setTimeout(function (){
        connector.signaturePadService.stopCapturingAsync();
        connector.signaturePadService.removeSignatureCapturingListener(onSignatureCapturing);
    }, 10000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

setDescriptionAsync

(
  • firstDescriptionLine
  • secondDescriptionLine
)
Promise | Boolean async

Set description displaying on signature pad display.

Parameters:

  • firstDescriptionLine String

    The first description line to be displayed on signature pad display.

  • secondDescriptionLine String

    The second description line to be displayed on signature pad display.

Returns:

Promise | Boolean:

A promise of the result.

Example:

// Creates a shortcut to avoid using long references to FailureReason below in code.
var FailureReason = buildingLink.connector.services.FailureReason;

var connector = new buildingLink.Connector();

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

// Adds clicked listener to button "Update Description". It is supposed that HTML contains the following elements:
// <button id="btnUpdateDescription">Update Description</button>
// <input id="inptFirstLine"></input>
// <input id="inptSecondLine"></input>
var updateDescriptionButton = document.getElementById("btnUpdateDescription");
var firstLine = document.getElementById("inptFirstLine").value;
var secondLine = document.getElementById("inptSecondLine").value;
updateDescriptionButton.addEventListener("click", function () {
    connector.signaturePadService.setDescriptionAsync(firstLine, secondLine).then(function(result) {
        if(result){
            alert("Description updated.");
        }
    }, failureHandler);
});

var connectionSuccededCallback = function() {
    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789").then(function (result) {
        // Handle StartSignatureCapturingResult
    }, failureHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

showSettingsAsync

() Promise | Void async

Inherited from DeviceService:

Allows to show device settings in Connector app.

Returns:

Promise | Void:

A promise of the result.

Example:

var connector = new buildingLink.Connector();

var connectionSuccededCallback = function() {
    // Shows device settings for selected service. This method is common for all services and can be used: connector.idCardScanService.showSettingsAsync(), connector.barcodeScanService.showSettingsAsync(), etc.
    connector.printService.showSettingsAsync();
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

startCapturingAsync

(
  • firstDescriptionLine
  • secondDescriptionLine
)
Promise | StartSignatureCapturingResult async

Starts capturing a signature from selected signature pad.

Parameters:

  • firstDescriptionLine String

    The first description line to be displayed on signature pad display.

  • secondDescriptionLine String

    The second description line to be displayed on signature pad display.

Returns:

Promise | StartSignatureCapturingResult:

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

Example:

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

var connector = new buildingLink.Connector();

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

var connectionSuccededCallback = function() {
    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789").then(function (result) {
        switch (result.startCapturingStatus) {
            case StartSignatureCapturingStatus.SignaturePadBusy:
                alert("SignaturePadStarted result: signature pad is busy by another program."); // Shows signature pad busy message.
                break;
            case StartSignatureCapturingStatus.Started:
                alert("SignaturePadStarted result: signature pad capturing started"); // Shows signature pad started message.
                break;
            default:
                throw new Error("result.startCapturingStatus");
        }
    }, failureStartCapturingHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

stopCapturingAsync

() Promise | Boolean async

Stops capturing a signature from selected signature pad.

Returns:

Promise | Boolean:

A promise of the result.

Example:

var connector = new buildingLink.Connector();

var connectionSuccededCallback = function() {
    // Starts signature capturing from selected signature pad.
    connector.signaturePadService.startCapturingAsync("10-Techart", "DHL-123456789");

    // Stops signature capturing from selected signature pad in 5 seconds.
    setTimeout(function (){
        connector.signaturePadService.stopCapturingAsync().then(function() {
            alert("Signature capturing stopped.");
        });
    }, 5000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);