CxoneHeadsetClient | nice-cxone-acd-agent-apps

Singleton class for headset client

Hierarchy

CxoneHeadsetClient

Constructors

constructor

new CxoneHeadsetClient(): CxoneHeadsetClient

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:32
Constructor initializes session manager and Jabra SDK service.

example
new CxoneHeadsetClient()

Returns CxoneHeadsetClient

Properties

Private acdClient

acdClient: CXoneAcdClient = ...

Private acdSession

acdSession: ACDSessionManager = ...

Private agentLegEventSubscription

agentLegEventSubscription: Subscription = ...

Private callContactEventSubscription

callContactEventSubscription: Subscription = ...

Private callMap

callMap: Map<string, 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> }>> = ...

Private isCallConference

isCallConference: boolean = false

jabraSdk

jabraSdk: JabraSdkService = ...

Private muteEventSubscription

muteEventSubscription: Subscription = ...

Private primaryCall

primaryCall: string = ''

Private secondaryCall

secondaryCall: string = ''

Static Private singleton

singleton: CxoneHeadsetClient

Accessors

Static instance

get instance(): CxoneHeadsetClient

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:42
Method to create singleton object of the class

example
const headset = CxoneHeadsetClient.instance();

Returns CxoneHeadsetClient

Methods

addDevice

addDevice(): Promise<void>

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:53
Adds device and gets webhid consent from user

example
addDevice();

Returns Promise<void>

Private handleAgentLegEvent

handleAgentLegEvent(): void

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:183
Function to handle agentLeg event

example
handleAgentLegEvent(event)

Returns void

Private handleCallContactEvent

handleCallContactEvent(): void

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:108
Subscribes to CallContactEvent and handles incoming events.

example
handleCallContactEvents(event)

Returns void

Private handleCallStack

handleCallStack(callContactEvent: 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> }>): string

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:195
Function to handle call stack

example
handleCallContactEvents(event)

Parameters
- callContactEvent: 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> }>
Returns string

Private handleMuteEvent

handleMuteEvent(): void

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:165
Function to handle Mute event

example
handleMuteEvent()

Returns void

Private updateCalls

updateCalls(): void

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:242
Function to handle Primary and Secondary calls

example
updateCalls()

Returns void

updateCurrentDevice

updateCurrentDevice(deviceId: string): Promise<void>

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:62
Updates current selected device

example
updateCurrentDevice("Jabra Engage 50 II")

Parameters
- deviceId: string
  
  string
Returns Promise<void>

updateEventSubscribers

updateEventSubscribers(isDeviceSelected: boolean): Promise<void>

- Defined in headset-sdk/src/lib/cxone-headset-client.ts:74
update Event Subscribers

example
updateEventSubscribers(true)

Parameters
- isDeviceSelected: boolean
  
  boolean
Returns Promise<void>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CxoneHeadsetClient

Properties

Private acdClient

Private acdSession

Private agentLegEventSubscription

Private callContactEventSubscription

Private callMap

Private isCallConference

jabraSdk

Private muteEventSubscription

Private primaryCall

Private secondaryCall

Static Private singleton

Accessors

Static instance

Returns CxoneHeadsetClient

Methods

addDevice

Returns Promise<void>

Private handleAgentLegEvent

Returns void

Private handleCallContactEvent

Returns void

Private handleCallStack

Parameters

Returns string

Private handleMuteEvent

Returns void

Private updateCalls

Returns void

updateCurrentDevice

Parameters

deviceId: string

Returns Promise<void>

updateEventSubscribers

Parameters

isDeviceSelected: boolean

Returns Promise<void>