Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JabraSdkService

Class for jabra sdk services

Hierarchy

  • JabraSdkService

Index

Constructors

Properties

Methods

Constructors

constructor

  • 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>; 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>; 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 = ...

jabraDevice

jabraDevice: IDevice = ...

jabraErrorEvent

jabraErrorEvent: Subject<JabraErrorTypes> = ...

Private logger

logger: Logger = ...

Private primaryCall

primaryCall: string = ''

Private secondaryCall

secondaryCall: string = ''

source

source: string = ''

state

state: State = ...

Private voiceControlService

voiceControlService: VoiceControlService = ...

Methods

acceptIncomingCall

  • acceptIncomingCall(): Promise<void>

  • Accept incoming call

    example

    acceptIncomingCall();

    Returns Promise<void>

checkCallStatus

  • checkCallStatus(callId: string): string

  • Check the status from callMap

    example

    checkCallStatus( 'callId' );

    Parameters

    • callId: string

    Returns string

endActiveCall

  • endActiveCall(): Promise<void>

  • End active call

    example

    endActiveCall();

    Returns Promise<void>

Private endAllActiveCalls

  • endAllActiveCalls(): Promise<void>

  • End All Active Calls

    example

    isConsultCall();

    Returns Promise<void>

Private endPrimaryOrSecondaryCall

  • endPrimaryOrSecondaryCall(): Promise<void>

  • End Primary Or Secondary Call

    example

    endPrimaryOrSecondaryCall();

    Returns Promise<void>

Private getValidCallId

  • getValidCallId(): string

  • Get Valid Call Id

    example

    getValidCallId();

    Returns string

getWebHidConsent

  • getWebHidConsent(): Promise<void>

  • Get webHID consent

    example

    getWebHidConsent();

    Returns Promise<void>

Private handleCallDecrease

  • handleCallDecrease(ongoingCalls: number): Promise<void>

  • Handle Call Decrease i.e. Call disconnects

    example

    handleCallDecrease(1);

    Parameters

    • ongoingCalls: number

    Returns Promise<void>

Private handleHoldState

  • handleHoldState(newHoldState: string): Promise<void>

  • Handle Hold State change

    example

    handleHoldState();

    Parameters

    • newHoldState: string

    Returns Promise<void>

Private handleIncomingCall

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

  • handle Incoming Call

    example

    handleIncomingCall('callStatus', true);

    Parameters

    • callStatus: string
    • isConsultCall: boolean

    Returns Promise<void>

Private handleMuteState

  • handleMuteState(newMuteState: string): Promise<void>

  • Handle Mute State change

    example

    handleMuteState();

    Parameters

    • newMuteState: string

    Returns Promise<void>

hold

  • hold(): Promise<void>

  • Hold a call

    example

    hold();

    Returns Promise<void>

initAll

  • initAll(): Promise<void>

  • Initialize all the methods

    example

    initAll();

    Returns Promise<void>

Private initJabraSdk

  • initJabraSdk(): Promise<void>

  • Initializes the Jabra SDK and sets up the EasyCallControlFactory.

    example

    new JabraSdkService()

    Returns Promise<void>

Private isConsultCall

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

  • Checks if is Consult Call

    example

    isConsultCall('callType', 'callStatus');

    Parameters

    • callType: string
    • callStatus: string

    Returns boolean

mute

  • mute(): Promise<void>

  • Mute a call

    example

    mute();

    Returns Promise<void>

rejectIncomingCall

  • rejectIncomingCall(): Promise<void>

  • Reject incoming call

    example

    rejectIncomingCall();

    Returns Promise<void>

resume

  • resume(): Promise<void>

  • Resume a call

    example

    resume();

    Returns Promise<void>

setUpDeviceSync

  • setUpDeviceSync(): Promise<void>

  • Set up device sync

    example

    setUpDeviceSync();

    Returns Promise<void>

signalIncomingCall

  • signalIncomingCall(): Promise<void>

  • Signal incoming call

    example

    signalIncomingCall();

    Returns Promise<void>

startNewCall

  • startNewCall(): Promise<void>

  • Start a new call

    example

    startNewCall();

    Returns Promise<void>

Private subscribeToCallState

  • subscribeToCallState(): void

  • subscribe To Call State

    example

    subscribeToCallState();

    Returns void

Private subscribeToHoldState

  • subscribeToHoldState(): void

  • Updates the state subscriptions for hold state for current call control device.

    example

    subscribeToHoldState();

    Returns void

Private subscribeToMuteState

  • subscribeToMuteState(): void

  • subscribe To MuteState

    example

    subscribeToMuteState();

    Returns void

unmute

  • unmute(): Promise<void>

  • Unmute a call

    example

    unmute();

    Returns Promise<void>

Private unsubscribeFromCurrentDevice

  • unsubscribeFromCurrentDevice(): void

  • unsubscribe From Current Device

    example

    unsubscribeFromCurrentDevice();

    Returns void

updateAgentLegEvent

  • Update Agent Leg

    example

    updateAgentLegEvent();

    Parameters

    Returns void

updateAgentPreference

  • updateAgentPreference(): void

  • 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>; 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>; 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

  • 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>; 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>; 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>

  • Updates current Call Control Device to No Device

    example

    updateCurrentDeviceToNoDevice();

    Returns Promise<void>

updateCurrentJabraDevice

  • updateCurrentJabraDevice(deviceId: string): Promise<void>

  • Updates current Call Control Device

    example

    updateCurrentJabraDevice(device)

    Parameters

    • deviceId: string

      string

    Returns Promise<void>

updateSource

  • updateSource(source: string): void

  • Update jabra state

    example

    updateSource();

    Parameters

    • source: string

    Returns void

updateStateSubscription

  • updateStateSubscription(): State

  • Updates the state subscriptions for the current call control device.

    example

    updateStateSubscription();

    Returns State

Generated using TypeDoc