JabraSdkService | nice-cxone-acd-agent-apps

Class for jabra sdk services

Hierarchy

JabraSdkService

Constructors

constructor

new JabraSdkService(): JabraSdkService

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:66
Constructor for initialization params

example
new JabraSdkService()

Returns JabraSdkService

Properties

Private agentLegEvent

agentLegEvent: AgentLegEvent = ...

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> }>> = ...

deviceCollectionService

deviceCollectionService: DeviceCollectionService = ...

easyCallControlFactory

easyCallControlFactory: EasyCallControlFactory = ...

Private isCallConference

isCallConference: boolean = false

Private isMuteVisible

isMuteVisible: boolean = false

jabraApi

jabraApi: IApi = ...

jabraConnectAgentLegEvent

jabraConnectAgentLegEvent: Subject<ConnectAgentLeg> = ...

jabraDevice

jabraDevice: IDevice = ...

jabraErrorEvent

jabraErrorEvent: Subject<JabraErrorTypes> = ...

Private logger

logger: Logger = ...

Private primaryCall

primaryCall: string = ''

Private secondaryCall

secondaryCall: string = ''

Private shouldSkipNextCallStateEvent

shouldSkipNextCallStateEvent: boolean = false

source

source: string = ''

state

state: State = ...

Private voiceControlService

voiceControlService: VoiceControlService = ...

Methods

acceptIncomingCall

acceptIncomingCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:388
Accept incoming call

example
acceptIncomingCall();

Returns Promise<void>

checkCallStatus

checkCallStatus(callId: string): string

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:403
Check the status from callMap

example
checkCallStatus( 'callId' );

Parameters
- callId: string
Returns string

endActiveCall

endActiveCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:264
End active call

example
endActiveCall();

Returns Promise<void>

Private endAllActiveCalls

