ContactManager | nice-cxone-acd-agent-apps

Class to handle the contacts

Hierarchy

ContactManager

Index

Constructors

constructor

Methods

Constructors

constructor

new ContactManager(): ContactManager

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:94
example
```
const contactManager = new ContactManager();
```
Returns ContactManager

Properties

Private acdSession

acdSession: ACDSessionManager = ...

Private adminService

adminService: AdminService = ...

Private allContacts

allContacts: {} = {}

Type declaration

[key: string]: string | any

conferenceCallEvent

conferenceCallEvent: Subject<string> = ...

contactService

contactService: ContactService = ...

cxoneVoiceContact

cxoneVoiceContact: CXoneVoiceContact = ...

dispositionService

dispositionService: DispositionService = ...

Private dispositionsData

dispositionsData: Record<string, CXoneDisposition[]> = {}

Private isDisposed

isDisposed: boolean = false

Private logger

logger: Logger = ...

onCoBrowseEvent

onCoBrowseEvent: Subject<CoBrowseEvent> = ...

onDigitalContactNewMessageEvent

onDigitalContactNewMessageEvent: Subject<{ contactId: string; interactionId: string; message: 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> }> }> = ...

onDigitalContactUserTypingPreviewEvent

onDigitalContactUserTypingPreviewEvent: Subject<{ eventType: string; message?: any; threadId: string }> = ...

onDispositionEvent

onDispositionEvent: Subject<CXoneDisposition[] | CXoneSdkError> = ...

onLocalPostEvent

onLocalPostEvent: Subject<LocalPostEvent> = ...

onTagsEvent

onTagsEvent: Subject<TagsResponse | CXoneSdkError> = ...

onUserSlotEvent

onUserSlotEvent: Subject<any> = ...

onVoiceTranscriptContactEndEvent

onVoiceTranscriptContactEndEvent: Subject<{ contactId: string }> = ...

personalConnectionService

personalConnectionService: PersonalConnectionService = ...

Private renewStateSubscription

renewStateSubscription: Subscription = null

Private skillService

skillService: SkillService = ...

Private tagsData

tagsData: Record<string, TagsResponse> = {}

voiceCallRecordServicePollingEvent

voiceCallRecordServicePollingEvent: Subject<boolean> = ...

Private voiceContactMap

voiceContactMap: Map<string, CXoneVoiceContact> = ...

voiceContactUpdateEvent

voiceContactUpdateEvent: Subject<CXoneVoiceContact> = ...

Private voiceMailContactMap

voiceMailContactMap: Map<string, CXoneVoiceMailContact> = ...

voiceMailContactUpdateEvent

voiceMailContactUpdateEvent: Subject<CXoneVoiceMailContact> = ...

voiceMailPlayBackEvent

voiceMailPlayBackEvent: Subject<AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; iisHost: default<string, AnyObject, string>; playBackPaused: RequiredBooleanSchema<boolean, AnyObject>; playBackPosition: RequiredNumberSchema<number, AnyObject>; type: RequiredStringSchema<string, AnyObject>; vcHost: default<string, AnyObject, string> }>> = ...

voiceService

voiceService: VoiceService = ...

Private workItemContactMap

workItemContactMap: Map<string, CXoneWorkItemContact> = ...

workItemContactUpdateEvent

workItemContactUpdateEvent: Subject<CXoneWorkItemContact> = ...

Methods

Private VoiceMailPlayBackEventHandler

VoiceMailPlayBackEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1137
Method to get subscribe to voiceMailPlayBackEvent

Returns void

Private callContactEventHandler

callContactEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:561
Method to subscribe the call contact event from the agentSession.

Returns void

checkAcdContactsAvailable

checkAcdContactsAvailable(): boolean

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:509
Method to check if any voice contact is available in VoiceContactMap

example
checkAcdContactsAvailable

Returns boolean

checkForExistingContact

checkForExistingContact(contactEvent: ContactEventTypeAlias, contactMap: Map<string, CXoneContactType>, contactConstructor: any): any

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:519
example
Parameters
- contactEvent: ContactEventTypeAlias
- contactMap: Map<string, CXoneContactType>
- contactConstructor: any
Returns any

