Class AgentAssistWSService

web socket class for agent assist

Hierarchy

WebsocketClient
- AgentAssistWSService

Constructors

constructor

new AgentAssistWSService(): AgentAssistWSService

Overrides WebsocketClient.constructor
constructor for AgentAssistWSService
example
- new AgentAssistWSService();
Returns AgentAssistWSService

Properties

WS_INTERVAL_HEARTBEAT

WS_INTERVAL_HEARTBEAT: number = 10000

agentAssistProcessorService

agentAssistProcessorService: AgentAssistProcessorService = ...

connectionId

connectionId: string = ''

Private hearbeatSubscription

hearbeatSubscription: Subscription

Private hearbeatTimer

hearbeatTimer: Observable<number>

isWSConnected

isWSConnected: boolean = false

logger

logger: Logger

onMessageNotification

onMessageNotification: Subject<AgentAssistBaseResponse> = ...

Private serviceName

serviceName: string = 'agent-assist'

wssWorker

wssWorker: any

Methods

attemptReconnect

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

Inherited from WebsocketClient.attemptReconnect
example
```
attemptReconnect({reconnectInterval: 300, reconnectAttempts:4});
```
Parameters
- reconnectInfo: WsReconnectInfo
  
  reconnectIntervalInMs in millisecond, maxReconnectAttempts in number and ws url
- Optional wsWorker: any
Returns void

attemptToReSubscribe

attemptToReSubscribe(): void

Use to attempt to reconnect and resubscribe active topics to the web socket worker
example
```
this.attemptToReSubscribe();
```
Returns void

broadcastWSMessage

broadcastWSMessage(message: any): void

used to broadcast the acp messages to other tabs.
example
```
this.broadcastWSMessage(message);
```
Parameters
- message: any
  
  message to broadcast
Returns void

checkWSEvent

checkWSEvent(wsResponse: WsResponse): void

Inherited from WebsocketClient.checkWSEvent
This method to perform the different actions on callback response
example
```
checkWSEvent(event);
```
Parameters
- wsResponse: WsResponse
Returns void

close

close(wsWorker?: any): void

Inherited from WebsocketClient.close
This function used to close connection with websocket server
example
```
close();
```
Parameters
- Optional wsWorker: any
Returns void

closeWebsocket

closeWebsocket(): void

Use to close the web socket
example
```
this.closeWebsocket();
```
Returns void

connect

connect(websocketServerUri: string): void

Overrides WebsocketClient.connect
used to connect to the socket.
example
```
this.connect('ws://localhost:8080');
```
Parameters
- websocketServerUri: string
  
  websocketServer uri
Returns void

Private generateTopicForProvider

generateTopicForProvider(agentAssistWSInput: AgentAssistWSRequest | AgentAssistInput): string

generate topic for WebSocket for given provider ws input
example
```
const topic = this.generateTopicForProvider(agentAssistWSInput);
```
Parameters
- agentAssistWSInput: AgentAssistWSRequest | AgentAssistInput
  
  agent assist WebSocket input
Returns string

Protected initLogger

initLogger(className: string): void

Use to initializing the logger
example
```
this.initLogger('agent-assist');
```
Parameters
- className: string
  
  name of class for logger
Returns void

Protected initWebSocketWorker

initWebSocketWorker(workerName: string): void

Use to initializing the web socket worker and will return the method inside the worker
example
```
this.initWebSocketWorker();
```
Parameters
- workerName: string
Returns void

loadFeatureToggles

loadFeatureToggles(): Promise<void>

load feature toggles with Feature toggle service
example
```
this.loadFeatureToggles();
```
Returns Promise<void>

onClosed

onClosed(): void

Overrides WebsocketClient.onClosed
callback for when the socket closed.
example
```
onClosed();
```
Returns void

onError

onError(): void

Overrides WebsocketClient.onError
callback for when error received
```
@example -  onError();
```
Returns void

onMessage

onMessage(message: any): void

Overrides WebsocketClient.onMessage
on websocket message received
example
- this.onMessage(message);
Parameters
- message: any
  
  message
Returns void

Protected onOpen

onOpen(): void

Overrides WebsocketClient.onOpen
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
Callback method when a ws reconnect attempts in progress
example
- this.onReconnect()
Parameters
- _msg: any
Returns void

Protected onReconnectComplete

onReconnectComplete(): void

Overrides WebsocketClient.onReconnectComplete
Callback method when a ws reconnect attempts are completed
example
- this.onReconnectComplete()
Returns void

Protected onReconnectSuccess

onReconnectSuccess(): void

Inherited from WebsocketClient.onReconnectSuccess
Callback method when a ws reconnect attempts was successful
example
- this.onReconnectSuccess()
Returns void

parse

parse(response: any): AgentAssistBaseResponse

method to parse the response
example
```
this.parse(response);
```
Parameters
- response: any
  
  response
Returns AgentAssistBaseResponse

registerAgentAssistGetNextSubject

registerAgentAssistGetNextSubject(): Promise<void>

used to register subscription to the agentAssistGetNextEventSubject for getting the AgentAssist getnext event
example
```
this.registerAgentAssistGetNextSubject();
```
Returns Promise<void>

registerWebSocketCloseRequest

registerWebSocketCloseRequest(): Promise<void>

used to register subscription to the agentAssistWebSocketUnsubsribeSubject for unsubscribing topics for a contact Id
example
```
this.registerWebSocketCloseRequest();
```
Returns Promise<void>

registerWebSocketConnectionRequest

registerWebSocketConnectionRequest(): Promise<void>

used to register subscription to the agentAssistWSSubject for connect and subscribe to websocket
example
```
this.registerWebSocketConnectionRequest();
```
Returns Promise<void>

registerWebSocketOnMessageNotification

registerWebSocketOnMessageNotification(): void

used to register subscription to the websocket onMessageNotification subject
example
```
this.registerWebSocketOnMessageNotification();
```
Returns void

resubscribeAllActiveTopicsToWebSocket

resubscribeAllActiveTopicsToWebSocket(): Promise<void>

used to unsubscribe and disconnect to socket events.
example
- unsubscribeAllActiveTopicsFromtWebsocket();
Returns Promise<void>

sendHeartbeat

sendHeartbeat(): void

used to send heart beat to websocket
example
```
this.sendHeartbeat();
```
Returns void

sendMessage

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

Inherited from WebsocketClient.sendMessage
Method to send to websocket worker
example
```
sendMessage('hi');
```
Parameters
- msg: unknown
  
  message send to websocket
- wsWorker: any
Returns void

subscribe

subscribe(agentAssistWSInput: AgentAssistInput): boolean

Subscribe to websocket topic
example
```
this.subscribe('topic');
```
Parameters
- agentAssistWSInput: AgentAssistInput
Returns boolean

terminateWebSocketWorker

terminateWebSocketWorker(): void

Use to terminate the web socket worker
example
```
this.terminateWebSocketWorker();
```
Returns void

unsubscribeFromWebSocketForContactId

unsubscribeFromWebSocketForContactId(contactId: string, getNextDataForContactId: AgentAssistWSRequest[]): void

unsubscribe from websocket for a contact Id
example
```
this.unsubscribeFromWebSocketForContactId(contactId);
```
Parameters
- contactId: string
  
  contact Id
- getNextDataForContactId: AgentAssistWSRequest[]
  
  get next data for contact Id
Returns void

Generated using TypeDoc