endAllActiveCalls(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:539
End All Active Calls

example
isConsultCall();

Returns Promise<void>

Private endPrimaryOrSecondaryCall

endPrimaryOrSecondaryCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:555
End Primary Or Secondary Call

example
endPrimaryOrSecondaryCall();

Returns Promise<void>

Private getValidCallId

getValidCallId(): string

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:570
Get Valid Call Id

example
getValidCallId();

Returns string

getWebHidConsent

getWebHidConsent(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:113
Get webHID consent

example
getWebHidConsent();

Returns Promise<void>

Private handleCallDecrease

handleCallDecrease(ongoingCalls: number): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:527
Handle Call Decrease i.e. Call disconnects

example
handleCallDecrease(1);

Parameters
- ongoingCalls: number
Returns Promise<void>

Private handleHoldState

handleHoldState(newHoldState: string): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:599
Handle Hold State change

example
handleHoldState();

Parameters
- newHoldState: string
Returns Promise<void>

Private handleIncomingCall

handleIncomingCall(callStatus: string, isConsultCall: boolean): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:506
handle Incoming Call

example
handleIncomingCall('callStatus', true);

Parameters
- callStatus: string
- isConsultCall: boolean
Returns Promise<void>

Private handleMuteState

handleMuteState(newMuteState: string): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:444
Handle Mute State change

example
handleMuteState();

Parameters
- newMuteState: string
Returns Promise<void>

hold

hold(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:328
Hold a call

example
hold();

Returns Promise<void>

initAll

initAll(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:126
Initialize all the methods

example
initAll();

Returns Promise<void>

Private initJabraSdk

initJabraSdk(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:75
Initializes the Jabra SDK and sets up the EasyCallControlFactory.

example
new JabraSdkService()

Returns Promise<void>

Private isConsultCall

isConsultCall(callType: string, callStatus: string): boolean

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:498
Checks if is Consult Call

example
isConsultCall('callType', 'callStatus');

Parameters
- callType: string
- callStatus: string
Returns boolean

mute

mute(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:298
Mute a call

example
mute();

Returns Promise<void>

rejectIncomingCall

rejectIncomingCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:373
Reject incoming call

example
rejectIncomingCall();

Returns Promise<void>

resume

resume(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:343
Resume a call

example
resume();

Returns Promise<void>

setUpDeviceSync

setUpDeviceSync(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:134
Set up device sync

example
setUpDeviceSync();

Returns Promise<void>

signalIncomingCall

signalIncomingCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:358
Signal incoming call

example
signalIncomingCall();

Returns Promise<void>

startNewCall

startNewCall(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:282
Start a new call

example
startNewCall();

Returns Promise<void>

Private subscribeToCallState

subscribeToCallState(): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:461
subscribe To Call State

example
subscribeToCallState();

Returns void

Private subscribeToHoldState

subscribeToHoldState(): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:583
Updates the state subscriptions for hold state for current call control device.

example
subscribeToHoldState();

Returns void

Private subscribeToMuteState

subscribeToMuteState(): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:424
subscribe To MuteState

example
subscribeToMuteState();

Returns void

unmute

unmute(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:313
Unmute a call

example
unmute();

Returns Promise<void>

Private unsubscribeFromCurrentDevice

unsubscribeFromCurrentDevice(): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:414
unsubscribe From Current Device

example
unsubscribeFromCurrentDevice();

Returns void

updateAgentLegEvent

updateAgentLegEvent(agentLegEvent: AgentLegEvent): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:245
Update Agent Leg

example
updateAgentLegEvent();

Parameters
- agentLegEvent: AgentLegEvent
Returns void

updateAgentPreference

updateAgentPreference(): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:214
Method to check the agent has mute, record and mask permission
example
```
this.updateAgentPreference()
```
Returns void

updateCallMap

updateCallMap(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> }>>, primaryCall: string, secondaryCall: string, isCallConference: boolean): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:253
Update Call Map

example
updateCallMap();

Parameters
- 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> }>>
- primaryCall: string
- secondaryCall: string
- isCallConference: boolean
Returns void

updateCurrentDeviceToNoDevice

updateCurrentDeviceToNoDevice(): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:199
Updates current Call Control Device to No Device

example
updateCurrentDeviceToNoDevice();

Returns Promise<void>

updateCurrentJabraDevice

updateCurrentJabraDevice(deviceId: string): Promise<void>

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:170
Updates current Call Control Device

example
updateCurrentJabraDevice(device)

Parameters
- deviceId: string
  
  string
Returns Promise<void>

updateSource

updateSource(source: string): void

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:237
Update jabra state

example
updateSource();

Parameters
- source: string
Returns void

updateStateSubscription

updateStateSubscription(): State

- Defined in headset-sdk/src/lib/jabra/jabra-sdk-service.ts:616
Updates the state subscriptions for the current call control device.

example
updateStateSubscription();

Returns State

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns JabraSdkService

Properties

Private agentLegEvent

callMap

deviceCollectionService

easyCallControlFactory

Private isCallConference

Private isMuteVisible

jabraApi

jabraConnectAgentLegEvent

jabraDevice

jabraErrorEvent

Private logger

Private primaryCall

Private secondaryCall

Private shouldSkipNextCallStateEvent

source

state

Private voiceControlService

Methods

acceptIncomingCall

Returns Promise<void>

checkCallStatus

Parameters

callId: string

Returns string

endActiveCall

Returns Promise<void>

Private endAllActiveCalls

Returns Promise<void>

Private endPrimaryOrSecondaryCall

Returns Promise<void>

Private getValidCallId

Returns string

getWebHidConsent

Returns Promise<void>

Private handleCallDecrease

Parameters

ongoingCalls: number

Returns Promise<void>

Private handleHoldState

Parameters

newHoldState: string

Returns Promise<void>

Private handleIncomingCall

Parameters

callStatus: string

isConsultCall: boolean

Returns Promise<void>

Private handleMuteState

Parameters

newMuteState: string

Returns Promise<void>

hold

Returns Promise<void>

initAll

Returns Promise<void>

Private initJabraSdk

Returns Promise<void>

Private isConsultCall

Parameters

callType: string

callStatus: string

Returns boolean

mute

Returns Promise<void>

rejectIncomingCall

Returns Promise<void>

resume

Returns Promise<void>

setUpDeviceSync

Returns Promise<void>

signalIncomingCall