CallWithChatAdapter interface

Package:

@azure/communication-react

CallWithChatComposite Adapter interface.

Extends

CallWithChatAdapterManagement,AdapterState<CallWithChatAdapterState>,Disposable,CallWithChatAdapterSubscriptions

Inherited Properties

forbidAudio	forbids audio for the specified user ids.
forbidOthersAudio	forbids audio for Teams meeting attendees except the local user.
forbidOthersVideo	forbids video for Teams meeting attendees except the local user.
forbidVideo	forbids video for the specified user ids.
permitAudio	permits audio for the specified user ids.
permitOthersAudio	permits audio for Teams meeting attendees except the local user.
permitOthersVideo	permits video for Teams meeting attendees except the local user.
permitVideo	permits video for the specified user ids.
sendDtmfTone	send dtmf tone to another participant in the call in 1:1 calls
sendRealTimeText	Send real time text

Inherited Methods

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Adds a new Participant to the call.
askDevicePermission(PermissionConstraints)	Ask for permissions of devices.
createStreamView(string, VideoStreamOptions)	Create the html view for a stream.
createTogetherModeStreamView(TogetherModeStreamOptions)	Create the html view for a togethermode stream.
deleteMessage(string)	Delete a message in the thread.
dispose()	Dispose of the Composite
disposeLocalVideoStreamView()	Dispose the html view for a local video stream
disposeRemoteVideoStreamView(string)	Dispose the html view for a remote video stream
disposeScreenShareStreamView(string)	Dispose the html view for a screen share stream
disposeStreamView(string, VideoStreamOptions)	Dispose the html view for a stream.
disposeTogetherModeStreamView()	Dispose the html view for a togethermode stream.
downloadResourceToCache(ResourceDetails)
fetchInitialData()	Fetch initial state for the Chat adapter. Performs the minimal fetch necessary for ChatComposite and API methods.
getState()	Get the current State
holdCall()	Puts the Call in a Localhold.
joinCall(boolean)	Join the call with microphone initially on/off.
joinCall(JoinCallOptions)	Join the call with options bag to set microphone/camera initial state when joining call true = turn on the device when joining call false = turn off the device when joining call 'keep'/undefined = retain devices' precall state
leaveCall(boolean)	Leave the call.
loadPreviousChatMessages(number)	Load more previous messages in the chat thread history.
lowerHand()	Lower hand for local user.
mute()	Mute the current user during the call or disable microphone locally.
muteAllRemoteParticipants()	Mute a participant
muteParticipant(string)	Mute a participant
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)	Unsubscribes the handler to stateChanged events.
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)	Send Reaction to ongoing meeting.
onStateChange((state: CallWithChatAdapterState) => void)	Subscribes the handler to stateChanged events.
queryCameras()	Query for available camera devices.
queryMicrophones()	Query for available microphone devices.
querySpeakers()	Query for available microphone devices.
raiseHand()	Raise hand for local user.
removeParticipant(CommunicationIdentifier)	Remove a participant from the call.
removeParticipant(string)	Remove a participant from a Call.
removeResourceFromCache(ResourceDetails)
resumeCall()	Resumes the call from a LocalHold state.
returnFromBreakoutRoom()	Return to origin call of breakout room
sendMessage(string, SendMessageOptions)	Send a message in the thread.
sendReadReceipt(string)	Send a read receipt for a message.
sendTypingIndicator()	Send typing indicator in the thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Set the camera to use in the call.
setCaptionLanguage(string)	Function to set caption language
setMicrophone(AudioDeviceInfo)	Set the microphone to use in the call.
setSpeaker(AudioDeviceInfo)	Set the speaker to use in the call.
setSpokenLanguage(string)	Function to set spoken language
setTogetherModeSceneSize(number, number)	Recalculate the seating positions for together mode.
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	Start the call.
startCall(string[], StartCallOptions)	Start the call.
startCamera(VideoStreamOptions)	Start the camera. This method will start rendering a local camera view when the call is not active.
startCaptions(StartCaptionsAdapterOptions)	Function to Start captions
startNoiseSuppressionEffect()	Start the noise suppression effect.
startScreenShare()	Start sharing the screen during a call.
startSpotlight(string[])	Start spotlight
startTogetherMode()	Start together mode.
startVideoBackgroundEffect(VideoBackgroundEffect)	Start the video background effect.
stopAllSpotlight()	Stop all spotlights
stopCamera()	Stop the camera. This method will stop rendering a local camera view when the call is not active.
stopCaptions(StopCaptionsAdapterOptions)	Funtion to stop captions
stopNoiseSuppressionEffect()	Start the noise suppression effect.
stopScreenShare()	Stop sharing the screen.
stopSpotlight(string[])	Stop spotlight
stopVideoBackgroundEffects()	Stop the video background effect.
submitSurvey(CallSurvey)	Send the end of call survey result
unmute()	Unmute the current user during the call or enable microphone locally.
updateBackgroundPickerImages(VideoBackgroundImage[])	Override the background picker images for background replacement effect.
updateMessage(string, string, Record<string, string>)	Update a message content.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Update the selected video background effect

