DialpadProps interface

Package:

@azure/communication-react

Props for Dialpad component.

Properties

dialpadMode	Dialer mode for the dialpad. The dtmf mode is for sending dtmf tones and the appearence of the dialpad is changed like hiding the input box. When using dialer mode the input box is there and can be edited to change the number being dialed.
disableDtmfPlayback	Disables DTMF sounds when dialpad buttons are pressed. the actual tones are still sent to the call.
dtmfAudioContext	Audio context for generating DTMF tones. If this if not provided the dialpad will create one iteslf.
longPressTrigger	Determines what kind of device that the user is on and should respect that based on interaction interfaces available to the user
onChange	on change function for text field, provides an unformatted plain text
onClickDialpadButton	Callback for dialpad button behavior
onSendDtmfTone	function to send dtmf tones on button click
showDeleteButton	flag to determine when to show/hide delete button, default true
strings
styles	Styles for customizing the dialpad component
textFieldValue	set dialpad textfield content

Property Details

dialpadMode

Dialer mode for the dialpad. The dtmf mode is for sending dtmf tones and the appearence of the dialpad is changed like hiding the input box. When using dialer mode the input box is there and can be edited to change the number being dialed.

dialpadMode?: DialpadMode

Property Value

DialpadMode

disableDtmfPlayback

Disables DTMF sounds when dialpad buttons are pressed. the actual tones are still sent to the call.

disableDtmfPlayback?: boolean

Property Value

boolean

dtmfAudioContext

Audio context for generating DTMF tones. If this if not provided the dialpad will create one iteslf.

dtmfAudioContext?: AudioContext

Property Value

AudioContext

longPressTrigger

Determines what kind of device that the user is on and should respect that based on interaction interfaces available to the user

longPressTrigger?: LongPressTrigger

Property Value

LongPressTrigger

onChange

on change function for text field, provides an unformatted plain text

onChange?: (input: string) => void

Property Value

(input: string) => void

onClickDialpadButton

Callback for dialpad button behavior

onClickDialpadButton?: (buttonValue: string, buttonIndex: number) => void

Property Value

(buttonValue: string, buttonIndex: number) => void

onSendDtmfTone

function to send dtmf tones on button click

onSendDtmfTone?: (dtmfTone: DtmfTone) => Promise<void>

Property Value

(dtmfTone: DtmfTone) => Promise<void>

showDeleteButton

flag to determine when to show/hide delete button, default true

showDeleteButton?: boolean

Property Value

boolean

strings

strings?: DialpadStrings

Property Value

DialpadStrings

styles

Styles for customizing the dialpad component

styles?: DialpadStyles

Property Value

DialpadStyles

textFieldValue

set dialpad textfield content

textFieldValue?: string

Property Value

string