Class EasyCallControlFactory

Enables the creation of ISingleCallControl and IMultiCallControl objects which offer easy call control functionality on a specific connection that belongs on a specific device.

Remarks

Compared to the regular Call Control module, Easy Call Control automates device signal handling and command sequences.

A CallControlFactory is initialized by passing in softphone information and the core IApi interface. It can then be used to create ICallControl instances.

Methods

createMultiCallControl createSingleCallControl supportsEasyCallControl

Methods

createMultiCallControl

  • createMultiCallControl(
        device: IDevice,
        initialState?: IMultiInitialState,
    ): Promise<IMultiCallControl>

  • Creates a IMultiCallControl instance for a given device, enabling multi-call-control functionality.

    Parameters

    • device: IDevice

      an SDK device from which the call-control device will be constructed.

    • OptionalinitialState: IMultiInitialState

      An optional parameter, which sets the initial state of the created object. Use it when handling device changes.

    Returns Promise<IMultiCallControl>

    a Promise which emits a new IMultiCallControl.

    Remarks

    This includes APIs for setting a device on hold and handle multiple ongoing calls.

    If you do not need to handle multiple ongoing calls, we advise you to use the SingleCallControl interface instead - see method createSingleCallControl

createSingleCallControl

  • createSingleCallControl(
        device: IDevice,
        initialState?: ISingleInitialState,
    ): Promise<ISingleCallControl>

  • Creates a device with single-call-control functionality.

    Parameters

    • device: IDevice

      an SDK device from which the call-control device will be constructed.

    • OptionalinitialState: ISingleInitialState

      An optional parameter, which sets the initial state of the created object. Use it when handling device changes.

    Returns Promise<ISingleCallControl>

    a Promise which emits a new ISingleCallControl.

    Remarks

    This is a simple interface only containing the basic functionality for handling easy call control.

    If you wish to handle multiple calls and being able to set a call on hold, we advise you to use the MultiCallControl interface instead - see method createMultiCallControl

supportsEasyCallControl

  • supportsEasyCallControl(potentialDevice: IDevice): boolean

  • Verifies whether a device supports easy call control or not.

    Parameters

    Returns boolean

    true if the device has a connection that has support for any call control functionality, false otherwise.

Settings

Member Visibility

On This Page

Methods