@azure/communication-react package

Referenz

Klassen

CallError	Fehler, der von fehlerhaften zustandsbehafteten API-Methoden ausgelöst wird.
ChatError	Fehler, der von fehlgeschlagenen StatefulChatClient-Methoden ausgelöst wird.

Schnittstellen

ActiveErrorMessage	Aktive Fehlermeldungen, die über Die Fehlerleiste angezeigt werden sollen.
AdapterError	Fehler, der über Fehlerereignisse gemeldet und im Adapterzustand gespeichert wird.
AdapterState	Funktionalität für die Interfacing mit dem Zustand des zusammengesetzten Adapters.
BaseCompositeProps	Eigenschaften, die allen aus dieser Bibliothek exportierten Zusammengesetzten gemeinsam sind.
BaseCustomStyles	Grundlegende Fluent-Stile Requisiten für alle Komponenten, die aus dieser Bibliothek exportiert werden.
CallAdapter	Eine adapterspezifische Schnittstelle für Die Azure-Kommunikationsidentität, die CommonCallAdapter erweitert.
CallAdapterCallManagement	Funktionen zum Verwalten des aktuellen Anrufs oder zum Starten eines neuen Anrufs
CallAdapterCallOperations	Funktionalität zum Verwalten des aktuellen Aufrufs.
CallAdapterDeviceManagement	Funktionen zum Verwalten von Geräten innerhalb eines Anrufs.
CallAdapterSubscribers	Rufen Sie zusammengesetzte Ereignisse auf, die abonniert werden können.
CallAgentProviderProps	Argumente zum Initialisieren eines CallAgentProviders.
CallAgentState	Die zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23CallAgent> außer Aufrufen wird in ein untergeordnetes Element direkt von CallClientState verschoben und hier nicht eingeschlossen. Der Grund dafür, dass der Status von CallAgent proxied ist, besteht darin, Zugriff auf displayName zu gewähren. Wir vereinfachen CallAgent.displayName nicht und legen sie in CallClientState fest, da es mehrdeutig wäre, dass displayName tatsächlich von der Erstellung/Existenz von CallAgent abhängig ist, um verfügbar zu sein.
CallAndChatLocator	Argumente für die Verwendung in createAzureCommunicationCallWithChatAdapter , um einen Anruf mit einem zugeordneten Chatthread zu verbinden.
CallClientProviderProps	Argumente zum Initialisieren eines CallClientProviders.
CallClientState	Container für alle Zustandsdaten, die von StatefulCallClient proxisiert werden. Die Zustände calls, callsEnded, incomingCalls und incomingCallsEnded werden automatisch bereitgestellt, wenn ein callAgent erstellt wurde. Der deviceManager ist zunächst leer, bis aufgefüllt wird, siehe DeviceManagerState. Der UserId-Zustand wird als Benutzerfreundlichkeit für den Entwickler bereitgestellt und vom Entwickler vollständig gesteuert und festgelegt.
CallCompositeProps	Requisiten für CallComposite.
CallCompositeStrings	Zeichenfolgen, die direkt von CallComposite verwendet werden. Diese Zeichenfolgen werden zusätzlich zu den Zeichenfolgen verwendet, die von den Komponenten aus der Komponentenbibliothek verwendet werden.
CallProviderProps	Argumente zum Initialisieren eines CallProviders.
CallState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient ruft automatisch den Zustand von Call ab und fügt ihn dem Zustand hinzu, der von StatefulCallClient verfügbar gemacht wird.
CallWithChatAdapter	CallWithChatComposite Adapterschnittstelle.
CallWithChatAdapterManagement	Funktionalität zum Verwalten des aktuellen Anrufs mit Chat.
CallWithChatAdapterState	CallWithChat State ist eine Kombination aus Stateful Chat- und Stateful Calling-Clients, deren Status nur für callWithChat Composite spezifisch ist.
CallWithChatAdapterSubscriptions	Anruf- und Chatereignisse, die im CallWithChatAdapter abonniert werden können.
CallWithChatAdapterUiState	Ui-Status im Zusammenhang mit CallWithChatComposite.
CallWithChatClientState	Status der Back-End-Dienste, die CallWithChatComposite antreibt.
CallWithChatCompositeProps	Erforderliche Komponenten für CallWithChatComposite
CallWithChatCompositeStrings	Zeichenfolgen, die direkt von CallWithChatComposite verwendet werden. Diese Zeichenfolgen werden zusätzlich zu den Zeichenfolgen verwendet, die von den Komponenten aus der Komponentenbibliothek verwendet werden.
CallWithChatControlOptions	CallWithChatComposite Rufen Sie Steuerelemente auf, um Schaltflächen auf der aufrufenden Steuerleiste anzuzeigen oder auszublenden.
CallingHandlers	Objekt, das alle Handler enthält, die zum Aufrufen von Komponenten erforderlich sind. Durch Aufrufen verwandter Komponenten aus diesem Paket können relevante Handler aus diesem Objekt ausgewählt werden. Weitere Informationen finden Sie unter <xref:useHandlers> und verwendenPropsFor.
CallingTheme	Benutzerdefinierte Fluent-Designpalette, die durch Aufrufen verwandter Komponenten in dieser Bibliothek verwendet wird.
CameraButtonContextualMenuStyles	Formatvorlagen für das CameraButton-Menü .
CameraButtonProps	Eigenschaften für die CameraButton-Komponente .
CameraButtonStrings	Zeichenfolgen von CameraButton, die überschrieben werden können.
CameraButtonStyles	Stile für CameraButton
ChatAdapterSubscribers	Zusammengesetzte Chatereignisse, die abonniert werden können.
ChatAdapterThreadManagement	Funktionalität zum Verwalten des aktuellen Chatthreads.
ChatCompositeProps	Requisiten für ChatComposite.
ChatCompositeStrings	Zeichenfolgen, die direkt von ChatComposite verwendet werden. Diese Zeichenfolgen werden zusätzlich zu den Zeichenfolgen verwendet, die von den Komponenten aus der Komponentenbibliothek verwendet werden.
ChatMessage	Eine Chatnachricht.
CommonCallAdapter	CallComposite Adapterschnittstelle.
CommonCallingHandlers	Objekt, das alle Handler enthält, die zum Aufrufen von Komponenten erforderlich sind. Durch Aufrufen verwandter Komponenten aus diesem Paket können relevante Handler aus diesem Objekt ausgewählt werden. Weitere Informationen finden Sie unter <xref:useHandlers> und verwendenPropsFor.
ComponentLocale	Gebietsschemainformationen für alle Komponenten, die aus dieser Bibliothek exportiert werden.
ComponentStrings	Zeichenfolgen, die von allen aus dieser Bibliothek exportierten Komponenten verwendet werden.
CompositeLocale	Gebietsschemainformationen für alle aus dieser Bibliothek exportierten Zusammengesetzten.
CompositeStrings	Zeichenfolgen, die direkt in den Zusammengesetzten verwendet werden. Diese Zeichenfolgen werden von den Zusammengesetzten direkt und nicht von den enthaltenen Komponenten verwendet.
ContentSystemMessage	Eine Systemnachricht mit arbitären Inhalten.
ControlBarButtonProps	Eigenschaften für ControlBarButton.
ControlBarButtonStrings	Zeichenfolgen von ControlBarButton , die überschrieben werden können.
ControlBarProps	Eigenschaften für ControlBar.
CreateVideoStreamViewResult	Nach dem Erstellen eines lokalen oder Remotevideostreams zurückgegebenes Objekt. Diese enthält Hilfsfunktionen zum Bearbeiten des Renderns des Datenstroms.
CustomMessage	Ein benutzerdefinierter Nachrichtentyp. Benutzerdefinierte Nachrichten werden standardmäßig nicht gerendert, aber Anwendungen können benutzerdefinierte Renderer für sie bereitstellen.
DevicesButtonContextualMenuStyles	Stile für das Menü DevicesButton .
DevicesButtonProps	Props für DevicesButton.
DevicesButtonStrings	Zeichenfolgen von DevicesButton , die überschrieben werden können.
DevicesButtonStyles	Stile für die Menüelemente der Schaltfläche Geräte.
DiagnosticsCallFeatureState	Zustandsgeschützter Proxy für <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable	Funktionalität für die ordnungsgemäße Entsorgung eines Zusammengesetzten.
EndCallButtonProps	Props für EndCallButton.
EndCallButtonStrings	Zeichenfolgen von EndCallButton , die überschrieben werden können.
ErrorBarProps	Props für ErrorBar. Zusätzlich zu folgendem leitet ErrorBar alle <xref:%40fluentui%2Freact%23IMessageBarProps> an den zugrunde liegenden <xref:%40fluentui%2Freact%23MessageBar>weiter.
ErrorBarStrings	Alle Zeichenfolgen, die auf der Benutzeroberfläche in der ErrorBar angezeigt werden können.
FluentThemeProviderProps	Requisiten für FluentThemeProvider.
GridLayoutProps	Requisiten für GridLayout.
GridLayoutStyles	GridLayout Komponentenstile.
HorizontalGalleryStyles	<xref:HorizontalGallery> Komponentenstile.
IncomingCallState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient erkennt eingehende Aufrufe automatisch und fügt ihren Zustand dem Zustand hinzu, der von StatefulCallClient verfügbar gemacht wird.
JumpToNewMessageButtonProps	Argumente für <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState	Zustandsgeschützter Proxy für <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon	Allgemeine Eigenschaften aller Nachrichtentypen.
MessageStatusIndicatorProps	Props für MessageStatusIndicator.
MessageStatusIndicatorStrings	Zeichenfolgen von MessageStatusIndicator , die überschrieben werden können.
MessageThreadStrings	Zeichenfolgen von MessageThread , die überschrieben werden können.
MessageThreadStyles	Fluent-Stile für MessageThread.
MicrophoneButtonContextualMenuStyles	Formatvorlagen für das Menü MicrophoneButton .
MicrophoneButtonProps	Requisiten für MicrophoneButton.
MicrophoneButtonStrings	Zeichenfolgen von MicrophoneButton , die überschrieben werden können.
MicrophoneButtonStyles	Stile für MicrophoneButton
NetworkDiagnosticsState	Zustandsgeschützter Proxy für <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice	Ein Gerät, z. B. Kamera, Mikrofon oder Lautsprecher, im DevicesButton-Flyout .
ParticipantAddedSystemMessage	Eine Systemmeldung, die darüber informiert, dass dem Chatthread ein Teilnehmer hinzugefügt wurde.
ParticipantItemProps	Requisiten für ParticipantItem.
ParticipantItemStrings	Zeichenfolgen von ParticipantItem , die überschrieben werden können.
ParticipantItemStyles	Fluent-Stile für ParticipantItem.
ParticipantListItemStyles	Stile für das ParticipantList ParticipantItem.
ParticipantListStyles	Stile für die ParticipantList.
ParticipantRemovedSystemMessage	Eine Systemmeldung, die darüber informiert, dass ein Teilnehmer aus dem Chatthread entfernt wurde.
ParticipantsButtonContextualMenuStyles	Stile für das Menü ParticipantsButton .
ParticipantsButtonProps	Requisiten für ParticipantsButton.
ParticipantsButtonStrings	Zeichenfolgen von ParticipantsButton , die überschrieben werden können.
ParticipantsButtonStyles	Styles Props für ParticipantsButton.
RecordingCallFeature	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient lauscht automatisch auf den Aufzeichnungsstatus des Aufrufs und aktualisiert den von StatefulCallClient verfügbar gemachten Zustand entsprechend.
RemoteParticipantState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient ruft RemoteParticipants automatisch ab und fügt ihren Zustand dem Zustand hinzu, der von StatefulCallClient verfügbar gemacht wird.
RemoteVideoStreamState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps	Requisiten für ScreenShareButton.
ScreenShareButtonStrings	Zeichenfolgen von ScreenShareButton , die überschrieben werden können.
SendBoxProps	Requisiten für SendBox.
SendBoxStrings	Zeichenfolgen von SendBox , die überschrieben werden können.
SendBoxStylesProps	Fluent-Stile für <xref:Sendbox>.
StatefulCallClient	Definiert die Methoden, mit denen CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> zustandsbehaftet verwendet werden kann. Die Schnittstelle ermöglicht den Zugriff auf den Proxied-Zustand und ermöglicht auch die Registrierung eines Handlers für Zustandsänderungsereignisse. Eine Zustandsdefinition finden Sie unter CallClientState. Zustandsänderungsereignisse werden durch folgendes gesteuert: Zurückgegebene Daten von <xref:%40azure%2Fcommunication-calling%23DeviceManager> APIs. Zurückgegebene Daten von <xref:%40azure%2Fcommunication-calling%23CallAgent> APIs. Listener, die automatisch an verschiedene Azure-Kommunikationsaufrufobjekte angefügt werden: CallAgent 'incomingCall' CallAgent "callsUpdated" DeviceManager "videoDevicesUpdated" DeviceManager 'audioDevicesUpdated DeviceManager 'selectedMicrophoneChanged' DeviceManager 'selectedSpeakerChanged' Rufen Sie "stateChanged" auf. Aufrufen von "idChanged" Aufrufen von "isMutedChanged" Aufrufen von "isScreenSharingOnChanged" Aufrufen von "remoteParticipantsUpdated" Aufrufen von "localVideoStreamsUpdated" IncomingCall "callEnded" RemoteParticipant "stateChanged" RemoteParticipant 'isMutedChanged' RemoteParticipant "displayNameChanged" RemoteParticipant 'isSpeakingChanged' RemoteParticipant "videoStreamsUpdated" RemoteVideoStream "isAvailableChanged" TranskriptionCallFeature 'isTranscriptionActiveChanged' RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient	Definiert die Methoden, mit denen {@Link @azure/communication-chat#ChatClient} mit einem zentralisierten generierten Zustand verwendet werden kann. Die Schnittstelle ermöglicht den Zugriff auf den Proxied-Zustand und ermöglicht auch die Registrierung eines Handlers für Zustandsänderungsereignisse.
StatefulDeviceManager	Definiert die zusätzlichen Methoden, die vom zustandsbehafteten auf hinzugefügt werden <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps	Requisiten für StreamMedia.
SystemMessageCommon	Allgemeine Eigenschaften aller Systemmeldungen.
TopicUpdatedSystemMessage	Eine Systemmeldung, die darüber informiert, dass das Chatthreadthema aktualisiert wurde.
TranscriptionCallFeature	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient lauscht automatisch auf den Transkriptionszustand des Aufrufs und aktualisiert den von StatefulCallClient verfügbar gemachten Zustand entsprechend.
TypingIndicatorProps	Props for TypingIndicator.
TypingIndicatorStrings	Zeichenfolgen von TypingIndicator , die überschrieben werden können.
TypingIndicatorStylesProps	Fluent-Stile für TypingIndicator.
VideoGalleryProps	Requisiten für VideoGallery.
VideoGalleryRemoteParticipant	Der Status eines Remoteteilnehmers in der VideoGallery.
VideoGalleryStream	Videostream eines Teilnehmers in VideoGallery.
VideoGalleryStrings	Alle Zeichenfolgen, die auf der Benutzeroberfläche in der VideoGallery angezeigt werden können.
VideoGalleryStyles	VideoGallery Komponentenstile.
VideoStreamOptions	Optionen zum Steuern, wie Videostreams gerendert werden.
VideoStreamRendererViewState	Zustandsgeschützte Version von <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Diese Eigenschaft wird dem Zustand hinzugefügt, der von StatefulCallClient durch createView verfügbar gemacht und von disposeView entfernt wird.
VideoTileProps	Requisiten für VideoTile.
VideoTileStylesProps	Fluent-Stile für VideoTile.

