Class Client

Цей клас Client розширює EventEmitter, який використовується для керування подіями, що описані в інтерфейсі ClientEvents. Він має декілька полів для збереження стану клієнта, таких як agent, phone, lastError, lastLatency, а також деякі приватні поля для внутрішнього використання, такі як socket, connectionInfo, reqSeq, queueRequest, log, eventHandler, callStore, conversationStore, pingTimer, та toneTimer. Конструктор класу приймає конфігураційні параметри, які використовуються для ініціалізації клієнта.

Hierarchy

Constructors

constructor

Properties

[$listeners] _config agent lastError lastLatency phone? ev

Accessors

autoAnswerDelayTime buildVersion instanceId version

Methods

[$addListener] _onEventHandled? _onEventUnhandled? agentActiveTasks agentSession agentSetOffline agentSetOnline agentSetPause agentSetWaiting allCall allConversations allJob allTask answer auth call callById callBySipId callDestroyed callRecordId connect conversationById conversationDestroyed destroy destroyConversation deviceConfig disconnect eavesdrop emit fileUrlDownload fileUrlStream getTask handleError invite inviteToUser listeners off on one phoneIsRegister ping registerCallClient reportingChannelTask reportingTask request sessionInfo storeFile subscribeAgentsStatus subscribeCall subscribeChat subscribeJob subscribePhone subscribeTask subscribeUsersStatus unSubscribe useWebPhone count has keys unhandle

Constructors

constructor

  • new Client(_config): Client

  • Конструктор для створення екземпляра клієнта.

    Parameters

    • _config: Config

      Конфігураційні параметри клієнта.

    Returns Client

Properties

[$listeners]

[$listeners]: {
    call_hangup: undefined | IListenerList<ClientEvents, "call_hangup">;
    call_receive: undefined | IListenerList<ClientEvents, "call_receive">;
    connected: undefined | IListenerList<ClientEvents, "connected">;
    disconnected: undefined | IListenerList<ClientEvents, "disconnected">;
    error: undefined | IListenerList<ClientEvents, "error">;
    phone_connected: undefined | IListenerList<ClientEvents, "phone_connected">;
    phone_registered: undefined | IListenerList<ClientEvents, "phone_registered">;
    refresh_missed: undefined | IListenerList<ClientEvents, "refresh_missed">;
    sdp: undefined | IListenerList<ClientEvents, "sdp">;
    show_message: undefined | IListenerList<ClientEvents, "show_message">;
}

Protected Readonly_config

_config: Config

Конфігураційні параметри клієнта.

agent

agent: Agent

lastError

lastError: null | Error

lastLatency

lastLatency: null | number

Optionalphone

phone?: SipClient

Static Readonlyev

ev: symbol

Unique symbol for accessing the internal listener cache

Accessors

autoAnswerDelayTime

buildVersion

instanceId

version

Methods

Protected[$addListener]

  • [$addListener](arg, fn?, disposables?, once?): Client | ((...args:
        | []
        | [e: Error]
        | [code: number, err: null | Error]
        | [sock: string, ev: SdpEvent]
        | [call: Call]
        | [call: Call]
        | [registered: boolean]
        | [connected: boolean]
        | [ev: object]
        | [ev: MessageNotification]) => void)

  • Implementation of the on and one methods

    Parameters

    • arg: EventKey<ClientEvents> | Partial<{
          call_hangup: ((...args: [call: Call]) => void);
          call_receive: ((...args: [call: Call]) => void);
          connected: ((...args: []) => void);
          disconnected: ((...args: [code: number, err: null | Error]) => void);
          error: ((...args: [e: Error]) => void);
          phone_connected: ((...args: [connected: boolean]) => void);
          phone_registered: ((...args: [registered: boolean]) => void);
          refresh_missed: ((...args: [ev: object]) => void);
          sdp: ((...args: [sock: string, ev: SdpEvent]) => void);
          show_message: ((...args: [ev: MessageNotification]) => void);
      }>
    • Optionalfn: ((...args:
          | []
          | [e: Error]
          | [code: number, err: null | Error]
          | [sock: string, ev: SdpEvent]
          | [call: Call]
          | [call: Call]
          | [registered: boolean]
          | [connected: boolean]
          | [ev: object]
          | [ev: MessageNotification]) => void)
        • (...args): void

        • Parameters

          • Rest...args:
                | []
                | [e: Error]
                | [code: number, err: null | Error]
                | [sock: string, ev: SdpEvent]
                | [call: Call]
                | [call: Call]
                | [registered: boolean]
                | [connected: boolean]
                | [ev: object]
                | [ev: MessageNotification]

          Returns void

    • Optionaldisposables: Disposable[]
    • Optionalonce: boolean

    Returns Client | ((...args:
        | []
        | [e: Error]
        | [code: number, err: null | Error]
        | [sock: string, ev: SdpEvent]
        | [call: Call]
        | [call: Call]
        | [registered: boolean]
        | [connected: boolean]
        | [ev: object]
        | [ev: MessageNotification]) => void)

