API Docs for: 1.0.0
Show:

BarcodeScanService Class

Uses

Provides information about the barcode scanners and allows to listen to barcode scanned events.

Constructor

BarcodeScanService

()

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);

addBarcodeScannedListener

(
  • handler
)
Void

Adds listeners to BarcodeScanned event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles BarcodeScanned event.
var onBarcodeScanned = function(barcode) {
    alert(barcode);
};

var connectionSuccededCallback = function() {
    // Adds listener to BarcodeScanned event.
    connector.barcodeScanService.addBarcodeScannedListener(onBarcodeScanned);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addScannersListChangedListener

(
  • handler
)
Void

Adds listeners to ScannersListChanged 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 ScannersListChanged event.
var onScannersListChanged = function(scanners) {
    var alertMessage;
    if (scanners.length > 0) {
        var message = [];
        for (var i = 0; i < scanners.length; i++) {
            message.push("Barcode Scanner model name: " + scanners[i].modelName);
        }
        alertMessage = "Scanners list changed. New scanners: " + message.join(";");
    } else {
        alertMessage = "Scanners list changed.";
    }
    alert(alertMessage);
};

var connectionSuccededCallback = function() {
    // Adds listener to ScannersListChanged event.
    connector.barcodeScanService.addScannersListChangedListener(onScannersListChanged);
};

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);

getScannersAsync

() Promise | Device[] async

Gets barcode scanners.

Returns:

Promise | Device[]:

A promise of the result that returns the list of devices 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 failureGetScannersHandler = function(failureReason) {
    var failureMessage;
    switch (failureReason) {
        case FailureReason.ServiceNotAvailable:
            failureMessage = "No attached Barcode scanners.";
            break;
        case FailureReason.InternalError:
            failureMessage = "Internal error occured.";
            break;
        default:
            throw new Error("failureReason");
    }
    alert(failureMessage);
};

var connectionSuccededCallback = function() {
    // Gets barcode scanner devices.
    connector.barcodeScanService.getScannersAsync().then(function (scanners) {
        var message = [];
        for (var i = 0; i < scanners.length; i++) {
            message.push("Barcode Scanner name: " + scanners[i].name + "; " + "Barcode Scanner model name: " + scanners[i].modelName);
        }
        alert(message.join("\n")); // Shows barcode scanners name and model.
    }, failureGetScannersHandler);
};

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);

removeBarcodeScannedListener

(
  • handler
)
Void

Removes listeners from BarcodeScanned event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

var connector = new buildingLink.Connector();

// Handles BarcodeScanned event.
var onBarcodeScanned = function(barcode) {
    alert(barcode);
};

var connectionSuccededCallback = function() {
    // Adds listeners to BarcodeScanned event.
    connector.barcodeScanService.addBarcodeScannedListener(onBarcodeScanned);

    // Removes BarcodeScanned listener in 5 seconds.
    setTimeout(function (){
        connector.barcodeScanService.removeBarcodeScannedListener(onBarcodeScanned);
    }, 5000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeScannersListChangedListener

(
  • handler
)
Void

Removes listeners from ScannersListChanged 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 ScannersListChanged event.
var onScannersListChanged = function(scanners) {
    alert("Scanners list changed.");
};

var connectionSuccededCallback = function() {
    // Adds listeners to ScannersListChanged event.
    connector.barcodeScanService.addScannersListChangedListener(onScannersListChanged);

    // Removes ScannersListChanged listener in 5 seconds.
    setTimeout(function (){
        connector.barcodeScanService.removeScannersListChangedListener(onScannersListChanged);
    }, 5000);
};

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);