Typaliase

AdapterErrors	Adapter speichern den neuesten Fehler für jeden Vorgang im Status. `target` ist eine vom Adapter definierte Zeichenfolge für jeden eindeutigen Vorgang, der vom Adapter ausgeführt wird.
AreEqual	Vergleichen, wenn zwei React-Komponenten exakt gleich sind, ist der Ergebnistyp true/false.
AreParamEqual	Vergleichen, wenn die Eigenschaften von 2 React-Komponenten gleich sind, ist der Ergebnistyp true/false.
AreTypeEqual	Vergleichen, wenn zwei Typen gleich sind, ist der Ergebnistyp true/false.
AvatarPersonaData	Benutzerdefinierte Datenattribute zum Anzeigen eines Avatars für einen Benutzer.
AvatarPersonaDataCallback	Rückruffunktion, die verwendet wird, um benutzerdefinierte Daten bereitzustellen, um einen Avatar für einen Benutzer zu erstellen.
AzureCommunicationCallAdapterArgs	Argumente zum Erstellen der Azure Communication Services Implementierung von CallAdapter. Hinweis: `displayName` kann maximal 256 Zeichen lang sein.
AzureCommunicationCallWithChatAdapterArgs	Argumente für createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs	Argumente für <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs	Argumente zum Erstellen der Azure Communication Services Implementierung von ChatAdapter.
CallAdapterCallEndedEvent	Nutzlast für CallEndedListener mit Details zum beendeten Anruf.
CallAdapterClientState	CommonCallAdapter-Zustand, abgeleitet von Azure Communication Services Back-End.
CallAdapterLocator	Locator, der von createAzureCommunicationCallAdapter verwendet wird, um den Aufruf zum Beitreten zu suchen
CallAdapterState	CommonCallAdapter-Status .
CallAdapterUiState	CommonCallAdapter-Zustand für reine Ui-Zwecke.
CallCompositeIcons	Symbole, die für CallComposite überschrieben werden können.
CallCompositeOptions	Optionale Features von CallComposite.
CallCompositePage	Hauptbildschirme der Benutzeroberfläche, die in CallComposite angezeigt werden.
CallControlDisplayType	Anzeigetyp der Steuerelementleiste für CallComposite.
CallControlOptions	Anpassungsoptionen für die Steuerungsleiste in der Anrufumgebung.
CallEndedListener	Rückruf für callAdapterSubscribers "callEnded"-Ereignis.
CallErrorBarSelector	Selektortyp für die ErrorBar-Komponente .
CallErrorTarget	Zeichenfolgenliteraltyp für alle zulässigen Schlüssel in {@Link CallErrors}.
CallErrors	Fehler, die über API-Aufrufe an das Calling SDK ausgegeben wurden. Jede Eigenschaft im -Objekt speichert den neuesten Fehler für eine bestimmte SDK-API-Methode. Fehler aus diesem Objekt können mithilfe von <xref:newClearCallErrorsModifier>gelöscht werden. Darüber hinaus werden Fehler automatisch gelöscht, wenn: Der Status wird gelöscht. Nachfolgende Aufrufe verwandter API-Methoden sind erfolgreich. Ausführliche Informationen dazu, wann Fehler möglicherweise automatisch gelöscht werden, finden Sie in der Dokumentation zu einzelnen zustandsbehafteten Clientmethoden.
CallIdChangedListener	Rückruf für callAdapterSubscribers "callIdChanged"-Ereignis.
CallParticipantListParticipant	Aufrufen des Zustands des Teilnehmers, wie in den Ui-Komponenten widerspiegelt.
CallWithChatCompositeIcons	Symbole, die für CallWithChatComposite überschrieben werden können.
CallWithChatCompositeOptions	Optionale Features von CallWithChatComposite.
CallWithChatEvent	Ereignisse, die vom CallWithChatAdapter ausgelöst werden.
CallingBaseSelectorProps	Allgemeine Eigenschaften, die verwendet werden, um auf den aufrufenden deklarativen Clientzustand zu verweisen.
CallingReturnProps	Hilfstyp für usePropsFor.
CameraButtonSelector	Selektortyp für die CameraButton-Komponente .
ChatAdapter	ChatComposite Adapterschnittstelle.
ChatAdapterState	ChatAdapter-Status .
ChatAdapterUiState	ChatAdapter-Status für reine Ui-Zwecke.
ChatBaseSelectorProps	Allgemeine Eigenschaften für Selektoren für ChatClientState.
ChatClientProviderProps	Argumente zum Initialisieren eines ChatClientProviders.
ChatClientState	Zentralisierter Zustand für <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState	ChatAdapter-Zustand, abgeleitet von Azure Communication Services Back-End.
ChatCompositeIcons	Symbole, die für ChatComposite überschrieben werden können.
ChatCompositeOptions	Optionale Features von ChatComposite.
ChatErrorBarSelector	Selektortyp für die ErrorBar-Komponente .
ChatErrorTarget	Zeichenfolgenliteraltyp für alle zulässigen Schlüssel in ChatErrors.
ChatErrors	Fehler, die über API-Aufrufe an das Chat SDK ausgegeben wurden. Jede Eigenschaft im -Objekt speichert den neuesten Fehler für eine bestimmte SDK-API-Methode.
ChatHandlers	Objekt, das alle für Chatkomponenten erforderlichen Handler enthält. Chatbezogene Komponenten aus diesem Paket können relevante Handler aus diesem Objekt auswählen. Weitere Informationen finden Sie unter <xref:useHandlers> und verwendenPropsFor.
ChatMessageWithStatus	Eine Erweiterung für <xref:%40azure%2Fcommunication-chat%23ChatMessage> , die nur clientseitige Metadaten für Chatnachrichten speichert. TODO: Der Name wurde bitrotted. Benennen Sie mich um.
ChatParticipantListSelector	Selektortyp für die ParticipantList-Komponente .
ChatReturnProps	Hilfstyp für usePropsFor.
ChatThreadClientProviderProps	Argumente zum Initialisieren eines ChatThreadClientProviders.
ChatThreadClientState	Zentralisierter Zustand für <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties	Eigenschaften eines Chatthreads. Wir definieren eine minimale, die uns hilft, die verschiedenen Typen zu verbergen, die von der zugrunde liegenden API verwendet werden.
ClientState	Zentralisierter Zustand für <xref:%40azure%2Fcommunication-calling%23CallClient> oder <xref:%40azure%2Fcommunication-chat%23ChatClient>. Siehe auch: CallClientState, ChatClientState.
Common	Zurückgeben des Schnittpunkttyps von 2 Typen
CommonProperties	Zurückgeben von Schnitteigenschaften von 2 Typen
CommunicationParticipant	Der Status eines Chat- oder Anrufteilnehmers, wie in der Benutzeroberfläche dargestellt.
ComponentIcons	Symbole, die vom React aus dieser Bibliothek exportierten Komponenten verwendet werden.
ComponentProps	Hilfstyp für usePropsFor.
CompositeIcons	Symbole, die in einer der von dieser Bibliothek exportierten Zusammengesetzten überschrieben werden können. Zieltypen finden Sie unter ChatCompositeIcons, CallCompositeIcons und CallWithChatCompositeIcons .
ControlBarButtonStyles	Stile für alle ControlBarButton-Implementierungen .
ControlBarLayout	Präsentieren sie Layouts für die ControlBar.
CreateViewResult	Gibt das Ergebnis aus createView zurück.
CustomAvatarOptions	Optionen, die in die `onRender` Funktion zum Anpassen einer Avatar (`Persona`) -Komponente eingefügt werden können.
DeviceManagerState	Dieser Typ soll den gesamten Zustand in <xref:%40azure%2Fcommunication-calling%23DeviceManager>kapseln. Für optionale Parameter sind sie möglicherweise erst verfügbar, wenn der Benutzer die Berechtigung erteilt hat. Die Kameras, Mikrofone, Lautsprecher und DeviceAccess-Zustände sind leer, bis die entsprechenden <xref:%40azure%2Fcommunication-calling%23DeviceManager>apIs getCameras, getMicrophones, getSpeakers und askDevicePermission aufgerufen und abgeschlossen sind.
DevicesButtonSelector	Selectortyp für die DevicesButton-Komponente .
DiagnosticChangedEventListner	Rückruf für callAdapterSubscribers "diagnosticChanged"-Ereignis.
DisplayNameChangedListener	Rückruf für das CallAdapterSubscribers -Ereignis "displayNameChanged".
EmptySelector	Ein Typ für triviale Selektoren, die keine Daten zurückgeben. Wird als Standardrückgabewert verwendet, wenn usePropsFor für eine Komponente aufgerufen wird, die keine Daten erfordert.
ErrorType	Alle Fehler, die in der Fehlerleiste angezeigt werden können.
GetCallingSelector	Spezifischer Typ des Selektors, der für eine bestimmte Komponente gilt.
GetChatSelector	Spezifischer Typ des Selektors, der für eine bestimmte Komponente gilt.
IsLocalScreenSharingActiveChangedListener	Rückruf für callAdapterSubscribers 'isLocalScreenSharingActiveChanged'-Ereignis.
IsMutedChangedListener	Rückruf für callAdapterSubscribers 'isMuted'-Ereignis.
IsSpeakingChangedListener	Rückruf für callAdapterSubscribers 'isSpeakingChanged'-Ereignis.
LoadingState	Gibt an, ob der Stream geladen wird oder nicht.
LocalizationProviderProps	Props für LocalizationProvider.
MediaDiagnosticChangedEvent	Nutzlast für DiagnosticChangedEventListner , bei dem eine Änderung in einer Mediendiagnose vorliegt.
Message	Diskriminierte Vereinigung aller Nachrichten. Der `messageType` Bereich ist auf Union-Varianten spezialisiert.
MessageAttachedStatus	Geben Sie an, ob eine Chatnachricht mit der Nachricht vor/nach der Nachricht zusammengeführt angezeigt werden soll. Nützlich, um viele Nachrichten desselben Absenders in einer einzelnen Nachrichtenblase zusammenzuführen.
MessageContentType	Unterstützte Typen von Chatnachrichteninhalten.
MessageProps	Props zum Rendern einer einzelnen Nachricht. Siehe MessageRenderer.
MessageReadListener	Rückruf für chatAdapterSubscribers "messageRead"-Ereignis.
MessageReceivedListener	Rückruf für chatAdapterSubscribers "messageReceived"-Ereignis.
MessageRenderer	Eine Komponente zum Rendern einer einzelnen Nachricht.
MessageSentListener	Rückruf für chatAdapterSubscribers "messageSent"-Ereignis.
MessageStatus	Clientseitiger Status einer gesendeten Nachricht. Enthält Übergangszustände, die auftreten, bevor die Nachrichtenübermittlung vom Back-End bestätigt wird.
MessageThreadProps	Requisiten für MessageThread.
MessageThreadSelector	Selectortyp für die MessageThread-Komponente .
MicrophoneButtonSelector	Selectortyp für die MicrophoneButton-Komponente .
NetworkDiagnosticChangedEvent	Nutzlast für DiagnosticChangedEventListner , bei dem eine Änderung in einer Netzwerkdiagnose vorliegt.
OnRenderAvatarCallback	Ein benutzerdefinierter gerenderter Rückruf, mit dem Benutzer das Rendering einer Persona-Komponente anpassen können.
ParticipantListParticipant	Teilnehmer, die in einer ParticipantList angezeigt werden.
ParticipantListProps	Requisiten für ParticipantList.
ParticipantListSelector	Selectortyp für die ParticipantList-Komponente .
ParticipantMenuItemsCallback	Ein Rückruf zum Bereitstellen benutzerdefinierter Menüelemente für jeden Teilnehmer in ParticipantList.
ParticipantState	Der Verbindungsstatus eines Anrufteilnehmers.
ParticipantsAddedListener	Rückruf für chatAdapterSubscribers "participantsAdded"-Ereignis.
ParticipantsButtonSelector	Selectortyp für die ParticipantsButton-Komponente .
ParticipantsJoinedListener	Rückruf für das CallAdapterSubscribers-Ereignis "participantsJoined".
ParticipantsLeftListener	Rückruf für das CallAdapterSubscribers-Ereignis "participantsLeft".
ParticipantsRemovedListener	Rückruf für chatAdapterSubscribers "participantsRemoved"-Ereignis.
ReadReceiptsBySenderId	Ein Array von Schlüsselwertpaaren, in dem der Anzeigename und die zuletzt gelesene Nachricht jedes Absenders gespeichert werden.
ScreenShareButtonSelector	Selectortyp für die ScreenShareButton-Komponente .
Selector	Ein optimierter Selektor, der ClientState-Updates in Requisiten für React Komponenten in dieser Bibliothek verfeinern.
SendBoxSelector	Selektortyp für die SendBox-Komponente .
StatefulCallClientArgs	Argumente zum Erstellen des StatefulCallClient.
StatefulCallClientOptions	Optionen zum Erstellen des StatefulCallClient mit.
StatefulChatClientArgs	Argumente zum Erstellen des StatefulChatClient.
StatefulChatClientOptions	Optionen zum Erstellen des StatefulChatClient.
SystemMessage	Diskriminierte Vereinigung aller Systemnachrichten. Der `systemMessageType` Bereich ist auf Union-Varianten spezialisiert.
TopicChangedListener	Rückruf für chatAdapterSubscribers "topicChanged"-Ereignis.
TypingIndicatorSelector	Selectortyp für die TypingIndicator-Komponente .
UpdateMessageCallback	Rückruffunktion wird ausgeführt, wenn eine Nachricht aktualisiert wird.
VideoGalleryLayout
VideoGalleryLocalParticipant	Der Status des lokalen Teilnehmers in der VideoGallery.
VideoGalleryParticipant	Der Status eines Teilnehmers in der VideoGallery.
VideoGallerySelector	Selektortyp für die VideoGallery-Komponente .
ViewScalingMode	Skalierungsmodus eines VideoGalleryStream.

