API Docs for: 1.0.0
Show:

AutoDialerService Class

Uses

Provides information about the auto dialer device, allows to dial/hang up and capture dialing events.

Constructor

AutoDialerService

()

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

addCallCompletedListener

(
  • handler
)
Void

Adds listeners to CallCompleted event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

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

var connector = new buildingLink.Connector();

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

// Handles CallCompleted event.
var onCallCompleted = function(callCompletedResult) {
    var callCompletedMessage;
    switch (callCompletedResult.status) {
        case CallCompletedStatus.Busy:
            callCompletedMessage = "Callee is busy.";
            break;
        case CallCompletedStatus.CurrentLineDropped:
            callCompletedMessage = "Current line is dropped.";
            break;
        case CallCompletedStatus.OnHook:
            callCompletedMessage = "On hook.";
            break;
        case CallCompletedStatus.HangUp:
            callCompletedMessage = "Hang up.";
            break;
        default:
            throw new Error("failureReason");
    }
    alert(callCompletedMessage);
};

var connectionSuccededCallback = function() {
    // Adds listener to CallCompleted event.
    connector.autoDialerService.addCallCompletedListener(onCallCompleted);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addCallStartedListener

(
  • handler
)
Void

Adds listeners to CallStarted event.

Parameters:

  • handler Function

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

Returns:

Void:

addCallWaitingListener

(
  • handler
)
Void

Adds listeners to CallWaiting 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:

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

var connector = new buildingLink.Connector();

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

// Handles CallWaiting event.
var onCallWaiting = function() {
    alert("Call waiting.");
};

var connectionSuccededCallback = function() {
    // Adds listener to CallWaiting event.
    connector.autoDialerService.addCallWaitingListener(onCallWaiting);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addDialingDoneListener

(
  • handler
)
Void

Adds listeners to DialingDone 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:

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

var connector = new buildingLink.Connector();

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

// Handles DialingDone event.
var onDialingDone = function() {
    alert("Dialing done.");
};

var connectionSuccededCallback = function() {
    // Adds listener to DialingDone event.
    connector.autoDialerService.addDialingDoneListener(onDialingDone);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addDialToneDetectedListener

(
  • handler
)
Void

Adds listeners to DialToneDetected 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:

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

var connector = new buildingLink.Connector();

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

// Handles DialToneDetected event.
var onDialToneDetected = function() {
    alert("Dial tone detected.");
};

var connectionSuccededCallback = function() {
    // Adds listener to DialToneDetected event.
    connector.autoDialerService.addDialToneDetectedListener(onDialToneDetected);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addEnteringNumberListener

(
  • handler
)
Void

Adds listeners to EnteringNumber event.

Parameters:

  • handler Function

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

Returns:

Void:

addIncomingCallDetectedListener

(
  • handler
)
Void

Adds listeners to IncomingCallDetected event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

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

var connector = new buildingLink.Connector();

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

// Handles IncomingCallDetected event.
var onIncomingCallDetected = function(incomingCallData) {
    alert("Icoming call detected: " + incomingCallData.callerInfo);
};

var connectionSuccededCallback = function() {
    // Adds listener to IncomingCallDetected event.
    connector.autoDialerService.addIncomingCallDetectedListener(onIncomingCallDetected);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addOffHookListener

(
  • handler
)
Void

Adds listeners to OffHook event.

Parameters:

  • handler Function

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

Returns:

Void:

addPhoneHookFlashListener

(
  • handler
)
Void

Adds listeners to PhoneHookFlash event.

Parameters:

  • handler Function

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

Returns:

Void:

addSelectedDialerChangedListener

(
  • handler
)
Void

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

var connectionSuccededCallback = function() {
    // Adds listener to SelectedDialerChanged event.
    connector.autoDialerService.addSelectedDialerChangedListener(onSelectedDialerChanged);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

addVoiceDetectedListener

(
  • handler
)
Void

Adds listeners to VoiceDetected 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:

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

var connector = new buildingLink.Connector();

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

// Handles VoiceDetected event.
var onVoiceDetected = function() {
    alert("Voice detected.");
};

var connectionSuccededCallback = function() {
    // Adds listener to VoiceDetected event.
    connector.autoDialerService.addVoiceDetectedListener(onVoiceDetected);

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

dialAsync

(
  • phoneNumber
)
Promise | StartDialStatus async

Dials phone number.

Parameters:

  • phoneNumber String

    Phone number.

Returns:

Promise | StartDialStatus:

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

Example:

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

var connector = new buildingLink.Connector();

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

var connectionSuccededCallback = function() {
    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        switch (startDialStatus) {
            case StartDialStatus.Failed:
                alert("StartDialStatus: Failed to dial."); // Shows failure message.
                break;
            case StartDialStatus.DeviceBusy:
                alert("StartDialStatus: Callee is busy."); // Shows callee busy message.
                break;
            case StartDialStatus.Successful:
                alert("StartDialStatus: Dialed successfully."); // Shows successfully dialed message.
                break;
            default:
                throw new Error("result.startCapturingStatus");
        }
    }, failureDialHandler);
};

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

getSelectedDialerAsync

() Promise | Device async

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

var connectionSuccededCallback = function() {
    // Gets selected dialer device.
    connector.autoDialerService.getSelectedDialerAsync().then(function (dialer) {
        alert("Dialer name: " + dialer.name + "\n" + "Dialer model name: " + dialer.modelName); // Shows dialer name and model.
    }, failureGetSelectedDialerHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

hangUpAsync

() Promise | Void async

Hangs up.

Returns:

Promise | Void:

A promise of the result.

Example:

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

var connector = new buildingLink.Connector();

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

var connectionSuccededCallback = function() {
    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        alert("Dialed");
    }, dialerFailureHandler);

    // Hangs up the call in 5 seconds.
    setTimeout(function (){
        connector.autoDialerService.hangUpAsync().then(function () {
             alert("Hang up.");
        }, dialerFailureHandler);
    }, 5000);
};

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

removeCallCompletedListener

(
  • handler
)
Void

Removes listeners to CallCompleted event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

// Creates shortcuts to avoid using long references to FailureReason below in code.
var FailureReason = buildingLink.connector.services.FailureReason;
var CallCompletedStatus = buildingLink.connector.services.autoDialing.CallCompletedStatus;

var connector = new buildingLink.Connector();

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

// Handles CallCompleted event.
var onCallCompleted = function(callCompletedResult) {
    alert("Call completed.");
};

var connectionSuccededCallback = function() {
    // Adds listener to CallCompleted event.
    connector.autoDialerService.addCallCompletedListener(onCallCompleted);

    // Removes listener to CallCompleted event.
    connector.autoDialerService.removeCallCompletedListener(onCallCompleted); // Observe that there is no 'CallCompleted' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeCallStartedListener

(
  • handler
)
Void

Removes listeners from CallStarted event.

Parameters:

  • handler Function

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

Returns:

Void:

removeCallWaitingListener

(
  • handler
)
Void

Removes listeners to CallWaiting 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:

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

var connector = new buildingLink.Connector();

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

// Handles CallWaiting event.
var onCallWaiting = function() {
    alert("Call waiting.");
};

var connectionSuccededCallback = function() {
    // Adds listener to CallWaiting event.
    connector.autoDialerService.addCallWaitingListener(onCallWaiting);

    // Removes listener to CallWaiting event.
    connector.autoDialerService.removeCallWaitingListener(onCallWaiting); // Observe that there is no 'CallWaiting' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeDialingDoneListener

(
  • handler
)
Void

Removes listeners from DialingDone 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:

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

var connector = new buildingLink.Connector();

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

// Handles DialingDone event.
var onDialingDone = function() {
    alert("Dialing done.");
};

var connectionSuccededCallback = function() {
    // Adds listener to DialingDone event.
    connector.autoDialerService.addDialingDoneListener(onDialingDone);

    // Removes listener to DialingDone event.
    connector.autoDialerService.removeDialingDoneListener(onDialingDone); // Observe that there is no 'DialingDone' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeDialToneDetectedListener

(
  • handler
)
Void

Removes listeners from DialToneDetected 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:

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

var connector = new buildingLink.Connector();

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

// Handles DialToneDetected event.
var onDialToneDetected = function() {
    alert("Dial tone detected.");
};

var connectionSuccededCallback = function() {
    // Adds listener to DialToneDetected event.
    connector.autoDialerService.addDialToneDetectedListener(onDialToneDetected);

    // Removes listener to DialToneDetected event.
    connector.autoDialerService.removeDialToneDetectedListener(onDialToneDetected); // Observe that there is no 'DialToneDetected' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeEnteringNumberListener

(
  • handler
)
Void

Removes listeners from EnteringNumber event.

Parameters:

  • handler Function

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

Returns:

Void:

removeIncomingCallDetectedListener

(
  • handler
)
Void

Removes listeners from IncomingCallDetected event.

Parameters:

  • handler Function

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

Returns:

Void:

Example:

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

var connector = new buildingLink.Connector();

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

// Handles IncomingCallDetected event.
var onIncomingCallDetected = function(incomingCallData) {
    alert("Icoming call detected.");
};

var connectionSuccededCallback = function() {
    // Adds listener to IncomingCallDetected event.
    connector.autoDialerService.addIncomingCallDetectedListener(onIncomingCallDetected);

    // Removes listener to IncomingCallDetected event.
    connector.autoDialerService.removeIncomingCallDetectedListener(onIncomingCallDetected); // Observe that there is no 'IncomingCallDetected' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeOffHookListener

(
  • handler
)
Void

Removes listeners from OffHook event.

Parameters:

  • handler Function

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

Returns:

Void:

removePhoneHookFlashListener

(
  • handler
)
Void

Removes listeners from PhoneHookFlash event.

Parameters:

  • handler Function

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

Returns:

Void:

removeSelectedDialerChangedListener

(
  • handler
)
Void

Removes listeners from SelectedDialerChanged 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 SelectedDialerChanged event.
var onSelectedDialerChanged = function(dialer) {
    alert("Selected dialer changed.");
};

var connectionSuccededCallback = function() {
    // Adds listener to SelectedDialerChanged event.
    connector.autoDialerService.addSelectedDialerChangedListener(onSelectedDialerChanged);

    // Removes SelectedDialerChanged listener in 5 seconds.
    setTimeout(function (){
        connector.autoDialerService.removeSelectedDialerChangedListener(onSelectedDialerChanged);
        alert("SelectedDialerChanged listener removed");
    }, 5000);
};

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

connector.activate(connectionSuccededCallback, connectionClosedCallback);

removeVoiceDetectedListener

(
  • handler
)
Void

Removes listeners to VoiceDetected 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:

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

var connector = new buildingLink.Connector();

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

// Handles VoiceDetected event.
var onVoiceDetected = function() {
    alert("Voice detected.");
};

var connectionSuccededCallback = function() {
    // Adds listener to VoiceDetected event.
    connector.autoDialerService.addVoiceDetectedListener(onVoiceDetected);

    // Removes listener to VoiceDetected event.
    connector.autoDialerService.removeVoiceDetectedListener(onVoiceDetected); // Observe that there is no 'VoiceDetected' alerts during the following call.

    // Starts dialing on selected dialer.
    connector.autoDialerService.dialAsync("123456789").then(function (startDialStatus) {
        // Handle startDialStatus.
    }, failureDialHandler);
};

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

startListeningToEventsAsync

() Promise | Boolean async

Starts listning to dialer events. Captures exclusive acces to auto dialer.

Returns:

Promise | Boolean:

A promise of the result.

stopListeningToEvents

() Promise | Void async

Stops listning to dialer events.

Returns:

Promise | Void:

A promise of the result.