Class UIQueueWsProvider

Class to connect UI Queue web socket

Hierarchy

UIQueueWsProvider

Constructors

constructor

new UIQueueWsProvider(): UIQueueWsProvider

constructor which sets agent session instance
example
```
UIQueueWsProvider();
```
Returns UIQueueWsProvider

Properties

Private adminService

adminService: AdminService

Private agentSession

agentSession: ACDSessionManager

Private baseUri

baseUri: string = ''

Private getNextEventAdapter

getNextEventAdapter: CXoneGetNextAdapter = ...

Private getkeepAlivePollingisActive

getkeepAlivePollingisActive: boolean = false

Private hearbeatPoller

hearbeatPoller: any

Private hubConnection

hubConnection: HubConnection

Private hubUrl

hubUrl: string = ''

Private isUIQueueDegraded

isUIQueueDegraded: boolean = false

Private keepAlivePollingWorker

keepAlivePollingWorker: any

Private loader

loader: LoadWorker = ...

Private logger

logger: Logger = ...

Private receivedEvents

receivedEvents: any = []

Protected utilService

utilService: HttpUtilService = ...

Static Private singleton

singleton: UIQueueWsProvider

Accessors

Static instance

get instance(): UIQueueWsProvider

The static method that controls the access to the singleton instance.
example
```
const uiQueueWsProvider = UIQueueWsProvider.instance();
```
Returns UIQueueWsProvider

Methods

Private addEventListeners

addEventListeners(userInfo: UserInfo): void

Method to add event listeners
example
```
addEventListeners(userInfo)
```
Parameters
- userInfo: UserInfo
  
  user info object
Returns void

connectAgent

connectAgent(userInfo: UserInfo, invokeSnapshot?: boolean): void

Method to establish connection
example
```
connectAgent(userInfo, invokeSnapshot)
```
Parameters
- userInfo: UserInfo
  
  user info object
- Optional invokeSnapshot: boolean
  
  flag to invoke snapshot request
Returns void

disconnectConsumerAgent

disconnectConsumerAgent(): void

Method to disconnectAgent
example
```
disconnectConsumerAgent()
```
Returns void

establishSocketConnection

establishSocketConnection(userInfo: UserInfo, invokeSnapshot?: boolean): Promise<void>

Method to establish connection
example
```
establishSocketConnection(userInfo, invokeSnapshot)
```
Parameters
- userInfo: UserInfo
  
  user info object
- invokeSnapshot: boolean = false
  
  flag to invoke snapshot request
Returns Promise<void>

Private getInitialGetNextEvent

getInitialGetNextEvent(sessionId?: string): Promise<void>

Method to call the get-next API once (in order to flush the initial renew-state event from the agent state)
example
```
getInitialGetNextEvent('12345');
```
Parameters
- Optional sessionId: string
  
  sessionid
Returns Promise<void>
Promise that resolves when the API call is successful

Private handleReceivedEvents

handleReceivedEvents(events: {}): void

Method to add event listeners
example
```
handleReceivedEvents(events)
```
Parameters
- events: {}
  
  recieved events
  - [key: string]: string
Returns void

initAgentKeepAliveWorker

initAgentKeepAliveWorker(): void

Use to initializing the user slot worker and will return the method inside the worker
example
```
this.initAgentKeepAliveWorker();
```
Returns void

invokeUIQEventSnapshotRequest

invokeUIQEventSnapshotRequest(): void

Method to invoke snapshot request
example
```
invokeUIQEventSnapshotRequest()
```
Returns void

Private keepAlivePolling

keepAlivePolling(sessionId?: string): void

Calls keepalive api on worker thread
example
```
this.getNextEvents(retryOptions, '12345');
```
Parameters
- Optional sessionId: string
  
  sessionid
Returns void

Private restartWorker

restartWorker(): void

Use to restart worker
example
```
this.restartWorker();
```
Returns void

sendRefreshToken

sendRefreshToken(): void

Method to invoke snapshot request
example
```
sendRefreshToken()
```
Returns void

startConnection

startConnection(userInfo: UserInfo): Promise<void>

Method to start connection
example
```
startConnection(userInfo)
```
Parameters
- userInfo: UserInfo
  
  current logged in user information
Returns Promise<void>

startKeepAlivePolling

startKeepAlivePolling(sessionId?: string): void

Starts KeepAlivePolling for specified agent session
example
```
this.startKeepAlivePolling();
```
Parameters
- Optional sessionId: string
  
  sessionid
Returns void

Private startSocketHeartBeat

startSocketHeartBeat(agentId: string, tenantId: string): void

Method to send heartbeat
example
```
startSocketHeartBeat(agentId, tenantId)
```
Parameters
- agentId: string
  
  Agent ID
- tenantId: string
  
  tenant ID
Returns void

terminatePolling

terminatePolling(ifRestart?: boolean): void

Used to terminate the polling of get-next api
example
```
this.terminatePolling();
```
Parameters
- Optional ifRestart: boolean
Returns void

Generated using TypeDoc