Functions

CallAgentProvider(CallAgentProviderProps)	Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-calling%23CallAgent>. Aufrufen von Komponenten aus diesem Paket muss mit einem CallAgentProvider umschlossen werden.
CallClientProvider(CallClientProviderProps)	Ein <xref:React.Context> , der einen StatefulCallClient speichert. Aufrufen von Komponenten aus diesem Paket muss mit einem CallClientProvider umschlossen werden.
CallComposite(CallCompositeProps)	Eine anpassbare Benutzeroberfläche für das Aufrufen von Funktionen.
CallProvider(CallProviderProps)	Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-calling%23Call>. Aufrufen von Komponenten aus diesem Paket muss mit einem CallProvider umschlossen werden.
CallWithChatComposite(CallWithChatCompositeProps)	CallWithChatComposite vereint wichtige Komponenten, um einen vollständigen Anruf mit Chaterfahrung sofort bereitzustellen.
CameraButton(CameraButtonProps)	Eine Schaltfläche zum Ein-/Ausschalten der Kamera. Kann mit ControlBar verwendet werden.
ChatClientProvider(ChatClientProviderProps)	Ein <xref:React.Context> , der einen StatefulChatClient speichert. Chatkomponenten aus diesem Paket müssen mit einem ChatClientProvider umschlossen werden.
ChatComposite(ChatCompositeProps)	Eine anpassbare Benutzeroberfläche für die Chaterfahrung.
ChatThreadClientProvider(ChatThreadClientProviderProps)	Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Chatkomponenten aus diesem Paket müssen mit einem ChatThreadClientProvider umschlossen werden.
ControlBar(ControlBarProps)	Ein Container für verschiedene Schaltflächen für Anrufsteuerungen. Verwenden Sie direkt mit verschiedenen Aufrufsteuerungsschaltflächen in dieser Bibliothek, z. B. CameraButton oder Ihren eigenen Instanzen von ControlBarButton .
ControlBarButton(ControlBarButtonProps)	Standardschaltfläche im Format für die ControlBar. Verwenden Sie diese Komponente, um benutzerdefinierte Schaltflächen zu erstellen, die mit anderen Schaltflächen identisch sind, die von der UI-Bibliothek bereitgestellt werden.
DevicesButton(DevicesButtonProps)	Eine Schaltfläche zum Öffnen eines Menüs, das Geräteoptionen steuert. Kann mit ControlBar verwendet werden.
EndCallButton(EndCallButtonProps)	Eine Schaltfläche zum Beenden eines laufenden Anrufs. Kann mit ControlBar verwendet werden.
ErrorBar(ErrorBarProps)	Eine Komponente zum Anzeigen von Fehlermeldungen auf der Benutzeroberfläche. Alle Zeichenfolgen, die angezeigt werden können, werden als Zeichenfolgen akzeptiert, damit sie lokalisiert werden können. Aktive Fehler werden von activeErrorMessages ausgewählt. Diese Komponente verfolgt intern die vom Benutzer verworfenen. Fehler mit zugeordnetem Zeitstempel: Der Fehler wird auf der Benutzeroberfläche erneut angezeigt, wenn er nach dem Schließen auftritt. Fehler ohne Zeitstempel: Der Fehler wird geschlossen, bis er aus den Requisiten verschwindet. Wenn der Fehler wiederholt wird, wird er auf der Benutzeroberfläche angezeigt. Verwendet <xref:%40fluentui%2Freact%23MessageBar> ein UI-Element.
FluentThemeProvider(FluentThemeProviderProps)	Anbieter, um ein Fluent-Design auf die React-Komponenten dieser Bibliothek anzuwenden.
GridLayout(GridLayoutProps)	Eine Komponente zum Anordnen von Audio-/Videoteilnehmerkacheln in einem Anruf.
LocalizationProvider(LocalizationProviderProps)	Anbieter, der lokalisierte Zeichenfolgen für die React-Komponenten dieser Bibliothek bereitstellt.
MessageStatusIndicator(MessageStatusIndicatorProps)	Komponente zum Anzeigen der status einer gesendeten Nachricht. Fügt ein Symbol und eine QuickInfo hinzu, die der Meldung status.
MessageThread(MessageThreadProps)	`MessageThread` ermöglicht ihnen die einfache Erstellung einer Komponente zum Rendern von Chatnachrichten, zum Verarbeiten des Bildlaufverhaltens neuer/alter Nachrichten und zum Anpassen von Symbolen & Steuerelementen innerhalb des Chatthreads.
MicrophoneButton(MicrophoneButtonProps)	Eine Schaltfläche zum Ein-/Ausschalten des Mikrofons. Kann mit ControlBar verwendet werden.
ParticipantItem(ParticipantItemProps)	Komponente zum Rendern eines Anruf- oder Chatteilnehmers. Zeigt avatar, displayName und status des Teilnehmers sowie optionale Symbole und Kontextmenü an.
ParticipantList(ParticipantListProps)	Komponente zum Rendern aller Anruf- oder Chatteilnehmer. Standardmäßig wird jeder Teilnehmer mit ParticipantItem gerendert. Weitere Informationen finden Sie <xref:ParticipantListProps.onRenderParticipant> unter Überschreiben.
ParticipantsButton(ParticipantsButtonProps)	Eine Schaltfläche zum Anzeigen eines Menüs mit Anruf- oder Chatteilnehmern. Kann mit ControlBar verwendet werden. Diese Schaltfläche enthält Dropdownmenüelemente, die über die -Eigenschaft `menuProps`definiert sind. Standardmäßig kann die Anzahl von Remoteteilnehmern mit der vollständigen Liste als Untermenü und einer Option zum Stummschalten aller Teilnehmer sowie eine Schaltfläche zum Kopieren in die Zwischenablage angezeigt werden, um die Anrufseinladungs-URL zu kopieren. Dies `menuProps` kann vollständig neu definiert werden, und seine Eigenschaft ist vom Typ IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)	Eine Schaltfläche zum Starten/Beenden der Bildschirmfreigabe. Kann mit ControlBar verwendet werden.
SendBox(SendBoxProps)	Komponente zum Eingeben und Senden von Nachrichten. Unterstützt das Senden von Eingabebenachrichtigungen, wenn der Benutzer mit der Eingabe von Text beginnt. Unterstützt eine optionale Nachricht unterhalb des Texteingabefelds.
StreamMedia(StreamMediaProps)	Hilfsprogrammkomponente, um ein HTMLElement mit einem Videostream in ein JSX-Element zu konvertieren. Verwenden Sie , um ein HTMLElement zu konvertieren, das von der API für den Headless-Aufruf zurückgegeben wird, in eine Komponente, die als VideoTile gerendert werden kann.
TypingIndicator(TypingIndicatorProps)	Komponente, die den lokalen Benutzer benachrichtigt, wenn ein oder mehrere Teilnehmer im Chatthread eingeben.
VideoGallery(VideoGalleryProps)	VideoGallery stellt ein Layout von Videokacheln für einen bestimmten Anruf dar. Es zeigt eine VideoTile für den lokalen Benutzer sowie für jeden Remoteteilnehmer an, der dem Anruf beigetreten ist.
VideoTile(VideoTileProps)	Eine Komponente zum Rendern des Videodatenstroms für einen einzelnen Anrufteilnehmer. Verwenden Sie mit GridLayout in einer VideoGallery.Use with GridLayout in a VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Erstellen Sie einen CallAdapter, der von Azure Communication Services unterstützt wird. Dies ist die Standardimplementierung von CallAdapter, die von dieser Bibliothek bereitgestellt wird. Hinweis: `displayName` kann maximal 256 Zeichen lang sein.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)	Erstellen Sie einen CallAdapter mit dem bereitgestellten StatefulCallClient. Nützlich, wenn Sie einen Verweis auf StatefulCallClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationCallAdapter für eine einfachere API.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)	Erstellen Sie einen CallWithChatAdapter, der von Azure Communication Services unterstützt wird, um das Plug-In callWithChatComposite herzustellen.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	Erstellen Sie einen CallWithChatAdapter mit dem bereitgestellten StatefulChatClient und StatefulCallClient. Nützlich, wenn Sie einen Verweis auf StatefulChatClient und StatefulCallClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationCallWithChatAdapter für eine einfachere API.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)	Erstellen Sie einen ChatAdapter, der von Azure Communication Services unterstützt wird. Dies ist die Standardimplementierung von ChatAdapter, die von dieser Bibliothek bereitgestellt wird.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)	Erstellen Sie einen ChatAdapter mit dem bereitgestellten StatefulChatClient. Nützlich, wenn Sie einen Verweis auf StatefulChatClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationChatAdapter für eine einfachere API.
createDefaultCallingHandlers(StatefulCallClient, undefined \| CallAgent, undefined \| StatefulDeviceManager, undefined \| Call)	Erstellen Sie die Standardimplementierung von CallingHandlers für Teams-Aufrufe. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)	Erstellen Sie die Standardimplementierung von ChatHandlers. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. Das zurückgegebene Objekt wird gespeichert, um ein erneutes Rendern zu vermeiden, wenn es als Eigenschaften für React Components verwendet wird.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)	Erstellt einen StatefulCallClient StatefulCallClient durch Proxys von CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> mit ProxyCallClient <xref:ProxyCallClient> , der dann den Zugriff auf den Zustand deklarativ zulässt. Es ist wichtig, die <xref:%40azure%2Fcommunication-calling%23DeviceManager> und und <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (und usw.) zu verwenden, die vom StatefulCallClient abgerufen werden, damit ihre Zustandsänderungen ordnungsgemäß übermittelt werden.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)	Erstellt einen zustandsbehafteten ChatClient StatefulChatClient durch Proxys von ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> mit ProxyChatClient <xref:ProxyChatClient> , der dann den Zugriff auf zustandsbehaftete Weise zulässt.
fromFlatCommunicationIdentifier(string)	Umgekehrter Vorgang von toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)	Rufen Sie den Selektor für eine angegebene Komponente ab. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
getChatSelector<Component>(Component)	Rufen Sie den Selektor für eine angegebene Komponente ab. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
toFlatCommunicationIdentifier(CommunicationIdentifier)	Eine Zeichenfolgendarstellung von <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Diese Zeichenfolgendarstellung von CommunicationIdentifier ist für einen eindeutigen Communication-Benutzer garantiert stabil. Demnach sind Sie kann verwendet werden, um die Identität eines Benutzers in externen Datenbanken beizubehalten. Es kann als Schlüssel in einer Zuordnung verwendet werden, um Daten für den Benutzer zu speichern.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)	Ein benutzerdefinierter React Hook, um die Erstellung von CallAdapter zu vereinfachen. Ähnlich wie createAzureCommunicationCallAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters. Ermöglicht das Undefinieren von Argumenten, sodass Sie die Regel der Hooks respektieren und Argumente übergeben können, während sie erstellt werden. Der Adapter wird nur erstellt, wenn alle Argumente definiert sind. Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)	Ein benutzerdefinierter React Hook, um die Erstellung von CallWithChatAdapter zu vereinfachen. Ähnlich wie createAzureCommunicationCallWithChatAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters. Ermöglicht das Undefinieren von Argumenten, sodass Sie die Regel der Hooks respektieren und Argumente übergeben können, während sie erstellt werden. Der Adapter wird nur erstellt, wenn alle Argumente definiert sind. Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)	Ein benutzerdefinierter React Hook, um die Erstellung von ChatAdapter zu vereinfachen. Ähnlich wie createAzureCommunicationChatAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters. Ermöglicht das Undefinieren von Argumenten, sodass Sie die Regel der Hooks respektieren und Argumente übergeben können, während sie erstellt werden. Der Adapter wird nur erstellt, wenn alle Argumente definiert sind. Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.
useCall()	Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-calling%23Call> . Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. Sie müssen den CallProvider zuvor mit einem Call-Objekt verwendet haben, um diesen Hook verwenden zu können.
useCallAgent()	Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-calling%23CallAgent> . Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
useCallClient()	Hook, um StatefulCallClient vom Anbieter abzurufen. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
useChatClient()	Hook, um StatefulChatClient vom Anbieter abzurufen. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
useChatThreadClient()	Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> . Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
useDeviceManager()	Hook, um StatefulDeviceManager vom Anbieter abzurufen. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
usePropsFor<Component>(Component, "chat" \| "calling")	Primärer Hook, um alle Hooks abzurufen, die für eine React Komponente aus dieser Bibliothek erforderlich sind. Um diesen Hook aufrufen zu können, muss die Komponente unter den folgenden Anbietern umschlossen werden: Für Chatkomponenten: ChatClientProvider und ChatThreadClientProvider. Für Aufrufkomponenten: CallClientProvider, CallAgentProvider und CallAgentProvider. Die einfachste Verwendung einer Komponente sieht wie folgt aus: Beispiel `import { ParticipantList, usePropsFor } from '@azure/communication-react'; const App = (): JSX.Element => { // ... code to setup Providers ... return <ParticipantList {...usePropsFor(ParticipantList)}/> }`
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" \| "calling")	Hook, um einen Selektor für eine angegebene Komponente zu erhalten. Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
useTheme()	React Zum Zugriff auf das Design

