Class WSService

This is the base class for WebSocket Service

Hierarchy

WSService

Index

Constructors

constructor

Properties

auth

Methods

Constructors

constructor

new WSService(): WSService

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:17
Create instance for websocket service
example
```
new WSService();
```
Returns WSService

Properties

Private auth

auth: CXoneAuth

Methods

getConnectedMessage

getConnectedMessage(): DynamicDirectoyMessage

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:118
Method used to get connected message
example
```
getConnectedMessage();
```
Returns DynamicDirectoyMessage
- return the websocket request

getConnectionMessage

getConnectionMessage(type: string): WsRequest

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:29
Method used to get connection message with access token
example
```
this.getConnectionMessage('heartbeat');
```
Parameters
- type: string
Returns WsRequest
- return the websocket request

getErrorMessage

getErrorMessage(errorMessage: string): DynamicDirectoyMessage

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:137
Method used to get error message with error message
example
```
getErrorMessage('error message');
```
Parameters
- errorMessage: string
Returns DynamicDirectoyMessage
- return the error message

getReconnectedMessage

getReconnectedMessage(): DynamicDirectoyMessage

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:99
Method used to get reconnected message with access token
example
```
getReconnectedMessage();
```
Returns DynamicDirectoyMessage
- return the websocket request

getSubscriptionMessage

getSubscriptionMessage(subscriptionId: string): WsRequest

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:55
Method used to get subscribe message with subscriptionId
example
```
getSubscriptionMessage(subscriptionId);
```
Parameters
- subscriptionId: string
Returns WsRequest
- return the websocket subscription request

getUnsubscribeMessage

getUnsubscribeMessage(subscriptionId: string): WsRequest

- Defined in agent-sdk/src/lib/dynamic-directory/service/ws-service.ts:77
Method used to get unsubscribe from web socket
example
```
getUnsubscribeMessage(subscriptionId);
```
Parameters
- subscriptionId: string
Returns WsRequest
- return the websocket unsubscribe request

Generated using TypeDoc