Protected Optional_onEventHandled

  • _onEventHandled(key): void

  • Called when an event goes from 0 -> 1 listeners

    Parameters

    • key: string

    Returns void

Protected Optional_onEventUnhandled

  • _onEventUnhandled(key): void

  • Called when an event goes from 1 -> 0 listeners

    Parameters

    • key: string

    Returns void

agentActiveTasks

  • agentActiveTasks(agentId): Promise<object>

  • Parameters

    • agentId: number

    Returns Promise<object>

agentSession

agentSetOffline

  • agentSetOffline(agentId): Promise<object>

  • Parameters

    • agentId: number

    Returns Promise<object>

agentSetOnline

  • agentSetOnline(agentId, channels, onDemand): Promise<object>

  • Parameters

    • agentId: number
    • channels: string[]
    • onDemand: boolean

    Returns Promise<object>

agentSetPause

  • agentSetPause(agentId, payload?): Promise<object>

  • Parameters

    • agentId: number
    • Optionalpayload: any

    Returns Promise<object>

agentSetWaiting

  • agentSetWaiting(agentId, channel): Promise<object>

  • Parameters

    • agentId: number
    • channel: string

    Returns Promise<object>

allCall

allConversations

allJob

allTask

answer

auth

call

callById

callBySipId

callDestroyed

callRecordId

connect

conversationById

conversationDestroyed

destroy

destroyConversation

deviceConfig

  • deviceConfig(name?): Promise<object>

  • Parameters

    • Optionalname: string

    Returns Promise<object>

disconnect

eavesdrop

emit

  • emit<K>(key, ...args): void | Out<ClientEvents[K]>

  • Call the listeners of an event

    Type Parameters

    Parameters

    Returns void | Out<ClientEvents[K]>

fileUrlDownload

fileUrlStream

getTask

handleError

invite

inviteToUser

