Class WSProvider

This is the base class for WSProvider

Hierarchy

WebsocketClient
- WSProvider

Constructors

constructor

new WSProvider(directory: CXoneDynamicDirectory): WSProvider

Overrides WebsocketClient.constructor
Create instance for dynamic directory WSProvider
example
```
new WSProvider(CXoneDynamicDirectory);
```
Parameters
- directory: CXoneDynamicDirectory
  
  Instance of CXoneDynamicDirectory class
Returns WSProvider

Properties

Private auth

auth: CXoneAuth

Private connected

connected: boolean = false

Private dynamicDirectory

dynamicDirectory: CXoneDynamicDirectory

Private heartbeatTimer

heartbeatTimer: any

Private logger

logger: Logger = ...

Private subscribed

subscribed: boolean = false

Private wsService

wsService: WSService = ...

wsWorker

wsWorker: 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

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(): void

Overrides WebsocketClient.close
Use to close the web socket worker
example
```
this.close();
```
Returns void

connect

connect(websocketUrl: string, wsWorker?: any): void

Inherited from WebsocketClient.connect
This function used to make connection with websocket server
example
```
connect('ws://localhost:8089');
```
Parameters
- websocketUrl: string
- Optional wsWorker: any
Returns void

connectSocket

connectSocket(): void

Method used to connect the WebSocket
example
```
this.connectSocket();
```
Returns void

initAgentStateSocketWorker

initAgentStateSocketWorker(): any

Use to initializing the web socket worker and will return the method inside the worker
example
```
this.initAgentStateSocketWorker();
```
Returns any

Protected onClosed

onClosed(): void

Overrides WebsocketClient.onClosed
Used to receive WebSocket connection closed
example
```
onClosed();
```
Returns void

Protected onError

onError(): void

Overrides WebsocketClient.onError
Method used to receive the WebSocket Error and ReConnect the WebSocket
example
```
onError();
```
Returns void

Protected onMessage

onMessage(msg: DynamicDirectoyMessage): DynamicDirectoyMessage

Overrides WebsocketClient.onMessage
Method used to receive message from WebSocket
example
```
onMessage(msg);
```
Parameters
- msg: DynamicDirectoyMessage
  
  WebSocket Messages exchange format
Returns DynamicDirectoyMessage

Protected onOpen

onOpen(): void

Overrides WebsocketClient.onOpen
Method used to send message websocket worker
example
```
onOpen();
```
Returns void

Protected onReconnect

onReconnect(msg?: WsReconnectResponse): void

Overrides WebsocketClient.onReconnect
Method used to reconnect the WebSocket
example
```
onReconnect(msg);
```
Parameters
- Optional msg: WsReconnectResponse
  
  Websocket Reconnect response
Returns void

Protected onReconnectComplete

onReconnectComplete(): void

Overrides WebsocketClient.onReconnectComplete
Method used to receive ws reconnect attempts are completed
example
```
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

Private runHeartbeat

runHeartbeat(): void

Use to start heartbeat comment for websocket
example
```
this.runHeartbeat();
```
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

subscribeSearch

subscribeSearch(subscriptionId: string): void

Use to subscribe to search results
example
```
this.subscribeSearch(subscriptionId);
```
Parameters
- subscriptionId: string
Returns void

unsubscribeSearch

unsubscribeSearch(subscriptionId: string): void

Use to unsubscribe from websocket
example
```
this.unsubscribeSearch(subscriptionID);
```
Parameters
- subscriptionId: string
Returns void

Generated using TypeDoc