CallWithChatAdapterState interface

  • Reference
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

call

State of the current call.
chat

State of the current chat.
devices

State of available and currently selected devices
displayName

Display name of the participant using this CallWithChatAdapter.
isLocalPreviewMicrophoneEnabled

Microphone state before a call has joined.
isTeamsCall

State of whether the active call is a Teams interop call
latestCallErrors

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

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

Current page of the Composite.
userId

ID of the call participant using this CallWithChatAdapter.

Inherited Property Details

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

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

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

latestCallErrors

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

latestCallErrors: AdapterErrors

Property Value

AdapterErrors

Inherited From CallWithChatClientState.latestCallErrors

latestChatErrors

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

latestChatErrors: AdapterErrors

Property Value

AdapterErrors

Inherited From CallWithChatClientState.latestChatErrors

page

Current page of the Composite.

public page: CallCompositePage

Property Value

CallCompositePage

Inherited From CallWithChatAdapterUiState.page

userId

ID of the call participant using this CallWithChatAdapter.

userId: CommunicationIdentifierKind

Property Value

CommunicationIdentifierKind

Inherited From CallWithChatClientState.userId