listeners

  • listeners<K>(key): IterableIterator<((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)>

  • Iterate over the listeners of an event

    Type Parameters

    Parameters

    • key: K

    Returns IterableIterator<((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)>

off

  • off<K>(key, fn?): this

  • Remove one or all listeners of an event

    Type Parameters

    Parameters

    Returns this

  • off(key): this

  • Remove all listeners from all events

    Parameters

    • key: "*"

    Returns this

on

  • on<K>(key, fn, disposables?): ((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)

  • Add a recurring listener

    Type Parameters

    Parameters

    Returns ((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)

  • on(map, disposables?): this

  • Add many recurring listeners

    Parameters

    • map: Partial<{
          call_hangup: ((...args: [call: Call]) => void);
          call_receive: ((...args: [call: Call]) => void);
          connected: ((...args: []) => void);
          disconnected: ((...args: [code: number, err: null | Error]) => void);
          error: ((...args: [e: Error]) => void);
          phone_connected: ((...args: [connected: boolean]) => void);
          phone_registered: ((...args: [registered: boolean]) => void);
          refresh_missed: ((...args: [ev: object]) => void);
          sdp: ((...args: [sock: string, ev: SdpEvent]) => void);
          show_message: ((...args: [ev: MessageNotification]) => void);
      }>
    • Optionaldisposables: Disposable[]

    Returns this

one

  • one<K>(key, fn): ((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)

  • Add a one-time listener

    Type Parameters

    Parameters

    Returns ((...args: In<ClientEvents[K]>) => void | Out<ClientEvents[K]>)

  • one(map): this

  • Add many one-time listeners

    Parameters

    • map: Partial<{
          call_hangup: ((...args: [call: Call]) => void);
          call_receive: ((...args: [call: Call]) => void);
          connected: ((...args: []) => void);
          disconnected: ((...args: [code: number, err: null | Error]) => void);
          error: ((...args: [e: Error]) => void);
          phone_connected: ((...args: [connected: boolean]) => void);
          phone_registered: ((...args: [registered: boolean]) => void);
          refresh_missed: ((...args: [ev: object]) => void);
          sdp: ((...args: [sock: string, ev: SdpEvent]) => void);
          show_message: ((...args: [ev: MessageNotification]) => void);
      }>

    Returns this

phoneIsRegister

ping

registerCallClient

reportingChannelTask

reportingTask

  • reportingTask(attemptId, reporting): Promise<object>

  • Parameters

    • attemptId: number
    • reporting: Reporting

    Returns Promise<object>

request

  • request(action, data?): Promise<object>

  • Parameters

    • action: string
    • Optionaldata: object

    Returns Promise<object>

sessionInfo

storeFile

subscribeAgentsStatus

subscribeCall

subscribeChat

subscribeJob

subscribePhone

subscribeTask

subscribeUsersStatus

unSubscribe

useWebPhone

Staticcount

  • count<T>(ee, key): number

  • Count the number of listeners for an event

    Type Parameters

    • T

    Parameters

    • ee: EventEmitter<T>
    • key: EventKey<T>

    Returns number

Statichas

  • has<T>(ee, key): boolean

  • Check if an event has listeners

    Type Parameters

    • T

    Parameters

    • ee: EventEmitter<T>
    • key: EventKey<T> | "*"

    Returns boolean

Statickeys

  • keys<T>(ee): EventKey<T>[]

  • Get an array of event keys that have listeners

    Type Parameters

    • T

    Parameters

    • ee: EventEmitter<T>

    Returns EventKey<T>[]

Staticunhandle

  • unhandle<T, K>(ee, key, impl, disposables?): ((...args: In<T[K]>) => void | Out<T[K]>)

  • Call the given listener when no other listeners exist

    Type Parameters

    • T
    • K extends string

    Parameters

    • ee: EventEmitter<T>
    • key: K
    • impl: ((...args: In<T[K]>) => void | Out<T[K]>)
        • (...args): void | Out<T[K]>

        • Parameters

          • Rest...args: In<T[K]>

          Returns void | Out<T[K]>

    • Optionaldisposables: Disposable[]

    Returns ((...args: In<T[K]>) => void | Out<T[K]>)

      • (...args): void | Out<T[K]>

      • Parameters

        • Rest...args: In<T[K]>

        Returns void | Out<T[K]>

Settings

Member Visibility

On This Page

constructor[$listeners]_configagentlastErrorlastLatencyphoneevautoAnswerDelayTimebuildVersioninstanceIdversion[$addListener]_onEventHandled_onEventUnhandledagentActiveTasksagentSessionagentSetOfflineagentSetOnlineagentSetPauseagentSetWaitingallCallallConversationsallJoballTaskanswerauthcallcallByIdcallBySipIdcallDestroyedcallRecordIdconnectconversationByIdconversationDestroyeddestroydestroyConversationdeviceConfigdisconnecteavesdropemitfileUrlDownloadfileUrlStreamgetTaskhandleErrorinviteinviteToUserlistenersoffononephoneIsRegisterpingregisterCallClientreportingChannelTaskreportingTaskrequestsessionInfostoreFilesubscribeAgentsStatussubscribeCallsubscribeChatsubscribeJobsubscribePhonesubscribeTasksubscribeUsersStatusunSubscribeuseWebPhonecounthaskeysunhandle