Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CXoneVoiceMailContact

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

contactID

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

finalState

finalState: boolean
remarks
  • represent model for final state

from

from: string
remarks
  • represent model for from

Optional fromProvider

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

initialHasPlayed

initialHasPlayed: boolean = false
remarks
  • represent model for has voicemail auto played

interactionId

interactionId: string
remarks
  • represent model for interaction id

lastStateChangeTime

lastStateChangeTime: Date
remarks
  • represent model for last state change time

Optional maxSecondsACW

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

Optional requireDisposition

requireDisposition?: boolean
remarks
  • represent model for require disposition value

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

type

type: string
remarks
  • represent model for contact type

Private voiceControlService

voiceControlService: VoiceControlService = ...

voiceMailControlButton

voiceMailControlButton: VoiceMailControlButton = ...

voiceMailEventData

voiceMailEventData: 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> }>

Methods

end

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

    example
    end('123');

    Returns Promise<HttpResponse | CXoneSdkError>

Private initiateButtonStates

  • initiateButtonStates(): void

  • Method to initiate the button states

    Returns void

pause

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

    example
    pause('123')

    Returns Promise<HttpResponse | CXoneSdkError>

play

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

    example
    resume('123');

    Returns Promise<HttpResponse | CXoneSdkError>

playVoiceMail

  • Method to play the voicemail audio

    example
    playVoiceMail(true, 50);

    Parameters

    • playTimeStamp: boolean

      Include date/time in audio playback

    • position: number

      Position of the wav file at a specified second

    Returns Promise<HttpResponse | CXoneSdkError>

resumeVoiceMail

transfer

  • Method to transfer a voicemail contact.

    example
    transfer('123');

    Parameters

    • agentId: string

      id of agent initiating the transfer

    Returns Promise<HttpResponse | CXoneSdkError>

updateButtonState

  • updateButtonState(): void

  • Update vm controls

    example
    this.updateButtonState();

    Returns void

Private updateCurrentContactInfo

  • updateCurrentContactInfo(vmInfo: 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> }>): void

  • assign the event properties to CXoneVoiceMailContact class property

    Parameters

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

    Returns void

Private updateVoiceMailControlButtons

  • updateVoiceMailControlButtons(): void

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

    Returns void

Private updateVoiceMailControlButtonsOnACWState

  • updateVoiceMailControlButtonsOnACWState(): void

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

    Returns void

Private updateVoiceMailControlButtonsOnActive

  • updateVoiceMailControlButtonsOnActive(): void

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

    Returns void

Private updateVoiceMailControlButtonsOnEnd

  • updateVoiceMailControlButtonsOnEnd(): void

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

    Returns void

Private updateVoiceMailControlButtonsOnHold

  • updateVoiceMailControlButtonsOnHold(): void

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

    Returns void

Private updateVoiceMailControlButtonsOnIncoming

  • updateVoiceMailControlButtonsOnIncoming(): void

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

    Returns void

updateVoiceMailControls

  • updateVoiceMailControls(voiceMailContactEvent?: 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> }>): void

  • Update the class properties and button state for the vm

    example
    this.updateVoiceMailControls(voiceMailContactEvent)

    Parameters

    • Optional voiceMailContactEvent: 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> }>

      vm contact event

    Returns void

Generated using TypeDoc