WemNotificationProvider | nice-cxone-acd-agent-apps

This class to manage notification

Hierarchy

WemNotificationProvider

Constructors

constructor

new WemNotificationProvider(notificationBase: CXoneNotificationManager): WemNotificationProvider

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:35
get instance for wemNotificationProvider and wemNotificationService
example
```
const notification = new CXoneNotification();
```
Parameters
- notificationBase: CXoneNotificationManager
Returns WemNotificationProvider

Properties

Private embeddedPageLoaded

embeddedPageLoaded: boolean = false

Private embeddedPagesLinks

embeddedPagesLinks: string[] = []

Private isRecordingNotificationEnabled

isRecordingNotificationEnabled: boolean = null

Private logger

logger: Logger = ...

Private notificationBase

notificationBase: CXoneNotificationManager = ...

Private notificationMessages

notificationMessages: WemNotificationMessage[] = []

Private validationUtils

validationUtils: ValidationUtils = ...

Private wemNotificationSvc

wemNotificationSvc: WemNotificationService = ...

Private wemWorker

wemWorker: any

Methods

Private attemptReconnect

attemptReconnect(): void

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:109
This method to perform the different actions on callback response
example
```
attemptReconnect();
```
Returns void

getWemNotificationPollingConfig

getWemNotificationPollingConfig(): WemNotificationRequestData

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:319
Use to get polling request parameters for leader election
example
```
this.getWemNotificationPollingConfig();
```
Returns WemNotificationRequestData
- notification request parameters

handleWemNotificationWSResponse

handleWemNotificationWSResponse(wsResponse: WsResponse, isPostedFromLeader?: boolean): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:241
This method to perform the different actions on callback response of worker events
example
```
handleWemNotificationWSResponse(wsResponse);
```
Parameters
- wsResponse: WsResponse
- Optional isPostedFromLeader: boolean
Returns Promise<void>

Private initWemNotificationWorker

initWemNotificationWorker(): void

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:288
Use to initializing the wem notification worker and will return the method inside the worker
example
```
this.initWemNotificationWorker();
```
Returns void

initialWemNotifications

initialWemNotifications(): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:333
Use to load initial wem notifications from index db for non-leader
example
```
this.initialWemNotifications();
```
Returns Promise<void>

Private isSupportedByEmbeddedPages

isSupportedByEmbeddedPages(notificationURL: string): boolean

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:206
This method to check notification url is supported by embedded pages
example
```
isSupportedByEmbeddedPages('https://na1.dev.nice.com/wfm/#/mySchedule?date=2022-01-12')
```
Parameters
- notificationURL: string
  
  notification url
Returns boolean
- boolean

Private onWemEmbeddedPageLinkResponse

onWemEmbeddedPageLinkResponse(response: WemEmbeddedPageLinks): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:220
This method to get embedded pages links and publish wem notification whenever we get response of that api we set "embeddedPageLoaded" property true then process the messages from notificationMessages array and publish the notification to the consumer
example
```
onWemEmbeddedPageLinkResponse(response)
```
Parameters
- response: WemEmbeddedPageLinks
  
  Embedded page list
Returns Promise<void>

Private onWemNotificationMessage

onWemNotificationMessage(message: WemNotificationMessage, isPostedFromLeader?: boolean): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:126
This method to manipulate and publish notification messages when websocket is connection is authenticate we receive "CONNECTED" command from ws server so first we getEmbeddedPages api and in which we required embedded pages links to filter notification messages until we will not api response will store the all messages into "notificationMessages" array.
example
```
onWemNotificationMessage(message)
```
Parameters
- message: WemNotificationMessage
  
  notification message
- Optional isPostedFromLeader: boolean
Returns Promise<void>

Private publishRecordingNotification

publishRecordingNotification(message: WemNotificationMessage): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:181
Publishes a recording notification if the message notification template is of type RECORDING_STATUS.
example
```
publishRecordingNotification(message)
```
Parameters
- message: WemNotificationMessage
  
  notification message
Returns Promise<void>

Private publishWemNotification

publishWemNotification(message: WemNotificationMessage): Promise<void>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:155
This method to process notification messages
example
```
publishWemNotification(message)
```
Parameters
- message: WemNotificationMessage
  
  notification message
Returns Promise<void>

sendWemAcknowledge

sendWemAcknowledge(msgId: string): Promise<void | CXoneSdkError>

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:81
This method to send message is ready Acknowledgement to WebSocket
example
```
sendAcknowledge('abc1234')
```
Parameters
- msgId: string
  
  Notification message id
Returns Promise<void | CXoneSdkError>
- boolean | CXoneSdkError

startWemWebSocket

startWemWebSocket(requestData: WemNotificationRequestData): void

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:49
This method to start websocket
example
```
startWebsocket({'en-US', 'Asia/Calcutta',{maxRetryAttempts:5, retryInterval: 2000}});
```
Parameters
- requestData: WemNotificationRequestData
  
  locale of the system
Returns void
- started ws connection or CXoneSdkError

terminateWemWebSocket

terminateWemWebSocket(): void | CXoneSdkError

- Defined in agent-sdk/src/lib/notification/provider/wem-notification-provider.ts:300
Use to terminate the ws worker instance
example
```
this.terminateWsWorker();
```
Returns void | CXoneSdkError

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

notificationBase: CXoneNotificationManager

Returns WemNotificationProvider

Properties

Private embeddedPageLoaded

Private embeddedPagesLinks

Private isRecordingNotificationEnabled

Private logger

Private notificationBase

Private notificationMessages

Private validationUtils

Private wemNotificationSvc

Private wemWorker

Methods

Private attemptReconnect

Returns void

getWemNotificationPollingConfig

Returns WemNotificationRequestData

handleWemNotificationWSResponse

Parameters

wsResponse: WsResponse

Optional isPostedFromLeader: boolean

Returns Promise<void>

Private initWemNotificationWorker

Returns void

initialWemNotifications

Returns Promise<void>

Private isSupportedByEmbeddedPages

Parameters

notificationURL: string

Returns boolean

Private onWemEmbeddedPageLinkResponse

Parameters

response: WemEmbeddedPageLinks

Returns Promise<void>

Private onWemNotificationMessage

Parameters

message: WemNotificationMessage

Optional isPostedFromLeader: boolean

Returns Promise<void>

Private publishRecordingNotification

Parameters

message: WemNotificationMessage

Returns Promise<void>

Private publishWemNotification

Parameters

message: WemNotificationMessage

Returns Promise<void>

sendWemAcknowledge

Parameters

msgId: string

Returns Promise<void | CXoneSdkError>

startWemWebSocket

Parameters

requestData: WemNotificationRequestData

Returns void

terminateWemWebSocket

Returns void | CXoneSdkError