Class GetNextEventProvider

GetNextEventProvider to perform getNextEvent polling

Hierarchy

GetNextEventProvider

Constructors

Private constructor

new GetNextEventProvider(): GetNextEventProvider

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:43
constructor which sets agent session instance

Returns GetNextEventProvider

Properties

Private agentSession

agentSession: ACDSessionManager

Private baseUri

baseUri: string = ''

Private getNextEventAdapter

getNextEventAdapter: CXoneGetNextAdapter = ...

Private getNextEventHandler

getNextEventHandler: Timeout

Private getNextEventTimeout

getNextEventTimeout: string = ...

Private getNextPollingWorker

getNextPollingWorker: any

Private isCustomGetNextEventPollingTimeoutEnabled

isCustomGetNextEventPollingTimeoutEnabled: boolean = ...

Private isRestartGetNextEventEnabled

isRestartGetNextEventEnabled: boolean = ...

logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Static Private singleton

singleton: GetNextEventProvider

Accessors

adapter

get adapter(): CXoneGetNextAdapter

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:68
Getter to access the get next event adapter instance
example
```
const adapter = GetNextEventProvider.instance.adapter;
```
Returns CXoneGetNextAdapter

Static instance

get instance(): GetNextEventProvider

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:54
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

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:100
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

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:336
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

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:176
Captures data returned from get-next-event api

Parameters
- response: GetNextEventResponse
  
  collection of events
Returns void

Private onPollingRetrySuccess

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

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:238
Captures data returned from get-next-event api after successful retry

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

postNetworkFailure

postNetworkFailure(event: any): void

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:321
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

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:79
Starts GetNextEvents for specified agent session
example
```
this.startGetNextEvents();
```
Parameters
- Optional sessionId: string
Returns void

terminateUtilWorker

terminateUtilWorker(): void

- Defined in core-sdk/src/lib/agent/providers/get-next-event-provider.ts:352
Use to terminate the util worker instance
example
```
this.terminateUtilWorker();
```
Returns void

Generated using TypeDoc