Interface IEasyCallControlBase

Base interface containing APIs shared between ISingleCallControl and IMultiCallControl.

interface IEasyCallControlBase {
    device: IDevice;
    muteState: Observable<MuteState>;
    onDisconnect: Observable<void>;
    ringState: Observable<boolean>;
    endCall(): Promise<void>;
    mute(): Promise<void>;
    mute(): void;
    rejectIncomingCall(): void;
    signalIncomingCall(ringTimeout?: number): Promise<boolean>;
    startCall(): Promise<void>;
    teardown(): void;
    unmute(): void;
}

Hierarchy (View Summary)

Methods

endCall mute rejectIncomingCall signalIncomingCall startCall teardown unmute

Properties

device muteState onDisconnect ringState

Methods

endCall

  • endCall(): Promise<void>

  • Ends the current call.

    Returns Promise<void>

    Throws

    If a call is not active.

mute

  • mute(): Promise<void>

  • Mutes the device.

    Returns Promise<void>

    Remarks

    You can only change the mute state while the device is in an active call.

    Throws

    If a call is not active.

  • mute(): void

  • Mute the device.

    Returns void

    Throws

    If a call is not active.

    Deprecated

    Return type has changed. Now it returns Promise<void> instead of void. Nevertheless, the API will still work without awaiting.

rejectIncomingCall

  • rejectIncomingCall(): void

  • Rejects an incoming call.

    Returns void

    Remarks

    The call can be rejected by the user by interacting with their device or with your softphone. In the first case, the incoming call will be automatically rejected and IEasyCallControlBase.signalIncomingCall will resolve with false. The second case requires your softphone to manually call this method, before the incoming call is rejected and IEasyCallControlBase.signalIncomingCall is resolved with false.

    Throws

    If an incoming call is not pending.

signalIncomingCall

  • signalIncomingCall(ringTimeout?: number): Promise<boolean>

  • Signals that there is an incoming call. The promise resolves only once the incoming call is either accepted or rejected.

    Parameters

    • OptionalringTimeout: number

      Optional parameter, determining how long before the incoming call is automatically rejected due to a timeout.

    Returns Promise<boolean>

    true if the call was accepted, and false if rejected.

    Remarks

    On most devices, this starts the device ringer.

    Throws

    If the device is locked by another softphone.

startCall

  • startCall(): Promise<void>

  • Sets the device into call state.

    Returns Promise<void>

    Throws

    If the device is used by another softphone.

teardown

  • teardown(): void

  • Teardown the Easy Call Control instance.

    All internal state subscriptions will be stopped to avoid potential memory leaks, and the internal call lock will be released if taken.

    After using this method, you must create a new Easy Call Control instance to continue usage.

    Returns void

    Remarks

    Use this when you want to stop using the ISingleCallControl or IMultiCallControl object but the connection to the device is still active (e.g. when changing device or navigating between views).

unmute

  • unmute(): void

  • Unmutes the device.

    Returns void

    Remarks

    You can only change the mute state while the device is in an active call.

    Throws

    If a call is not active.

Properties

Readonlydevice

device: IDevice

The single physical device to which the easy call control functionalities are associated to.

muteState

muteState: Observable<MuteState>

Emits the mute state of the device whenever that state changes.

Remarks

This can happen due to interaction with the device (e.g. raising the boom arm) or due to interaction with your softphone (e.g. pressing a mute button in the GUI).

ReadonlyonDisconnect

onDisconnect: Observable<void>

Emits when the connection used for easy call control gets disconnected.

Remarks

If this observable emits, the connection and thus the Easy Call Control instance can no longer be used.

If this happens, for example, in the middle of a call, you can select a new device (or the same device with another connection) and recover the state. See ISingleInitialState or IMultiInitialState and for examples refer to the 'Easy Call Control' chapter of the 'Managing Calls' section of the JavaScript Developer's Guide.

ringState

ringState: Observable<boolean>

Emits the ring state of the device whenever that state changes.

Remarks

This can happen whenever a new incoming call is signalled, and whenever that incoming call is accepted or rejected.

Settings

Member Visibility

On This Page

Methods
Properties