Details zur Funktion

CallAgentProvider(CallAgentProviderProps)

Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Aufrufen von Komponenten aus diesem Paket muss mit einem CallAgentProvider umschlossen werden.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parameter

props: CallAgentProviderProps

Gibt zurück

Element

CallClientProvider(CallClientProviderProps)

Ein <xref:React.Context> , der einen StatefulCallClient speichert.

Aufrufen von Komponenten aus diesem Paket muss mit einem CallClientProvider umschlossen werden.

function CallClientProvider(props: CallClientProviderProps): Element

Parameter

props: CallClientProviderProps

Gibt zurück

Element

CallComposite(CallCompositeProps)

Eine anpassbare Benutzeroberfläche für das Aufrufen von Funktionen.

function CallComposite(props: CallCompositeProps): Element

Parameter

props: CallCompositeProps

Gibt zurück

Element

Hinweise

Die Aufrufbreite/Höhe des zusammengesetzten Mindestwerts ist wie folgt:

mobil: 17.5rem x 21rem (280px x 336px, mit standard rem bei 16px)
Desktop: 30rem x 22rem (480px x 352px, mit standard rem bei 16px)

CallProvider(CallProviderProps)

Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-calling%23Call>.

Aufrufen von Komponenten aus diesem Paket muss mit einem CallProvider umschlossen werden.

