UIQueueWsProvider | nice-cxone-acd-agent-apps

Class to connect UI Queue web socket

Hierarchy

UIQueueWsProvider

Index

Constructors

constructor

Accessors

Constructors

constructor

new UIQueueWsProvider(): UIQueueWsProvider

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:85
constructor which sets agent session instance
example
```
UIQueueWsProvider();
```
Returns UIQueueWsProvider

Properties

Private Readonly MAX_MISSED_PONGS

MAX_MISSED_PONGS: 3 = 3

Private adminService

adminService: AdminService

Private agentId

agentId: string = ''

Private agentSession

agentSession: ACDSessionManager

Private baseUri

baseUri: string = ''

Private getNextEventAdapter

getNextEventAdapter: CXoneGetNextAdapter = ...

Private getkeepAlivePollingisActive

getkeepAlivePollingisActive: boolean = false

Private heartbeatWorker

heartbeatWorker: Worker

Private hubConnection

hubConnection: HubConnection

Private hubUrl

hubUrl: string = ''

Private internetCheckTimer

internetCheckTimer: Timer = undefined

Private isAutoLogoutEnabled

isAutoLogoutEnabled: boolean = ...

Private isConnectionInProgress

isConnectionInProgress: boolean = false

Private isCustomKeepAlivePollingTimeoutEnabled

isCustomKeepAlivePollingTimeoutEnabled: boolean = ...

Private isUIQDegraded

isUIQDegraded: boolean = false

Private keepAlivePollingWorker

keepAlivePollingWorker: any

Private keepAliveTimeout

keepAliveTimeout: number = ...

Private listenersAttached

listenersAttached: boolean = false

Private loader

loader: LoadWorker = ...

Private logger

logger: Logger = ...

Private missedPongCount

missedPongCount: number = 0

Private receivedEvents

receivedEvents: any = []

Private tenantId

tenantId: string = ''

Protected utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Static Private singleton

singleton: UIQueueWsProvider

Accessors

Private agentContext

get agentContext(): string

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:251
Returns a consistent debug context tag with agentId and tenantId for log messages.

Returns string

Static instance

get instance(): UIQueueWsProvider

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:241
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

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:436
Method to add event listeners
example
```
addEventListeners(userInfo)
```
Parameters
- userInfo: UserInfo
  
  user info object
Returns void

Private closeHandler

closeHandler(userInfo: UserInfo): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:527
Method to handle close event
example
```
closeHandler(userInfo)
```
Parameters
- userInfo: UserInfo
  
  current logged in user information
Returns void

connectAgent

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

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:303
Method to establish connection
example
```
connectAgent(userInfo, invokeSnapshot)
```
Parameters
- userInfo: UserInfo
  
  user info object
- Optional invokeSnapshot: boolean
  
  flag to invoke snapshot request
- Optional sessionId: string
Returns void

disconnectConsumerAgent