Inherited Property Details

forbidAudio

forbids audio for the specified user ids.

forbidAudio: (userIds: string[]) => Promise<void>

Property Value

(userIds: string[]) => Promise<void>

Inherited From CallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

forbids audio for Teams meeting attendees except the local user.

forbidOthersAudio: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

forbids video for Teams meeting attendees except the local user.

forbidOthersVideo: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

forbids video for the specified user ids.

forbidVideo: (userIds: string[]) => Promise<void>

Property Value

(userIds: string[]) => Promise<void>

Inherited From CallWithChatAdapterManagement.forbidVideo

permitAudio

permits audio for the specified user ids.

permitAudio: (userIds: string[]) => Promise<void>

Property Value

(userIds: string[]) => Promise<void>

Inherited From CallWithChatAdapterManagement.permitAudio

permitOthersAudio

permits audio for Teams meeting attendees except the local user.

permitOthersAudio: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

permits video for Teams meeting attendees except the local user.

permitOthersVideo: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CallWithChatAdapterManagement.permitOthersVideo

permitVideo

permits video for the specified user ids.

permitVideo: (userIds: string[]) => Promise<void>

Property Value

(userIds: string[]) => Promise<void>

Inherited From CallWithChatAdapterManagement.permitVideo

sendDtmfTone

send dtmf tone to another participant in the call in 1:1 calls

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

Property Value

(dtmfTone: DtmfTone) => Promise<void>

Inherited From CallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

Send real time text

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Property Value

(text: string, isFinalized: boolean) => Promise<void>

Inherited From CallWithChatAdapterManagement.sendRealTimeText

Inherited Method Details

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parameters

participant

CommunicationUserIdentifier

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adds a new Participant to the call.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Parameters

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.addParticipant

askDevicePermission(PermissionConstraints)

Ask for permissions of devices.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

Parameters

constrain

PermissionConstraints

Define constraints for accessing local devices <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Returns

Promise<DeviceAccess>

Remarks

Browser permission window will pop up if permissions are not granted yet.

Inherited From CallWithChatAdapterManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Create the html view for a stream.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parameters

remoteUserId

string

Id of the participant to render, leave it undefined to create the local camera view

options

VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void | CreateVideoStreamViewResult>

Remarks

This method is implemented for composite.

Inherited From CallWithChatAdapterManagement.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Create the html view for a togethermode stream.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parameters

options

TogetherModeStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void | TogetherModeStreamViewResult>

Remarks

This method is implemented for composite

Inherited From CallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Delete a message in the thread.

function deleteMessage(messageId: string): Promise<void>

Parameters

messageId

string

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.deleteMessage

dispose()

Dispose of the Composite

function dispose()

Inherited From Disposable_2.dispose

disposeLocalVideoStreamView()

Dispose the html view for a local video stream