function CallProvider(props: CallProviderProps): Element

Parameter

props: CallProviderProps

Gibt zurück

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite vereint wichtige Komponenten, um einen vollständigen Anruf mit Chaterfahrung sofort bereitzustellen.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parameter

props: CallWithChatCompositeProps

Gibt zurück

Element

CameraButton(CameraButtonProps)

Eine Schaltfläche zum Ein-/Ausschalten der Kamera.

Kann mit ControlBar verwendet werden.

function CameraButton(props: CameraButtonProps): Element

Parameter

props: CameraButtonProps

Gibt zurück

Element

ChatClientProvider(ChatClientProviderProps)

Ein <xref:React.Context> , der einen StatefulChatClient speichert.

Chatkomponenten aus diesem Paket müssen mit einem ChatClientProvider umschlossen werden.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parameter

props: ChatClientProviderProps

Gibt zurück

Element

ChatComposite(ChatCompositeProps)

Eine anpassbare Benutzeroberfläche für die Chaterfahrung.

function ChatComposite(props: ChatCompositeProps): Element

Parameter

props: ChatCompositeProps

Gibt zurück

Element

Hinweise

Zusammengesetzte Mindestbreite und Höhe des Chats sind 17,5 rem bzw. 20 rem (280px und 320px, mit standard rem bei 16px).