disconnectConsumerAgent(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:736
Method to disconnectAgent
example
```
disconnectConsumerAgent()
```
Returns void

establishSocketConnection

establishSocketConnection(userInfo: UserInfo, _invokeSnapshot?: boolean, sessionId?: string): Promise<void>

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:387
Method to establish connection
example
```
establishSocketConnection(userInfo, invokeSnapshot)
```
Parameters
- userInfo: UserInfo
  
  user info object
- _invokeSnapshot: boolean = false
- Optional sessionId: string
Returns Promise<void>

Private failoverToGetNext

failoverToGetNext(error: CXoneSdkError): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:803
Method to failover to get-next polling
example
```
failoverToGetNext(error)
```
Parameters
- error: CXoneSdkError
  
  error object
Returns void

Private getHubUrl

getHubUrl(): Promise<string>

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:263
Method to get hub url
example
```
getHubUrl();
```
Returns Promise<string>
hub url

Private getInitialGetNextEvent

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

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:190
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

getNewHubConnection

getNewHubConnection(userInfo: UserInfo, retryOptions: RetryOptions, sessionId?: string): Promise<void>

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:333
Method to get new hub connection
example
```
getNewHubConnection(userInfo, retryOptions, sessionId)
```
Parameters
- userInfo: UserInfo
  
  user info object used to establish the connection
- retryOptions: RetryOptions
  
  retry options for establishing the connection
- Optional sessionId: string
  
  optional session identifier for the hub connection
Returns Promise<void>
hub connection

Private getValidAccessToken

getValidAccessToken(): string

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:286
Method to get valid access token
example
```
getValidAccessToken();
```
Returns string
access token

handleInternetDisruption

handleInternetDisruption(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:597
Method to check the internet connection and handle the disruption This method will start a timer to check the internet connection every 10 seconds.
example
```
this.handleInternetDisruption();
```
Returns void

Private handleReceivedEvents

handleReceivedEvents(events: {}): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:416
Method to add event listeners
example
```
handleReceivedEvents(events)
```
Parameters
- events: {}
  
  recieved events
  - [key: string]: string
Returns void

initAgentKeepAliveWorker

initAgentKeepAliveWorker(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:174
Use to initializing the user slot worker and will return the method inside the worker
example
```
this.initAgentKeepAliveWorker();
```
Returns void

initHeartbeatWorker

initHeartbeatWorker(userInfo: UserInfo): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:650
Use to initialize the heartbeat worker and start heartbeat tick polling on a worker thread
example
```
this.initHeartbeatWorker(userInfo);
```
Parameters
- userInfo: UserInfo
  
  user info object containing agentId and tenantId
Returns void

invokeUIQEventSnapshotRequest

invokeUIQEventSnapshotRequest(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:710
Method to invoke snapshot request
example
```
invokeUIQEventSnapshotRequest()
```
Returns void

Private keepAlivePolling

keepAlivePolling(sessionId?: string): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:124
Calls keepalive api on worker thread
example
```
this.keepAlivePolling('12345');
```
Parameters
- Optional sessionId: string
  
  sessionid
Returns void

Private restartWorker

restartWorker(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:758
Use to restart worker
example
```
this.restartWorker();
```
Returns void

sendRefreshToken

sendRefreshToken(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:683
Method to send refresh token
example
```
sendRefreshToken()
```
Returns void

startConnection

startConnection(userInfo: UserInfo): Promise<void>

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:637
Method to start connection
example
```
startConnection(userInfo)
```
Parameters
- userInfo: UserInfo
  
  current logged in user information
Returns Promise<void>

startKeepAlivePolling

startKeepAlivePolling(sessionId?: string): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:102
Starts KeepAlivePolling for specified agent session
example
```
this.startKeepAlivePolling();
```
Parameters
- Optional sessionId: string
  
  sessionid
Returns void

Private startSocketHeartBeat

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

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:557
Method to send heartbeat
example
```
startSocketHeartBeat(agentId, tenantId)
```
Parameters
- agentId: string
  
  Agent ID
- tenantId: string
  
  tenant ID
Returns void

Private stopHeartbeatWorker

stopHeartbeatWorker(): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:787
Stops the heartbeat worker, sends a stop message, and clears the reference.
example
```
this.stopHeartbeatWorker();
```
Returns void

terminatePolling

terminatePolling(ifRestart?: boolean): void

- Defined in core-sdk/src/lib/agent/providers/ui-queue-ws-provider.ts:772
Used to terminate the polling of get-next api
example
```
this.terminatePolling();
```
Parameters
- Optional ifRestart: boolean
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns UIQueueWsProvider

Properties

Private Readonly MAX_MISSED_PONGS

Private adminService

Private agentId

Private agentSession

Private baseUri

Private getNextEventAdapter

Private getkeepAlivePollingisActive

Private heartbeatWorker

Private hubConnection

Private hubUrl

Private internetCheckTimer

Private isAutoLogoutEnabled

Private isConnectionInProgress

Private isCustomKeepAlivePollingTimeoutEnabled

Private isUIQDegraded

Private keepAlivePollingWorker

Private keepAliveTimeout

Private listenersAttached

Private loader

Private logger

Private missedPongCount

Private receivedEvents

Private tenantId

Protected utilService

Private validationUtils

Static Private singleton

Accessors

Private agentContext

Returns string

Static instance

Returns UIQueueWsProvider

Methods

Private addEventListeners

Parameters

userInfo: UserInfo

Returns void

Private closeHandler

Parameters

userInfo: UserInfo

Returns void

connectAgent

Parameters

userInfo: UserInfo

Optional invokeSnapshot: boolean

Optional sessionId: string

Returns void

disconnectConsumerAgent

Returns void

establishSocketConnection

Parameters

userInfo: UserInfo

_invokeSnapshot: boolean = false

Optional sessionId: string

Returns Promise<void>

Private failoverToGetNext

Parameters

error: CXoneSdkError

Returns void

Private getHubUrl

Returns Promise<string>

Private getInitialGetNextEvent

Parameters

Optional sessionId: string

Returns Promise<void>

getNewHubConnection

Parameters

userInfo: UserInfo

retryOptions: RetryOptions

Optional sessionId: string

Returns Promise<void>