Share via


CallWithChatControlOptions interface

Customization options for the control bar in calling with chat experience.

Extends

Properties

chatButton

Show or hide the chat button in the call-with-chat composite control bar.

Inherited Properties

cameraButton

Show or Hide Camera Button during a call

captionsButton

Show, Hide or Disable captions during a call.

devicesButton

Show or Hide Devices button during a call.

displayType

CallControlDisplayType to change how the call controls are displayed. 'compact' display type will decreases the size of buttons and hide the labels.

dtmfDialerButton

Show or hide the dialpad button in the composite control bar.

endCallButton

Show or Hide EndCall button during a call.

exitSpotlightButton

Show or hide the exit spotlight button in the composite control bar when local participant is spotlighted.

galleryControlsButton

Show, Hide or Disable gallery controls button during a call.

holdButton
microphoneButton

Show or Hide Microphone button during a call.

moreButton

Show, Hide or disable the more button during a call.

onFetchCustomButtonProps

Inject custom buttons in the call controls.

participantsButton

Show, Hide or Disable participants button during a call.

peopleButton

Show or hide the people button in the composite control bar.

raiseHandButton

Show, Hide or Disable the screen share button during a call.

reactionButton

Show, Hide or Disable the reaction button during a call.

realTimeTextButton

Show, Hide or Disable real time text during a call.

screenShareButton

Show, Hide or Disable the screen share button during a call.

teamsMeetingPhoneCallButton

Show, meeting conference phone information.

Property Details

chatButton

Show or hide the chat button in the call-with-chat composite control bar.

chatButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited Property Details

cameraButton

Show or Hide Camera Button during a call

cameraButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.cameraButton

captionsButton

Show, Hide or Disable captions during a call.

captionsButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.captionsButton

devicesButton

Show or Hide Devices button during a call.

devicesButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.devicesButton

displayType

CallControlDisplayType to change how the call controls are displayed. 'compact' display type will decreases the size of buttons and hide the labels.

displayType?: CallControlDisplayType

Property Value

Remarks

If the composite formFactor is set to 'mobile', the control bar will always use compact view.

Inherited From CommonCallControlOptions.displayType

dtmfDialerButton

Show or hide the dialpad button in the composite control bar.

dtmfDialerButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.dtmfDialerButton

endCallButton

Show or Hide EndCall button during a call.

endCallButton?: boolean | { disableEndCallModal?: boolean, hangUpForEveryone?: false | "endCallOptions" }

Property Value

boolean | { disableEndCallModal?: boolean, hangUpForEveryone?: false | "endCallOptions" }

Inherited From CommonCallControlOptions.endCallButton

exitSpotlightButton

Show or hide the exit spotlight button in the composite control bar when local participant is spotlighted.

exitSpotlightButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.exitSpotlightButton

galleryControlsButton

Show, Hide or Disable gallery controls button during a call.

galleryControlsButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.galleryControlsButton

holdButton

holdButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.holdButton

microphoneButton

Show or Hide Microphone button during a call.

microphoneButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.microphoneButton

moreButton

Show, Hide or disable the more button during a call.

moreButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.moreButton

onFetchCustomButtonProps

Inject custom buttons in the call controls.

onFetchCustomButtonProps?: CustomCallControlButtonCallback[]

Property Value

Inherited From CommonCallControlOptions.onFetchCustomButtonProps

participantsButton

Show, Hide or Disable participants button during a call.

participantsButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.participantsButton

peopleButton

Show or hide the people button in the composite control bar.

peopleButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.peopleButton

raiseHandButton

Show, Hide or Disable the screen share button during a call.

raiseHandButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.raiseHandButton

reactionButton

Show, Hide or Disable the reaction button during a call.

reactionButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.reactionButton

realTimeTextButton

Show, Hide or Disable real time text during a call.

realTimeTextButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.realTimeTextButton

screenShareButton

Show, Hide or Disable the screen share button during a call.

screenShareButton?: boolean | { disabled: boolean }

Property Value

boolean | { disabled: boolean }

Inherited From CommonCallControlOptions.screenShareButton

teamsMeetingPhoneCallButton

Show, meeting conference phone information.

teamsMeetingPhoneCallButton?: boolean

Property Value

boolean

Inherited From CommonCallControlOptions.teamsMeetingPhoneCallButton