Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneVoiceContact

Class to perform the business logic for show / hide and enable / disable the voice contact buttons

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional acwTypeId

acwTypeId?: number
remarks
  • represent model for ACW Type Id value

agentMuted

agentMuted: boolean = false

allowDispositions

allowDispositions: boolean

ani

ani: string

ansMachineOverride

ansMachineOverride: boolean

ansMachineOverrideEndTime

ansMachineOverrideEndTime: string

blendingToSkillName

blendingToSkillName: string

callControlButton

callControlButton: CallControlButton = ...

callType

callType: string

complianceRecord

complianceRecord: boolean

confirmationRequired

confirmationRequired: boolean

contactID

contactID: string
remarks
  • 'contactID' is identifier for the ACD contacts only. For DFO Contact please refer 'caseID' property in CXoneDigitalContact

customData

customData: string

customerCardUrl

customerCardUrl: string

customerName

customerName: string

deliveryType

deliveryType: string

disconnectCode

disconnectCode: string

dnis

dnis: string

externalId

externalId: string

finalState

finalState: boolean

Optional fromProvider

fromProvider?: string
remarks
  • represent model for denoting type of parent interaction while elevating

Private hideInboundHangup

hideInboundHangup: boolean = false

interactionId

interactionId: string
remarks
  • represent model for interaction id

isInbound

isInbound: boolean

isLinked

isLinked: boolean

isLogging

isLogging: boolean

Private isMaskVisible

isMaskVisible: boolean = false

Private isMuteVisible

isMuteVisible: boolean = false

Private isRecordVisible

isRecordVisible: boolean = false

isRequireManualAccept

isRequireManualAccept: boolean

label

label: string

lastStateChangeTime

lastStateChangeTime: Date

masterID

masterID: string

Optional maxSecondsACW

maxSecondsACW?: number
remarks
  • represent model for max seconds ACW

omniGroupId

omniGroupId: string

originalState

originalState: boolean

otherInformation

otherInformation: string

otherInformationNewFormat

otherInformationNewFormat: string

parentContactId

parentContactId: string

requireDisposition

requireDisposition: boolean = false
remarks
  • represent model for require disposition value

screenPopUrl

screenPopUrl: string

screenPopUrlVariables

screenPopUrlVariables: {}[]

skill

skill: string
remarks
  • represent model for contact skill

skillName

skillName: string
remarks
  • represent model for skill name

startTime

startTime: Date
remarks
  • represent model for start time

status

status: string
remarks
  • represent model for contact status

timeZones

timeZones: string

timeout

timeout: number

type

type: string
remarks
  • represent model for contact type

voiceBioHubPatronId

voiceBioHubPatronId: string

Private voiceControlService

voiceControlService: VoiceControlService = ...

Methods

Private assignToCurrentContact

  • assignToCurrentContact(callInfo: 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> }>): void

  • assign the event properties to CXoneVoiceContact class property

    Parameters

    • callInfo: 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> }>

    Returns void

end

  • Method to validate the contact has end button then invoke the endContact method.

    example
    end('123');

    Returns Promise<HttpResponse | CXoneSdkError>

hold

  • Method to validate the contact has hold button then invoke the holdContact method

    example
    hold('123')

    Returns Promise<HttpResponse | CXoneSdkError>

Private initiateButtonStates

  • initiateButtonStates(): void

  • Method to initiate the button states

    Returns void

mask

  • Method to validate the contact has mask button then invoke the maskCall method.

    example
    mask();

    Returns Promise<HttpResponse | CXoneSdkError>

mute

  • Method to validate the contact has mute button then invoke the muteAgent method.

    example
    mute();

    Returns Promise<HttpResponse | CXoneSdkError>

record

  • Method to validate the contact has record button then invoke the recordCall method.

    example
    record();

    Returns Promise<HttpResponse | CXoneSdkError>

resume

  • Method to validate the contact has hold button then invoke the resumeContact method.

    example
    resume('123');

    Returns Promise<HttpResponse | CXoneSdkError>

unmask

  • Method to validate the contact has unmask access then invoke the unmask method.

    example
    unmask();

    Returns Promise<HttpResponse | CXoneSdkError>

unmute

  • Method to validate the contact has unmute acccess then invoke the unmute method.

    example
    unmute();

    Returns Promise<HttpResponse | CXoneSdkError>

updateAgentPreference

  • updateAgentPreference(): void

  • Method to check the agent has mute, record and mask permission

    example
    this.updateAgentPreference()

    Returns void

updateButtonState

  • updateButtonState(): void

  • Update call controls

    example
    this.updateButtonState();

    Returns void

Private updateCallControlButtons

  • updateCallControlButtons(): void

  • Method to perform the logic for enable / disable the call controls

    Returns void

Private updateCallControlButtonsOnACWState

  • updateCallControlButtonsOnACWState(): void

  • This method to set all call buttons visibility true and enable false when status is disconnected in ACW state

    Returns void

Private updateCallControlButtonsOnActive

  • updateCallControlButtonsOnActive(): void

  • Method to set state of the call controls when status is Active

    Returns void

Private updateCallControlButtonsOnEnd

  • updateCallControlButtonsOnEnd(): void

  • This method to set all call buttons visibility false when status is disconnected

    Returns void

Private updateCallControlButtonsOnHold

  • updateCallControlButtonsOnHold(): void

  • Method to set state of the call controls when status is holding

    Returns void

Private updateCallControlButtonsOnIncoming

  • updateCallControlButtonsOnIncoming(): void

  • Method to set state of the call control when status is incoming

    Returns void

Private updateCallControlButtonsOnMask

  • updateCallControlButtonsOnMask(): void

  • Method to set state of the call controls when status is masking

    Returns void

Private updateCallControlButtonsOnMute

  • updateCallControlButtonsOnMute(): void

  • Method to set state of the call controls on mute

    Returns void

Private updateCallControlButtonsOnRecord

  • updateCallControlButtonsOnRecord(): void

  • Method to set state of the Record button when isLogging is true

    Returns void

updateCallControls

  • updateCallControls(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>; 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> }>): void

  • Update the class properties and button state for the consult call

    example
    this.updateCallControls(callContactEvent)

    Parameters

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

      call contact event

    Returns void

updateConsultCallControls

  • updateConsultCallControls(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>; 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> }>): void

  • Update the class properties and button state for the consult call

    example
    this.updateConsultCallControls(callContactEvent);

    Parameters

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

      Call contact event

    Returns void

updateControlsOnConsultCallStarted

  • updateControlsOnConsultCallStarted(): void

  • This method to update the call control if consult call is started/running

    example
    • updateControlsOnConsultCallStarted()

    Returns void

Private updateMultiCallControlButtons

  • updateMultiCallControlButtons(): void

  • Method to handle the controls for the second call contact

    Returns void

updateMuteState

  • updateMuteState(isAgentMuted: boolean): void

  • Get agentMute value from mute event to update mute button state

    example
    this.updateMuteState(false)

    Parameters

    • isAgentMuted: boolean

      boolean

    Returns void

Generated using TypeDoc