Private clearContact

clearContact(contact: CXoneContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:363
Method to clear a stuck contact from all maps and storage
example
```
clearContact(contact)
```
Parameters
- contact: CXoneContact
  
  the contact to clear
Returns void

coBrowseEventHandler

coBrowseEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:412
initialize coBrowse event handler

example
coBrowseEventHandler

Returns void

Private conferenceCallEventHandler

conferenceCallEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:720
Method to subscribe the conference call event from the agentSession.

Returns void

Private connectVoiceBioHubWebSocket

connectVoiceBioHubWebSocket(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:459
connect to websocket for voice bio hub

Returns void

Private contactEventHandler

contactEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:546
Method to subscribe the contact event from the agentSession.
example
```
contactEventHandler()
```
Returns void

Private createContactEventObject

createContactEventObject(contact: CXoneContactType): ContactEventTypeAlias

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:210
Method to create contact event object based on contact type
example
```
createContactEventObject(contact)
```
Parameters
- contact: CXoneContactType
  
  CXoneContactType (CXoneVoiceContact | CXoneVoiceMailContact | CXoneWorkItemContact)
Returns ContactEventTypeAlias
CallContactEvent | VoiceMailContactEvent | WorkItemContactEvent

dispose

dispose(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:108
Disposes of subscriptions to prevent memory leaks when this instance is replaced. Must be called before creating a new ContactManager instance.
example
```
contactManager.dispose();
```
Returns void

getAllContacts

getAllContacts(): {}

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1174
Method to get all contacts
example
```
getAllContacts()
```
Returns {}
- [key: string]: string | any

getDispositions

getDispositions(skillId: string, mediaType: MediaType): Promise<CXoneDisposition[] | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:852
Used to get the disposition based on the skill id provided
example
```
cxoneClient.contactManager.getDispositions("123456");
```
Parameters
- skillId: string
  
  skill id to fetch the skill details
- mediaType: MediaType
Returns Promise<CXoneDisposition[] | CXoneSdkError>

Private getDispositionsOnContactEvent

getDispositionsOnContactEvent(skillId: string, contactId: string, mediaType: MediaType): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:737
Method to get dispositions for CallContactEvents and VoiceMailContactEvents
example
```
getDispositionsOnContactEvent(1234, 4321, MediaType.VOICE)
```
Parameters
- skillId: string
  
  skill id to fetch the skill dispositions
- contactId: string
  
  used to fetch disposition
- mediaType: MediaType
Returns void

getDispositionsWithCategories

getDispositionsWithCategories(skillId: string, mediaType: MediaType): Promise<CXoneDisposition[] | CXoneSdkError>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:867
Used to get the disposition based on the skill id provided
example
```
cxoneClient.contactManager.getDispositionsWithCategories("123456");
```
Parameters
- skillId: string
  
  skill id to fetch the skill details
- mediaType: MediaType
  
  media type
Returns Promise<CXoneDisposition[] | CXoneSdkError>

getInboundAgentDetails

getInboundAgentDetails(ani: string): Promise<{}>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1150
Get the details of calling agent in case of inbound voice interaction

example
getInboundAgentDetails

Parameters
- ani: string
  
  ani number(agent id)
Returns Promise<{}>

Private getSkillById

getSkillById(contact: CXoneWorkItemContact | CXoneVoiceContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1104
Method to get Skill Name for SkillId

Parameters
- contact: CXoneWorkItemContact | CXoneVoiceContact
  
  cxone voice contact or cxone work item contact details
Returns void

Private getSmartReachDispositionsOnContactEvent

getSmartReachDispositionsOnContactEvent(skillId: string, contactId: string, mediaType: MediaType): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:772
Method to get Smartreach dispositions for CallContactEvents
example
```
getSmartReachDispositionsOnContactEvent(1234, 4321, MediaType.VOICE)
```
Parameters
- skillId: string
  
  skill id to fetch the skill dispositions
- contactId: string
  
  used to fetch disposition
- mediaType: MediaType
  
  media type to fetch the dispositions
Returns void

Private getTagsOnContactEvent

getTagsOnContactEvent(skillId: string, contactId: string): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:804
Method to get tags for CallContactEvents and VoiceMailContactEvents
example
```
getTagsOnContactEvent(1234, 4321)
```
Parameters
- skillId: string
  
  skill id to fetch the skill tags
- contactId: string
  
  contactId to be set on tags
Returns void

Private getVoiceMailSkillById

getVoiceMailSkillById(voiceMailContact: CXoneVoiceMailContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1076
Method to get voicemail skill details

Parameters
- voiceMailContact: CXoneVoiceMailContact
  
  cxone voicemail contact details
Returns void

Private handleRenewState

handleRenewState(backendContactIds: string[]): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:176
Handle renew state event - compares backend contacts with UI contacts to find and clear stuck contacts
example
```
handleRenewState(['contactId1', 'contactId2'])
```
Parameters
- backendContactIds: string[]
  
  array of contact IDs currently active in the backend
Returns void

hasAnyPersonalConnectionContact

hasAnyPersonalConnectionContact(): boolean

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:392
Returns whether the agent has any PC dialer calls

example
hasAnyPersonalConnectionContact()

Returns boolean

Private initialize

initialize(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:119
Method to create instance for voice and contact service and update agent permissions and call contact event

Returns void

localPostEventHandler

localPostEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:424
initialize localpost event handler

example
localPostEventHandler

Returns void

Private mapToCallContactEvent

mapToCallContactEvent(contact: CXoneVoiceContact): AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:228
Maps CXoneVoiceContact to CallContactEvent

Parameters
- contact: CXoneVoiceContact
  
  CXoneVoiceContact instance
Returns AssertsShape<{ allowDispositions: RequiredBooleanSchema<boolean, AnyObject>; ani: RequiredStringSchema<string, AnyObject>; ansMachineOverride: default<boolean, AnyObject, boolean>; ansMachineOverrideEndTime: RequiredStringSchema<string, AnyObject>; blendingToSkillName: RequiredStringSchema<string, AnyObject>; callType: RequiredStringSchema<string, AnyObject>; complianceRecord: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequired: RequiredBooleanSchema<boolean, AnyObject>; contactId: RequiredStringSchema<string, AnyObject>; customData: RequiredStringSchema<string, AnyObject>; customerCardUrl: default<string, AnyObject, string>; deliveryType: RequiredStringSchema<string, AnyObject>; disconnectCode: RequiredStringSchema<string, AnyObject>; dnis: RequiredStringSchema<string, AnyObject>; externalCustomerId: default<string, AnyObject, string>; externalId: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; interactionId: RequiredStringSchema<string, AnyObject>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; isLinked: RequiredBooleanSchema<boolean, AnyObject>; isLogging: RequiredBooleanSchema<boolean, AnyObject>; isRequireManualAccept: default<boolean, AnyObject, boolean>; label: RequiredStringSchema<string, AnyObject>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: RequiredStringSchema<string, AnyObject>; originalState: RequiredBooleanSchema<boolean, AnyObject>; otherInformation: RequiredStringSchema<string, AnyObject>; otherInformationNewFormat: RequiredStringSchema<string, AnyObject>; parentContactId: RequiredStringSchema<string, AnyObject>; screenPopUrl: RequiredStringSchema<string, AnyObject>; screenPopUrlVariables: MixedSchema<any, AnyObject, any>; skill: RequiredStringSchema<string, AnyObject>; smartReachTransactionId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; timeZones: RequiredStringSchema<string, AnyObject>; timeout: RequiredNumberSchema<number, AnyObject> }>
CallContactEvent

Private mapToVoiceMailContactEvent

mapToVoiceMailContactEvent(contact: CXoneVoiceMailContact): AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:278
Maps CXoneVoiceMailContact to VoiceMailContactEvent

Parameters
- contact: CXoneVoiceMailContact
  
  CXoneVoiceMailContact instance
Returns AssertsShape<{ contactId: RequiredStringSchema<string, AnyObject>; createdDate: RequiredDateSchema<Date, AnyObject>; customData: default<string, AnyObject, string>; fileDuration: RequiredNumberSchema<number, AnyObject>; fileName: RequiredStringSchema<string, AnyObject>; finalState: RequiredBooleanSchema<boolean, AnyObject>; from: default<string, AnyObject, string>; isInbound: RequiredBooleanSchema<boolean, AnyObject>; label: default<string, AnyObject, string>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; masterID: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parentContactId: default<string, AnyObject, string>; requireDisposition: default<boolean, AnyObject, boolean>; screenPopUrl: RequiredStringSchema<string, AnyObject>; skill: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; to: default<string, AnyObject, string>; type: default<string, AnyObject, string>; voiceMailType: default<string, AnyObject, string> }>
VoiceMailContactEvent

Private mapToWorkItemContactEvent

mapToWorkItemContactEvent(contact: CXoneWorkItemContact): AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:310
Maps CXoneWorkItemContact to WorkItemContactEvent

Parameters
- contact: CXoneWorkItemContact
  
  CXoneWorkItemContact instance
Returns AssertsShape<{ agentId: RequiredNumberSchema<number, AnyObject>; closePopoutUponTermination: default<boolean, AnyObject, boolean>; contactId: RequiredStringSchema<string, AnyObject>; customData: default<string, AnyObject, string>; finalState: RequiredBooleanSchema<boolean, AnyObject>; iisHost: default<string, AnyObject, string>; inFocus: default<boolean, AnyObject, boolean>; lastStateChangeTime: RequiredDateSchema<Date, AnyObject>; lastStateChangeTimeUtc: RequiredDateSchema<Date, AnyObject>; masterId: RequiredStringSchema<string, AnyObject>; omniGroupId: default<string, AnyObject, string>; parenContactId: default<string, AnyObject, string>; popDestination: default<string, AnyObject, string>; popoutWindowHeight: default<number, AnyObject, number>; popoutWindowWidth: default<number, AnyObject, number>; refusalTimeout: default<number, AnyObject, number>; screenPopUrl: RequiredStringSchema<string, AnyObject>; sessionId: RequiredStringSchema<string, AnyObject>; skillId: default<string, AnyObject, string>; startTime: RequiredDateSchema<Date, AnyObject>; startTimeUtc: RequiredDateSchema<Date, AnyObject>; status: RequiredStringSchema<string, AnyObject>; tabTitle: default<string, AnyObject, string>; type: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string>; vcHost: default<string, AnyObject, string>; workItemId: default<string, AnyObject, string>; workItemPayload: default<string, AnyObject, string>; workItemType: default<string, AnyObject, string> }>
WorkItemContactEvent

Private muteEventHandler

muteEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:908
Method to subscribe the mute event from the agentSession

Returns void

Private publishContact

publishContact(contact: CXoneContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:972
Method used to get the CXoneContact

Parameters
- contact: CXoneContact
Returns void

Private removeBioHubFromLocalStorage

removeBioHubFromLocalStorage(contactKeys: string[]): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:662
Method to remove bio hub data from local storage when call gets disconnected

example
removeBioHubFromLocalStorage(contactKeys)

Parameters
- contactKeys: string[]
  
  contact keys available in voice contact map
Returns void

Private removeContactData

removeContactData(contactID: string): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:349
Method to remove contact data from all maps and storage
example
- removeContactData(contact)
Parameters
- contactID: string
Returns void

Private removeVoiceTranscriptionFromIndexedDB

removeVoiceTranscriptionFromIndexedDB(contactId: string): Promise<void>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:652
Removes voice transcription data from IndexedDB for a specific contact.

Parameters
- contactId: string
  
  contactId for which voice transcription to be removed
Returns Promise<void>

saveDisposition

saveDisposition(contactId: string, dispositionPayload: CXoneDispositionDetails): Promise<HttpResponse>

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:883
Used to save the disposition data provided
example
```
cxoneClient.contactManager.saveDisposition("123456",{primaryDispositionId: 456789, primaryDispositionNotes: "test notes"});
```
Parameters
- contactId: string
  
  contact id for disposition
- dispositionPayload: CXoneDispositionDetails
  
  payload
Returns Promise<HttpResponse>

Private setVoiceContactInMap

setVoiceContactInMap(contact: CXoneVoiceContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1048
set / delete / find the voice contacts in map using contactID.

Parameters
- contact: CXoneVoiceContact
  
  cxone voice contact details
Returns void

Private setVoiceMailContactInMap

setVoiceMailContactInMap(contact: CXoneVoiceMailContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:993
set / delete / find the voicemail contacts in map using contactID.

Parameters
- contact: CXoneVoiceMailContact
  
  cxone voicemail contact details
Returns void

Private setWorkItemContactInMap

setWorkItemContactInMap(contact: CXoneWorkItemContact): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:1021
set / delete / find the work item contacts in map using contactID.

Parameters
- contact: CXoneWorkItemContact
  
  cxone work item contact details
Returns void

Private subscribeToRenewStateEvents

subscribeToRenewStateEvents(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:150
Method to subscribe to renew state events from the GetNextAdapter This handles stuck contacts when icBranchValue === '3' is received Uses dynamic import to avoid circular dependency

Returns void

Private updateAgentPreference

updateAgentPreference(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:486
Update agent permission for voice contacts

Returns void

Private updateAutoSummaryEventHandler

updateAutoSummaryEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:436
subscribe to auto summary event

Returns void

Private updateControlsWithNewConsultCall

updateControlsWithNewConsultCall(masterID: string): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:836
Method to update call controls state if new consult call started and publish for primary contact
example
```
updateControlsWithNewConsultCall('1234')
```
Parameters
- masterID: string
  
  skill id to fetch the skill details
Returns void

Private updateMuteState

updateMuteState(isAgentMuted: boolean): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:919
Update Mute button state for voice contacts

Parameters
- isAgentMuted: boolean
Returns void

Private updatePermissionsEventHandler

updatePermissionsEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:473
subscribe the update agent permissions event

Returns void

updateVoiceCallRecordState

updateVoiceCallRecordState(isRecording: boolean): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:944
Update the record state for voice contacts
example
```
contactManager.updateVoiceCallRecordState(true);
```
Parameters
- isRecording: boolean
  
  boolean value to indicate if the call is being recorded
Returns void

Private voicemailContactEventHandler

voicemailContactEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:699
Method to subscribe the voicemail contact event from the agentSession.

Returns void

Private workItemContactEventHandler

workItemContactEventHandler(): void

- Defined in acd-sdk/src/lib/acd/contact/contact-manager.ts:678
Method to subscribe the workitem contact event from the agentSession.

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ContactManager

Properties

Private acdSession

Private adminService

Private allContacts

Type declaration

[key: string]: string | any

conferenceCallEvent

contactService

cxoneVoiceContact

dispositionService

Private dispositionsData

Private isDisposed

Private logger

onCoBrowseEvent

onDigitalContactNewMessageEvent

onDigitalContactUserTypingPreviewEvent

onDispositionEvent

onLocalPostEvent

onTagsEvent

onUserSlotEvent

onVoiceTranscriptContactEndEvent

personalConnectionService

Private renewStateSubscription

Private skillService

Private tagsData

voiceCallRecordServicePollingEvent

Private voiceContactMap

voiceContactUpdateEvent

Private voiceMailContactMap

voiceMailContactUpdateEvent

voiceMailPlayBackEvent

voiceService

Private workItemContactMap

workItemContactUpdateEvent

Methods

Private VoiceMailPlayBackEventHandler

Returns void

Private callContactEventHandler

Returns void

checkAcdContactsAvailable

Returns boolean

checkForExistingContact

Parameters

contactEvent: ContactEventTypeAlias

contactMap: Map<string, CXoneContactType>

contactConstructor: any

Returns any

Private clearContact

Parameters

contact: CXoneContact

Returns void

coBrowseEventHandler

Returns void

Private conferenceCallEventHandler

Returns void

Private connectVoiceBioHubWebSocket

Returns void

Private contactEventHandler

Returns void

Private createContactEventObject

Parameters

contact: CXoneContactType

Returns ContactEventTypeAlias

dispose

Returns void

getAllContacts

Returns {}

[key: string]: string | any

getDispositions

Parameters

skillId: string

mediaType: MediaType