@azure/communication-react package
Klassen
| CallError |
Fehler, der von fehlgeschlagenen zustandsbehafteten API-Methoden ausgelöst wird. |
| ChatError |
Fehler, der von fehlgeschlagenen StatefulChatClient- Methoden ausgelöst wurde. |
Schnittstellen
| AcceptedTransfer |
Übertragen des KE-Zustands |
| ActiveErrorMessage |
Aktive Fehlermeldungen, die über ErrorBar-angezeigt werden sollen. |
| ActiveNotification |
Aktive Benachrichtigungen, die über NotificationStack angezeigt werden sollen. |
| AdapterError |
Fehler, der über Fehlerereignisse gemeldet und im Adapterzustand gespeichert ist. |
| AdapterNotification |
Benachrichtigung vom Aufrufclientstatus, der im Adapterstatus gespeichert ist. |
| AdapterState |
Funktionalität für die Kopplung mit dem Verbundadapterstatus. |
| AttachmentMetadata |
Datenmodell, das einen Chatnachrichtenanhang darstellt, wobei es eine ID zur eindeutigen Identifizierung des Anhangs, einen Namen, der den Namen der Datei darstellt, und eine URL zum Herunterladen des Anhangs enthält. |
| BaseCompositeProps |
Eigenschaften, die für alle aus dieser Bibliothek exportierten Composites gemeinsam sind. |
| BaseCustomStyles |
Grundlegende Fluent-Stil-Eigenschaften für alle Komponenten, die aus dieser Bibliothek exportiert wurden. |
| BreakoutRoomsState |
Status von Breakout-Räumen |
| CallAdapter |
Eine adapterspezifische Schnittstelle für Azure Communication Identity, die CommonCallAdapter-erweitert. |
| CallAdapterCallManagement |
Funktionalität für die Verwaltung des aktuellen Anrufs oder Starten eines neuen Anrufs |
| CallAdapterCallOperations |
Funktionalität für die Verwaltung des aktuellen Anrufs. |
| CallAdapterDeviceManagement |
Funktionalität für die Verwaltung von Geräten innerhalb eines Anrufs. |
| CallAdapterSubscribers |
Aufrufen zusammengesetzter Ereignisse, die abonniert werden können. |
| CallAgentProviderProps |
Argumente zum Initialisieren eines CallAgentProvider-. |
| CallAgentState |
Zustandsversion von <xref:%40azure%2Fcommunication-calling%23CallAgent> mit Ausnahme von Aufrufen wird direkt von CallClientState verschoben und nicht hier enthalten. Der Grund dafür, dass callAgents Status proxied ist, den Zugriff auf displayName zu ermöglichen. Wir flachen CallAgent.displayName nicht ab und fügen ihn in CallClientState ein, da es mehrdeutig wäre, dass displayName tatsächlich auf die Erstellung/Existenz von CallAgent angewiesen ist, verfügbar zu sein. |
| CallAndChatLocator |
Argumente für die Verwendung in createAzureCommunicationCallWithChatAdapter, um einem Anruf mit einem zugeordneten Chatthread beizutreten. |
| CallClientProviderProps |
Argumente zum Initialisieren eines CallClientProvider-. |
| CallClientState |
Container für alle Zustandsdaten, die von StatefulCallClientproxiziert werden. Die Zustände "callsEnded", "incomingCalls" und "incomingCallsEnded" werden automatisch bereitgestellt, wenn ein CallAgent erstellt wurde. Der deviceManager ist anfangs leer, bis DeviceManagerState-angezeigt wird. Der UserId-Status wird als Benutzerfreundlichkeit für den Entwickler bereitgestellt und vom Entwickler vollständig gesteuert und festgelegt. |
| CallCompositeLoaderProps |
Requisiten für OutboundCallComposite, die Sie in Ihrer Anwendung verwenden können. Enthält zwei Optionsbeutel:
|
| CallCompositeProps |
Requisiten für CallComposite. |
| CallCompositeStrings |
Zeichenfolgen, die von der CallComposite- direkt verwendet werden. Diese Zeichenfolgen sind zusätzlich zu den Zeichenfolgen, die von den Komponenten aus der Komponentenbibliothek verwendet werden. |
| CallFeatureStreamState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Stellt den Zustand des Aufruf-Feature-Streams dar. |
| CallInfoState |
State zum Nachverfolgen der Typen <xref:CallInfo> und <xref:TeamsCallInfo> |
| CallNotification | |
| CallProviderProps |
Argumente zum Initialisieren eines CallProvider-. |
| CallState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient- ruft den Status des Anrufs automatisch ab und fügt ihn dem Zustand hinzu, der von StatefulCallClientverfügbar gemacht wird. |
| CallSurveyImprovementSuggestions |
Stellt den Verbesserungsvorschlagsteil der Anrufumfrage dar |
| CallWithChatAdapter |
CallWithChatComposite Adapterschnittstelle. |
| CallWithChatAdapterManagement |
Funktionalität für die Verwaltung des aktuellen Anrufs mit Chat. |
| CallWithChatAdapterState |
CallWithChat State ist eine Kombination aus Stateful Chat- und Stateful Calling-Clients mit einem bestimmten Status, der nur für "CallWithChat Composite" spezifisch ist. |
| CallWithChatAdapterSubscriptions |
Anruf- und Chatereignisse, die im CallWithChatAdapterabonniert werden können. |
| CallWithChatAdapterUiState |
Ui-Zustand im Zusammenhang mit der CallWithChatComposite. |
| CallWithChatClientState |
Status von den Back-End-Diensten, die CallWithChatComposite. |
| CallWithChatCompositeLoaderProps |
Requisiten für CallWithChatComposite, die Sie in Ihrer Anwendung verwenden können. Enthält zwei Optionsbeutel:
|
| CallWithChatCompositeProps |
Für das CallWithChatComposite- erforderliche Props |
| CallWithChatCompositeStrings |
Zeichenfolgen, die von der CallWithChatComposite- direkt verwendet werden. Diese Zeichenfolgen sind zusätzlich zu den Zeichenfolgen, die von den Komponenten aus der Komponentenbibliothek verwendet werden. |
| CallWithChatControlOptions |
Anpassungsoptionen für die Steuerungsleiste in Anrufen mit Chat-Erfahrung. |
| CallingHandlers |
Objekt mit allen Handlern, die zum Aufrufen von Komponenten erforderlich sind. Das Aufrufen verwandter Komponenten aus diesem Paket kann relevante Handler aus diesem Objekt auswählen. Siehe <xref:useHandlers> und usePropsFor. |
| CallingTheme |
Benutzerdefinierte Fluent-Designpalette, die durch Aufrufen verwandter Komponenten in dieser Bibliothek verwendet wird. |
| CameraButtonContextualMenuStyles |
Formatvorlagen für das CameraButton--Menü. |
| CameraButtonProps |
Requisiten für die CameraButton-Komponente . |
| CameraButtonStrings |
Zeichenfolgen von CameraButton, die überschrieben werden können. |
| CameraButtonStyles |
Formatvorlagen für CameraButton- |
| CapabilitiesFeatureState |
Nur staatliche Version von <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature> |
| CapabilityChangedNotificationStrings |
Zeichenfolgen für die Benachrichtigung über Funktionsänderungen |
| CaptionLanguageStrings |
Untertitel-Sprachzeichenfolgen für Untertitel, die modal festlegen |
| CaptionsBannerProps |
CaptionsBanner-Komponenten-Requisiten. |
| CaptionsBannerStrings |
Zeichenfolgen für Untertitel Banner |
| CaptionsCallFeatureState | |
| CaptionsInfo | |
| CaptionsSettingsModalProps |
CaptionsSettingsModal Komponenten-Requisiten. |
| CaptionsSettingsModalStrings |
Zeichenfolgen für Untertitel, die modal setzen |
| ChatAdapterSubscribers |
Zusammengesetzte Chatereignisse, die abonniert werden können. |
| ChatAdapterThreadManagement |
Funktionalität zum Verwalten des aktuellen Chatthreads. |
| ChatCompositeLoaderProps |
Requisiten für ChatComposite, die Sie in Ihrer Anwendung verwenden können. Enthält die Optionen für ChatCompositeChatCompositeOptions. |
| ChatCompositeProps |
Requisiten für ChatComposite. |
| ChatCompositeStrings |
Zeichenfolgen, die vom ChatComposite- direkt verwendet werden. Diese Zeichenfolgen sind zusätzlich zu den Zeichenfolgen, die von den Komponenten aus der Komponentenbibliothek verwendet werden. |
| ChatMessage |
Eine Chatnachricht. |
| CommonCallAdapter |
CallComposite Adapterschnittstelle. |
| CommonCallingHandlers |
Objekt mit allen Handlern, die zum Aufrufen von Komponenten erforderlich sind. Das Aufrufen verwandter Komponenten aus diesem Paket kann relevante Handler aus diesem Objekt auswählen. Siehe <xref:useHandlers> und usePropsFor. |
| ComponentLocale |
Gebietsschemainformationen für alle Komponenten, die aus dieser Bibliothek exportiert wurden. |
| ComponentStrings |
Zeichenfolgen, die von allen Komponenten verwendet werden, die aus dieser Bibliothek exportiert wurden. |
| CompositeLocale |
Gebietsschemainformationen für alle aus dieser Bibliothek exportierten Composites. |
| CompositeStrings |
Zeichenfolgen, die in den Verbundelementen direkt verwendet werden. Diese Zeichenfolgen werden von den Zusammengesetzten direkt anstelle der enthaltenen Komponenten verwendet. |
| ConferencePhoneInfo |
Informationen für Konferenz-Infos |
| ContentSystemMessage |
Eine Systemnachricht mit arbitärem Inhalt. |
| ControlBarButtonProps |
Props für ControlBarButton. |
| ControlBarButtonStrings |
Zeichenfolgen ControlBarButton-, die überschrieben werden können. |
| ControlBarProps |
Props für ControlBar. |
| CreateVideoStreamViewResult |
Objekt, das nach dem Erstellen eines lokalen oder Remotevideostreams zurückgegeben wird. Dies enthält Hilfsfunktionen zum Bearbeiten des Renderns des Datenstroms. |
| CustomCallControlButtonCallbackArgs |
Argumente für CustomCallControlButtonCallback. |
| CustomCallControlButtonProps |
Antwort von CustomCallControlButtonCallback. Enthält die Basisrequisiten, die zum Rendern einer ControlBarButton - oder <xref:DrawerMenuItem>. |
| CustomCallControlButtonStrings |
Zeichenfolgen für CustomCallControlButtons |
| CustomMessage |
Ein benutzerdefinierter Nachrichtentyp. Benutzerdefinierte Nachrichten werden nicht standardmäßig gerendert, aber Anwendungen können benutzerdefinierte Renderer für sie bereitstellen. |
| DevicesButtonContextualMenuStyles |
Formatvorlagen für das menü DevicesButton. |
| DevicesButtonProps |
Props für DevicesButton. |
| DevicesButtonStrings |
Zeichenfolgen DevicesButton-, die überschrieben werden können. |
| DevicesButtonStyles |
Formatvorlagen für die Menüelemente der Schaltfläche "Geräte". |
| DiagnosticsCallFeatureState |
Nur Proxy für <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>. |
| DialpadProps |
Requisiten für die Dialpad-Komponente . |
| DialpadStrings |
Zeichenfolgen von Dialpad , die überschrieben werden können. |
| DialpadStyles |
Stile für die Dialpad-Komponente . |
| Disposable |
Funktionalität zum ordnungsgemäßen Entfernen eines Zusammengesetzten. |
| DtmfDialPadOptions |
Optionen zum Festlegen des Rendering-Verhaltens des dtmfDialers im CallComposite |
| EndCallButtonProps |
Props für EndCallButton. |
| EndCallButtonStrings |
Zeichenfolgen EndCallButton-, die überschrieben werden können. |
| ErrorBarProps |
Requisiten für ErrorBar. Zusätzlich zu den folgenden, leitet ErrorBar alle <xref:%40fluentui%2Freact%23IMessageBarProps> an die zugrunde liegende <xref:%40fluentui%2Freact%23MessageBar>weiter. |
| ErrorBarStrings |
Alle Zeichenfolgen, die auf der Benutzeroberfläche in der ErrorBar-angezeigt werden können. |
| FluentThemeProviderProps |
Props für FluentThemeProvider. |
| GridLayoutProps |
Props für GridLayout. |
| GridLayoutStyles |
GridLayout- Komponentenformatvorlagen. |
| HoldButtonProps | |
| HoldButtonStrings |
Zeichenfolgen für die Beschriftungen der Haltetaste |
| HorizontalGalleryStyles |
<xref:HorizontalGallery> Komponentenformatvorlagen. |
| ImageOverlayProps |
Requisiten für ImageOverlay. |
| ImageOverlayStrings |
Zeichenfolgen von ImageOverlay , die überschrieben werden können. |
| IncomingCallNotificationProps |
Eigenschaften für die Komponente zur Benachrichtigung über eingehende Anrufe. |
| IncomingCallNotificationStrings |
Zeichenfolgen für die Komponente zur Benachrichtigung über eingehende Anrufe. |
| IncomingCallNotificationStyles |
Stile für die Komponente zur Benachrichtigung über eingehende Anrufe. |
| IncomingCallStackCall |
Stellt einen aktiven eingehenden Anruf dar. |
| IncomingCallStackProps |
Requisiten für die IncomingCallManager-Komponente. |
| IncomingCallState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient- erkennt eingehende Anrufe automatisch und fügt ihren Zustand dem Zustand hinzu, der von StatefulCallClientverfügbar gemacht wird. |
| InlineImage |
Der Zustand von InlineImage, wie er in der Benutzeroberfläche angezeigt wird. |
| InlineImageOptions |
Optionen zum Anzeigen von Inline-Bildern im Inline-Bild-Szenario. |
| JoinCallOptions |
Optionen zum Einstellen des Mikrofon- und Kamerastatus beim Beitreten zu einem Anruf true = Gerät beim Beitritt zum Anruf einschalten false = Gerät ausschalten, wenn einem Anruf beigetreten wird 'behalten'/undefined = Status des Geräts vor dem Anruf beibehalten |
| JumpToNewMessageButtonProps |
Argumente für <xref:MessageThreadProps.onRenderJumpToNewMessageButton>. |
| LocalVideoCameraCycleButtonProps | |
| LocalVideoStreamState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>. |
| LocalVideoStreamVideoEffectsState |
Geben Sie nur die Version an, die .<xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature> |
| LocalVideoTileOptions |
Optionen für die Kachel "Lokales Video" in der Anrufkomposition. |
| MediaAccessState |
Status des Medienzugriffs |
| MediaDiagnosticsState |
Nur Proxy für <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>. |
| MeetingConferencePhoneInfoModalStrings |
Zeichenfolgen für das Telefoninfo-Modal |
| MessageCommon |
Allgemeine Eigenschaften aller Nachrichtentypen. |
| MessageStatusIndicatorProps |
Props für MessageStatusIndicator. |
| MessageStatusIndicatorStrings |
Zeichenfolgen MessageStatusIndicator-, die überschrieben werden können. |
| MessageThreadStrings |
Zeichenfolgen MessageThread-, die überschrieben werden können. |
| MessageThreadStyles |
Fluent-Formatvorlagen für MessageThread-. |
| MicrophoneButtonContextualMenuStyles |
Formatvorlagen für das menü MicrophoneButton. |
| MicrophoneButtonProps |
Props für MicrophoneButton. |
| MicrophoneButtonStrings |
Zeichenfolgen MicrophoneButton-, die überschrieben werden können. |
| MicrophoneButtonStyles |
Formatvorlagen für MicrophoneButton- |
| NetworkDiagnosticsState |
Nur Proxy für <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>. |
| NotificationOptions |
Optionen zum Steuern der Benachrichtigungen im Composite. |
| NotificationProps |
Requisiten für die Benachrichtigung. |
| NotificationStackProps |
Props für NotificationStack. |
| NotificationStackStrings |
Alle Zeichenfolgen, die auf der Benutzeroberfläche im NotificationStack angezeigt werden können. |
| NotificationStrings |
Alle Zeichenfolgen, die auf der Benutzeroberfläche in der Benachrichtigung angezeigt werden können. |
| NotificationStyles |
Stile für die Benachrichtigungskomponente. |
| OptimalVideoCountFeatureState |
Nur Version der Funktion <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>"Optimale Videoanzahl" angeben. |
| OptionsDevice |
Ein Gerät, z. B. Kamera, Mikrofon oder Lautsprecher, im DevicesButton Flyout. |
| OutboundCallCompositeLoaderProps |
Requisiten für OutboundCallComposite, die Sie in Ihrer Anwendung verwenden können. Enthält zwei Optionsbeutel:
|
| PPTLiveCallFeatureState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient lauscht automatisch auf pptLive während des Anrufs und aktualisiert den von StatefulCallClient verfügbar gemachten Zustand entsprechend. |
| ParticipantAddedSystemMessage |
Eine Systemnachricht, die benachrichtigt, dass ein Teilnehmer dem Chatthread hinzugefügt wurde. |
| ParticipantItemProps |
Requisiten für ParticipantItem. |
| ParticipantItemStrings |
Zeichenfolgen ParticipantItem-, die überschrieben werden können. |
| ParticipantItemStyles |
Fluent-Stile für ParticipantItem-. |
| ParticipantListItemStyles |
Formatvorlagen für die ParticipantListParticipantItem-. |
| ParticipantListStyles |
Formatvorlagen für die ParticipantList-. |
| ParticipantRemovedSystemMessage |
Eine Systemnachricht, die benachrichtigt, dass ein Teilnehmer aus dem Chatthread entfernt wurde. |
| ParticipantsButtonContextualMenuStyles |
Formatvorlagen für das menü ParticipantsButton. |
| ParticipantsButtonProps |
Requisiten für TeilnehmerButton. |
| ParticipantsButtonStrings |
Zeichenfolgen von ParticipantsButton-, die überschrieben werden können. |
| ParticipantsButtonStyles |
Formatvorlagen-Eigenschaften für ParticipantsButton. |
| RaiseHandButtonProps |
Requisiten für RaiseHandButton. |
| RaiseHandButtonStrings |
Zeichenfolgen von RaiseHandButton , die überschrieben werden können. |
| RaiseHandCallFeature |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient lauscht automatisch auf erhobene Hände beim Anruf und aktualisiert den von StatefulCallClient verfügbar gemachten Zustand entsprechend. |
| ReactionButtonProps |
Requisiten für ReactionButton. |
| ReactionButtonStrings |
Zeichenfolgen von ReactionButton , die überschrieben werden können. |
| ReactionResources |
Schnittstelle für Animation, Sprite-Bild und zugehörige Metadaten |
| RealTimeTextCallFeatureState | |
| RealTimeTextInfo | |
| RealTimeTextModalProps |
RealTimeTextModal-Komponentenrequisiten. |
| RealTimeTextModalStrings |
Zeichenfolgen für das realTimeText-Modal |
| RealTimeTextProps |
Requisiten für eine einzelne Zeile RealTimeText. |
| RealTimeTextStrings |
Strings für RTT |
| RecordingCallFeature |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient- überwacht automatisch den Aufzeichnungsstatus des Anrufs und aktualisiert den Zustand, der von StatefulCallClient verfügbar gemacht wird. |
| RemoteParticipantState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient- ruft remoteParticipants automatisch ab und fügt ihren Zustand dem Zustand hinzu, der von StatefulCallClientverfügbar gemacht wird. |
| RemoteVideoStreamState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>. |
| RemoteVideoTileMenuOptions |
Menüoptionen für Remote-Videokacheln in der VideoGallery. |
| ScreenShareButtonProps |
Props für ScreenShareButton. |
| ScreenShareButtonStrings |
Zeichenfolgen ScreenShareButton-, die überschrieben werden können. |
| SendBoxProps |
Props für SendBox. |
| SendBoxStrings |
Zeichenfolgen von SendBox-, die überschrieben werden können. |
| SendBoxStylesProps |
Fluent-Formatvorlagen für <xref:Sendbox>. |
| SpokenLanguageStrings |
Zeichenfolgen in gesprochener Sprache für Untertitel, die modal festlegen |
| SpotlightCallFeatureState |
Nur staatliche Version von <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature> |
| SpotlightPromptStrings |
Zeichenfolgen, die in der Eingabeaufforderung im Zusammenhang mit Spotlight verwendet werden |
| SpotlightState |
Spotlight-Zustand mit Ordnung |
| StartCaptionsAdapterOptions |
Optionen, die an adapter.startCaptions übergeben werden |
| StartCaptionsButtonProps | |
| StartCaptionsButtonStrings |
Zeichenfolgen für die Beschriftungen der Haltetaste |
| StartRealTimeTextButtonProps |
Requisiten für die StartRealTimeTextButton-Komponente |
| StartRealTimeTextButtonStrings |
Zeichenfolgen für die Beschriftungen der Haltetaste |
| StatefulCallClient |
Definiert die Methoden, mit denen CallClient-<xref:%40azure%2Fcommunication-calling%23CallClient> zustandsmäßig verwendet werden können. Die Schnittstelle bietet Zugriff auf den proxiierten Zustand und ermöglicht auch das Registrieren eines Handlers für Zustandsänderungsereignisse. Eine Statusdefinition finden Sie unter CallClientState. Zustandsänderungsereignisse werden von:
|
| StatefulChatClient |
Definiert die Methoden, mit denen {@Link @azure/communication-chat#ChatClient} mit einem zentralisierten generierten Zustand verwendet werden kann. Die Schnittstelle bietet Zugriff auf den proxiierten Zustand und ermöglicht auch das Registrieren eines Handlers für Zustandsänderungsereignisse. |
| StatefulDeviceManager |
Definiert die zusätzlichen Methoden, die vom Zustand oben auf <xref:%40azure%2Fcommunication-calling%23DeviceManager>hinzugefügt werden. |
| StopCaptionsAdapterOptions |
Optionen, die an adapter.stopCaptions übergeben werden |
| StreamMediaProps |
Props für StreamMedia. |
| SurveyIssues |
Entsprechende Texte zu jeder Anrufausgabe |
| SurveyIssuesHeadingStrings |
Entsprechende Texte zu jedem Aufrufausgabetyp |
| SystemMessageCommon |
Allgemeine Eigenschaften aller Systemmeldungen. |
| TeamsCallAdapter |
Eine Adapterschnittstelle, die speziell für die Teams-Identität ist und CommonCallAdapter erweitert. |
| TeamsCallingHandlers |
Objekt, das alle Team-Anrufhandler enthält, die zum Aufrufen von Komponenten erforderlich sind. Das Aufrufen verwandter Komponenten aus diesem Paket kann relevante Handler aus diesem Objekt auswählen. Siehe <xref:useHandlers> und usePropsFor. |
| TeamsIncomingCallState |
Nur staatliche Version von <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> |
| TogetherModeCallFeatureState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Stellt den Status der Funktion "Together-Modus" dar. |
| TogetherModeSeatingPositionState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>. Stellt die Sitzposition eines Teilnehmers im Together-Modus dar. |
| TogetherModeStreamOptions |
Schnittstelle, die das Ergebnis einer Stream-Ansicht im Together-Modus darstellt. |
| TogetherModeStreamViewResult |
Schnittstelle, die das Ergebnis einer Stream-Ansicht im Together-Modus darstellt. |
| TogetherModeStreamsState |
Stellt die Streams im Together-Modus dar. |
| TopicUpdatedSystemMessage |
Eine Systemnachricht, die benachrichtigt, dass das Chatthreadthema aktualisiert wurde. |
| TranscriptionCallFeature |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient- überwacht automatisch den Transkriptionsstatus des Anrufs und aktualisiert den Zustand, der von StatefulCallClient verfügbar gemacht wird. |
| TransferFeature |
Übertragen des KE-Zustands |
| TypingIndicatorProps |
Props für TypingIndicator. |
| TypingIndicatorStrings |
Zeichenfolgen TypingIndicator, die überschrieben werden können. |
| TypingIndicatorStylesProps |
Fluent-Formatvorlagen für TypingIndicator. |
| VerticalGalleryControlBarStyles |
Formatvorlagen für die Steuerleiste in der VerticalGallery-Komponente |
| VerticalGalleryStrings |
Zeichenketten für die Lokalisierung der vertikalen Galerie. |
| VerticalGalleryStyles |
Stile für die VerticalGallery-Komponente |
| VideoBackgroundBlurEffect |
Enthält die Attribute des Hintergrundeffekts "Videounschärfe" |
| VideoBackgroundImage |
Enthält die Eigenschaften eines Hintergrundbildes wie URL, Name usw. |
| VideoBackgroundNoEffect |
Enthält die Attribute zum Entfernen des Videohintergrundeffekts |
| VideoBackgroundReplacementEffect |
Enthält die Attribute eines ausgewählten Ersatz-Videohintergrundeffekts |
| VideoGalleryLocalParticipant |
Der Zustand des lokalen Teilnehmers in der VideoGallery. |
| VideoGalleryProps |
Props 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 Komponentenformatvorlagen. |
| VideoGalleryTogetherModeSeatingInfo |
Schnittstelle, die die Sitzinformationen im Together-Modus darstellt. |
| VideoGalleryTogetherModeStreams |
Schnittstelle, die die Streams im Together-Modus darstellt. |
| VideoStreamOptions |
Optionen zum Steuern, wie Videostreams gerendert werden. |
| VideoStreamRendererViewState |
Nur Zustandsversion von <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Diese Eigenschaft wird dem Zustand hinzugefügt, der von StatefulCallClient durch createView- verfügbar gemacht und von disposeViewentfernt wird. |
| VideoTileContextualMenuProps |
Eigenschaften für die Anzeige des Kontextmenüs für entfernte VideoTile-Komponenten in der VideoGallery. |
| VideoTileDrawerMenuProps |
Eigenschaften für die Anzeige des Schubladenmenüs auf der Fernbedienung VideoTile lange Berührung in der VideoGallery. |
| VideoTileProps |
Props für VideoTile. |
| VideoTileStrings |
Zeichenfolgen von VideoTile , die überschrieben werden können. |
| VideoTileStylesProps |
Fluent-Formatvorlagen für VideoTile. |
| VideoTilesOptions |
Optionen, die für alle Videokacheln in der Videogalerie gelten |
Typaliase
| AdapterErrors |
Adapter speichert den neuesten Fehler für jeden Vorgang im Zustand.
|
| AdapterNotifications |
Adapter speichert die neueste Benachrichtigung für jedes Ziel. |
| AreEqual |
Vergleichen, wenn 2 React-Komponenten exakt gleich sind, Ergebnistyp wahr/falsch |
| AreParamEqual |
Vergleichen, wenn Eigenschaften von 2 React-Komponenten gleich sind, Ergebnistyp "true/false" ist |
| AreTypeEqual |
Vergleichen, wenn zwei Typen gleich sind, Ergebnistyp wahr/falsch |
| AvatarPersonaData |
Benutzerdefinierte Datenattribute zum Anzeigen des 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: |
| AzureCommunicationCallAdapterOptions |
Optionale Parameter zum Erstellen useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) |
| AzureCommunicationCallWithChatAdapterArgs |
Argumente für createAzureCommunicationCallWithChatAdapter |
| AzureCommunicationCallWithChatAdapterFromClientArgs |
Argumente für <xref:createAzureCommunicationCallWithChatAdapterFromClient> |
| AzureCommunicationChatAdapterArgs |
Argumente zum Erstellen der Azure Communication Services-Implementierung von ChatAdapter. |
| AzureCommunicationOutboundCallAdapterArgs |
Argumente zum Erstellen der Azure Communication Services-Implementierung von CallAdapter-. Diese Argumente werden verwendet, um Szenarien für ausgehende Anrufe zu erstellen. Hinweis: |
| CallAdapterCallEndedEvent |
Nutzlast für CallEndedListener mit Details zum beendeten Anruf. |
| CallAdapterClientState |
CommonCallAdapter Zustand, der aus dem Back-End von Azure Communication Services abgeleitet wurde. |
| CallAdapterLocator |
Locator, der von createAzureCommunicationCallAdapter verwendet wird, um den Aufruf zur Teilnahme zu finden |
| CallAdapterState | |
| CallAdapterUiState |
CommonCallAdapter Zustand für reine UI-Zwecke. |
| CallCompositeIcons |
Symbole, die für CallComposite-überschrieben werden können. |
| CallCompositeOptions |
Optionale Features der CallComposite-. |
| CallCompositePage |
Hauptbildschirme der Benutzeroberfläche, die in der 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 |
Auswahltyp für ErrorBar Komponente. |
| CallErrorTarget |
Zeichenfolgenliteraltyp für alle zulässigen Schlüssel in {@Link CallErrors}. |
| CallErrors |
Fehler, die von API-Aufrufen an das Aufrufen des SDK stammen. Jede Eigenschaft im Objekt speichert den neuesten Fehler für eine bestimmte SDK-API-Methode. Fehler aus diesem Objekt können mithilfe des <xref:newClearCallErrorsModifier>gelöscht werden. Darüber hinaus werden Fehler automatisch gelöscht, wenn:
|
| CallFeatureStreamName |
Stellt den Namen des Aufruf-Feature-Streams dar |
| CallIdChangedListener |
Rückruf für CallAdapterSubscribers 'callIdChanged'-Ereignis. |
| CallNotifications | |
| CallParticipantListParticipant |
Der Status des Anrufteilnehmers, wie in den UI-Komponenten widerspiegelt. |
| CallWithChatCompositeIcons |
Symbole, die für CallWithChatCompositeüberschrieben werden können. |
| CallWithChatCompositeOptions |
Optionale Features des CallWithChatComposite-. |
| CallWithChatEvent |
Ereignisse, die vom CallWithChatAdapter-ausgelöst wurden. |
| CallingBaseSelectorProps |
Allgemeine Props, die zum Verweisen auf den aufrufenden deklarativen Clientstatus verwendet werden. |
| CallingHandlersOptions |
Konfigurationsoptionen zum Einbeziehen der Hintergrundabhängigkeit von Videoeffekten. |
| CallingReturnProps |
Hilfstyp für usePropsFor. |
| CallingSounds |
Typ zur Darstellung einer Reihe von Sounds, die für verschiedene Aufrufereignisse verwendet werden sollen |
| CameraButtonSelector |
Auswahltyp für CameraButton Komponente. |
| CancelEditCallback |
Die Callback-Funktion wird ausgeführt, wenn eine Nachrichtenbearbeitung abgebrochen wird. |
| CapabilitiesChangedListener |
Rückruf für das 'capabilitiesChanged'-Ereignis von CallAdapterSubscribers . |
| CaptionSettingsSelector |
Selektortyp für Komponenten zum Ändern der Untertitelsprache und der gesprochenen Sprache |
| CaptionsBannerSelector |
Selektortyp für die CaptionsBanner-Komponente . |
| CaptionsInformation |
Erforderliche Informationen für jede Zeile der Beschriftung |
| CaptionsOptions |
Optionstasche zum Starten von Untertiteln |
| CaptionsReceivedListener |
Callback für das 'captionsReceived'-Ereignis von CallAdapterSubscribers . |
| ChatAdapter |
ChatComposite Adapterschnittstelle. |
| ChatAdapterOptions |
Optionen für die Konfiguration des ChatAdapters. |
| ChatAdapterState |
ChatAdapter Zustand. |
| ChatAdapterUiState |
ChatAdapter Zustand für reine UI-Zwecke. |
| ChatAttachmentType |
Stellt den Typ des Anhangs dar |
| ChatBaseSelectorProps |
Allgemeine Eigenschaften für Selektoren für ChatClientState. |
| ChatClientProviderProps |
Argumente zum Initialisieren eines ChatClientProvider-. |
| ChatClientState |
Zentraler Zustand für <xref:%40azure%2Fcommunication-chat%23ChatClient>. |
| ChatCompositeClientState |
ChatAdapter Zustand, der vom Back-End von Azure Communication Services abgeleitet wurde. |
| ChatCompositeIcons |
Symbole, die für ChatComposite-überschrieben werden können. |
| ChatCompositeOptions |
Optionale Features der ChatComposite-. |
| ChatErrorBarSelector |
Auswahltyp für ErrorBar Komponente. |
| ChatErrorTarget |
Zeichenfolgenliteraltyp für alle zulässigen Schlüssel in ChatErrors. |
| ChatErrors |
Fehler, die von API-Aufrufen an das Chat SDK stammen. Jede Eigenschaft im Objekt speichert den neuesten Fehler für eine bestimmte SDK-API-Methode. |
| ChatHandlers |
Objekt mit allen Handlern, die für Chatkomponenten erforderlich sind. Chat-bezogene Komponenten aus diesem Paket können relevante Handler aus diesem Objekt auswählen. Siehe <xref:useHandlers> und usePropsFor. |
| ChatInitializedListener |
Rückruf für <xref:CallWithChatAdapterSubscribers> das Ereignis 'chatInitialized'. |
| ChatMessageWithStatus |
Eine Erweiterung für <xref:%40azure%2Fcommunication-chat%23ChatMessage>, die nur clientseitige Metadaten für Chatnachrichten speichert. TODO: Der Name hat bitrottet. Benennen Sie mich um. |
| ChatParticipantListSelector |
Auswahltyp für ParticipantList Komponente. |
| ChatProfile |
Das Profil eines Benutzers oder Bots. |
| ChatReturnProps |
Hilfstyp für usePropsFor. |
| ChatThreadClientProviderProps |
Argumente zum Initialisieren eines ChatThreadClientProvider-. |
| ChatThreadClientState |
Zentraler Zustand für <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. |
| ChatThreadProperties |
Eigenschaften eines Chatthreads. Wir definieren ein Minimum, mit dem wir die verschiedenen Typen ausblenden können, die von der zugrunde liegenden API verwendet werden. |
| ClientState |
Zentraler Zustand für <xref:%40azure%2Fcommunication-calling%23CallClient> oder <xref:%40azure%2Fcommunication-chat%23ChatClient>. Siehe auch: CallClientState, ChatClientState. |
| Common |
Zurückgeben des Überschneidens von 2 Typen |
| CommonCallAdapterOptions |
Allgemeine optionale Parameter zum Erstellen useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) oder TeamsCallAdapter |
| CommonCallControlOptions |
Anpassungsoptionen für die Steuerungsleiste in der Anrufumgebung. |
| CommonProperties |
Zurückgeben von Überschneiden von Eigenschaften von 2 Typen |
| CommunicationParticipant |
Der Status eines Chat- oder Anrufteilnehmers, wie in der Benutzeroberfläche widerspiegelt. |
| ComponentIcons |
Symbole, die von den React-Komponenten verwendet werden, die aus dieser Bibliothek exportiert wurden. |
| ComponentProps |
Hilfstyp für usePropsFor. |
| ComponentSlotStyle |
ComponentSlotStyle ist ein @fluentui/react-northstar Typ. Da wir uns von diesem Paket entfernt haben, haben wir aus Gründen der Interoperabilität den generischeren IRawStyle-Typ von Fluent verwendet. |
| CompositeIcons |
Symbole, die in einem der von dieser Bibliothek exportierten Composites überschrieben werden können. Weitere gezieltere Typen finden Sie unter ChatCompositeIcons, CallCompositeIcons und CallWithChatCompositeIcons. |
| ControlBarButtonStyles |
Formatvorlagen für alle ControlBarButton- Implementierungen. |
| ControlBarLayout |
Präsentieren Sie Layouts für die ControlBar-. |
| CreateDefaultCallingHandlers |
Typ von createDefaultCallingHandlers. |
| CreateViewResult |
Ergebnis aus createView-zurückgeben. |
| CustomAvatarOptions |
Optionen, die in die |
| CustomCallControlButtonCallback |
Ein Callback, der die Eigenschaften zum Rendern eines benutzerdefinierten ControlBarButton und <xref:DrawerMenuItem>zurückgibt. Die Antwort gibt an, wo die benutzerdefinierte Schaltfläche platziert werden soll. Leistungstipp: Dieser Callback wird nur aufgerufen, wenn sich entweder der Callback oder seine Argumente ändern. |
| CustomCallControlButtonPlacement |
Platzierung für eine benutzerdefinierte Schaltfläche, die in die <xref:CommonCallControlBar>. 'primary': Platzieren Sie die Schaltfläche(n) am rechten Ende der mittleren Steuerleiste, aber vor dem EndCallButton (linkes Ende im RTL-Modus). 'overflow': Platzieren Sie die Schaltfläche(n) am Ende des Overflow-Menüs. 'secondary': Platzieren Sie die Schaltfläche(n) am linken Ende der seitlichen Steuerleiste (rechts im RTL-Modus). Mehrere Schaltflächen, denen die gleiche Position zugewiesen ist, werden der Reihe nach angehängt. Wenn z.B. zwei Schaltflächen in 'sekundär' platziert sind, erscheinen sie beide am linken Ende (rechtes Ende im rtl-Modus) in der angegebenen Reihenfolge. Nur die "primäre" Platzierung funktioniert, wenn die Legacy-Anrufsteuerung im Anrufverbund aktiviert ist |
| DeclarativeCallAgent |
|
| DeclarativeTeamsCallAgent |
|
| DeepNoiseSuppressionEffectDependency |
Abhängigkeitstyp, der für eine tiefgreifende Rauschunterdrückung injiziert werden soll |
| DeviceManagerState |
Dieser Typ soll den gesamten Zustand innerhalb <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>'s getCameras, getMicrophones, getSpeakers und askDevicePermission-APIs aufgerufen und abgeschlossen werden. |
| DevicesButtonSelector |
Auswahltyp für DevicesButton Komponente. |
| DiagnosticChangedEventListner |
Rückruf für CallAdapterSubscribers "diagnosticChanged"-Ereignis. |
| DialpadMode |
Modi der Wähltastatur-Komponente. |
| DisplayNameChangedListener |
Rückruf für CallAdapterSubscribers "displayNameChanged"-Ereignis. |
| DtmfTone |
DTMF-Ton für PSTN-Anrufe. |
| EmptySelector |
Ein Typ für triviale Selektoren, die keine Daten zurückgeben. Wird als Standardrücklaufwert verwendet, wenn usePropsFor für eine Komponente aufgerufen wird, für die keine Daten erforderlich sind. |
| ErrorType |
Alle Fehler, die in der ErrorBar-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. |
| HoldButtonSelector |
Selektortyp für die HoldButton-Komponente . |
| IncomingCallManagement |
Dieses enthält ein schreibgeschütztes Array, das alle aktiven |
| IncomingCallStackSelector |
Selektor, um die aktiven und entfernten eingehenden Anrufe abzurufen. |
| IsCaptionLanguageChangedListener |
Callback für CallAdapterSubscribers 'isCaptionLanguageChanged'-Ereignis. |
| IsCaptionsActiveChangedListener |
Callback für das CallAdapterSubscribers-Ereignis 'isCaptionsActiveChanged'. |
| IsLocalScreenSharingActiveChangedListener |
Rückruf für CallAdapterSubscribers "isLocalScreenSharingActiveChanged"-Ereignis. |
| IsMutedChangedListener |
Rückruf für CallAdapterSubscribers "isMuted"-Ereignis. |
| IsSpeakingChangedListener |
Rückruf für CallAdapterSubscribers "isSpeakingChanged"-Ereignis. |
| IsSpokenLanguageChangedListener |
Callback für das CallAdapterSubscribers-Ereignis 'isSpokenLanguageChanged'. |
| LoadingState |
Gibt an, ob der Datenstrom geladen wird oder nicht. |
| LocalScreenShareView | |
| LocalVideoTileSize |
Verschiedene Modi der lokalen Videokachel |
| LocalizationProviderProps |
Requisiten für LocalizationProvider. |
| LongPressTrigger |
Modi, wie die Longpress-Handler tiggert werden können. |
| MediaAccess |
Zugriffsstatus auf Audio-/Videomedien |
| MediaDiagnosticChangedEvent |
Nutzlast für DiagnosticChangedEventListner, bei dem sich eine Änderung in einer Mediendiagnose befindet. |
| Message |
Diskriminierte Vereinigung aller Nachrichten. Das |
| MessageAttachedStatus |
Geben Sie an, ob eine Chatnachricht vor/nach der Nachricht mit der Nachricht zusammengeführt werden soll.
Wenn |
| MessageContentType |
Unterstützte Arten von Chatnachrichteninhalten. |
| MessageDeletedListener |
Rückruf für das 'messageDeleted'-Ereignis von ChatAdapterSubscribers . |
| MessageEditedListener |
Rückruf für das 'messageEdited'-Ereignis von ChatAdapterSubscribers . |
| 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 Zustand einer gesendeten Nachricht. Umfasst Übergangszustände, die auftreten, bevor die Nachrichtenübermittlung vom Back-End bestätigt wird. |
| MessageThreadProps |
Requisiten für MessageThread. |
| MessageThreadSelector |
Auswahltyp für MessageThread Komponente. |
| MicrophoneButtonSelector |
Auswahltyp für MicrophoneButton Komponente. |
| NetworkDiagnosticChangedEvent |
Nutzlast für DiagnosticChangedEventListner, bei denen sich eine Änderung in einer Netzwerkdiagnose befindet. |
| NotificationStackSelector | |
| NotificationTarget | |
| NotificationType |
Alle Benachrichtigungen, die im NotificationStack angezeigt werden können. |
| OnFetchChatProfileCallback |
Callback-Funktion, die zum Bereitstellen benutzerdefinierter Daten zum Erstellen eines Profils für einen Benutzer oder Bot verwendet wird. |
| OnFetchProfileCallback |
Callback-Funktion, die zum Bereitstellen benutzerdefinierter Daten zum Erstellen eines Profils für einen Benutzer oder Bot verwendet wird. |
| OnRenderAvatarCallback |
Ein benutzerdefinierter gerenderter Rückruf, mit dem Benutzer das Rendern einer Persona-Komponente anpassen können. |
| OverflowGalleryPosition |
Verschiedene Modi und Positionen der Überlaufgalerie in der VideoGallery |
| ParticipantListParticipant |
Teilnehmer, die in einer ParticipantList-angezeigt werden. |
| ParticipantListProps |
Requisiten für ParticipantList. |
| ParticipantListSelector |
Auswahltyp für 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 |
Auswahltyp für ParticipantsButton Komponente. |
| ParticipantsJoinedListener |
Rückruf für CallAdapterSubscribers "participantsJoined"-Ereignis. |
| ParticipantsLeftListener |
Rückruf für CallAdapterSubscribers "participantsLeft"-Ereignis. |
| ParticipantsRemovedListener |
Rückruf für ChatAdapterSubscribers "participantsRemoved"-Ereignis. |
| Profile |
Das Profil eines Benutzers oder Bots. |
| RaiseHandButtonSelector |
Selektortyp für die RaiseHandButton-Komponente . |
| RaisedHand |
Erhobene Hand mit Ordnung |
| RaisedHandState |
Erhobene Hand mit Ordnung |
| Reaction |
Reaktionszustand mit dem zu rendernden Reaktionstyp |
| ReactionButtonReaction |
Reaktionstypen für die Schaltfläche Reaktion |
| ReactionSprite |
Typ für Animation, Sprite-Bild und zugehörige Metadaten |
| ReactionState |
Geben Sie nur die Version von <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> mit UI-Hilfsrequisiten receivedOn an. Reaktionsstatus mit einem Zeitstempel, der der Benutzeroberfläche hilft, zu entscheiden, ob die Reaktion entsprechend gerendert werden soll. |
| ReadReceiptsBySenderId |
Ein Array von Schlüsselwertpaaren, in denen der Anzeigename und die Nachricht mit dem letzten Lesen jedes Absenders gespeichert werden. |
| RealTimeTextInformation |
Informationen, die für jede Zeile Echtzeittext erforderlich sind |
| RealTimeTextReceivedListener |
Callback für CallAdapterSubscribers 'realTimeTextReceived'-Ereignis. |
| ResourceDetails |
Details, die zum Herunterladen einer Ressource zum Zwischenspeichern erforderlich sind. |
| ResourceFetchResult |
Ergebnis der Ressource, die von einem zustandsbehafteten Client heruntergeladen wurde |
| ScreenShareButtonSelector |
Auswahltyp für ScreenShareButton Komponente. |
| Selector |
Eine optimierte Auswahl, die ClientState Updates für React-Komponenten in dieser Bibliothek optimiert. |
| SendBoxSelector |
Auswahltyp für SendBox- Komponente. |
| SoundEffect |
Typ zum Darstellen eines benutzerdefinierten Sounds, der für ein aufrufendes Ereignis verwendet werden soll |
| Spotlight |
Spotlight-Zustand mit Ordnung |
| SpotlightChangedListener |
Callback für das 'spotlightChanged'-Ereignis von CallAdapterSubscribers . |
| StartCallIdentifier |
Bezeichnertypen zum Initiieren eines Anrufs mit dem CallAdapter |
| StartCaptionsButtonSelector |
Selektortyp für die StartCaptionsButton-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-. |
| SupportedCaptionLanguage | |
| SupportedSpokenLanguage | |
| SystemMessage |
Diskriminierte Vereinigung aller Systemnachrichten. Das |
| TeamsAdapterOptions |
Optionale Parameter zum Erstellen von TeamsCallAdapter |
| TeamsCallAdapterArgs |
Argumente für die Erstellung der Azure Communication Services-Implementierung von TeamsCallAdapter. |
| TeamsCallAdapterArgsCommon |
Gemeinsamer Teil von args zum Erstellen der Azure Communication Services-Implementierung von TeamsCallAdapter. |
| TeamsIncomingCallManagement |
Proxys für die <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> Schnittstelle. |
| TogetherModeParticipantSeatingState |
Stellt die Sitzpositionen der Teilnehmer im Together-Modus dar. |
| TopicChangedListener |
Rückruf für ChatAdapterSubscribers "topicChanged"-Ereignis. |
| TransferAcceptedListener |
Callback für das 'transferRequested'-Ereignis von CallAdapterSubscribers . |
| TypingIndicatorSelector |
Auswahltyp für TypingIndicator Komponente. |
| UpdateMessageCallback |
Die Rückruffunktion wird ausgeführt, wenn eine Nachricht aktualisiert wird. |
| VideoBackgroundEffect |
Enthält die Attribute eines ausgewählten Video-Hintergrundeffekts |
| VideoBackgroundEffectsDependency |
Abhängigkeitstyp, der für Videohintergrundeffekte eingefügt werden soll |
| VideoGalleryLayout | |
| VideoGalleryParticipant |
Der Zustand eines Teilnehmers an der VideoGallery. |
| VideoGallerySelector |
Auswahltyp für VideoGallery Komponente. |
| VideoGalleryTogetherModeParticipantPosition |
Schnittstelle, die die Position eines Teilnehmers im Together-Modus darstellt. |
| ViewScalingMode |
Skalierungsmodus eines VideoGalleryStream-. |
Functions
| Call |
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-calling%23CallAgent>speichert. Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallAgentProvider-eingeschlossen werden. |
| Call |
Eine <xref:React.Context>, die einen StatefulCallClient-speichert. Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallClientProvider-eingeschlossen werden. |
| Call |
Eine anpassbare Benutzeroberfläche, die für die Anruferfahrung zusammengesetzt ist. |
| Call |
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-calling%23Call>speichert. Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallProvider-eingeschlossen werden. |
| Call |
CallWithChatComposite vereint wichtige Komponenten, um einen vollständigen Anruf mit Chaterfahrung sofort bereitzustellen. |
| Camera |
Eine Taste zum Aktivieren/Deaktivieren der Kamera. Kann mit ControlBar-verwendet werden. |
| Captions |
Eine Komponente zum Anzeigen eines CaptionsBanner mit Benutzersymbol, displayName und captions-Text. |
| Captions |
Eine Komponente zum Festlegen gesprochener Sprachen |
| Chat |
Eine <xref:React.Context>, die einen StatefulChatClient-speichert. Chatkomponenten aus diesem Paket müssen mit einem ChatClientProvider-eingeschlossen werden. |
| Chat |
Eine anpassbare Benutzeroberfläche, die für die Chaterfahrung zusammengesetzt ist. |
| Chat |
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>speichert. Chatkomponenten aus diesem Paket müssen mit einem ChatThreadClientProvider-eingeschlossen werden. |
| Control |
Ein Container für verschiedene Schaltflächen für Anrufsteuerelemente. Verwenden Sie in dieser Bibliothek verschiedene Anrufsteuerungsschaltflächen, z. B. CameraButton-oder ihre eigenen Instanzen von ControlBarButton direkt. |
| Control |
Standardschaltfläche, die für die ControlBar-formatiert ist. Verwenden Sie diese Komponente, um benutzerdefinierte Schaltflächen zu erstellen, die den gleichen Stil aufweisen wie andere Schaltflächen, die von der Ui-Bibliothek bereitgestellt werden. |
| Devices |
Eine Schaltfläche zum Öffnen eines Menüs, das Geräteoptionen steuert. Kann mit ControlBar-verwendet werden. |
| Dialpad(Dialpad |
Eine Komponente, die es Benutzern ermöglicht, die Telefonnummer durch Klicken auf die Wähltastatur/Verwendung der Tastatur einzugeben Es wird eine leere Komponente für stabile Builds zurückgeben |
| End |
Eine Schaltfläche zum Beenden eines laufenden Anrufs. Kann mit ControlBar-verwendet werden. |
| Error |
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 durch activeErrorMessagesausgewählt. Diese Komponente verfolgt intern geschlossen vom Benutzer geschlossen.
Verwendet <xref:%40fluentui%2Freact%23MessageBar> UI-Element. |
| Fluent |
Anbieter, um ein Fluent-Design auf die React-Komponenten dieser Bibliothek anzuwenden. |
| Grid |
Eine Komponente zum Anordnen von Audio-/Videoteilnehmer-Kacheln in einem Anruf. |
| Hold |
Eine Taste zum Halten oder Fortsetzen eines laufenden Anrufs. Kann mit ControlBar verwendet werden |
| Image |
Komponente, um ein Vollbildmodal für ein ausgewähltes Bild zu rendern. |
| Incoming |
Eine Notification-Komponente, die verwendet werden soll, um eingehende Anrufe an den Endbenutzer darzustellen. Ermöglicht es dem Benutzer, den eingehenden Anruf anzunehmen oder abzulehnen. |
| Incoming |
Wrapper zur Verwaltung mehrerer eingehender Anrufe |
| Localization |
Anbieter, der lokalisierte Zeichenfolgen für die React-Komponenten dieser Bibliothek bereitstellt. |
| Message |
Komponente zum Anzeigen des Status einer gesendeten Nachricht. Fügt ein Symbol und eine QuickInfo hinzu, die dem Status der Nachricht entspricht. |
| Message |
mit |
| Microphone |
Eine Schaltfläche zum Aktivieren/Deaktivieren des Mikrofons. Kann mit ControlBar-verwendet werden. |
| Notification(Notification |
Eine Komponente zum Anzeigen von Benachrichtigungen auf der Benutzeroberfläche. |
| Notification |
Eine Komponente zum Anzeigen von Benachrichtigungen auf der Benutzeroberfläche. Alle Zeichenfolgen, die angezeigt werden können, werden als Zeichenfolgen akzeptiert, damit sie lokalisiert werden können. Aktive Benachrichtigungen werden durch activeNotifications ausgewählt. Diese Komponente verfolgt intern geschlossen vom Benutzer geschlossen.
|
| Participant |
Komponente zum Rendern eines Anruf- oder Chatteilnehmers. Zeigt den Avatar, den DisplayName und den Status des Teilnehmers sowie optionale Symbole und das Kontextmenü an. |
| Participant |
Komponente zum Rendern aller Anruf- oder Chatteilnehmer. Standardmäßig wird jeder Teilnehmer mit ParticipantItem-gerendert. Siehe <xref:ParticipantListProps.onRenderParticipant> zum Außerkraftsetzen. |
| Participants |
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 ihre Eigenschaft |
| Raise |
Eine Schaltfläche zum Starten/Beenden der Bildschirmfreigabe. Kann mit ControlBar-verwendet werden. |
| Reaction |
Eine Schaltfläche zum Senden von Reaktionen. Kann mit ControlBar-verwendet werden. |
| Real |
Eine Komponente zum Anzeigen einer einzelnen Zeile von RealTimeText |
| Real |
eine Komponente für das realTimeText-Modal |
| Screen |
Eine Schaltfläche zum Starten/Beenden der Bildschirmfreigabe. Kann mit ControlBar-verwendet werden. |
| Send |
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 Meldung unterhalb des Texteingabefelds. |
| Start |
Eine Schaltfläche zum Starten oder Stoppen von Untertiteln Kann mit ControlBar verwendet werden |
| Start |
eine Schaltfläche zum Starten von RealTimeText basierend auf den Anforderungen an die Barrierefreiheit, Echtzeittext kann nicht deaktiviert werden, sobald er aktiviert ist Kann mit ControlBar verwendet werden |
| Stream |
Hilfskomponente zum Konvertieren eines HTMLElements mit einem Videostream in ein JSX-Element. Wird verwendet, um ein HTMLElement, das von headless aufrufenden API zurückgegeben wird, in eine Komponente zu konvertieren, die als VideoTile-gerendert werden kann. |
| Typing |
Komponente zum Benachrichtigen des lokalen Benutzers, wenn ein oder mehrere Teilnehmer im Chatthread eingaben. |
| Video |
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. |
| Video |
Eine Komponente zum Rendern des Videostreams für einen einzelnen Anrufteilnehmer. Wird mit GridLayout- in einer VideoGallery-verwendet. |
| create |
Erstellen Sie eine CallAdapter- von Azure Communication Services unterstützt. Dies ist die Standardimplementierung von CallAdapter-, die von dieser Bibliothek bereitgestellt wird. Hinweis: |
| create |
Erstellen Sie eine CallAdapter- von Azure Communication Services unterstützt. Dies ist die Standardimplementierung von CallAdapter-, die von dieser Bibliothek bereitgestellt wird. Hinweis: |
| create |
Erstellen Sie eine CallAdapter- mithilfe der bereitgestellten StatefulCallClient-. Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API. |
| create |
Erstellen Sie eine CallAdapter- mithilfe der bereitgestellten StatefulCallClient-. Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API. |
| create |
Erstellen Sie einen callWithChatAdapter, der von Azure Communication-Diensten unterstützt wird, um das CallWithChatComposite-. |
| create |
Erstellen Sie eine CallWithChatAdapter- mithilfe der bereitgestellten StatefulChatClient- und StatefulCallClient-. Nützlich, wenn Sie einen Verweis auf StatefulChatClient- und StatefulCallClient-beibehalten möchten. Bitte beachten Sie, dass chatThreadClient von StatefulChatClient über die chatClient.getChatThreadClient(chatThreadId) API erstellt werden muss. Erwägen Sie die Verwendung createAzureCommunicationCallWithChatAdapter- für eine einfachere API. |
| create |
Erstellen Sie eine ChatAdapter- von Azure Communication Services unterstützt. Dies ist die Standardimplementierung von ChatAdapter-, die von dieser Bibliothek bereitgestellt wird. |
| create |
Erstellen Sie eine ChatAdapter- mithilfe der bereitgestellten StatefulChatClient-. Nützlich, wenn Sie einen Verweis auf StatefulChatClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationChatAdapter- für eine einfachere API. |
| create |
Erstellen Sie die Standardimplementierung von CallingHandlers für Den Teams-Anruf. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| create |
Erstellen Sie die Standardimplementierung von ChatHandlers. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. Das zurückgegebene Objekt wird memoisiert, um rerendert zu vermeiden, wenn es als Props für React-Komponenten verwendet wird. |
| create |
Erstellen Sie die Standardimplementierung von TeamsCallingHandlers für Teams-Aufrufe . Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| create |
Erstellt einen StatefulCallClient-StatefulCallClient- durch proxying CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> mit ProxyCallClient-<xref:ProxyCallClient>, die dann den Zugriff auf den Status auf deklarative Weise zulässt. Es ist wichtig, die <xref:%40azure%2Fcommunication-calling%23DeviceManager> und <xref:%40azure%2Fcommunication-calling%23CallAgent> und <xref:%40azure%2Fcommunication-calling%23Call> (und usw.) zu verwenden, die vom StatefulCallClient abgerufen werden, damit ihre Zustandsänderungen ordnungsgemäß erfolgen. |
| create |
Erstellt einen zustandsbehafteten ChatClient StatefulChatClient- durch Proxys von ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> mit ProxyChatClient <xref:ProxyChatClient>, der dann den Zugriff auf den Status auf deklarative Weise ermöglicht. |
| create |
|
| create |
Erstellen Sie einen TeamsCallAdapter mit dem bereitgestellten StatefulCallClient. Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API. |
| from |
Umgekehrter Vorgang von toFlatCommunicationIdentifier. |
| get |
Rufen Sie die Selektor für eine angegebene Komponente ab. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| get |
Rufen Sie die Selektor für eine angegebene Komponente ab. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| load |
Loader-Funktion für CallComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den CallComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist. |
| load |
Requisiten für CallWithChatComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt das CallWithChatComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist. |
| load |
Loader-Funktion für den ChatComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den ChatComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist. |
| load |
Loader-Funktion für OutboundCallComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den CallComposite in das bereitgestellte HTML-Element, um ausgehende Aufrufe zu tätigen. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist. |
| on |
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading. |
| on |
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading. |
| on |
Auflösung von Abhängigkeiten für Videohintergrundeffekte. |
| on |
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading. |
| to |
Eine Zeichenfolgendarstellung einer <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Diese Zeichenfolgendarstellung von CommunicationIdentifier ist garantiert stabil für einen eindeutigen Kommunikationsbenutzer. So
|
| use |
Ein benutzerdefinierter React-Hook, um die Erstellung von CallAdapter-zu vereinfachen. Ähnlich wie createAzureCommunicationCallAdapter, kümmert sich jedoch um die interne asynchrone Erstellung des Adapters. Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook. |
| use |
Ein benutzerdefinierter React-Hook, um die Erstellung von CallWithChatAdapterzu vereinfachen. Ähnlich wie createAzureCommunicationCallWithChatAdapter, kümmert sich jedoch um die asynchrone Erstellung des Adapters intern. Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook. |
| use |
Ein benutzerdefinierter React-Hook, um die Erstellung von ChatAdapter-zu vereinfachen. Ähnlich wie createAzureCommunicationChatAdapter, kümmert sich jedoch um die asynchrone Erstellung des Adapters intern. Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook. |
| use |
Hook, um <xref:%40azure%2Fcommunication-calling%23Call> vom Anbieter zu erhalten. Hilfreich beim Implementieren 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 zu verwenden. |
| use |
Hook, um <xref:%40azure%2Fcommunication-calling%23CallAgent> vom Anbieter zu erhalten. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Hook zum Abrufen StatefulCallClient- vom Anbieter. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Hook zum Abrufen StatefulChatClient- vom Anbieter. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Hook, um <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> vom Anbieter zu erhalten. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Hook zum Abrufen StatefulDeviceManager- vom Anbieter. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Primärer Hook zum Abrufen aller Hooks, die für eine React-Komponente aus dieser Bibliothek erforderlich sind. Um diesen Hook aufzurufen, muss die Komponente unter diesen Anbietern eingeschlossen werden:
Die einfachste Verwendung einer Komponente sieht wie folgt aus: Beispiel
|
| use |
Hook zum Abrufen einer Selektor für eine angegebene Komponente. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
Hook, um <xref:%40azure%2Fcommunication-calling%23TeamsCall> vom Anbieter zu erhalten. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. Sie müssen zuvor den CallProvider mit einem TeamsCall-Objekt verwendet haben, um diesen Hook verwenden zu können |
| use |
Ein benutzerdefinierter React-Hook zur Vereinfachung der Erstellung von TeamsCallAdapter. Ähnlich wie <xref:createTeamsAzureCommunicationCallAdapter>, kümmert sich aber intern um die asynchrone Erstellung des Adapters. Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook. |
| use |
Hook, um <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> vom Anbieter zu erhalten. Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet. |
| use |
React-Hook für den Zugriff auf das Design |
Details zur Funktion
CallAgentProvider(CallAgentProviderProps)
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-calling%23CallAgent>speichert.
Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallAgentProvider-eingeschlossen werden.
function CallAgentProvider(props: CallAgentProviderProps): Element
Parameter
- props
- CallAgentProviderProps
Gibt zurück
Element
CallClientProvider(CallClientProviderProps)
Eine <xref:React.Context>, die einen StatefulCallClient-speichert.
Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallClientProvider-eingeschlossen werden.
function CallClientProvider(props: CallClientProviderProps): Element
Parameter
- props
- CallClientProviderProps
Gibt zurück
Element
CallComposite(CallCompositeProps)
Eine anpassbare Benutzeroberfläche, die für die Anruferfahrung zusammengesetzt ist.
function CallComposite(props: CallCompositeProps): Element
Parameter
- props
- CallCompositeProps
Gibt zurück
Element
Hinweise
Die Zusammengesetzte Mindestbreite/Höhe des Anrufs sind 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)
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-calling%23Call>speichert.
Das Aufrufen von Komponenten aus diesem Paket muss mit einem CallProvider-eingeschlossen 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
Gibt zurück
Element
CameraButton(CameraButtonProps)
Eine Taste zum Aktivieren/Deaktivieren der Kamera.
Kann mit ControlBar-verwendet werden.
function CameraButton(props: CameraButtonProps): Element
Parameter
- props
- CameraButtonProps
Gibt zurück
Element
CaptionsBanner(CaptionsBannerProps)
Eine Komponente zum Anzeigen eines CaptionsBanner mit Benutzersymbol, displayName und captions-Text.
function CaptionsBanner(props: CaptionsBannerProps): Element
Parameter
- props
- CaptionsBannerProps
Gibt zurück
Element
CaptionsSettingsModal(CaptionsSettingsModalProps)
Eine Komponente zum Festlegen gesprochener Sprachen
function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element
Parameter
Gibt zurück
Element
ChatClientProvider(ChatClientProviderProps)
Eine <xref:React.Context>, die einen StatefulChatClient-speichert.
Chatkomponenten aus diesem Paket müssen mit einem ChatClientProvider-eingeschlossen werden.
function ChatClientProvider(props: ChatClientProviderProps): Element
Parameter
- props
- ChatClientProviderProps
Gibt zurück
Element
ChatComposite(ChatCompositeProps)
Eine anpassbare Benutzeroberfläche, die für die Chaterfahrung zusammengesetzt ist.
function ChatComposite(props: ChatCompositeProps): Element
Parameter
- props
- ChatCompositeProps
Gibt zurück
Element
Hinweise
Chat composite min width and height are respectively 17,5rem and 20rem (280px and 320px, with default rem at 16px)
ChatThreadClientProvider(ChatThreadClientProviderProps)
Eine <xref:React.Context>, die eine <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>speichert.
Chatkomponenten aus diesem Paket müssen mit einem ChatThreadClientProvider-eingeschlossen werden.
function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element
Parameter
Gibt zurück
Element
ControlBar(ControlBarProps)
Ein Container für verschiedene Schaltflächen für Anrufsteuerelemente.
Verwenden Sie in dieser Bibliothek verschiedene Anrufsteuerungsschaltflächen, z. B. CameraButton-oder ihre eigenen Instanzen von ControlBarButton direkt.
function ControlBar(props: ControlBarProps): Element
Parameter
- props
- ControlBarProps
Gibt zurück
Element
ControlBarButton(ControlBarButtonProps)
Standardschaltfläche, die für die ControlBar-formatiert ist.
Verwenden Sie diese Komponente, um benutzerdefinierte Schaltflächen zu erstellen, die den gleichen Stil aufweisen wie andere Schaltflächen, 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
Dialpad(DialpadProps)
Eine Komponente, die es Benutzern ermöglicht, die Telefonnummer durch Klicken auf die Wähltastatur/Verwendung der Tastatur einzugeben Es wird eine leere Komponente für stabile Builds zurückgeben
function Dialpad(props: DialpadProps): Element
Parameter
- props
- DialpadProps
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 durch activeErrorMessagesausgewählt.
Diese Komponente verfolgt intern geschlossen vom Benutzer geschlossen.
- Fehler mit einem zugeordneten Zeitstempel: Der Fehler wird auf der Benutzeroberfläche erneut angezeigt, wenn er nach dem Schließen auftritt.
- Fehler, die keinen Zeitstempel aufweisen: Der Fehler wird geschlossen, bis er aus den Props verschwindet. Wenn der Fehler rekursiert, wird er in der Benutzeroberfläche angezeigt.
Verwendet <xref:%40fluentui%2Freact%23MessageBar> 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
Die Komponenten in dieser Bibliothek bestehen hauptsächlich aus der Fluent-Benutzeroberfläche, Steuerelementen und dem Mischen von v8- und v9-Steuerelementen. Dieser Anbieter übernimmt das Anwenden beliebiger Designs, die für die zugrunde liegenden Steuerelemente der Fluent-Benutzeroberfläche bereitgestellt werden. *
GridLayout(GridLayoutProps)
Eine Komponente zum Anordnen von Audio-/Videoteilnehmer-Kacheln in einem Anruf.
function GridLayout(props: GridLayoutProps): Element
Parameter
- props
- GridLayoutProps
Gibt zurück
Element
HoldButton(HoldButtonProps)
Eine Taste zum Halten oder Fortsetzen eines laufenden Anrufs.
Kann mit ControlBar verwendet werden
function HoldButton(props: HoldButtonProps): Element
Parameter
- props
- HoldButtonProps
Eigenschaften für die Schaltfläche "Halten".
Gibt zurück
Element
ImageOverlay(ImageOverlayProps)
Komponente, um ein Vollbildmodal für ein ausgewähltes Bild zu rendern.
function ImageOverlay(props: ImageOverlayProps): Element
Parameter
- props
- ImageOverlayProps
Gibt zurück
Element
IncomingCallNotification(IncomingCallNotificationProps)
Eine Notification-Komponente, die verwendet werden soll, um eingehende Anrufe an den Endbenutzer darzustellen. Ermöglicht es dem Benutzer, den eingehenden Anruf anzunehmen oder abzulehnen.
function IncomingCallNotification(props: IncomingCallNotificationProps): Element
Parameter
Gibt zurück
Element
IncomingCallStack(IncomingCallStackProps)
Wrapper zur Verwaltung mehrerer eingehender Anrufe
function IncomingCallStack(props: IncomingCallStackProps): Element
Parameter
- props
- IncomingCallStackProps
<xref:IncomingCallManagerProps>
Gibt zurück
Element
LocalizationProvider(LocalizationProviderProps)
Anbieter, der lokalisierte Zeichenfolgen für die React-Komponenten dieser Bibliothek bereitstellt.
function LocalizationProvider(props: LocalizationProviderProps): Element
Parameter
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 des Status einer gesendeten Nachricht.
Fügt ein Symbol und eine QuickInfo hinzu, die dem Status der Nachricht entspricht.
function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element
Parameter
Gibt zurück
Element
MessageThread(MessageThreadProps)
mit MessageThread können Sie ganz einfach eine Komponente zum Rendern von Chatnachrichten erstellen, das Bildlaufverhalten neuer/alter Nachrichten behandeln und Symbole & Steuerelemente innerhalb des Chatthreads anpassen.
function MessageThread(props: MessageThreadProps): Element
Parameter
- props
- MessageThreadProps
vom Typ MessageThreadProps
Benutzer müssen mindestens Chatnachrichten und UserId bereitstellen, um die MessageThread Komponente zu rendern.
Benutzer können auch MessageThread anpassen, indem sie ihren eigenen Avatar, MessageStatusIndicator Symbol, JumpToNewMessageButton, LoadPreviousMessagesButton und das Verhalten dieser Steuerelemente übergeben.
MessageThread Verwendet intern die Chat Komponente von @fluentui-contrib/chat. Sie können die Details zu diesen Komponenten hier einsehen.
Gibt zurück
Element
MicrophoneButton(MicrophoneButtonProps)
Eine Schaltfläche zum Aktivieren/Deaktivieren des Mikrofons.
Kann mit ControlBar-verwendet werden.
function MicrophoneButton(props: MicrophoneButtonProps): Element
Parameter
- props
- MicrophoneButtonProps
Gibt zurück
Element
Notification(NotificationProps)
Eine Komponente zum Anzeigen von Benachrichtigungen auf der Benutzeroberfläche.
function Notification(props: NotificationProps): Element
Parameter
- props
- NotificationProps
Gibt zurück
Element
NotificationStack(NotificationStackProps)
Eine Komponente zum Anzeigen von Benachrichtigungen auf der Benutzeroberfläche. Alle Zeichenfolgen, die angezeigt werden können, werden als Zeichenfolgen akzeptiert, damit sie lokalisiert werden können. Aktive Benachrichtigungen werden durch activeNotifications ausgewählt.
Diese Komponente verfolgt intern geschlossen vom Benutzer geschlossen.
- Benachrichtigungen, denen ein Zeitstempel zugeordnet ist: Die Benachrichtigung wird erneut auf der Benutzeroberfläche angezeigt, wenn sie nach dem Verwerfen erfolgt.
- Benachrichtigungen, die keinen Zeitstempel haben: Die Benachrichtigung wird verworfen, bis sie aus den Requisiten verschwindet. Wenn die Benachrichtigung erneut auftritt, wird sie in der Benutzeroberfläche angezeigt.
function NotificationStack(props: NotificationStackProps): Element
Parameter
- props
- NotificationStackProps
Gibt zurück
Element
ParticipantItem(ParticipantItemProps)
Komponente zum Rendern eines Anruf- oder Chatteilnehmers.
Zeigt den Avatar, den DisplayName und den Status des Teilnehmers sowie optionale Symbole und das 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. Siehe <xref:ParticipantListProps.onRenderParticipant> zum Außerkraftsetzen.
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 ihre Eigenschaft menuPropsdefiniert sind. Standardmäßig kann die Anzahl der Remoteteilnehmer mit der vollständigen Liste als Untermenü und eine Option zum Stummschalten aller Teilnehmer sowie eine Schaltfläche zum Kopieren der Anrufseinladungs-URL angezeigt werden.
Diese 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
RaiseHandButton(RaiseHandButtonProps)
Eine Schaltfläche zum Starten/Beenden der Bildschirmfreigabe.
Kann mit ControlBar-verwendet werden.
function RaiseHandButton(props: RaiseHandButtonProps): Element
Parameter
- props
- RaiseHandButtonProps
Gibt zurück
Element
ReactionButton(ReactionButtonProps)
Eine Schaltfläche zum Senden von Reaktionen.
Kann mit ControlBar-verwendet werden.
function ReactionButton(props: ReactionButtonProps): Element
Parameter
- props
- ReactionButtonProps
Gibt zurück
Element
RealTimeText(RealTimeTextProps)
Eine Komponente zum Anzeigen einer einzelnen Zeile von RealTimeText
function RealTimeText(props: RealTimeTextProps): Element
Parameter
- props
- RealTimeTextProps
Gibt zurück
Element
RealTimeTextModal(RealTimeTextModalProps)
eine Komponente für das realTimeText-Modal
function RealTimeTextModal(props: RealTimeTextModalProps): Element
Parameter
- props
- RealTimeTextModalProps
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 Meldung unterhalb des Texteingabefelds.
function SendBox(props: SendBoxProps): Element
Parameter
- props
- SendBoxProps
Gibt zurück
Element
StartCaptionsButton(StartCaptionsButtonProps)
Eine Schaltfläche zum Starten oder Stoppen von Untertiteln
Kann mit ControlBar verwendet werden
function StartCaptionsButton(props: StartCaptionsButtonProps): Element
Parameter
- props
- StartCaptionsButtonProps
Eigenschaften für die Schaltfläche Untertitel starten.
Gibt zurück
Element
StartRealTimeTextButton(StartRealTimeTextButtonProps)
eine Schaltfläche zum Starten von RealTimeText basierend auf den Anforderungen an die Barrierefreiheit, Echtzeittext kann nicht deaktiviert werden, sobald er aktiviert ist
Kann mit ControlBar verwendet werden
function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element
Parameter
Eigenschaften für die Schaltfläche RealTimeText starten.
Gibt zurück
Element
StreamMedia(StreamMediaProps)
Hilfskomponente zum Konvertieren eines HTMLElements mit einem Videostream in ein JSX-Element.
Wird verwendet, um ein HTMLElement, das von headless aufrufenden API zurückgegeben wird, in eine Komponente zu konvertieren, die als VideoTile-gerendert werden kann.
function StreamMedia(props: StreamMediaProps): Element
Parameter
- props
- StreamMediaProps
Gibt zurück
Element
TypingIndicator(TypingIndicatorProps)
Komponente zum Benachrichtigen des lokalen Benutzers, wenn ein oder mehrere Teilnehmer im Chatthread eingaben.
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 Videostreams für einen einzelnen Anrufteilnehmer.
Wird mit GridLayout- in einer VideoGallery-verwendet.
function VideoTile(props: VideoTileProps): Element
Parameter
- props
- VideoTileProps
Gibt zurück
Element
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)
Erstellen Sie eine CallAdapter- von Azure Communication Services unterstützt.
Dies ist die Standardimplementierung von CallAdapter-, die von dieser Bibliothek bereitgestellt wird.
Hinweis: displayName kann maximal 256 Zeichen lang sein.
function createAzureCommunicationCallAdapter(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
Parameter
Gibt zurück
Promise<CallAdapter>
createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)
Erstellen Sie eine CallAdapter- von Azure Communication Services unterstützt.
Dies ist die Standardimplementierung von CallAdapter-, die von dieser Bibliothek bereitgestellt wird.
Hinweis: displayName kann maximal 256 Zeichen lang sein.
function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>
Parameter
Gibt zurück
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)
Erstellen Sie eine CallAdapter- mithilfe der bereitgestellten StatefulCallClient-.
Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parameter
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- targetCallees
- options
- CommonCallAdapterOptions
Gibt zurück
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)
Erstellen Sie eine CallAdapter- mithilfe der bereitgestellten StatefulCallClient-.
Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parameter
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
Gibt zurück
Promise<CallAdapter>
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)
Erstellen Sie einen callWithChatAdapter, der von Azure Communication-Diensten unterstützt wird, um das CallWithChatComposite-.
function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>
Parameter
- __namedParameters
- AzureCommunicationCallWithChatAdapterArgs
Gibt zurück
Promise<CallWithChatAdapter>
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)
Erstellen Sie eine CallWithChatAdapter- mithilfe der bereitgestellten StatefulChatClient- und StatefulCallClient-.
Nützlich, wenn Sie einen Verweis auf StatefulChatClient- und StatefulCallClient-beibehalten möchten. Bitte beachten Sie, dass chatThreadClient von StatefulChatClient über die chatClient.getChatThreadClient(chatThreadId) API erstellt werden muss. Erwägen Sie die Verwendung createAzureCommunicationCallWithChatAdapter- für eine einfachere API.
function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>
Parameter
- __namedParameters
- AzureCommunicationCallWithChatAdapterFromClientArgs
Gibt zurück
Promise<CallWithChatAdapter>
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)
Erstellen Sie eine ChatAdapter- von Azure Communication Services unterstützt.
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, ChatAdapterOptions)
Erstellen Sie eine ChatAdapter- mithilfe der bereitgestellten StatefulChatClient-.
Nützlich, wenn Sie einen Verweis auf StatefulChatClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationChatAdapter- für eine einfachere API.
function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>
Parameter
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
- chatAdapterOptions
- ChatAdapterOptions
Gibt zurück
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call, CallingHandlersOptions)
Erstellen Sie die Standardimplementierung von CallingHandlers für Den Teams-Anruf.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call, options?: CallingHandlersOptions): CallingHandlers
Parameter
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
- options
- CallingHandlersOptions
Gibt zurück
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)
Erstellen Sie die Standardimplementierung von ChatHandlers.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
Das zurückgegebene Objekt wird memoisiert, um rerendert zu vermeiden, wenn es als Props für React-Komponenten verwendet wird.
function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers
Parameter
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Gibt zurück
createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })
Erstellen Sie die Standardimplementierung von TeamsCallingHandlers für Teams-Aufrufe .
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers
Parameter
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- deviceManager
- StatefulDeviceManager
- call
- TeamsCall
- options
-
{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }
Gibt zurück
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)
Erstellt einen StatefulCallClient-StatefulCallClient- durch proxying CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> mit ProxyCallClient-<xref:ProxyCallClient>, die dann den Zugriff auf den Status auf deklarative Weise zulässt.
Es ist wichtig, die <xref:%40azure%2Fcommunication-calling%23DeviceManager> und <xref:%40azure%2Fcommunication-calling%23CallAgent> und <xref:%40azure%2Fcommunication-calling%23Call> (und usw.) zu verwenden, die vom StatefulCallClient abgerufen werden, damit ihre Zustandsänderungen ordnungsgemäß erfolgen.
function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient
Parameter
Gibt zurück
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 den Status auf deklarative Weise ermöglicht.
function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient
Parameter
- options
- StatefulChatClientOptions
Gibt zurück
createTeamsCallAdapter(TeamsCallAdapterArgs)
function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>
Parameter
- args
- TeamsCallAdapterArgs
Gibt zurück
Promise<TeamsCallAdapter>
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)
Erstellen Sie einen TeamsCallAdapter mit dem bereitgestellten StatefulCallClient.
Nützlich, wenn Sie einen Verweis auf StatefulCallClient-beibehalten möchten. Erwägen Sie die Verwendung createAzureCommunicationCallAdapter- für eine einfachere API.
function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>
Parameter
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
Gibt zurück
Promise<TeamsCallAdapter>
fromFlatCommunicationIdentifier(string)
Umgekehrter Vorgang von toFlatCommunicationIdentifier.
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
Parameter
- id
-
string
Gibt zurück
getCallingSelector<Component>(Component)
Rufen Sie die Selektor für eine angegebene Komponente ab.
Hilfreich beim Implementieren 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 die Selektor für eine angegebene Komponente ab.
Hilfreich beim Implementieren 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>
loadCallComposite(CallCompositeLoaderProps, HTMLElement)
Loader-Funktion für CallComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den CallComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist.
function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parameter
- loaderArgs
- CallCompositeLoaderProps
- htmlElement
-
HTMLElement
Gibt zurück
Promise<undefined | CallAdapter>
loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)
Requisiten für CallWithChatComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt das CallWithChatComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist.
function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>
Parameter
- loaderArgs
- CallWithChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Gibt zurück
Promise<undefined | CallWithChatAdapter>
loadChatComposite(ChatCompositeLoaderProps, HTMLElement)
Loader-Funktion für den ChatComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den ChatComposite in das bereitgestellte HTML-Element. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist.
function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>
Parameter
- loaderArgs
- ChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Gibt zurück
Promise<undefined | ChatAdapter>
loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)
Loader-Funktion für OutboundCallComposite, die Sie in Ihrer Anwendung verwenden können. Diese Funktion lädt den CallComposite in das bereitgestellte HTML-Element, um ausgehende Aufrufe zu tätigen. Der beste Anwendungsfall dafür ist ein Node-UI-Framework, das nicht React-basiert ist.
function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parameter
- loaderArgs
- OutboundCallCompositeLoaderProps
- htmlElement
-
HTMLElement
Gibt zurück
Promise<undefined | CallAdapter>
onResolveDeepNoiseSuppressionDependency()
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading.
function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>
Gibt zurück
Promise<DeepNoiseSuppressionEffectDependency>
onResolveDeepNoiseSuppressionDependencyLazy()
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading.
function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>
Gibt zurück
Promise<DeepNoiseSuppressionEffectDependency>
onResolveVideoEffectDependency()
Auflösung von Abhängigkeiten für Videohintergrundeffekte.
function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>
Gibt zurück
Promise<VideoBackgroundEffectsDependency>
onResolveVideoEffectDependencyLazy()
Auflösung von Abhängigkeiten für Videohintergrundeffekte mit Lazy Loading.
function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>
Gibt zurück
Promise<VideoBackgroundEffectsDependency>
toFlatCommunicationIdentifier(CommunicationIdentifier)
Eine Zeichenfolgendarstellung einer <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.
Diese Zeichenfolgendarstellung von CommunicationIdentifier ist garantiert stabil für einen eindeutigen Kommunikationsbenutzer. So
- sie kann verwendet werden, um die Identität eines Benutzers in externen Datenbanken beizubehalten.
- sie kann als Schlüssel in einer Karte 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 | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
Ein benutzerdefinierter React-Hook, um die Erstellung von CallAdapter-zu vereinfachen.
Ähnlich wie createAzureCommunicationCallAdapter, kümmert sich jedoch um die interne asynchrone Erstellung des Adapters.
Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.
function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
Parameter
- 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 CallWithChatAdapterzu vereinfachen.
Ähnlich wie createAzureCommunicationCallWithChatAdapter, kümmert sich jedoch um die asynchrone Erstellung des Adapters intern.
Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes 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
- 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, kümmert sich jedoch um die asynchrone Erstellung des Adapters intern.
Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes 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 <xref:%40azure%2Fcommunication-calling%23Call> vom Anbieter zu erhalten.
Hilfreich beim Implementieren 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 zu verwenden.
function useCall(): undefined | Call
Gibt zurück
undefined | Call
useCallAgent()
Hook, um <xref:%40azure%2Fcommunication-calling%23CallAgent> vom Anbieter zu erhalten.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function useCallAgent(): undefined | CallAgent
Gibt zurück
undefined | CallAgent
useCallClient()
Hook zum Abrufen StatefulCallClient- vom Anbieter.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function useCallClient(): StatefulCallClient
Gibt zurück
useChatClient()
Hook zum Abrufen StatefulChatClient- vom Anbieter.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function useChatClient(): StatefulChatClient
Gibt zurück
useChatThreadClient()
Hook, um <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> vom Anbieter zu erhalten.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function useChatThreadClient(): ChatThreadClient
Gibt zurück
useDeviceManager()
Hook zum Abrufen StatefulDeviceManager- vom Anbieter.
Hilfreich beim Implementieren 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 zum Abrufen aller Hooks, die für eine React-Komponente aus dieser Bibliothek erforderlich sind.
Um diesen Hook aufzurufen, muss die Komponente unter diesen Anbietern eingeschlossen 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 zum Abrufen einer Selektor für eine angegebene Komponente.
Hilfreich beim Implementieren 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)
useTeamsCall()
Hook, um <xref:%40azure%2Fcommunication-calling%23TeamsCall> vom Anbieter zu erhalten.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
Sie müssen zuvor den CallProvider mit einem TeamsCall-Objekt verwendet haben, um diesen Hook verwenden zu können
function useTeamsCall(): undefined | TeamsCall
Gibt zurück
undefined | TeamsCall
useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)
Ein benutzerdefinierter React-Hook zur Vereinfachung der Erstellung von TeamsCallAdapter.
Ähnlich wie <xref:createTeamsAzureCommunicationCallAdapter>, kümmert sich aber intern um die asynchrone Erstellung des Adapters.
Ermöglicht das Nichtdefinieren von Argumenten, sodass Sie die Regel von Hooks respektieren und Argumente bei der Erstellung übergeben können. 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 für jedes Rendern neu erstellt wird. Typische Verwendungsbeispiele finden Sie im Storybook.
function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter
Parameter
- args
-
Partial<TeamsCallAdapterArgs>
- afterCreate
-
(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>
- beforeDispose
-
(adapter: TeamsCallAdapter) => Promise<void>
Gibt zurück
undefined | TeamsCallAdapter
useTeamsCallAgent()
Hook, um <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> vom Anbieter zu erhalten.
Hilfreich beim Implementieren einer benutzerdefinierten Komponente, die die aus dieser Bibliothek exportierten Anbieter verwendet.
function useTeamsCallAgent(): undefined | TeamsCallAgent
Gibt zurück
undefined | TeamsCallAgent
useTheme()
React-Hook für den Zugriff auf das Design
function useTheme(): Theme
Gibt zurück
Theme