CallWithChatAdapterState interface

Package:

@azure/communication-react

CallWithChat State is a combination of Stateful Chat and Stateful Calling clients with some state specific to the CallWithChat Composite only.

Extends

CallWithChatAdapterUiState,CallWithChatClientState

Inherited Properties

alternateCallerId	alternateCallerId for PSTN call
call	State of the current call.
chat	State of the current chat.
deepNoiseSuppressionOnByDefault	State to track whether the noise suppression should be on by default.
devices	State of available and currently selected devices
displayName	Display name of the participant using this CallWithChatAdapter.
environmentInfo	Environment information for system adapter is made on
hideAttendeeNames	Hide attendee names in teams meeting
hideDeepNoiseSuppressionButton	State to track whether to hide the noise suppression button.
isLocalPreviewMicrophoneEnabled	Microphone state before a call has joined.
isTeamsCall	State of whether the active call is a Teams interop call
isTeamsMeeting	State of whether the active call is a Teams interop meeting
latestCallErrors	Latest call error encountered for each operation performed via the adapter.
latestCallNotifications	Latest call notifications encountered in the call client state via the adapter.
latestChatErrors	Latest chat error encountered for each operation performed via the adapter.
onResolveDeepNoiseSuppressionDependency	Dependency to be injected for deep noise suppression effect.
onResolveVideoEffectDependency	Dependency to be injected for video background effects
page	Current page of the Composite.
reactions	Reaction resources to render in meetings
selectedVideoBackgroundEffect	State to track the selected video background effect
userId	ID of the call participant using this CallWithChatAdapter.
videoBackgroundImages	Default set of background images for background replacement effect

Inherited Property Details

alternateCallerId

alternateCallerId for PSTN call

alternateCallerId?: string

Property Value

string

Inherited From CallWithChatClientState.alternateCallerId

call

State of the current call.

call?: CallState

Property Value

CallState

Inherited From CallWithChatClientState.call

chat

State of the current chat.

chat?: ChatThreadClientState

Property Value

ChatThreadClientState

Inherited From CallWithChatClientState.chat

deepNoiseSuppressionOnByDefault

State to track whether the noise suppression should be on by default.

deepNoiseSuppressionOnByDefault?: boolean

Property Value

boolean

Inherited From CallWithChatClientState.deepNoiseSuppressionOnByDefault

devices

State of available and currently selected devices

devices: DeviceManagerState

Property Value

DeviceManagerState

Inherited From CallWithChatClientState.devices

displayName

Display name of the participant using this CallWithChatAdapter.

displayName: undefined | string

Property Value

undefined | string

Inherited From CallWithChatClientState.displayName

environmentInfo

Environment information for system adapter is made on

environmentInfo?: EnvironmentInfo

Property Value

EnvironmentInfo

Inherited From CallWithChatClientState.environmentInfo

hideAttendeeNames

Hide attendee names in teams meeting

hideAttendeeNames?: boolean

Property Value

boolean

Inherited From CallWithChatClientState.hideAttendeeNames

hideDeepNoiseSuppressionButton

State to track whether to hide the noise suppression button.

hideDeepNoiseSuppressionButton?: boolean

Property Value

boolean

Inherited From CallWithChatClientState.hideDeepNoiseSuppressionButton

isLocalPreviewMicrophoneEnabled

Microphone state before a call has joined.

public isLocalPreviewMicrophoneEnabled: boolean

Property Value

boolean

Inherited From CallWithChatAdapterUiState.isLocalPreviewMicrophoneEnabled

isTeamsCall

State of whether the active call is a Teams interop call

isTeamsCall: boolean

Property Value

boolean

Inherited From CallWithChatClientState.isTeamsCall

isTeamsMeeting

State of whether the active call is a Teams interop meeting

isTeamsMeeting: boolean

Property Value

boolean

Inherited From CallWithChatClientState.isTeamsMeeting

latestCallErrors

Latest call error encountered for each operation performed via the adapter.

latestCallErrors: AdapterErrors

Property Value

AdapterErrors

Inherited From CallWithChatClientState.latestCallErrors

latestCallNotifications

Latest call notifications encountered in the call client state via the adapter.

latestCallNotifications: AdapterNotifications

Property Value

AdapterNotifications

Inherited From CallWithChatClientState.latestCallNotifications

latestChatErrors

Latest chat error encountered for each operation performed via the adapter.

latestChatErrors: AdapterErrors

Property Value

AdapterErrors

Inherited From CallWithChatClientState.latestChatErrors

onResolveDeepNoiseSuppressionDependency

Dependency to be injected for deep noise suppression effect.

onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>

Property Value

() => Promise<DeepNoiseSuppressionEffectDependency>

Inherited From CallWithChatClientState.onResolveDeepNoiseSuppressionDependency

onResolveVideoEffectDependency

Dependency to be injected for video background effects

onResolveVideoEffectDependency?: () => Promise<VideoBackgroundEffectsDependency>

Property Value

() => Promise<VideoBackgroundEffectsDependency>

Inherited From CallWithChatClientState.onResolveVideoEffectDependency

page

Current page of the Composite.

public page: CallCompositePage

Property Value

CallCompositePage

Inherited From CallWithChatAdapterUiState.page

reactions

Reaction resources to render in meetings

reactions?: ReactionResources

Property Value

ReactionResources

Inherited From CallWithChatClientState.reactions

selectedVideoBackgroundEffect

State to track the selected video background effect

selectedVideoBackgroundEffect?: VideoBackgroundEffect

Property Value

VideoBackgroundEffect

Inherited From CallWithChatClientState.selectedVideoBackgroundEffect

userId

ID of the call participant using this CallWithChatAdapter.

userId: CommunicationIdentifierKind

Property Value

CommunicationIdentifierKind

Inherited From CallWithChatClientState.userId

videoBackgroundImages

Default set of background images for background replacement effect

videoBackgroundImages?: VideoBackgroundImage[]

Property Value

VideoBackgroundImage[]

Inherited From CallWithChatClientState.videoBackgroundImages