AutoSummaryService | nice-cxone-acd-agent-apps

web socket class for auto summary

Hierarchy

WebsocketClient
- AutoSummaryService

Constructors

constructor

new AutoSummaryService(): AutoSummaryService

Inherited from WebsocketClient.constructor
Returns AutoSummaryService

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

attemptReconnect(reconnectInfo: WsReconnectInfo, wsWorker?: any): void

Inherited from WebsocketClient.attemptReconnect
- Defined in core-sdk/src/lib/ws/websocket-client.ts:48
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

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:331
Use to attempt to reconnect to the web socket worker
example
```
this.attemptToReconnect();
```
Returns void

broadcastAutoSummary

broadcastAutoSummary(message: any): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:103
used to broadcast the message to other tabs.
example
- broadcastAutoSummary();
Parameters
- message: any
  
  message to broadcast
Returns void

checkWSEvent

checkWSEvent(wsResponse: WsResponse): void

Inherited from WebsocketClient.checkWSEvent
- Defined in core-sdk/src/lib/ws/websocket-client.ts:118
This method to perform the different actions on callback response
example
```
checkWSEvent(event);
```
Parameters
- wsResponse: WsResponse
Returns void

close

close(): void

Overrides WebsocketClient.close
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:87
used to unsubscribe events and clear props.
example
- close()
Returns void

connect

connect(websocketServerUri: string): boolean

Overrides WebsocketClient.connect
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:135
used to connect to the socket.
example
- connect();
Parameters
- websocketServerUri: string
  
  websocketServer uri
Returns boolean

disconnectWebsocket

disconnectWebsocket(): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:175
used to unsubscribe and disconnect to socket events.
example
- disconnectWebsocket();
Returns void

Private initWebSocketWorker

initWebSocketWorker(): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:319
Use to initializing the web socket worker and will return the method inside the worker
example
```
this.initWebSocketWorker();
```
Returns void

Protected onClosed

onClosed(): void

Overrides WebsocketClient.onClosed
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:277
callback for when the socket closed.
example
- onClosed();
Returns void

Protected onError

onError(): void

Overrides WebsocketClient.onError
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:263
callback for when error received
example
- onError();
Returns void

Protected onMessage

onMessage(responseMessage: any): void

Overrides WebsocketClient.onMessage
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:208
callback for when message received
example
- onMessage(msg);
Parameters
- responseMessage: any
Returns void

Protected onOpen

onOpen(): void

Overrides WebsocketClient.onOpen
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:285
Callback method when a connection is open and ready to send and receive data
example
- onOpen()
Returns void

Protected onReconnect

onReconnect(_msg: any): void

Overrides WebsocketClient.onReconnect
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:300
Callback method when a ws reconnect attempts in progress
example
- this.onReconnect()
Parameters
- _msg: any
Returns void

Protected onReconnectComplete

onReconnectComplete(): void

Overrides WebsocketClient.onReconnectComplete
- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:308
Callback method when a ws reconnect attempts are completed
example
- this.onReconnectComplete()
Returns void

Protected onReconnectSuccess

onReconnectSuccess(): void

Inherited from WebsocketClient.onReconnectSuccess
- Defined in core-sdk/src/lib/ws/websocket-client.ts:106
Callback method when a ws reconnect attempts was successful
example
- this.onReconnectSuccess()
Returns void

reconnectWebsocket

reconnectWebsocket(): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:152
used to Reconnect to the socket.
example
- reConnectToSocket();
Returns void

Protected sendHeartbeat

sendHeartbeat(): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:197
used to send heart beat to socket.
example
- sendHeartbeat();
Returns void

sendMessage

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

Inherited from WebsocketClient.sendMessage
- Defined in core-sdk/src/lib/ws/websocket-client.ts:64
Method to send to websocket worker
example
```
sendMessage('hi');
```
Parameters
- msg: unknown
  
  message send to websocket
- wsWorker: any
Returns void

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

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:47
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

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:186
used to subscribe to socket events.
example
- subscribeToSocket('');
Parameters
- topic: string
  
  topic to subscribe
Returns boolean

terminateWebSocketWorker

terminateWebSocketWorker(): void

- Defined in agent-sdk/src/lib/auto-summary/auto-summary-service.ts:164
Use to terminate the web socket worker
example
```
this.terminateWebSocketWorker();
```
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AutoSummaryService

Properties

IsSubscribeDummyResponse

Private WS_INTERVAL_HEARTBEAT

auth

Private autoSummaryInput

Type declaration

contactId: string

subscriptions: string[]

webSocketUri: string

Private connectionId

Private contactId

Private hearbeatSubscription

Private hearbeatTimer

logger

onAutoSummaryReceived

Private subscriptions

Private websocketUri

wssWorker

Methods

attemptReconnect

Parameters

reconnectInfo: WsReconnectInfo

Optional wsWorker: any

Returns void

Private attemptToReconnect

Returns void

broadcastAutoSummary

Parameters

message: any

Returns void

checkWSEvent

Parameters

wsResponse: WsResponse

Returns void

close

Returns void

connect

Parameters

websocketServerUri: string

Returns boolean

disconnectWebsocket

Returns void

Private initWebSocketWorker

Returns void

Protected onClosed

Returns void

Protected onError

Returns void

Protected onMessage

Parameters

responseMessage: any

Returns void

Protected onOpen

Returns void

Protected onReconnect

Parameters

_msg: any

Returns void

Protected onReconnectComplete

Returns void

Protected onReconnectSuccess

Returns void

reconnectWebsocket

Returns void

Protected sendHeartbeat

Returns void

sendMessage

Parameters

msg: unknown

wsWorker: any

Returns void

subscribe