CallWithChatAdapter interface
CallWithChatComposite Adapterschnittstelle.
- Extends
Geerbte Methoden
Details zur geerbten Methode
askDevicePermission(PermissionConstraints)
Fragen Sie nach Berechtigungen für Geräte.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>
Parameter
- constrain
- PermissionConstraints
Definieren von Einschränkungen für den Zugriff auf lokale Geräte <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Gibt zurück
Promise<void>
Hinweise
Das Fenster "Browserberechtigungen" wird angezeigt, wenn berechtigungen noch nicht erteilt wurden.
createStreamView(string, VideoStreamOptions)
Erstellen Sie die HTML-Ansicht für einen Stream.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>
Parameter
- remoteUserId
-
string
ID des zu rendernden Teilnehmers, lassen Sie sie nicht definiert, um die lokale Kameraansicht zu erstellen.
- options
- VideoStreamOptions
Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Gibt zurück
Promise<void | CreateVideoStreamViewResult>
Hinweise
Diese Methode wird für zusammengesetzt implementiert.
deleteMessage(string)
Löschen Sie eine Nachricht im Thread.
function deleteMessage(messageId: string): Promise<void>
Parameter
- messageId
-
string
Gibt zurück
Promise<void>
dispose()
disposeStreamView(string, VideoStreamOptions)
Entsorgen Sie die HTML-Ansicht für einen Stream.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
Parameter
- remoteUserId
-
string
ID des zu rendernden Teilnehmers, lassen Sie sie nicht definiert, um die lokale Kameraansicht zu entsorgen
- options
- VideoStreamOptions
Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Gibt zurück
Promise<void>
Hinweise
Diese Methode wird für zusammengesetzt implementiert.
fetchInitialData()
Ruft den Anfangszustand für den Chatadapter ab.
Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.
function fetchInitialData(): Promise<void>
Gibt zurück
Promise<void>
getState()
Abrufen des aktuellen Zustands
function getState(): CallWithChatAdapterState
Gibt zurück
Geerbt vonAdapterState.getState
joinCall(boolean)
Schließen Sie sich dem Anruf an, wobei das Mikrofon zunächst ein-/ausschaltet.
function joinCall(microphoneOn?: boolean): undefined | Call
Parameter
- microphoneOn
-
boolean
Gibt an, ob das Mikrofon anfänglich aktiviert ist
Gibt zurück
undefined | Call
Geerbt vonCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Verlassen Sie den Anruf.
function leaveCall(forEveryone?: boolean): Promise<void>
Parameter
- forEveryone
-
boolean
Ob alle Teilnehmer beim Verlassen entfernt werden sollen
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Laden Sie weitere frühere Nachrichten in den Chatthreadverlauf.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parameter
- messagesToLoad
-
number
Gibt zurück
Promise<boolean>
Hinweise
Diese Methode wird normalerweise verwendet, um den inkrementellen Abruf/unendlichen Bildlauf zu steuern.
Geerbt vonCallWithChatAdapterManagement.loadPreviousChatMessages
mute()
Schalten Sie den aktuellen Benutzer während des Anrufs stumm, oder deaktivieren Sie das Mikrofon lokal.
function mute(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.mute
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parameter
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Geerbt vonCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Geerbt vonCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parameter
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parameter
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Geerbt vonCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parameter
- event
-
"messageRead"
- listener
- MessageReadListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parameter
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parameter
- event
-
"messageSent"
- listener
- MessageReceivedListener
Geerbt vonCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Geerbt vonCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Geerbt vonCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Beendet den Handler für stateChanged-Ereignisse.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Parameter
- handler
-
(state: CallWithChatAdapterState) => void
Geerbt vonAdapterState.offStateChange
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parameter
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Geerbt vonCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Geerbt vonCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parameter
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parameter
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Geerbt vonCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parameter
- event
-
"messageRead"
- listener
- MessageReadListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parameter
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parameter
- event
-
"messageSent"
- listener
- MessageReceivedListener
Geerbt vonCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Geerbt vonCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Geerbt vonCallWithChatAdapterSubscriptions.on
onStateChange((state: CallWithChatAdapterState) => void)
Abonniert den Handler für stateChanged-Ereignisse.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Parameter
- handler
-
(state: CallWithChatAdapterState) => void
Geerbt vonAdapterState.onStateChange
queryCameras()
Abfrage nach verfügbaren Kamerageräten.
function queryCameras(): Promise<VideoDeviceInfo[]>
Gibt zurück
Promise<VideoDeviceInfo[]>
Ein Array von Videogeräte-Informationsentitäten <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Hinweise
Diese Methode sollte nach askDevicePermission() aufgerufen werden.
queryMicrophones()
Abfrage nach verfügbaren Mikrofongeräten.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Gibt zurück
Promise<AudioDeviceInfo[]>
Ein Array von Audiogeräte-Informationsentitäten <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Hinweise
Diese Methode sollte nach askDevicePermission() aufgerufen werden.
querySpeakers()
Abfrage nach verfügbaren Mikrofongeräten.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Gibt zurück
Promise<AudioDeviceInfo[]>
Ein Array von Audiogeräte-Informationsentitäten <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Hinweise
Diese Methode sollte nach askDevicePermission() aufgerufen werden.
removeParticipant(string)
Entfernen sie einen Teilnehmer aus einem Anruf.
function removeParticipant(userId: string): Promise<void>
Parameter
- userId
-
string
UserId des zu entfernenden Teilnehmers.
Gibt zurück
Promise<void>
sendMessage(string, SendMessageOptions)
Senden Sie eine Nachricht im Thread.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parameter
- content
-
string
- options
- SendMessageOptions
Gibt zurück
Promise<void>
sendReadReceipt(string)
Senden sie eine Lesebestätigung für eine Nachricht.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parameter
- chatMessageId
-
string
Gibt zurück
Promise<void>
sendTypingIndicator()
Senden des Eingabeindikators im Thread.
function sendTypingIndicator(): Promise<void>
Gibt zurück
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Legen Sie die Kamera fest, die im Anruf verwendet werden soll.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parameter
- sourceInfo
- VideoDeviceInfo
Kameragerät zur Auswahl, wählen Sie ein von queryCameras zurückgegebenes Gerät aus.
- options
- VideoStreamOptions
Optionen zum Steuern, wie der Kameradatenstrom gerendert wird <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.setCamera
setMicrophone(AudioDeviceInfo)
Legen Sie das Mikrofon fest, das im Anruf verwendet werden soll.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parameter
- sourceInfo
- AudioDeviceInfo
Mikrofongerät zur Auswahl, wählen Sie ein von Abfrage zurückgegebenes GerätMicrophones aus.
Gibt zurück
Promise<void>
setSpeaker(AudioDeviceInfo)
Legen Sie den Lautsprecher fest, der im Anruf verwendet werden soll.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parameter
- sourceInfo
- AudioDeviceInfo
Wählen Sie ein von querySpeakers zurückgegebenes Lautsprechergerät aus.
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.setSpeaker
startCall(string[], StartCallOptions)
Starten Sie den Anruf.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parameter
- participants
-
string[]
Ein Array von Teilnehmer-IDs für die Teilnahme
- options
- StartCallOptions
Gibt zurück
undefined | Call
Geerbt vonCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Starten Sie die Kamera.
Diese Methode beginnt mit dem Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
function startCamera(options?: VideoStreamOptions): Promise<void>
Parameter
- options
- VideoStreamOptions
Optionen zum Steuern, wie Videostreams gerendert werden <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Gibt zurück
Promise<void>
startScreenShare()
Beginnen Sie mit der Freigabe des Bildschirms während eines Anrufs.
function startScreenShare(): Promise<void>
Gibt zurück
Promise<void>
stopCamera()
Beenden Sie die Kamera.
Diese Methode beendet das Rendern einer lokalen Kameraansicht, wenn der Aufruf nicht aktiv ist.
function stopCamera(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.stopCamera
stopScreenShare()
Beenden Sie die Freigabe des Bildschirms.
function stopScreenShare(): Promise<void>
Gibt zurück
Promise<void>
unmute()
Heben Sie die Stummschaltung des aktuellen Benutzers während des Anrufs auf, oder aktivieren Sie das Mikrofon lokal.
function unmute(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Aktualisieren sie den Inhalt einer Nachricht.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>
Parameter
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Gibt zurück
Promise<void>