Class CallSettingsBuilder

Hierarchy

CallSettingsBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new CallSettingsBuilder(): CallSettingsBuilder

Returns CallSettingsBuilder

Methods

build

build(): CallSettings

This method will return an object of the CallSettings class.

Returns CallSettings

enableDefaultLayout

enableDefaultLayout(defaultLayout: boolean): CallSettingsBuilder

Parameters
- defaultLayout: boolean
  
  This methods shows/hides the default button layout. If set to true the default button layout will be shown. If set to false the default button layout will be hidden. Default value is true
Returns CallSettingsBuilder

forceLegacyUI

forceLegacyUI(legacyUI: boolean): CallSettingsBuilder

Parameters
- legacyUI: boolean
  
  This method will render the legacy call UI. If set to true it will render the legacy call UI. Default value is false.
Returns CallSettingsBuilder

setAppId

setAppId(appId: string): CallSettingsBuilder

Parameters
- appId: string
  
  This method will set the appID.
Returns CallSettingsBuilder

setCustomCSS

setCustomCSS(customCSS: string): CallSettingsBuilder

Parameters
- customCSS: string
  
  This method will set the custom CSS of the call screen.
Returns CallSettingsBuilder

setIsAudioOnlyCall

setIsAudioOnlyCall(isAudioOnly: boolean): CallSettingsBuilder

Parameters
- isAudioOnly: boolean
  
  This methods sets the type(audio/video) of the call. If set to true, the call will be strictly an audio call. If set to false, the call will be an audio-video call. Default value is false
Returns CallSettingsBuilder

setLocalizedStringObject

setLocalizedStringObject(localizedStringObject: Object): CallSettingsBuilder

Parameters
- localizedStringObject: Object
  
  This method will set the localized text in the call screen.
Returns CallSettingsBuilder

setMode

setMode(mode: string): CallSettingsBuilder

Parameters
- mode: string
  
  This method sets the mode of the call.
Returns CallSettingsBuilder

setSessionID

setSessionID(sessionID: string): CallSettingsBuilder

Parameters
- sessionID: string
  
  This methods sets the session ID of the call.
Returns CallSettingsBuilder

showEndCallButton

showEndCallButton(showEndCallButton: boolean): CallSettingsBuilder

Parameters
- showEndCallButton: boolean
  
  This method shows/hides the end call button. If set to true it will display the end call button. If set to false it will hide the end call button. Default value is true.
Returns CallSettingsBuilder

showModeButton

showModeButton(showModeButton: boolean): CallSettingsBuilder

Parameters
- showModeButton: boolean
  
  This method shows/hides the switch mode button. If set to true it will display the switch mode button. If set to false it will hide the switch mode button. Default value is true.
Returns CallSettingsBuilder

showMuteAudioButton

showMuteAudioButton(showMuteAudioButton: boolean): CallSettingsBuilder

Parameters
- showMuteAudioButton: boolean
  
  This method shows/hides the mute audio button. If set to true it will display the mute audio button. If set to false it will hide the mute audio button. Default value is true.
Returns CallSettingsBuilder

showPauseVideoButton

showPauseVideoButton(showPauseVideoButton: boolean): CallSettingsBuilder

Parameters
- showPauseVideoButton: boolean
  
  This method shows/hides the pause video button. If set to true it will display the pause video button. If set to false it will hide the pause video button. Default value is true.
Returns CallSettingsBuilder

showRecordingButton

showRecordingButton(showRecordingButton: boolean): CallSettingsBuilder

Parameters
- showRecordingButton: boolean
  
  This method shows/hides the recording button. If set to true it will display the recording button. If set to false it will hide the recording button. Default value is false.
Returns CallSettingsBuilder

showScreenShareButton

showScreenShareButton(showScreenShareButton: boolean): CallSettingsBuilder

Parameters
- showScreenShareButton: boolean
  
  This method shows/hides the screen share button. If set to true it will display the screen share button. If set to false it will hide the screen share button. Default value is true.
Returns CallSettingsBuilder

startRecordingOnCallStart

startRecordingOnCallStart(startRecordingOnCallStart: boolean): CallSettingsBuilder

Parameters
- startRecordingOnCallStart: boolean
  
  This method starts the recording as soon as the call start. If set to true it will start the recording as soon as the call start. Default value is false.
Returns CallSettingsBuilder

startWithAudioMuted

startWithAudioMuted(audioMuted: boolean): CallSettingsBuilder

Parameters
- audioMuted: boolean
  
  This method allows the call to be started with audio muted. If set to true, the call will start with audio muted. Default value is false.
Returns CallSettingsBuilder

startWithVideoMuted

startWithVideoMuted(videoMuted: boolean): CallSettingsBuilder

Parameters
- videoMuted: boolean
  
  This method allows the call to be started with video muted. If set to true, the call will start with video muted. Default value is false.
Returns CallSettingsBuilder