MessageAddedIntoCaseDeltaEvent | nice-cxone-acd-agent-apps

Represents a delta event for when a message is added to a case.

Hierarchy

BaseDeltaEvent<MessageAddedDelta>
- MessageAddedIntoCaseDeltaEvent

Constructors

constructor

new MessageAddedIntoCaseDeltaEvent(eventData: any): MessageAddedIntoCaseDeltaEvent

Inherited from BaseDeltaEvent.constructor
- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-base-delta-event.ts:24
Creates a base delta event wrapper for validating event data.

example
// Use concrete implementation since this is an abstract class const event = new CaseStatusChangedDeltaEvent(eventData); const validatedEvent = event.parseAndValidate();

Parameters
- eventData: any
  
  Raw event payload to validate.
Returns MessageAddedIntoCaseDeltaEvent

Properties

caseId

caseId: string

delta

delta: MessageAddedDelta

eventType

eventType: string

interactionId

interactionId: string

timestamp

timestamp: Date

Optional traceId

traceId?: string

Methods

Private validateAttachments

validateAttachments(attachments: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:385
Validates the attachments array of a delta message.

Parameters
- attachments: any
  
  The raw attachments array.
Returns void

Private validateAuthorEndUserIdentity

validateAuthorEndUserIdentity(identity: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:463
Validates the authorEndUserIdentity field of a delta message.

Parameters
- identity: any
  
  The raw authorEndUserIdentity object.
Returns void

Private validateAuthorNameRemoved

validateAuthorNameRemoved(authorNameRemoved: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:837
Validates the authorNameRemoved field of a delta message.

Parameters
- authorNameRemoved: any
  
  The raw authorNameRemoved object.
Returns void

Private validateAuthorUser

validateAuthorUser(authorUser: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:494
Validates the authorUser field of a delta message.

Parameters
- authorUser: any
  
  The raw authorUser object.
Returns void

Private validateChanges

validateChanges(changes: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:646
Validates the _changes array of a delta message.

Parameters
- changes: any
  
  The raw _changes array.
Returns void

Private validateChannel

validateChannel(channel: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:875
Validates the channel field of a delta message.

Parameters
- channel: any
  
  The raw channel object.
Returns void

Protected validateCommonFields

validateCommonFields(eventData: any): void

Inherited from BaseDeltaEvent.validateCommonFields
- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-base-delta-event.ts:39
Validates common delta event fields shared across all event types.

Validates eventType, traceId, caseId, interactionId, and sets timestamp. Called internally by parseAndValidate() method.
throws
Error if validation fails for any common field

example
- validateCommonFields() is called internally by parseAndValidate().
Parameters
- eventData: any
  
  Raw event payload to validate.
Returns void

Private validateContentRemoved

validateContentRemoved(contentRemoved: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:818
Validates the contentRemoved field of a delta message.

Parameters
- contentRemoved: any
  
  The raw contentRemoved object.
Returns void

Private validateCustomerStatistics

validateCustomerStatistics(customerStatistics: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:802
Validates the customerStatistics field of a delta message.

Parameters
- customerStatistics: any
  
  The raw customerStatistics object.
Returns void

Private validateDelivered

validateDelivered(delivered: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:775
Validates the delivered array of a delta message.

Parameters
- delivered: any
  
  The raw delivered array.
Returns void

Protected validateDeltaFields

validateDeltaFields(eventData: any): void

Overrides BaseDeltaEvent.validateDeltaFields
- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:249
Validates and extracts the message delta fields from the event data.
example
```
const event = new MessageAddedIntoCaseDeltaEvent();
event.validateDeltaFields({ data: { message: { id: '123', text: 'Hello' } } });
```
Parameters
- eventData: any
  
  The raw event data containing the message information.
Returns void

Private validateDeviceFingerprint

validateDeviceFingerprint(deviceFingerprint: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:856
Validates the deviceFingerprint field of a delta message.

Parameters
- deviceFingerprint: any
  
  The raw deviceFingerprint object.
Returns void

Private validateForward

validateForward(forward: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:891
Validates the forward field of a delta message.

Parameters
- forward: any
  
  The raw forward object.
Returns void

Private validateMessageContent

validateMessageContent(messageContent: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:363
Validates the messageContent field of a delta message.

Parameters
- messageContent: any
  
  The raw messageContent object.
Returns void

Private validateMessageNoteUser

validateMessageNoteUser(user: any, noteIndex: number): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:570
Validates the user object nested within a message note.

Parameters
- user: any
  
  The raw note user object.
- noteIndex: number
  
  The index of the parent note in the messageNotes array.
Returns void

Private validateMessageNotes

validateMessageNotes(messageNotes: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:519
Validates the messageNotes array of a delta message.

Parameters
- messageNotes: any
  
  The raw messageNotes array.
Returns void

Private validateOptionalBooleanFields

validateOptionalBooleanFields(message: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:316
Validates optional boolean fields on a delta message.

Parameters
- message: any
  
  The raw message object.
Returns void

Private validateOptionalStringFields

validateOptionalStringFields(message: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:335
Validates optional loose string fields on a delta message.

Parameters
- message: any
  
  The raw message object.
Returns void

Private validateReactionStatistics

validateReactionStatistics(reactionStatistics: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:750
Validates the reactionStatistics field of a delta message.

Parameters
- reactionStatistics: any
  
  The raw reactionStatistics object.
Returns void

Private validateRecipients

validateRecipients(recipients: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:433
Validates the recipients array of a delta message.

Parameters
- recipients: any
  
  The raw recipients array.
Returns void

Private validateReplyChannel

validateReplyChannel(replyChannel: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:667
Validates the replyChannel field of a delta message.

Parameters
- replyChannel: any
  
  The raw replyChannel object.
Returns void

Private validateReplyToMessage

validateReplyToMessage(replyToMessage: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:731
Validates the replyToMessage field of a delta message.

Parameters
- replyToMessage: any
  
  The raw replyToMessage object.
Returns void

Private validateTags

validateTags(tags: any): void

- Defined in common-sdk/src/lib/model/digital/schema/events/cxone-message-added-delta-events.ts:619
Validates the tags array of a delta message.

Parameters
- tags: any
  
  The raw tags array.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

eventData: any

Returns MessageAddedIntoCaseDeltaEvent

Properties

caseId

delta

eventType

interactionId

timestamp

Optional traceId

Methods

Private validateAttachments

Parameters

attachments: any

Returns void

Private validateAuthorEndUserIdentity

Parameters

identity: any

Returns void

Private validateAuthorNameRemoved

Parameters

authorNameRemoved: any

Returns void

Private validateAuthorUser

Parameters

authorUser: any

Returns void

Private validateChanges

Parameters

changes: any

Returns void

Private validateChannel

Parameters

channel: any

Returns void

Protected validateCommonFields

Parameters

eventData: any

Returns void

Private validateContentRemoved

Parameters

contentRemoved: any

Returns void

Private validateCustomerStatistics

Parameters

customerStatistics: any

Returns void

Private validateDelivered

Parameters

delivered: any

Returns void

Protected validateDeltaFields

Parameters

eventData: any

Returns void

Private validateDeviceFingerprint

Parameters

deviceFingerprint: any

Returns void

Private validateForward

Parameters

forward: any

Returns void

Private validateMessageContent

Parameters

messageContent: any

Returns void

Private validateMessageNoteUser

Parameters

user: any

noteIndex: number

Returns void

Private validateMessageNotes