ChatThreadClientProvider(ChatThreadClientProviderProps)

Ein <xref:React.Context> , in dem ein gespeichert wird <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Chatkomponenten aus diesem Paket müssen mit einem ChatThreadClientProvider umschlossen werden.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parameter

props: ChatThreadClientProviderProps

Gibt zurück

Element

ControlBar(ControlBarProps)

Ein Container für verschiedene Schaltflächen für Anrufsteuerungen.

Verwenden Sie direkt mit verschiedenen Aufrufsteuerungsschaltflächen in dieser Bibliothek, z. B. CameraButton oder Ihren eigenen Instanzen von ControlBarButton .

function ControlBar(props: ControlBarProps): Element

Parameter

props: ControlBarProps

Gibt zurück

Element

ControlBarButton(ControlBarButtonProps)

Standardschaltfläche im Format für die ControlBar.

Verwenden Sie diese Komponente, um benutzerdefinierte Schaltflächen zu erstellen, die mit anderen Schaltflächen identisch sind, die von der UI-Bibliothek bereitgestellt werden.

function ControlBarButton(props: ControlBarButtonProps): Element

Parameter

props: ControlBarButtonProps

Gibt zurück

Element

DevicesButton(DevicesButtonProps)

Eine Schaltfläche zum Öffnen eines Menüs, das Geräteoptionen steuert.

Kann mit ControlBar verwendet werden.

function DevicesButton(props: DevicesButtonProps): Element

Parameter

props: DevicesButtonProps

Gibt zurück

Element

EndCallButton(EndCallButtonProps)

Eine Schaltfläche zum Beenden eines laufenden Anrufs.

Kann mit ControlBar verwendet werden.

function EndCallButton(props: EndCallButtonProps): Element

Parameter

props: EndCallButtonProps

Gibt zurück

Element

ErrorBar(ErrorBarProps)

Eine Komponente zum Anzeigen von Fehlermeldungen auf der Benutzeroberfläche. Alle Zeichenfolgen, die angezeigt werden können, werden als Zeichenfolgen akzeptiert, damit sie lokalisiert werden können. Aktive Fehler werden von activeErrorMessages ausgewählt.

Diese Komponente verfolgt intern die vom Benutzer verworfenen.

Fehler mit zugeordnetem Zeitstempel: Der Fehler wird auf der Benutzeroberfläche erneut angezeigt, wenn er nach dem Schließen auftritt.
Fehler ohne Zeitstempel: Der Fehler wird geschlossen, bis er aus den Requisiten verschwindet. Wenn der Fehler wiederholt wird, wird er auf der Benutzeroberfläche angezeigt.

Verwendet <xref:%40fluentui%2Freact%23MessageBar> ein UI-Element.

function ErrorBar(props: ErrorBarProps): Element

Parameter

props: ErrorBarProps

Gibt zurück

Element

FluentThemeProvider(FluentThemeProviderProps)

Anbieter, um ein Fluent-Design auf die React-Komponenten dieser Bibliothek anzuwenden.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parameter

props: FluentThemeProviderProps

Gibt zurück

Element

Hinweise

Komponenten in dieser Bibliothek bestehen in erster Linie aus Fluent UI, Steuerelementen und auch aus Fluent React Northstar-Steuerelementen. Dieser Anbieter behandelt das Anwenden eines beliebigen Designs, das sowohl den zugrunde liegenden Fluent UI-Steuerelementen als auch den Fluent React Northstar-Steuerelementen zur Verfügung gestellt wird.

GridLayout(GridLayoutProps)

Eine Komponente zum Anordnen von Audio-/Videoteilnehmerkacheln in einem Anruf.

function GridLayout(props: GridLayoutProps): Element

Parameter

props: GridLayoutProps

Gibt zurück

Element

LocalizationProvider(LocalizationProviderProps)