function disposeLocalVideoStreamView(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Dispose the html view for a remote video stream

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId

string

Id of the participant to dispose

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Dispose the html view for a screen share stream

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId

string

Id of the participant to dispose the screen share stream view for.

Returns

Promise<void>

Remarks

this method is implemented for composite

Inherited From CallWithChatAdapterManagement.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Dispose the html view for a stream.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parameters

remoteUserId

string

Id of the participant to render, leave it undefined to dispose the local camera view

options

VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Remarks

This method is implemented for composite.

Inherited From CallWithChatAdapterManagement.disposeStreamView

disposeTogetherModeStreamView()

Dispose the html view for a togethermode stream.

function disposeTogetherModeStreamView(): Promise<void>

Returns

Promise<void>

Remarks

This method is implemented for composite

Inherited From CallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parameters

resourceDetails

ResourceDetails

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.downloadResourceToCache

fetchInitialData()

Fetch initial state for the Chat adapter.

Performs the minimal fetch necessary for ChatComposite and API methods.

function fetchInitialData(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.fetchInitialData

getState()

Get the current State

function getState(): CallWithChatAdapterState

Returns

CallWithChatAdapterState

Inherited From AdapterState.getState

holdCall()

Puts the Call in a Localhold.

function holdCall(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.holdCall

joinCall(boolean)

Warning

This API is now deprecated.

Use joinCall(options?:JoinCallOptions) instead.

Join the call with microphone initially on/off.

function joinCall(microphoneOn?: boolean): undefined | Call

Parameters

microphoneOn

boolean

Whether microphone is initially enabled

Returns

undefined | Call

Inherited From CallWithChatAdapterManagement.joinCall

joinCall(JoinCallOptions)

Join the call with options bag to set microphone/camera initial state when joining call true = turn on the device when joining call false = turn off the device when joining call 'keep'/undefined = retain devices' precall state

function joinCall(options?: JoinCallOptions): undefined | Call

Parameters

options

JoinCallOptions

param to set microphone/camera initially on/off/use precall state.

Returns

undefined | Call

Inherited From CallWithChatAdapterManagement.joinCall

leaveCall(boolean)

Leave the call.

function leaveCall(forEveryone?: boolean): Promise<void>

Parameters

forEveryone

boolean

Whether to remove all participants when leaving

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.leaveCall

loadPreviousChatMessages(number)

Load more previous messages in the chat thread history.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parameters

messagesToLoad

number

Returns

Promise<boolean>

Remarks

This method is usually used to control incremental fetch/infinite scroll.

Inherited From CallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Lower hand for local user.

function lowerHand(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.lowerHand

mute()

Mute the current user during the call or disable microphone locally.

function mute(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Mute a participant

function muteAllRemoteParticipants(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Mute a participant

function muteParticipant(userId: string): Promise<void>

Parameters

userId

string

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("callEnded", CallEndedListener)

function off(event: "callEnded", listener: CallEndedListener)

Parameters

event

"callEnded"

listener

CallEndedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("callError", (e: AdapterError) => void)

function off(event: "callError", listener: (e: AdapterError) => void)

Parameters

event

"callError"

listener

(e: AdapterError) => void

Inherited From CallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parameters

event

"callIdChanged"

listener

CallIdChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parameters

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parameters

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

Inherited From CallWithChatAdapterSubscriptions.off

off("capabilitiesChanged", CapabilitiesChangedListener)

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameters

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("captionsReceived", CaptionsReceivedListener)

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameters

event

"captionsReceived"

listener

CaptionsReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("chatError", (e: AdapterError) => void)

function off(event: "chatError", listener: (e: AdapterError) => void)

Parameters

event

"chatError"

listener

(e: AdapterError) => void

Inherited From CallWithChatAdapterSubscriptions.off

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Parameters

event

"chatInitialized"

listener

ChatInitializedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parameters

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parameters

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parameters

event

"displayNameChanged"

listener

DisplayNameChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameters

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameters

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parameters

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Parameters

event

"isMutedChanged"

listener

IsMutedChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parameters

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameters

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Parameters

event

"messageDeleted"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Parameters

event

"messageEdited"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Parameters

event

"messageRead"

listener

MessageReadListener

Inherited From CallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Parameters

event

"messageReceived"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Parameters

event

"messageSent"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameters

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

Inherited From CallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parameters

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Inherited From CallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parameters

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Inherited From CallWithChatAdapterSubscriptions.off

off("spotlightChanged", SpotlightChangedListener)

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameters

event

"spotlightChanged"

listener

SpotlightChangedListener

Inherited From CallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

Unsubscribes the handler to stateChanged events.

function offStateChange(handler: (state: CallWithChatAdapterState) => void)

Parameters

handler

(state: CallWithChatAdapterState) => void

Inherited From AdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameters

event

"breakoutRoomsUpdated"

listener

BreakoutRoomsUpdatedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

function on(event: "callEnded", listener: CallEndedListener)

Parameters

event

"callEnded"

listener

CallEndedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("callError", (e: AdapterError) => void)

function on(event: "callError", listener: (e: AdapterError) => void)

Parameters

event

"callError"

listener

(e: AdapterError) => void

Inherited From CallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parameters

event

"callIdChanged"

listener

CallIdChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parameters

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parameters

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

Inherited From CallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameters

event

"capabilitiesChanged"

listener

CapabilitiesChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameters

event

"captionsReceived"

listener

CaptionsReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("chatError", (e: AdapterError) => void)

function on(event: "chatError", listener: (e: AdapterError) => void)

Parameters

event

"chatError"

listener

(e: AdapterError) => void

Inherited From CallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Parameters

event

"chatInitialized"

listener

ChatInitializedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parameters

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parameters

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parameters

event

"displayNameChanged"

listener

DisplayNameChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameters

event

"isCaptionLanguageChanged"

listener

IsCaptionLanguageChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameters

event

"isCaptionsActiveChanged"

listener

IsCaptionsActiveChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parameters

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Parameters

event

"isMutedChanged"

listener

IsMutedChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parameters

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameters

event

"isSpokenLanguageChanged"

listener

IsSpokenLanguageChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Parameters

event

"messageDeleted"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Parameters

event

"messageEdited"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Parameters

event

"messageRead"

listener

MessageReadListener

Inherited From CallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Parameters

event

"messageReceived"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Parameters

event

"messageSent"

listener

MessageReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameters

event

"realTimeTextReceived"

listener

RealTimeTextReceivedListener

Inherited From CallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parameters

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Inherited From CallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parameters

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Inherited From CallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameters

event

"spotlightChanged"

listener

SpotlightChangedListener

Inherited From CallWithChatAdapterSubscriptions.on

onReactionClick(Reaction)

Send Reaction to ongoing meeting.

function onReactionClick(reaction: Reaction): Promise<void>

Parameters

reaction

Reaction

A value of type <xref:%40azure%2Fcommunication-calling%23Reaction>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Subscribes the handler to stateChanged events.

function onStateChange(handler: (state: CallWithChatAdapterState) => void)

Parameters

handler

(state: CallWithChatAdapterState) => void

Inherited From AdapterState.onStateChange

queryCameras()

Query for available camera devices.

function queryCameras(): Promise<VideoDeviceInfo[]>

Returns

Promise<VideoDeviceInfo[]>

An array of video device information entities <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallWithChatAdapterManagement.queryCameras

queryMicrophones()

Query for available microphone devices.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Returns

Promise<AudioDeviceInfo[]>

An array of audio device information entities <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallWithChatAdapterManagement.queryMicrophones

querySpeakers()

Query for available microphone devices.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Returns

Promise<AudioDeviceInfo[]>

An array of audio device information entities <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarks

This method should be called after askDevicePermission()

Inherited From CallWithChatAdapterManagement.querySpeakers

raiseHand()

Raise hand for local user.

function raiseHand(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.raiseHand

removeParticipant(CommunicationIdentifier)

Remove a participant from the call.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Parameters

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> of the participant to be removed

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.removeParticipant

removeParticipant(string)

Remove a participant from a Call.

function removeParticipant(userId: string): Promise<void>

Parameters

userId

string

UserId of the participant to remove.

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parameters

resourceDetails

ResourceDetails

Inherited From CallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Resumes the call from a LocalHold state.

function resumeCall(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

Return to origin call of breakout room

function returnFromBreakoutRoom(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.returnFromBreakoutRoom

sendMessage(string, SendMessageOptions)

Send a message in the thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parameters

content

string

options

SendMessageOptions

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Send a read receipt for a message.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parameters

chatMessageId

string

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Send typing indicator in the thread.

function sendTypingIndicator(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.sendTypingIndicator

setCamera(VideoDeviceInfo, VideoStreamOptions)

Set the camera to use in the call.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parameters

sourceInfo

VideoDeviceInfo

Camera device to choose, pick one returned by queryCameras

options

VideoStreamOptions

Options to control how the camera stream is rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.setCamera

setCaptionLanguage(string)

Function to set caption language

function setCaptionLanguage(language: string): Promise<void>

Parameters

language

string

language set for caption

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Set the microphone to use in the call.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parameters

sourceInfo

AudioDeviceInfo

Microphone device to choose, pick one returned by queryMicrophones

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Set the speaker to use in the call.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parameters

sourceInfo

AudioDeviceInfo

Speaker device to choose, pick one returned by querySpeakers

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.setSpeaker

setSpokenLanguage(string)

Function to set spoken language

function setSpokenLanguage(language: string): Promise<void>

Parameters

language

string

spoken language

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Recalculate the seating positions for together mode.

function setTogetherModeSceneSize(width: number, height: number)

Parameters

width

number

Width of the container

height

number

Height of the container

Remarks

This method is implemented for composite

Inherited From CallWithChatAdapterManagement.setTogetherModeSceneSize

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Start the call.

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

Parameters

participants

(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

An array of <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> to be called

options

StartCallOptions

Returns

undefined | Call

Inherited From CallWithChatAdapterManagement.startCall

startCall(string[], StartCallOptions)

Start the call.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

Parameters

participants

string[]

An array of participant ids to join

options

StartCallOptions

Returns

undefined | Call

Inherited From CallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Start the camera.

This method will start rendering a local camera view when the call is not active.

function startCamera(options?: VideoStreamOptions): Promise<void>

Parameters

options

VideoStreamOptions

Options to control how video streams are rendered <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startCamera

startCaptions(StartCaptionsAdapterOptions)

Function to Start captions

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parameters

options

StartCaptionsAdapterOptions

options for start captions

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

Start the noise suppression effect.

function startNoiseSuppressionEffect(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

Start sharing the screen during a call.

function startScreenShare(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Start spotlight

function startSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds

string[]

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Start together mode.

function startTogetherMode(): Promise<void>

Returns

Promise<void>

Remarks

This method is implemented for composite

Inherited From CallWithChatAdapterManagement.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Start the video background effect.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parameters

videoBackgroundEffect

VideoBackgroundEffect

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Stop all spotlights

function stopAllSpotlight(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopAllSpotlight

stopCamera()

Stop the camera.

This method will stop rendering a local camera view when the call is not active.

function stopCamera(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funtion to stop captions

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parameters

options

StopCaptionsAdapterOptions

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

Start the noise suppression effect.

function stopNoiseSuppressionEffect(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Stop sharing the screen.

function stopScreenShare(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopScreenShare

stopSpotlight(string[])

Stop spotlight

function stopSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds

string[]

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Stop the video background effect.

function stopVideoBackgroundEffects(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Send the end of call survey result

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parameters

survey

CallSurvey

Returns

Promise<undefined | CallSurveyResponse>

Inherited From CallWithChatAdapterManagement.submitSurvey

unmute()

Unmute the current user during the call or enable microphone locally.

function unmute(): Promise<void>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Override the background picker images for background replacement effect.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameters

backgroundImages

VideoBackgroundImage[]

Array of custom background images.

Inherited From CallWithChatAdapterManagement.updateBackgroundPickerImages

updateMessage(string, string, Record<string, string>)

Update a message content.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

Parameters

messageId

string

content

string

options

Record<string, string>

Returns

Promise<void>

Inherited From CallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Update the selected video background effect

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameters

selectedVideoBackground

VideoBackgroundEffect

Inherited From CallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect