Class CXoneEventMessenger

This class is used to send events from the CXone Agent application.

Hierarchy

CXoneEventMessenger

Constructors

constructor

new CXoneEventMessenger(): CXoneEventMessenger

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:23
Constructor for CXoneEventMessenger
example
```
const cxoneEventMessenger = new CXoneEventMessenger();
```
Returns CXoneEventMessenger

Properties

Private agentSession

agentSession: ACDSessionManager

Private logger

logger: Logger = ...

Private pendingSubscriptions

pendingSubscriptions: MessageEvent<any>[] = []

Private windowEventSubscribers

windowEventSubscribers: PostMessageEvent[] = []

Static Private singleton

singleton: CXoneEventMessenger

Accessors

Static instance

get instance(): CXoneEventMessenger

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:35
Method to create singleton object of the class
```
@example
const cxoneAcdClient = CXoneAcdClient.instance();
```
Returns CXoneEventMessenger

Methods

canSendSessionInfo

canSendSessionInfo(subscriber: PostMessageEvent): boolean

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:467
Method to check if session info can be sent
example
```
canSendSessionInfo(subscriber);
```
Parameters
- subscriber: PostMessageEvent
  
  subscriber
Returns boolean
- boolean

checkForSubscriptionType

checkForSubscriptionType(subscriber: PostMessageEvent, type: EventSubscriptionType): boolean

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:483
Method to check for subscription type
example
```
checkForSubscriptionType(subscriber, type);
```
Parameters
- subscriber: PostMessageEvent
  
  subscriber
- type: EventSubscriptionType
  
  type
Returns boolean
- boolean

checkSubscriberForEvent

checkSubscriberForEvent(subscriber: PostMessageEvent, event: {}): boolean

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:427
Check subscriber for event
example
```
checkSubscriberForEvent(subscriber, event);
```
Parameters
- subscriber: PostMessageEvent
  
  subscriber
- event: {}
  
  event
  - [key: string]: string
Returns boolean
- result

checkWindowCanSendEvent

checkWindowCanSendEvent(subscriber: PostMessageEvent, event: {}): boolean

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:396
Check subscriber for event
example
```
checkSubscriberForEvent(subscriber, event);
```
Parameters
- subscriber: PostMessageEvent
  
  subscriber
- event: {}
  
  event
  - [key: string]: string
Returns boolean
- result

cleanSubscriptionEvent

cleanSubscriptionEvent(event: MessageEvent<PostMessageEventData>): PostMessageEvent

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:337
clean subscription event
example
```
cleanSubscriptionEvent(event);
```
Parameters
- event: MessageEvent<PostMessageEventData>
  
  event
Returns PostMessageEvent
- result

getEventsFromState

getEventsFromState(subscriber: PostMessageEvent): any[]

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:175
Method to get events from state
example
```
getEventsFromState(subscriberObject);
```
Parameters
- subscriber: PostMessageEvent
Returns any[]
- events

getNextEventHandler

getNextEventHandler(): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:234
Method to get next event received
example
```
onGetNextEventReceived();
```
Returns void

init

init(): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:50
Method to initiate the event messenger
example
```
init(event);
```
Returns void

onPostMessageReceived

onPostMessageReceived(event: MessageEvent<any>): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:62
Method to handle received events
example
```
onPostMessageReceived()
```
Parameters
- event: MessageEvent<any>
  
  event
Returns void

onSessionTokenUpdate

onSessionTokenUpdate(): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:104
Method to handle session token update
example
```
onSessionTokenUpdate();
```
Returns void

onWindowSubscribe

onWindowSubscribe(event: MessageEvent<PostMessageEventData>): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:137
Set up the window in windowEventSubscribers
example
```
onWindowSubscribe(event);
```
Parameters
- event: MessageEvent<PostMessageEventData>
  
  event
Returns void

onWindowUnsubscribe

onWindowUnsubscribe(event: MessageEvent<any>): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:495
Method to handle unsubscribe event
example
```
onWindowUnsubscribe(event);
```
Parameters
- event: MessageEvent<any>
  
  event
Returns void

processPendingSubscriptions

processPendingSubscriptions(pendingSubscriptions: MessageEvent<any>[]): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:123
Method to process the pending subscriptions

Parameters
- pendingSubscriptions: MessageEvent<any>[]
  pending subscriptions
```
@example
processPendingSubscriptions(pendingSubscriptions);
```
Returns void

publishEventsToWindows

publishEventsToWindows(events: {}[]): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:377
Publish events to windows
example
```
publishEventsToWindows(events);
```
Parameters
- events: {}[]
  
  events
Returns void

sendEventsToWindow

sendEventsToWindow(subscriber: PostMessageEvent, events: any): void

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:251
Send events to window
example
```
sendEventsToWindow(subscriberObject, events);
```
Parameters
- subscriber: PostMessageEvent
- events: any
  
  events
Returns void

standardizeSubscriptionTypes

standardizeSubscriptionTypes(subscriptionTypes: string[]): string[]

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:310
Returns an array with all of the subscription types in a cleaned state.Will not include any invalid subscription types.
example
```
standardizeSubscriptionTypes(event);
```
Parameters
- subscriptionTypes: string[]
  
  subscriptionTypes
Returns string[]
- result

validateAndCleanContactId

validateAndCleanContactId(contactId: number): number

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:360
validate and clean contact id
example
```
validateAndCleanContactId(contactId);
```
Parameters
- contactId: number
  
  contactId
Returns number
- result

validateSubscriptionEvent

validateSubscriptionEvent(event: MessageEvent<PostMessageEventData>): { reason: string; status: string }

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:286
validate subscription event
example
```
validateSubscriptionEvent(event);
```
Parameters
- event: MessageEvent<PostMessageEventData>
  
  event
Returns { reason: string; status: string }
- result
- reason: string
- status: string

validateWindowObjectIsNew

validateWindowObjectIsNew(childWindow: MessageEventSource): boolean

- Defined in acd-sdk/src/lib/event-messenger/cxone-event-messenger.ts:271
Returns true if the window object is not one we already have a reference to This will help avoid sending double messages to a window if they call subscribe twice
example
```
validateWindowObjectIsNew(window);
```
Parameters
- childWindow: MessageEventSource
Returns boolean
- result

Generated using TypeDoc