Anbieter, der lokalisierte Zeichenfolgen für die React-Komponenten dieser Bibliothek bereitstellt.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parameter

props: LocalizationProviderProps

Gibt zurück

Element

Hinweise

Komponenten werden standardmäßig lokalisierte Zeichenfolgen in Englisch (USA) bereitgestellt, wenn dieser Anbieter nicht verwendet wird.

MessageStatusIndicator(MessageStatusIndicatorProps)

Komponente zum Anzeigen der status einer gesendeten Nachricht.

Fügt ein Symbol und eine QuickInfo hinzu, die der Meldung status.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parameter

props: MessageStatusIndicatorProps

Gibt zurück

Element

MessageThread(MessageThreadProps)

MessageThread ermöglicht ihnen die einfache Erstellung einer Komponente zum Rendern von Chatnachrichten, zum Verarbeiten des Bildlaufverhaltens neuer/alter Nachrichten und zum Anpassen von Symbolen & Steuerelementen innerhalb des Chatthreads.

function MessageThread(props: MessageThreadProps): Element

Parameter

props: MessageThreadProps

vom Typ MessageThreadProps

Benutzer müssen mindestens Chatnachrichten und userId bereitstellen, um die Komponente zu rendern MessageThread . Benutzer können auch anpassenMessageThread, indem sie ihren eigenen Avatar, MessageStatusIndicator ihr eigenes SymbolJumpToNewMessageButtonLoadPreviousMessagesButton, und das Verhalten dieser Steuerelemente übergeben.

MessageThread verwendet intern die Chat komponente & Chat.Message von @fluentui/react-northstar. Sie können die Details zu diesen beiden Komponenten überprüfen.

Gibt zurück

Element

MicrophoneButton(MicrophoneButtonProps)

Eine Schaltfläche zum Ein-/Ausschalten des Mikrofons.

Kann mit ControlBar verwendet werden.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parameter

props: MicrophoneButtonProps

Gibt zurück

Element

ParticipantItem(ParticipantItemProps)

Komponente zum Rendern eines Anruf- oder Chatteilnehmers.

Zeigt avatar, displayName und status des Teilnehmers sowie optionale Symbole und Kontextmenü an.

function ParticipantItem(props: ParticipantItemProps): Element

Parameter

props: ParticipantItemProps

Gibt zurück

Element

ParticipantList(ParticipantListProps)

Komponente zum Rendern aller Anruf- oder Chatteilnehmer.

Standardmäßig wird jeder Teilnehmer mit ParticipantItem gerendert. Weitere Informationen finden Sie <xref:ParticipantListProps.onRenderParticipant> unter Überschreiben.

function ParticipantList(props: ParticipantListProps): Element

Parameter

props: ParticipantListProps

Gibt zurück

Element

ParticipantsButton(ParticipantsButtonProps)

Eine Schaltfläche zum Anzeigen eines Menüs mit Anruf- oder Chatteilnehmern.

Kann mit ControlBar verwendet werden.

Diese Schaltfläche enthält Dropdownmenüelemente, die über die -Eigenschaft menuPropsdefiniert sind. Standardmäßig kann die Anzahl von Remoteteilnehmern mit der vollständigen Liste als Untermenü und einer Option zum Stummschalten aller Teilnehmer sowie eine Schaltfläche zum Kopieren in die Zwischenablage angezeigt werden, um die Anrufseinladungs-URL zu kopieren. Dies menuProps kann vollständig neu definiert werden, und seine Eigenschaft ist vom Typ IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parameter

props: ParticipantsButtonProps

Gibt zurück

Element

ScreenShareButton(ScreenShareButtonProps)

Eine Schaltfläche zum Starten/Beenden der Bildschirmfreigabe.

Kann mit ControlBar verwendet werden.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parameter

props: ScreenShareButtonProps

Gibt zurück

Element

SendBox(SendBoxProps)

Komponente zum Eingeben und Senden von Nachrichten.

Unterstützt das Senden von Eingabebenachrichtigungen, wenn der Benutzer mit der Eingabe von Text beginnt. Unterstützt eine optionale Nachricht unterhalb des Texteingabefelds.

function SendBox(props: SendBoxProps): Element

Parameter

props: SendBoxProps

Gibt zurück

Element

StreamMedia(StreamMediaProps)

Hilfsprogrammkomponente, um ein HTMLElement mit einem Videostream in ein JSX-Element zu konvertieren.

Verwenden Sie , um ein HTMLElement zu konvertieren, das von der API für den Headless-Aufruf zurückgegeben wird, in eine Komponente, die als VideoTile gerendert werden kann.

function StreamMedia(props: StreamMediaProps): Element

Parameter

props: StreamMediaProps

Gibt zurück

Element

TypingIndicator(TypingIndicatorProps)

Komponente, die den lokalen Benutzer benachrichtigt, wenn ein oder mehrere Teilnehmer im Chatthread eingeben.

function TypingIndicator(props: TypingIndicatorProps): Element

Parameter

props: TypingIndicatorProps

Gibt zurück

Element

VideoGallery(VideoGalleryProps)

VideoGallery stellt ein Layout von Videokacheln für einen bestimmten Anruf dar. Es zeigt eine VideoTile für den lokalen Benutzer sowie für jeden Remoteteilnehmer an, der dem Anruf beigetreten ist.

function VideoGallery(props: VideoGalleryProps): Element

Parameter

props: VideoGalleryProps

Gibt zurück

Element

VideoTile(VideoTileProps)

Eine Komponente zum Rendern des Videodatenstroms für einen einzelnen Anrufteilnehmer.

Verwenden Sie mit GridLayout in einer VideoGallery.Use with GridLayout in a VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parameter

props: VideoTileProps

Gibt zurück

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Erstellen Sie einen CallAdapter, der von Azure Communication Services unterstützt wird.

Dies ist die Standardimplementierung von CallAdapter, die von dieser Bibliothek bereitgestellt wird.

Hinweis: displayName kann maximal 256 Zeichen lang sein.

function createAzureCommunicationCallAdapter(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>

Parameter

__namedParameters: AzureCommunicationCallAdapterArgs

Gibt zurück

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Erstellen Sie einen CallAdapter mit dem bereitgestellten StatefulCallClient.

Nützlich, wenn Sie einen Verweis auf StatefulCallClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationCallAdapter für eine einfachere API.

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator): Promise<CallAdapter>

Parameter

callClient: StatefulCallClient

callAgent: CallAgent

locator: CallAdapterLocator

Gibt zurück

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Erstellen Sie einen CallWithChatAdapter, der von Azure Communication Services unterstützt wird, um das Plug-In callWithChatComposite herzustellen.

function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>

Parameter

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

Gibt zurück

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Erstellen Sie einen CallWithChatAdapter mit dem bereitgestellten StatefulChatClient und StatefulCallClient.

Nützlich, wenn Sie einen Verweis auf StatefulChatClient und StatefulCallClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationCallWithChatAdapter für eine einfachere API.

function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>

Parameter

__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs

Gibt zurück

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Erstellen Sie einen ChatAdapter, der von Azure Communication Services unterstützt wird.

Dies ist die Standardimplementierung von ChatAdapter, die von dieser Bibliothek bereitgestellt wird.

function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>

Parameter

__namedParameters: AzureCommunicationChatAdapterArgs

Gibt zurück

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Erstellen Sie einen ChatAdapter mit dem bereitgestellten StatefulChatClient.

Nützlich, wenn Sie einen Verweis auf StatefulChatClient beibehalten möchten. Erwägen Sie die Verwendung von createAzureCommunicationChatAdapter für eine einfachere API.

function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>

Parameter

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Gibt zurück

Promise<ChatAdapter>

createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Erstellen Sie die Standardimplementierung von CallingHandlers für Teams-Aufrufe.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call): CallingHandlers

Parameter

callClient: StatefulCallClient

callAgent: undefined | CallAgent

deviceManager: undefined | StatefulDeviceManager

call: undefined | Call

Gibt zurück

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Erstellen Sie die Standardimplementierung von ChatHandlers.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

Das zurückgegebene Objekt wird gespeichert, um ein erneutes Rendern zu vermeiden, wenn es als Eigenschaften für React Components verwendet wird.

function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers

