LabelPrintService - connector-documentation-generator

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

`addSelectedPrinterChangedListener`

(

handler

)

Void

Adds listeners to SelectedPrinterChanged 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 SelectedPrinterChanged event.
var onSelectedLabelPrinterChanged = function(labelPrinter) {
    var alertMessage;
    if (labelPrinter) {
        alertMessage = "Selected label printer changed. New printer: " + labelPrinter.modelName;
    } else {
        alertMessage = "Selected label printer changed.";
    }
    alert(alertMessage);
};

var connectionSuccededCallback = function() {
    // Adds listener to SelectedPrinterChanged event.
    connector.labelPrintService.addSelectedPrinterChangedListener(onSelectedLabelPrinterChanged);
};

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

`getSelectedPrinterAsync`

() Promise | Device async

Gets selected label printer 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 failureGetSelectedLabelPrinterHandler = function(failureReason) {
    var failureMessage;
    switch (failureReason) {
        case FailureReason.ServiceNotAvailable:
            failureMessage = "No attached Label Printers.";
            break;
        case FailureReason.InternalError:
            failureMessage = "Internal error occured.";
            break;
        default:
            throw new Error("failureReason");
    }
    alert(failureMessage);
};

var connectionSuccededCallback = function() {
    // Gets selected label printer device.
    connector.labelPrintService.getSelectedPrinterAsync().then(function (labelPrinter) {
        alert("Label Printer name: " + labelPrinter.name + "\n" + "Label Printer model name: " + labelPrinter.modelName); // Shows label printer name and model.
    }, failureGetSelectedLabelPrinterHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

`printLabelAsync`

(

printJobDescription
labelTemplate
packageData
numberOfCopies

)

Promise | LabelPrintStatus async

Prints label according to template and template data.

Parameters:

printJobDescription String

The print job description.
labelTemplate String

The label template.
packageData LabelTemplateData[]

The array of objects LabelTemplateData to fill template objects data.
numberOfCopies Number

[numberOfCopies=1] Number of copies to print.

Returns:

Promise | LabelPrintStatus:

A promise of the result that returns printing status 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 LabelTemplateData = buildingLink.connector.services.labelPrinting.LabelTemplateData;
var LabelPrintStatus = buildingLink.connector.services.labelPrinting.LabelPrintStatus;

var connector = new buildingLink.Connector();

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

// Defines job description, label template and data for printing.
var jobDescription = "Print label";
var labelTemplate = "<?xml version='1.0' encoding='utf-8'?><DieCutLabel Version='8.0' Units='twips'><PaperOrientation>Landscape</PaperOrientation><Id>LargeShipping</Id><PaperName>30256 Shipping</PaperName><DrawCommands><RoundRectangle X='0' Y='0' Width='3331' Height='5715' Rx='270' Ry='270' /></DrawCommands><ObjectInfo><BarcodeObject><Name>BARCODE</Name><ForeColor Alpha='255' Red='0' Green='0' Blue='0' /><BackColor Alpha='0' Red='255' Green='255' Blue='255' /><LinkedObjectName></LinkedObjectName><Rotation>Rotation0</Rotation><IsMirrored>False</IsMirrored><IsVariable>True</IsVariable><Text></Text><Type>Code128Auto</Type><Size>Medium</Size><TextPosition>Bottom</TextPosition><TextFont Family='Arial' Size='14' Bold='False' Italic='False' Underline='False' Strikeout='False' /><CheckSumFont Family='Arial' Size='8' Bold='False' Italic='False' Underline='False' Strikeout='False' /><TextEmbedding>None</TextEmbedding><ECLevel>0</ECLevel><HorizontalAlignment>Center</HorizontalAlignment><QuietZonesPadding Left='0' Top='0' Right='0' Bottom='0' /></BarcodeObject><Bounds X='396' Y='750' Width='5025' Height='1830' /></ObjectInfo></DieCutLabel>";
var printingData = [new LabelTemplateData("BARCODE", "123456789")];

var connectionSuccededCallback = function() {
    // Prints 2 labels from template.
    connector.labelPrintService.printLabelAsync(jobDescription, labelTemplate, printingData, 2).then(function (labelPrintStatus) {
        var labelPrintStatusMessage;
        switch (labelPrintStatus) {
            case LabelPrintStatus.AddedToQueue:
                labelPrintStatusMessage = "Added to queue.";
                break;
            case LabelPrintStatus.QueueIsInError:
                labelPrintStatusMessage = "Queue is in error state.";
                break;
            case LabelPrintStatus.DocumentAlreadyInQueue:
                labelPrintStatusMessage = "Document is already in queue.";
                break;
            default:
                throw new Error("labelPrintStatus");
        }
        alert(labelPrintStatusMessage);
    }, failureLabelPrintHandler);
};

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

`removeSelectedPrinterChangedListener`

(

handler

)

Void

Removes listeners from SelectedPrinterChanged 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 SelectedPrinterChanged event.
var onSelectedLabelPrinterChanged = function(labelPrinter) {
    alert("Selected label printer changed.");
};

var connectionSuccededCallback = function() {
    // Adds listeners to SelectedPrinterChanged event.
    connector.labelPrintService.addSelectedPrinterChangedListener(onSelectedLabelPrinterChanged);

    // Removes SelectedPrinterChanged listener in 5 seconds.
    setTimeout(function (){
        connector.labelPrintService.removeSelectedPrinterChangedListener(onSelectedLabelPrinterChanged);
    }, 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);

APIs

LabelPrintService Class

Constructor