Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneDigitalUtil

Utility Class containing methods related to handling of generic logic

Hierarchy

  • CXoneDigitalUtil

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private acdSession

acdSession: ACDSessionManager = ACDSessionManager.instance

digitalContactService

digitalContactService: DigitalContactService = ...

digitalEventSyncService

digitalEventSyncService: DigitalEventSyncService = ...

Private isWSAPIIntegrationRevampToggleEnabled

isWSAPIIntegrationRevampToggleEnabled: boolean = ...

Protected logger

logger: CcfLogger = ...

Static Private singleton

singleton: CXoneDigitalUtil

Accessors

Static instance

Methods

checkIfEventConsumed

  • checkIfEventConsumed(response: HttpResponse, contactId: string, eventName: CXoneDigitalEventType, eventData?: string | AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorRecipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>[]>; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; recipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>, traceXId?: string): Promise<boolean>

  • Method to check if event is already consumed

    example
    • checkIfEventConsumed(response, '645337', 'CASE_INBOX_ASSIGNED',eventData,traceXid);

    Parameters

    • response: HttpResponse

      Http response from API

    • contactId: string

      Contact Id of the digital contact

    • eventName: CXoneDigitalEventType

      Event name to check

    • Optional eventData: string | AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorRecipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>[]>; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; recipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>

      Event data to be passed for syncEventResponse (or) status will be passed in case of casestatus changed event

    • Optional traceXId: string

      traceXId from the response header

    Returns Promise<boolean>

    • isEventConsumed

getDigitalRecipients

  • getDigitalRecipients(recipients: AssertsShape<{ idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>[]): { bccRecipients: string[]; ccRecipients: string[]; toRecipients: string[] }

  • Method to get Recipients data for email contact

    Parameters

    • recipients: AssertsShape<{ idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>[]

    Returns { bccRecipients: string[]; ccRecipients: string[]; toRecipients: string[] }

    • returns recipient array filtered based on To,CC,BCC addresses
    @example
    getDigitalRecipients()
    • bccRecipients: string[]
    • ccRecipients: string[]
    • toRecipients: string[]

handleAgentAssistUnsubscribe

  • Method to handle WebSocket unsubscribe for agent assist

    example
    handleAgentAssistUnsubscribe('123456', CXoneDigitalEventType.CASE_STATUS_CHANGED, DigitalContactStatus.CLOSED)

    Parameters

    • contactId: string

      Contact Id to unsubscribe from

    • eventType: CXoneDigitalEventType

      Type of digital event

    • status: string

      Current contact status

    Returns void

isUserSlotFeatureToggleEnabled

  • isUserSlotFeatureToggleEnabled(): Promise<boolean>

Generated using TypeDoc