Class AgentAssistNotificationService Abstract

web socket base class for Agent assist notification

Hierarchy

WebsocketClient
- AgentAssistNotificationService
  - CopilotNotificationClient
  - AutoSummaryNotificationService

Constructors

constructor

new AgentAssistNotificationService(): AgentAssistNotificationService

Inherited from WebsocketClient.constructor
Returns AgentAssistNotificationService

Properties

IsSubscribeDummyResponse

IsSubscribeDummyResponse: boolean = true

Protected agentAssistInput

agentAssistInput: AgentAssistInput = empytyAgentAssistInput

auth

auth: CXoneAuth = CXoneAuth.instance

Protected connectionId

connectionId: string = ''

Private contactId

contactId: number = 0

logger

logger: Logger

reconnectAttemptSource

reconnectAttemptSource: "fromOnError" | "fromOnClosed" = null

Protected subscriptions

subscriptions: 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/agent-assist/agent-assist-notification-service.ts:233
Use to attempt to reconnect to the web socket worker
example
```
this.attemptToReconnect();
```
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/agent-assist/agent-assist-notification-service.ts:60
used to unsubscribe events and clear props.
example
- close()
Returns void

connect

connect(websocketServerUri: string, providerId?: string): boolean

Overrides WebsocketClient.connect
- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:75
used to connect to the socket.
example
- connect();
Parameters
- websocketServerUri: string
  
  websocketServer uri
- providerId: string = 'Agent-Assist'
Returns boolean

disconnectWebsocket

disconnectWebsocket(): void

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

Protected initLogger

initLogger(providerId: string): void

- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:222
Use to initializing the web socket worker and will return the method inside the worker
example
```
this.initLogger('ccai');
```
Parameters
- providerId: string
  
  AAH provider
Returns void

Protected initWebSocketWorker

initWebSocketWorker(providerId: string): void

- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:188
Use to initializing the web socket worker and will return the method inside the worker
example
```
this.initWebSocketWorker();
```
Parameters
- providerId: string
Returns void

Protected onClosed

onClosed(): void

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

Protected onError

onError(): void

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

Protected Abstract onMessage

onMessage(responseMessage: any): void

Overrides WebsocketClient.onMessage
- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:54
function to recieve websocket messages

example
Parameters
- responseMessage: any
  
  message
Returns void

Protected onOpen

onOpen(): void

Overrides WebsocketClient.onOpen
- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:160
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/agent-assist/agent-assist-notification-service.ts:169
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/agent-assist/agent-assist-notification-service.ts:177
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/agent-assist/agent-assist-notification-service.ts:87
used to Reconnect to the socket.
example
- reConnectToSocket();
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

Abstract subscribe

subscribe(agentAssistInput: AgentAssistInput): boolean

- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:46
Used to open the webSocket data and subscribe to it.
example
```
subscribe();
@param agentAssistInput - input for subscribing to wwebscket comprising of webSocketUri,contactId, subscriptions & providerId
```
Parameters
- agentAssistInput: AgentAssistInput
Returns boolean

Protected subscribeToSocket

subscribeToSocket(topic: string): boolean

- Defined in agent-sdk/src/lib/agent-assist/agent-assist-notification-service.ts:123
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/agent-assist/agent-assist-notification-service.ts:100
Use to terminate the web socket worker
example
```
this.terminateWebSocketWorker();
```
Returns void

Generated using TypeDoc