Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoSummaryService

web socket class for auto summary

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

IsSubscribeDummyResponse

IsSubscribeDummyResponse: boolean = true

Private WS_INTERVAL_HEARTBEAT

WS_INTERVAL_HEARTBEAT: number = 10000

auth

auth: CXoneAuth = CXoneAuth.instance

Private autoSummaryInput

autoSummaryInput: { contactId: string; subscriptions: string[]; webSocketUri: string } = ...

Type declaration

  • contactId: string
  • subscriptions: string[]
  • webSocketUri: string

Private connectionId

connectionId: string = ''

Private contactId

contactId: string = '0'

Private hearbeatSubscription

hearbeatSubscription: Subscription

Private hearbeatTimer

hearbeatTimer: Observable<number>

logger

logger: Logger = ...

onAutoSummaryReceived

onAutoSummaryReceived: Subject<AutoSummaryBroadcastData> = ...

used to send emitted websocket events data.

Private subscriptions

subscriptions: string[] = []

Private websocketUri

websocketUri: string = ''

wssWorker

wssWorker: any

Methods

attemptReconnect

  • example
    attemptReconnect({reconnectInterval: 300, reconnectAttempts:4});

    Parameters

    • reconnectInfo: WsReconnectInfo

      reconnectIntervalInMs in millisecond, maxReconnectAttempts in number and ws url

    • Optional wsWorker: any

    Returns void

Private attemptToReconnect

  • attemptToReconnect(): void

  • Use to attempt to reconnect to the web socket worker

    example
    this.attemptToReconnect();

    Returns void

broadcastAutoSummary

  • broadcastAutoSummary(message: any): void

  • used to broadcast the message to other tabs.

    example
    • broadcastAutoSummary();

    Parameters

    • message: any

      message to broadcast

    Returns void

checkWSEvent

close

  • close(): void

  • used to unsubscribe events and clear props.

    example
    • close()

    Returns void

connect

  • connect(websocketServerUri: string): boolean

  • used to connect to the socket.

    example
    • connect();

    Parameters

    • websocketServerUri: string

      websocketServer uri

    Returns boolean

disconnectWebsocket

  • disconnectWebsocket(): void

  • used to unsubscribe and disconnect to socket events.

    example
    • disconnectWebsocket();

    Returns void

Private initWebSocketWorker

  • initWebSocketWorker(): void

  • Use to initializing the web socket worker and will return the method inside the worker

    example
    this.initWebSocketWorker();

    Returns void

Protected onClosed

  • onClosed(): void

Protected onError

  • onError(): void

Protected onMessage

  • onMessage(responseMessage: any): void

  • callback for when message received

    example
    • onMessage(msg);

    Parameters

    • responseMessage: any

    Returns void

Protected onOpen

  • onOpen(): void

  • Callback method when a connection is open and ready to send and receive data

    example
    • onOpen()

    Returns void

Protected onReconnect

  • onReconnect(_msg: any): void

  • Callback method when a ws reconnect attempts in progress

    example
    • this.onReconnect()

    Parameters

    • _msg: any

    Returns void

Protected onReconnectComplete

  • onReconnectComplete(): void

Protected onReconnectSuccess

  • onReconnectSuccess(): void

reconnectWebsocket

  • reconnectWebsocket(): void

  • used to Reconnect to the socket.

    example
    • reConnectToSocket();

    Returns void

Protected sendHeartbeat

  • sendHeartbeat(): void

  • used to send heart beat to socket.

    example
    • sendHeartbeat();

    Returns void

sendMessage

  • sendMessage(msg: unknown, wsWorker: any): void

  • Method to send to websocket worker

    example
    sendMessage('hi');

    Parameters

    • msg: unknown

      message send to websocket

    • wsWorker: any

    Returns void

subscribe

  • subscribe(autoSummaryInput: { contactId: string; subscriptions: string[]; webSocketUri: string }): void

  • Used to open the webSocket data and subscribe to it.

    example
    subscribe();
    @param webSocketUri - webSocketUri for auto summary
    @param contactId - contactId for auto summary
    @param subscriptions - subscriptions for auto summary

    Parameters

    • autoSummaryInput: { contactId: string; subscriptions: string[]; webSocketUri: string }
      • contactId: string
      • subscriptions: string[]
      • webSocketUri: string

    Returns void

Protected subscribeToSocket

  • subscribeToSocket(topic: string): boolean

  • used to subscribe to socket events.

    example
    • subscribeToSocket('');

    Parameters

    • topic: string

      topic to subscribe

    Returns boolean

terminateWebSocketWorker

  • terminateWebSocketWorker(): void

  • Use to terminate the web socket worker

    example
    this.terminateWebSocketWorker();

    Returns void

Generated using TypeDoc