Parameter

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Gibt zurück

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Erstellt einen StatefulCallClient StatefulCallClient durch Proxys von CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> mit ProxyCallClient <xref:ProxyCallClient> , der dann den Zugriff auf den Zustand deklarativ zulässt.

Es ist wichtig, die <xref:%40azure%2Fcommunication-calling%23DeviceManager> und und <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (und usw.) zu verwenden, die vom StatefulCallClient abgerufen werden, damit ihre Zustandsänderungen ordnungsgemäß übermittelt werden.

function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient

Parameter

args: StatefulCallClientArgs

StatefulCallClientArgs

options: StatefulCallClientOptions

StatefulCallClientOptions

Gibt zurück

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Erstellt einen zustandsbehafteten ChatClient StatefulChatClient durch Proxys von ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> mit ProxyChatClient <xref:ProxyChatClient> , der dann den Zugriff auf zustandsbehaftete Weise zulässt.

function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parameter

id: string

Gibt zurück

CommunicationIdentifier

getCallingSelector<Component>(Component)

Rufen Sie den Selektor für eine angegebene Komponente ab.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function getCallingSelector<Component>(component: Component): GetCallingSelector<Component>

Parameter

component: Component

Gibt zurück

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Rufen Sie den Selektor für eine angegebene Komponente ab.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function getChatSelector<Component>(component: Component): GetChatSelector<Component>

Parameter

component: Component

Gibt zurück

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Eine Zeichenfolgendarstellung von <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Diese Zeichenfolgendarstellung von CommunicationIdentifier ist für einen eindeutigen Communication-Benutzer garantiert stabil. Demnach sind

Sie kann verwendet werden, um die Identität eines Benutzers in externen Datenbanken beizubehalten.
Es kann als Schlüssel in einer Zuordnung verwendet werden, um Daten für den Benutzer zu speichern.

function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parameter

identifier: CommunicationIdentifier

Gibt zurück

string

useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Ein benutzerdefinierter React Hook, um die Erstellung von CallAdapter zu vereinfachen.

Ähnlich wie createAzureCommunicationCallAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters.

Ermöglicht das Undefinieren von Argumenten, sodass Sie die Regel der Hooks respektieren und Argumente übergeben können, während sie erstellt werden. Der Adapter wird nur erstellt, wenn alle Argumente definiert sind.

Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.

function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter

Parameter

args: Partial<AzureCommunicationCallAdapterArgs>

afterCreate: (adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose: (adapter: CallAdapter) => Promise<void>

Gibt zurück

undefined | CallAdapter

useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

Ein benutzerdefinierter React Hook, um die Erstellung von CallWithChatAdapter zu vereinfachen.

Ähnlich wie createAzureCommunicationCallWithChatAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters.

Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.

function useAzureCommunicationCallWithChatAdapter(args: Partial<AzureCommunicationCallWithChatAdapterArgs>, afterCreate?: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, beforeDispose?: (adapter: CallWithChatAdapter) => Promise<void>): undefined | CallWithChatAdapter

Parameter

args: Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose: (adapter: CallWithChatAdapter) => Promise<void>

Gibt zurück

undefined | CallWithChatAdapter

useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

Ein benutzerdefinierter React Hook, um die Erstellung von ChatAdapter zu vereinfachen.

Ähnlich wie createAzureCommunicationChatAdapter, übernimmt aber intern die asynchrone Erstellung des Adapters.

Beachten Sie, dass Sie sich die Argumente merken müssen, um zu vermeiden, dass der Adapter bei jedem Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.

function useAzureCommunicationChatAdapter(args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: (adapter: ChatAdapter) => Promise<ChatAdapter>, beforeDispose?: (adapter: ChatAdapter) => Promise<void>): undefined | ChatAdapter

Parameter

args: Partial<AzureCommunicationChatAdapterArgs>

afterCreate: (adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose: (adapter: ChatAdapter) => Promise<void>

Gibt zurück

undefined | ChatAdapter

useCall()

Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-calling%23Call> .

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

Sie müssen den CallProvider zuvor mit einem Call-Objekt verwendet haben, um diesen Hook verwenden zu können.

function useCall(): undefined | Call

Gibt zurück

undefined | Call

useCallAgent()

Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-calling%23CallAgent> .

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useCallAgent(): undefined | CallAgent

Gibt zurück

undefined | CallAgent

useCallClient()

Hook, um StatefulCallClient vom Anbieter abzurufen.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useCallClient(): StatefulCallClient

Gibt zurück

StatefulCallClient

useChatClient()

Hook, um StatefulChatClient vom Anbieter abzurufen.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useChatClient(): StatefulChatClient

Gibt zurück

StatefulChatClient

useChatThreadClient()

Hook, um vom Anbieter zu erhalten <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> .

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useChatThreadClient(): ChatThreadClient

Gibt zurück

ChatThreadClient

useDeviceManager()

Hook, um StatefulDeviceManager vom Anbieter abzurufen.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useDeviceManager(): undefined | StatefulDeviceManager

Gibt zurück

undefined | StatefulDeviceManager

usePropsFor<Component>(Component, "chat" | "calling")

Primärer Hook, um alle Hooks abzurufen, die für eine React Komponente aus dieser Bibliothek erforderlich sind.

Um diesen Hook aufrufen zu können, muss die Komponente unter den folgenden Anbietern umschlossen werden:

Für Chatkomponenten: ChatClientProvider und ChatThreadClientProvider.
Für Aufrufkomponenten: CallClientProvider, CallAgentProvider und CallAgentProvider.

Die einfachste Verwendung einer Komponente sieht wie folgt aus:

Beispiel

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }

function usePropsFor<Component>(component: Component, type?: "chat" | "calling"): ComponentProps<Component>

Parameter

component: Component

type: "chat" | "calling"

Gibt zurück

ComponentProps<Component>

useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

Hook, um einen Selektor für eine angegebene Komponente zu erhalten.

Nützlich bei der Implementierung einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.

function useSelector<ParamT>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), type?: "chat" | "calling"): (ParamT extends Selector ? ReturnType<ParamT> : undefined)

Parameter

selector: ParamT

selectorProps: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined)

type: "chat" | "calling"

Gibt zurück

(ParamT extends Selector ? ReturnType<ParamT> : undefined)

useTheme()

React Zum Zugriff auf das Design

function useTheme(): Theme

Gibt zurück

Theme

Freigeben über

@azure/communication-react package

Klassen

Schnittstellen

Typaliase

Functions

Details zur Funktion

CallAgentProvider(CallAgentProviderProps)

Parameter

Gibt zurück

CallClientProvider(CallClientProviderProps)

Parameter

Gibt zurück

CallComposite(CallCompositeProps)

Parameter

Gibt zurück

Hinweise

CallProvider(CallProviderProps)

Parameter

Gibt zurück

CallWithChatComposite(CallWithChatCompositeProps)

Parameter

Gibt zurück

CameraButton(CameraButtonProps)

Parameter

Gibt zurück

ChatClientProvider(ChatClientProviderProps)

Parameter

Gibt zurück

ChatComposite(ChatCompositeProps)

Parameter

Gibt zurück

Hinweise

ChatThreadClientProvider(ChatThreadClientProviderProps)

Parameter

Gibt zurück

ControlBar(ControlBarProps)

Parameter

Gibt zurück

ControlBarButton(ControlBarButtonProps)

Parameter

Gibt zurück

DevicesButton(DevicesButtonProps)

Parameter

Gibt zurück

EndCallButton(EndCallButtonProps)

Parameter

Gibt zurück

ErrorBar(ErrorBarProps)

Parameter

Gibt zurück

FluentThemeProvider(FluentThemeProviderProps)

Parameter

Gibt zurück

Hinweise

GridLayout(GridLayoutProps)

Parameter

Gibt zurück

LocalizationProvider(LocalizationProviderProps)

Parameter

Gibt zurück

Hinweise

MessageStatusIndicator(MessageStatusIndicatorProps)

Parameter

Gibt zurück

MessageThread(MessageThreadProps)

Parameter

Gibt zurück

MicrophoneButton(MicrophoneButtonProps)

Parameter

Gibt zurück

ParticipantItem(ParticipantItemProps)

Parameter

Gibt zurück

ParticipantList(ParticipantListProps)

Parameter

Gibt zurück

ParticipantsButton(ParticipantsButtonProps)

Parameter

Gibt zurück