Class GetNextEventProvider

GetNextEventProvider to perform getNextEvent polling

Hierarchy

GetNextEventProvider

Index

Constructors

constructor

Properties

Accessors

instance

Methods

Constructors

Private constructor

new GetNextEventProvider(): GetNextEventProvider

constructor which sets agent session instance

Returns GetNextEventProvider

Properties

Private agentSession

agentSession: ACDSessionManager

Private baseUri

baseUri: string = ''

Private getNextEventAdapter

getNextEventAdapter: CXoneGetNextAdapter = ...

Private getNextPollingWorker

getNextPollingWorker: any

logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Static Private singleton

singleton: GetNextEventProvider

Accessors

Static instance

get instance(): GetNextEventProvider

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

Methods

Private getNextEvents

getNextEvents(retryOptions?: RetryOptions, sessionId?: string): void

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

initUtilWorker

initUtilWorker(): void

Use to initializing the util worker and will return the method inside the worker
example
```
this.initUtilWorker();
```
Returns void

Private onPollingExecuted

onPollingExecuted(response: GetNextEventResponse): void

Captures data returned from get-next-event api

Parameters
- response: GetNextEventResponse
  
  collection of events
Returns void

Private onPollingRetrySuccess

onPollingRetrySuccess(response: GetNextEventResponse, maxRetryAttempts?: number): void

Captures data returned from get-next-event api after successful retry

Parameters
- response: GetNextEventResponse
- Optional maxRetryAttempts: number
Returns void

postNetworkFailure

postNetworkFailure(event: any): void

example
-This is used to post message to other tab in case of network error

Parameters
- event: any
Returns void

startGetNextEvents

startGetNextEvents(sessionId?: string): void

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

terminateUtilWorker

terminateUtilWorker(): void

Use to terminate the util worker instance
example
```
this.terminateUtilWorker();
```
Returns void

Generated using TypeDoc