@azure/communication-react package
Klasy
| CallError |
Błąd zgłoszony z nieudanych metod interfejsu API stanowego. |
| ChatError |
Błąd zgłoszony z nieudanych metod StatefulChatClient. |
Interfejsy
| AcceptedTransfer |
Stan funkcji transferu |
| ActiveErrorMessage |
Aktywne komunikaty o błędach, które mają być wyświetlane za pośrednictwem ErrorBar. |
| ActiveNotification |
Aktywne powiadomienia mają być wyświetlane za pośrednictwem NotificationStack. |
| AdapterError |
Błąd zgłaszany za pośrednictwem zdarzeń błędów i przechowywany w stanie karty. |
| AdapterNotification |
Powiadomienie o stanie klienta połączenia przechowywane w stanie adaptera. |
| AdapterState |
Funkcjonalność komunikacji ze stanem karty złożonej. |
| AttachmentMetadata |
Model danych reprezentujący załącznik wiadomości czatu, w którym zawiera identyfikator jednoznacznie identyfikujący załącznik, nazwę reprezentującą nazwę pliku oraz adres URL służący do pobrania załącznika. |
| BaseCompositeProps |
Właściwości wspólne dla wszystkich złożonych wyeksportowanych z tej biblioteki. |
| BaseCustomStyles |
Podstawowe rekwizyty stylów płynnych dla wszystkich składników wyeksportowanych z tej biblioteki. |
| BreakoutRoomsState |
Stan oddzielnych pokoi |
| CallAdapter |
Interfejs karty specyficzny dla tożsamości usługi Azure Communication, który rozszerza CommonCallAdapter. |
| CallAdapterCallManagement |
Funkcje zarządzania bieżącym wywołaniem lub uruchamiania nowego wywołania |
| CallAdapterCallOperations |
Funkcje zarządzania bieżącym wywołaniem. |
| CallAdapterDeviceManagement |
Funkcje zarządzania urządzeniami w ramach wywołania. |
| CallAdapterSubscribers |
Wywoływanie zdarzeń złożonych, do których można zasubskrybować. |
| CallAgentProviderProps |
Argumenty inicjowania CallAgentProvider. |
| CallAgentState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23CallAgent> z wyjątkiem wywołań jest przenoszona jako element podrzędny bezpośrednio CallClientState i nie jest uwzględniony w tym miejscu. Powodem, dla którego stan callAgent jest proxied, jest zapewnienie dostępu do displayName. Nie spłaszczamy obiektu CallAgent.displayName i umieszczamy go w obiekcie CallClientState, ponieważ byłoby niejednoznaczne, że właściwość displayName jest rzeczywiście zależna od tworzenia/istnienia klasy CallAgent, aby była dostępna. |
| CallAndChatLocator |
Argumenty do użycia w createAzureCommunicationCallWithChatAdapter do dołączenia połączenia ze skojarzonym wątkiem czatu. |
| CallClientProviderProps |
Argumenty inicjowania CallClientProvider. |
| CallClientState |
Kontener dla wszystkich danych stanu proxied przez StatefulCallClient. Wywołania, wywołaniaEnded, incomingCalls i przychodzące StanyCallsEnded zostaną automatycznie podane, jeśli utworzono wywołanie. Menedżer urządzenia będzie początkowo pusty, dopóki nie zostanie wypełniony, zobacz DeviceManagerState. Stan userId jest udostępniany jako wygoda dla dewelopera i jest całkowicie sterowany i ustawiany przez dewelopera. |
| CallCompositeLoaderProps |
Właściwości dla OutboundCallComposite, których można użyć w aplikacji. Zawiera dwie torby z opcjami:
|
| CallCompositeProps |
Podziękowania dla CallComposite. |
| CallCompositeStrings |
Ciągi używane bezpośrednio przez CallComposite. Te ciągi są dodatkiem do tych używanych przez składniki z biblioteki składników. |
| CallFeatureStreamState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Reprezentuje stan strumienia funkcji wywołania. |
| CallInfoState |
stan, aby śledzić typy <xref:CallInfo> i <xref:TeamsCallInfo> |
| CallNotification | |
| CallProviderProps |
Argumenty inicjowania CallProvider. |
| CallState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient automatycznie pobierze stan wywołania i doda go do stanu uwidocznionego przez StatefulCallClient. |
| CallSurveyImprovementSuggestions |
Reprezentuje część ankiety telefonicznej dotyczącą sugestii ulepszeń |
| CallWithChatAdapter | |
| CallWithChatAdapterManagement |
Funkcje zarządzania bieżącym połączeniem za pomocą czatu. |
| CallWithChatAdapterState |
CallWithChat State to kombinacja stanowych rozmów i klientów wywołujących stan z określonym stanem tylko dla funkcji CallWithChat Composite. |
| CallWithChatAdapterSubscriptions |
Wywołaj zdarzenia rozmów i czatów, które można subskrybować w CallWithChatAdapter. |
| CallWithChatAdapterUiState |
Stan interfejsu użytkownika odnoszący się do CallWithChatComposite. |
| CallWithChatClientState |
Stan z usług zaplecza, które dyskują CallWithChatComposite. |
| CallWithChatCompositeLoaderProps |
Podziękowania dla CallWithChatComposite, których możesz użyć w swojej aplikacji. Zawiera dwie torby z opcjami:
|
| CallWithChatCompositeProps |
Props wymagane dla CallWithChatComposite |
| CallWithChatCompositeStrings |
Ciągi używane bezpośrednio przez CallWithChatComposite. Te ciągi są dodatkiem do tych używanych przez składniki z biblioteki składników. |
| CallWithChatControlOptions |
Opcje dostosowywania paska sterowania podczas połączeń z czatem. |
| CallingHandlers |
Obiekt zawierający wszystkie programy obsługi wymagane do wywoływania składników. Wywoływanie powiązanych składników z tego pakietu umożliwia wybranie odpowiednich procedur obsługi z tego obiektu. Zobacz <xref:useHandlers> i usePropsFor. |
| CallingTheme |
Niestandardowa paleta motywów Fluent używana przez wywoływanie powiązanych składników w tej bibliotece. |
| CameraButtonContextualMenuStyles |
Style menu CameraButton. |
| CameraButtonProps |
Rekwizyty dla składnika CameraButton. |
| CameraButtonStrings |
Ciągi cameraButton, które można zastąpić. |
| CameraButtonStyles |
Style CameraButton |
| CapabilitiesFeatureState |
Wersja tylko dla stanu <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature> |
| CapabilityChangedNotificationStrings |
Ciągi powiadomienia o zmianie możliwości |
| CaptionLanguageStrings |
Ciągi języka napisów dla modalnego ustawiania napisów |
| CaptionsBannerProps |
PodpisyBaner Komponent Rekwizyty. |
| CaptionsBannerStrings |
Ciągi znaków dla banera z napisami |
| CaptionsCallFeatureState | |
| CaptionsInfo | |
| CaptionsSettingsModalProps |
PodpisyUstawieniaModalne rekwizyty komponentu. |
| CaptionsSettingsModalStrings |
Ciągi do ustawiania podpisów modalnych |
| ChatAdapterSubscribers |
Zdarzenia złożone czatu, które można subskrybować. |
| ChatAdapterThreadManagement |
Funkcje zarządzania bieżącym wątkiem czatu. |
| ChatCompositeLoaderProps |
Podziękowania dla ChatComposite, których możesz użyć w swojej aplikacji. Zawiera opcje dla ChatCompositeChatCompositeOptions. |
| ChatCompositeProps |
Podziękowania dla ChatComposite. |
| ChatCompositeStrings |
Ciągi używane bezpośrednio przez ChatComposite. Te ciągi są dodatkiem do tych używanych przez składniki z biblioteki składników. |
| ChatMessage |
Wiadomość czatu. |
| CommonCallAdapter | |
| CommonCallingHandlers |
Obiekt zawierający wszystkie programy obsługi wymagane do wywoływania składników. Wywoływanie powiązanych składników z tego pakietu umożliwia wybranie odpowiednich procedur obsługi z tego obiektu. Zobacz <xref:useHandlers> i usePropsFor. |
| ComponentLocale |
Informacje o ustawieniach regionalnych dla wszystkich składników wyeksportowanych z tej biblioteki. |
| ComponentStrings |
Ciągi używane przez wszystkie składniki wyeksportowane z tej biblioteki. |
| CompositeLocale |
Informacje o ustawieniach regionalnych dla wszystkich złożonych wyeksportowanych z tej biblioteki. |
| CompositeStrings |
Ciągi używane bezpośrednio w złożonych elementach. Te ciągi są używane bezpośrednio przez złożone zamiast zawartych składników. |
| ConferencePhoneInfo |
Informacje o telefonie konferencyjnym |
| ContentSystemMessage |
Komunikat systemowy z zawartością arbitary. |
| ControlBarButtonProps |
Podziękowania dla ControlBarButton. |
| ControlBarButtonStrings |
Ciągi ControlBarButton, które można zastąpić. |
| ControlBarProps |
Podziękowania dla ControlBar. |
| CreateVideoStreamViewResult |
Obiekt zwrócony po utworzeniu lokalnego lub zdalnego strumienia wideo. Zawiera funkcje pomocnicze do manipulowania renderowaniem strumienia. |
| CustomCallControlButtonCallbackArgs |
Argumenty dla CustomCallControlButtonCallback. |
| CustomCallControlButtonProps |
Odpowiedź od CustomCallControlButtonCallback. Zawiera podstawowe właściwości niezbędne do renderowania elementu ControlBarButton lub <xref:DrawerMenuItem>. |
| CustomCallControlButtonStrings |
Ciągi dla CustomCallControlButtons |
| CustomMessage |
Niestandardowy typ komunikatu. Niestandardowe komunikaty nie są domyślnie renderowane, ale aplikacje mogą udostępniać im niestandardowe programy renderowane. |
| DevicesButtonContextualMenuStyles |
Style menu DevicesButton. |
| DevicesButtonProps |
Podziękowania dla DevicesButton. |
| DevicesButtonStrings |
Ciągi DevicesButton, które można zastąpić. |
| DevicesButtonStyles |
Style elementów menu przycisków Urządzenia. |
| DiagnosticsCallFeatureState |
Tylko serwer proxy stanu dla <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>. |
| DialpadProps |
Podziękowania dla komponentu Dialpad . |
| DialpadStrings |
Ciągi klawiatury numerycznej , które można zastąpić. |
| DialpadStyles |
Style dla komponentu Dialpad . |
| Disposable |
Funkcje prawidłowego rozdysponowania złożonego elementu. |
| DtmfDialPadOptions |
Opcje określające zachowanie renderowania dtmfDialer w CallComposite |
| EndCallButtonProps |
Podziękowania dla EndCallButton. |
| EndCallButtonStrings |
Ciągi EndCallButton, które można zastąpić. |
| ErrorBarProps |
Podziękowania dla ErrorBar. Oprócz poniższych ErrorBar przekazuje wszystkie <xref:%40fluentui%2Freact%23IMessageBarProps> do bazowego <xref:%40fluentui%2Freact%23MessageBar>. |
| ErrorBarStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika w ErrorBar. |
| FluentThemeProviderProps |
Podziękowania dla FluentThemeProvider. |
| GridLayoutProps |
Podziękowania dla GridLayout. |
| GridLayoutStyles |
GridLayout style składników. |
| HoldButtonProps | |
| HoldButtonStrings |
Ciągi znaków dla etykiet przycisków wstrzymania |
| HorizontalGalleryStyles |
<xref:HorizontalGallery> style składników. |
| ImageOverlayProps |
Podziękowania dla ImageOverlay. |
| ImageOverlayStrings |
Ciągi ImageOverlay , które można nadpisać. |
| IncomingCallNotificationProps |
Właściwości komponentu powiadamiania o połączeniach przychodzących. |
| IncomingCallNotificationStrings |
Ciągi znaków dla komponentu powiadamiania o połączeniach przychodzących. |
| IncomingCallNotificationStyles |
Style komponentu powiadamiania o połączeniach przychodzących. |
| IncomingCallStackCall |
Reprezentuje aktywne połączenie przychodzące. |
| IncomingCallStackProps |
Podziękowania dla komponentu IncomingCallManager. |
| IncomingCallState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient automatycznie wykryje wywołania przychodzące i doda stan do stanu uwidocznionego przez StatefulCallClient. |
| InlineImage |
Stan InlineImage odzwierciedlony w interfejsie użytkownika. |
| InlineImageOptions |
Opcje wyświetlania obrazu w wierszu w scenariuszu obrazu wbudowanego. |
| JoinCallOptions |
Opcje ustawiania stanu mikrofonu i kamery podczas dołączania do połączenia true = włącz urządzenie podczas dołączania do połączenia false = wyłącz urządzenie podczas dołączania do połączenia "keep" / undefined = zachowaj stan urządzeń przed połączeniem |
| JumpToNewMessageButtonProps |
Argumenty dla <xref:MessageThreadProps.onRenderJumpToNewMessageButton>. |
| LocalVideoCameraCycleButtonProps | |
| LocalVideoStreamState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>. |
| LocalVideoStreamVideoEffectsState |
Tylko stanowa wersja pliku <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>. |
| LocalVideoTileOptions |
Opcje lokalnego kafelka wideo w kompozycji połączeń. |
| MediaAccessState |
Stan dostępu do nośnika |
| MediaDiagnosticsState |
Tylko serwer proxy stanu dla <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>. |
| MeetingConferencePhoneInfoModalStrings |
Ciągi dla modalnych informacji telefonicznych |
| MessageCommon |
Wspólne właściwości wszystkich typów komunikatów. |
| MessageStatusIndicatorProps |
Właściwości dla MessageStatusIndicator. |
| MessageStatusIndicatorStrings |
Ciągi MessageStatusIndicator, które można zastąpić. |
| MessageThreadStrings |
Ciągi MessageThread, które można zastąpić. |
| MessageThreadStyles |
Płynne style dla MessageThread. |
| MicrophoneButtonContextualMenuStyles |
Style menu MicrophoneButton. |
| MicrophoneButtonProps |
Podziękowania dla MicrophoneButton. |
| MicrophoneButtonStrings |
Ciągi MicrophoneButton, które można zastąpić. |
| MicrophoneButtonStyles |
Style MicrophoneButton |
| NetworkDiagnosticsState |
Tylko serwer proxy stanu dla <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>. |
| NotificationOptions |
Opcje sterowania powiadomieniami w kompozycji. |
| NotificationProps |
Podziękowania za powiadomienie. |
| NotificationStackProps |
Podziękowania dla NotificationStack. |
| NotificationStackStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika w NotificationStack. |
| NotificationStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika w powiadomieniu. |
| NotificationStyles |
Style składnika powiadomienia. |
| OptimalVideoCountFeatureState |
Dostępna tylko wersja funkcji <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>optymalna liczba filmów . |
| OptionsDevice |
Urządzenie, np. aparat, mikrofon lub głośnik, w DevicesButton wysuwane. |
| OutboundCallCompositeLoaderProps |
Właściwości dla OutboundCallComposite, których można użyć w aplikacji. Zawiera dwie torby z opcjami:
|
| PPTLiveCallFeatureState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient automatycznie nasłuchuje pptLive w wywołaniu i odpowiednio aktualizuje stan ujawniony przez StatefulCallClient . |
| ParticipantAddedSystemMessage |
Komunikat systemowy z powiadomieniem, że uczestnik został dodany do wątku czatu. |
| ParticipantItemProps |
Podziękowania dla ParticipantItem. |
| ParticipantItemStrings |
Ciągi ParticipantItem, które można zastąpić. |
| ParticipantItemStyles |
Płynne style dla ParticipantItem. |
| ParticipantListItemStyles |
Style dla UczestnikaListaUczestnikitem. |
| ParticipantListStyles |
Style ParticipantList. |
| ParticipantRemovedSystemMessage |
Komunikat systemowy z powiadomieniem, że uczestnik został usunięty z wątku czatu. |
| ParticipantsButtonContextualMenuStyles |
Style menu UczestnicyButton. |
| ParticipantsButtonProps |
Podziękowania dla ParticipantsButton. |
| ParticipantsButtonStrings |
Ciągi ParticipantsButton, które można zastąpić. |
| ParticipantsButtonStyles |
Style props dla uczestników Button. |
| RaiseHandButtonProps |
Podziękowania dla RaiseHandButton. |
| RaiseHandButtonStrings |
Ciągi RaiseHandButton , które można zastąpić. |
| RaiseHandCallFeature |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient automatycznie nasłuchuje podniesionych rąk w wywołaniu i odpowiednio aktualizuje stan uwidoczniony przez StatefulCallClient . |
| ReactionButtonProps |
Podziękowania dla ReactionButton. |
| ReactionButtonStrings |
Ciągi ReactionButton , które można zastąpić. |
| ReactionResources |
Interfejs dla obrazu duszka animacji i powiązanych metadanych |
| RealTimeTextCallFeatureState | |
| RealTimeTextInfo | |
| RealTimeTextModalProps |
Właściwości komponentu RealTimeTextModal. |
| RealTimeTextModalStrings |
ciągi znaków dla modalnego realTimeText |
| RealTimeTextProps |
Podziękowania za pojedynczy wiersz RealTimeText. |
| RealTimeTextStrings |
Ciągi dla RTT |
| RecordingCallFeature |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient automatycznie nasłuchuje stanu rejestrowania wywołania i zaktualizuje stan uwidoczniony przez StatefulCallClient odpowiednio. |
| RemoteParticipantState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient automatycznie pobierze klasy RemoteParticipants i doda stan do stanu uwidocznionego przez StatefulCallClient. |
| RemoteVideoStreamState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>. |
| RemoteVideoTileMenuOptions |
Opcje menu dla zdalnych kafelków wideo w VideoGallery. |
| ScreenShareButtonProps |
Podziękowania dla ScreenShareButton. |
| ScreenShareButtonStrings |
Ciągi ScreenShareButton, które można zastąpić. |
| SendBoxProps |
Podziękowania dla SendBox. |
| SendBoxStrings |
Ciągi SendBox, które można zastąpić. |
| SendBoxStylesProps |
Płynne style dla <xref:Sendbox>. |
| SpokenLanguageStrings |
Ciągi języka mówionego do ustawiania napisów modalnych |
| SpotlightCallFeatureState |
Wersja tylko dla stanu <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature> |
| SpotlightPromptStrings |
Ciągi używane w monicie związanym z reflektorem |
| SpotlightState |
Stan reflektora z kolejnością |
| StartCaptionsAdapterOptions |
Opcje przekazane do adapter.startCaptions |
| StartCaptionsButtonProps | |
| StartCaptionsButtonStrings |
Ciągi znaków dla etykiet przycisków wstrzymania |
| StartRealTimeTextButtonProps |
Właściwości dla komponentu StartRealTimeTextButton |
| StartRealTimeTextButtonStrings |
Ciągi znaków dla etykiet przycisków wstrzymania |
| StatefulCallClient |
Definiuje metody, które umożliwiają używanie <xref:%40azure%2Fcommunication-calling%23CallClient> CallClient stanowo. Interfejs zapewnia dostęp do stanu proxied, a także umożliwia rejestrowanie programu obsługi zdarzeń zmiany stanu. Aby uzyskać definicję stanu, zobacz CallClientState. Zdarzenia zmiany stanu są sterowane przez:
|
| StatefulChatClient |
Definiuje metody, które umożliwiają używanie elementu {@Link @azure/communication-chat#ChatClient} ze scentralizowanym wygenerowanym stanem. Interfejs zapewnia dostęp do stanu proxied, a także umożliwia rejestrowanie programu obsługi zdarzeń zmiany stanu. |
| StatefulDeviceManager |
Definiuje dodatkowe metody dodane przez stanowe na podstawie <xref:%40azure%2Fcommunication-calling%23DeviceManager>. |
| StopCaptionsAdapterOptions |
Opcje przekazywane do adapter.stopCaptions |
| StreamMediaProps |
Podziękowania dla StreamMedia. |
| SurveyIssues |
Odpowiednie teksty do każdego problemu z połączeniem |
| SurveyIssuesHeadingStrings |
Teksty odpowiadające każdej kategorii problemów z połączeniami |
| SystemMessageCommon |
Typowe właściwości wszystkich komunikatów systemowych. |
| TeamsCallAdapter |
Interfejs adaptera specyficzny dla tożsamości usługi Teams, który rozszerza CommonCallAdapter. |
| TeamsCallingHandlers |
Obiekt zawierający wszystkie procedury obsługi wywołań zespołów wymagane do wywoływania składników. Wywoływanie powiązanych składników z tego pakietu umożliwia wybranie odpowiednich procedur obsługi z tego obiektu. Zobacz <xref:useHandlers> i usePropsFor. |
| TeamsIncomingCallState |
Wersja tylko dla stanu <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> |
| TogetherModeCallFeatureState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Reprezentuje stan funkcji Tryb Razem. |
| TogetherModeSeatingPositionState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>. Reprezentuje pozycję siedzącą uczestnika w trybie Razem. |
| TogetherModeStreamOptions |
Interfejs reprezentujący wynik widoku strumienia w trybie Razem. |
| TogetherModeStreamViewResult |
Interfejs reprezentujący wynik widoku strumienia w trybie Razem. |
| TogetherModeStreamsState |
Reprezentuje strumienie w trybie Razem. |
| TopicUpdatedSystemMessage |
Komunikat systemowy z powiadomieniem, że temat wątku czatu został zaktualizowany. |
| TranscriptionCallFeature |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient automatycznie nasłuchuje stanu transkrypcji wywołania i odpowiednio zaktualizuje stan uwidoczniony przez StatefulCallClient. |
| TransferFeature |
Stan funkcji transferu |
| TypingIndicatorProps |
Podziękowania dla TypingIndicator. |
| TypingIndicatorStrings |
Ciągi TypingIndicator, które można zastąpić. |
| TypingIndicatorStylesProps |
Płynne style dla TypingIndicator. |
| VerticalGalleryControlBarStyles |
Style paska sterowania wewnątrz składnika VerticalGallery |
| VerticalGalleryStrings |
Ciągi znaków do lokalizacji galerii pionowej. |
| VerticalGalleryStyles |
Style składnika VerticalGallery |
| VideoBackgroundBlurEffect |
Zawiera atrybuty efektu rozmycia tła wideo |
| VideoBackgroundImage |
Zawiera atrybuty obrazu tła, takie jak adres URL, nazwa itp. |
| VideoBackgroundNoEffect |
Zawiera atrybuty usuwające efekt tła wideo |
| VideoBackgroundReplacementEffect |
Zawiera atrybuty wybranego zastępczego efektu tła wideo |
| VideoGalleryLocalParticipant |
Stan lokalnego uczestnika VideoGallery. |
| VideoGalleryProps |
Podziękowania dla VideoGallery. |
| VideoGalleryRemoteParticipant |
Stan zdalnego uczestnika VideoGallery. |
| VideoGalleryStream |
Strumień wideo uczestnika VideoGallery. |
| VideoGalleryStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika w VideoGallery. |
| VideoGalleryStyles |
VideoGallery Style składników. |
| VideoGalleryTogetherModeSeatingInfo |
Interfejs reprezentujący informacje o miejscach siedzących w trybie Together. |
| VideoGalleryTogetherModeStreams |
Interfejs reprezentujący strumienie w trybie Together. |
| VideoStreamOptions |
Opcje kontrolowania sposobu renderowania strumieni wideo. |
| VideoStreamRendererViewState |
Stan tylko wersja <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Ta właściwość jest dodawana do stanu uwidocznionego przez StatefulCallClient przez createView i usunięta przez disposeView. |
| VideoTileContextualMenuProps |
Właściwości służące do wyświetlania menu kontekstowego dla zdalnych komponentów VideoTile w VideoGallery. |
| VideoTileDrawerMenuProps |
Właściwości wyświetlania menu szuflady na zdalnym długim dotknięciu kafelka VideoTile w VideoGallery. |
| VideoTileProps |
Podziękowania dla VideoTile. |
| VideoTileStrings |
Ciągi elementu VideoTile , które można zastąpić. |
| VideoTileStylesProps |
Płynne style dla VideoTile. |
| VideoTilesOptions |
Opcje, które mają zastosowanie do wszystkich kafelków wideo w VideoGallery |
Aliasy typu
| AdapterErrors |
Adaptery przechowują najnowszy błąd dla każdej operacji w stanie.
|
| AdapterNotifications |
Adaptery przechowują najnowsze powiadomienie dla każdego elementu docelowego. |
| AreEqual |
Porównaj, czy 2 składniki react są dokładnie równe, typ wyniku będzie mieć wartość true/false |
| AreParamEqual |
Porównaj, czy rekwizyty 2 składników react są równe, typ wyniku będzie mieć wartość true/false |
| AreTypeEqual |
Porównaj, jeśli dwa typy są równe, typ wyniku będzie mieć wartość true/false |
| AvatarPersonaData |
Niestandardowe atrybuty danych służące do wyświetlania awatara dla użytkownika. |
| AvatarPersonaDataCallback |
Funkcja wywołania zwrotnego używana do udostępniania danych niestandardowych w celu utworzenia awatara dla użytkownika. |
| AzureCommunicationCallAdapterArgs |
Argumenty dotyczące tworzenia implementacji usług Azure Communication Services CallAdapter. Uwaga: |
| AzureCommunicationCallAdapterOptions |
Opcjonalne parametry do utworzenia useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) |
| AzureCommunicationCallWithChatAdapterArgs | |
| AzureCommunicationCallWithChatAdapterFromClientArgs |
Argumenty <xref:createAzureCommunicationCallWithChatAdapterFromClient> |
| AzureCommunicationChatAdapterArgs |
Argumenty dotyczące tworzenia implementacji usług Azure Communication Services ChatAdapter. |
| AzureCommunicationOutboundCallAdapterArgs |
Argumenty dotyczące tworzenia implementacji usług Azure Communication Services CallAdapter. Te argumenty są używane do tworzenia scenariuszy połączeń wychodzących. Uwaga: |
| CallAdapterCallEndedEvent |
Ładunek dla CallEndedListener zawierający szczegóły dotyczące zakończonego wywołania. |
| CallAdapterClientState |
stanu CommonCallAdapter wywnioskowany z zaplecza usług Azure Communication Services. |
| CallAdapterLocator |
Lokalizator używany przez createAzureCommunicationCallAdapter, aby zlokalizować wywołanie sprzężenia |
| CallAdapterState |
stan CommonCallAdapter. |
| CallAdapterUiState |
stanu CommonCallAdapter na potrzeby czystego interfejsu użytkownika. |
| CallCompositeIcons |
Ikony, które można zastąpić dla CallComposite. |
| CallCompositeOptions |
Opcjonalne funkcje CallComposite. |
| CallCompositePage |
Główne ekrany interfejsu użytkownika wyświetlane w CallComposite. |
| CallControlDisplayType |
Typ wyświetlania paska sterowania dla CallComposite. |
| CallControlOptions |
Opcje dostosowywania paska sterowania w środowisku wywoływania. |
| CallEndedListener |
Wywołanie zwrotne dla callAdapterSubscribers zdarzenia "callEnded". |
| CallErrorBarSelector |
Typ selektora dla składnika ErrorBar. |
| CallErrorTarget |
Typ literału ciągu dla wszystkich dozwolonych kluczy w elemencie {@Link CallErrors}. |
| CallErrors |
Błędy teed z wywołań interfejsu API do zestawu Calling SDK. Każda właściwość w obiekcie przechowuje najnowszy błąd dla określonej metody interfejsu API zestawu SDK. Błędy z tego obiektu można wyczyścić przy użyciu <xref:newClearCallErrorsModifier>. Ponadto błędy są automatycznie czyszczone, gdy:
|
| CallFeatureStreamName |
Reprezentuje nazwę strumienia funkcji połączenia |
| CallIdChangedListener |
Wywołanie zwrotne dla CallAdapterSubscribers zdarzenia "callIdChanged". |
| CallNotifications | |
| CallParticipantListParticipant |
Wywoływanie stanu uczestnika, jak pokazano w składnikach interfejsu użytkownika. |
| CallWithChatCompositeIcons |
Ikony, które można zastąpić dla CallWithChatComposite. |
| CallWithChatCompositeOptions |
Opcjonalne funkcje CallWithChatComposite. |
| CallWithChatEvent |
Zdarzenia wyzwolone przez CallWithChatAdapter. |
| CallingBaseSelectorProps |
Typowe rekwizyty używane do odwołowania się do wywoływania stanu klienta deklaratywnego. |
| CallingHandlersOptions |
Opcje konfiguracji uwzględniające zależność tła efektu wideo. |
| CallingReturnProps |
Typ pomocnika dla usePropsFor. |
| CallingSounds |
Typ reprezentujący zestaw dźwięków, które mają być używane dla różnych zdarzeń wywołania |
| CameraButtonSelector |
Typ selektora dla składnika CameraButton. |
| CancelEditCallback |
Funkcja wywołania zwrotnego jest uruchamiana, gdy edycja wiadomości zostanie anulowana. |
| CapabilitiesChangedListener |
Wywołanie zwrotne dla zdarzenia "capabilitiesChanged" dla CallAdapterSubscriberss . |
| CaptionSettingsSelector |
Typ selektora dla komponentów dla Zmiana języka napisów i języka mówionego |
| CaptionsBannerSelector |
Typ selektora składnika CaptionsBanner . |
| CaptionsInformation |
informacje wymagane dla każdego wiersza podpisu |
| CaptionsOptions |
Torba z opcjami do uruchamiania napisów |
| CaptionsReceivedListener |
Wywołanie zwrotne dla zdarzenia "captionsReceived" dla CallAdapterSubscriberss . |
| ChatAdapter | |
| ChatAdapterOptions |
Opcje konfiguracji adaptera ChatAdapter. |
| ChatAdapterState |
stan ChatAdapter. |
| ChatAdapterUiState |
stan ChatAdapter na potrzeby czystego interfejsu użytkownika. |
| ChatAttachmentType |
Reprezentuje typ załącznika |
| ChatBaseSelectorProps |
Typowe rekwizyty selektorów ChatClientState. |
| ChatClientProviderProps |
Argumenty inicjowania ChatClientProvider. |
| ChatClientState |
Scentralizowany stan <xref:%40azure%2Fcommunication-chat%23ChatClient>. |
| ChatCompositeClientState |
ChatAdapter stan wywnioskowany z zaplecza usług Azure Communication Services. |
| ChatCompositeIcons |
Ikony, które można zastąpić ChatComposite. |
| ChatCompositeOptions |
Opcjonalne funkcje ChatComposite. |
| ChatErrorBarSelector |
Typ selektora dla składnika ErrorBar. |
| ChatErrorTarget |
Typ literału ciągu dla wszystkich dozwolonych kluczy w ChatErrors. |
| ChatErrors |
Błędy teed z wywołań interfejsu API do zestawu Chat SDK. Każda właściwość w obiekcie przechowuje najnowszy błąd dla określonej metody interfejsu API zestawu SDK. |
| ChatHandlers |
Obiekt zawierający wszystkie programy obsługi wymagane dla składników czatu. Składniki powiązane z czatem z tego pakietu mogą wybierać odpowiednie programy obsługi z tego obiektu. Zobacz <xref:useHandlers> i usePropsFor. |
| ChatInitializedListener |
Wywołanie zwrotne dla <xref:CallWithChatAdapterSubscribers> zdarzenia "chatInitialized". |
| ChatMessageWithStatus |
Rozszerzenie do <xref:%40azure%2Fcommunication-chat%23ChatMessage>, które przechowuje metadane tylko po stronie klienta dla wiadomości czatu. TODO: Nazwa została bitrotted. Zmień nazwę mnie. |
| ChatParticipantListSelector |
Typ selektora dla składnika ParticipantList. |
| ChatProfile |
Profil użytkownika lub bota. |
| ChatReturnProps |
Typ pomocnika dla usePropsFor. |
| ChatThreadClientProviderProps |
Argumenty inicjowania ChatThreadClientProvider. |
| ChatThreadClientState |
Scentralizowany stan <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. |
| ChatThreadProperties |
Właściwości wątku czatu. Definiujemy minimalny, który pomaga nam ukryć różne typy używane przez bazowy interfejs API. |
| ClientState |
Scentralizowany stan <xref:%40azure%2Fcommunication-calling%23CallClient> lub <xref:%40azure%2Fcommunication-chat%23ChatClient>. Zobacz również: CallClientState, ChatClientState. |
| Common |
Zwracanie typu krzyżowego 2 typów |
| CommonCallAdapterOptions |
Typowe parametry opcjonalne do utworzenia useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) lub TeamsCallAdapter |
| CommonCallControlOptions |
Opcje dostosowywania paska sterowania w środowisku wywoływania. |
| CommonProperties |
Zwracanie właściwości przecinających 2 typy |
| CommunicationParticipant |
Stan czatu lub połączenia uczestnika, jak pokazano w interfejsie użytkownika. |
| ComponentIcons |
Ikony używane przez składniki React wyeksportowane z tej biblioteki. |
| ComponentProps |
Typ pomocnika dla usePropsFor. |
| ComponentSlotStyle |
ComponentSlotStyle jest typem @fluentui/react-northstar . Ponieważ odeszliśmy od tego pakietu, użyliśmy bardziej ogólnego typu IRawStyle od fluent do interoperacyjności. |
| CompositeIcons |
Ikony, które można zastąpić w jednej z kompozycji wyeksportowanych przez tę bibliotekę. Zobacz ChatCompositeIcons, CallCompositeIcons i CallWithChatCompositeIcons , aby uzyskać bardziej docelowe typy. |
| ControlBarButtonStyles |
Style dla wszystkich implementacji ControlBarButton. |
| ControlBarLayout |
Przedstawia układy ControlBar. |
| CreateDefaultCallingHandlers | |
| CreateViewResult |
Zwraca wynik z createView. |
| CustomAvatarOptions |
Opcje, które można wstrzyknąć do funkcji |
| CustomCallControlButtonCallback |
Wywołanie zwrotne, które zwraca właściwości w celu renderowania niestandardowego elementu ControlBarButton i <xref:DrawerMenuItem>. Odpowiedź wskazuje, gdzie należy umieścić przycisk niestandardowy. Wskazówka dotycząca wydajności: To wywołanie zwrotne jest wywoływane tylko wtedy, gdy zmieni się wywołanie zwrotne lub jego argumenty. |
| CustomCallControlButtonPlacement |
Umieszczenie niestandardowego przycisku wstrzykniętego w pliku .<xref:CommonCallControlBar> "primary": Umieść przycisk(i) po prawej stronie środkowego paska sterowania, ale przed EndCallButton (lewym końcem w trybie rtl). 'overflow': Umieść przycisk(i) na końcu menu przepełnienia. "drugorzędny": Umieść przycisk(i) po lewej stronie bocznego paska sterowania (po prawej stronie w trybie rtl). Wiele przycisków przypisanych do tego samego miejsca jest dołączanych w kolejności. Na przykład, jeśli dwa przyciski zostaną umieszczone w "drugorzędnym", oba pojawią się po lewej stronie (po prawej stronie w trybie rtl) w podanej kolejności. Tylko "podstawowe" miejsce docelowe działa, gdy starsza wersja sterowania połączeniami jest włączona w połączeniu połączeń |
| DeclarativeCallAgent |
|
| DeclarativeTeamsCallAgent |
|
| DeepNoiseSuppressionEffectDependency |
Typ zależności, który ma zostać wstrzyknięty w celu głębokiego tłumienia szumów |
| DeviceManagerState |
Ten typ jest przeznaczony do hermetyzacji całego stanu wewnątrz <xref:%40azure%2Fcommunication-calling%23DeviceManager>. W przypadku parametrów opcjonalnych mogą nie być dostępne do momentu udzielenia użytkownikowi uprawnień. Aparaty fotograficzne, mikrofony, głośniki i stany deviceAccess będą puste do momentu wywołania i ukończenia odpowiednich interfejsów API getCameras <xref:%40azure%2Fcommunication-calling%23DeviceManager>getMicrophones, getMicrophones i askDevicePermission API. |
| DevicesButtonSelector |
Typ selektora dla składnika DevicesButton. |
| DiagnosticChangedEventListner |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "diagnosticChanged". |
| DialpadMode |
Tryby komponentu klawiatury numerycznej. |
| DisplayNameChangedListener |
Wywołanie zwrotne dla callAdapterSubscribers zdarzenia "displayNameChanged". |
| DtmfTone |
Ton DTMF dla wywołań PSTN. |
| EmptySelector |
Typ dla trywialnych selektorów, które nie zwracają żadnych danych. Używana jako domyślna wartość zwracana, jeśli usePropsFor jest wywoływana dla składnika, który nie wymaga danych. |
| ErrorType |
Wszystkie błędy, które można wyświetlić w ErrorBar. |
| GetCallingSelector |
Określony typ selektora, który ma zastosowanie do danego składnika. |
| GetChatSelector |
Określony typ selektora, który ma zastosowanie do danego składnika. |
| HoldButtonSelector |
Typ selektora składnika HoldButton . |
| IncomingCallManagement |
Zawiera tablicę tylko do odczytu, która zwraca wszystkie aktywne |
| IncomingCallStackSelector |
Selektor, aby uzyskać aktywne i usunięte połączenia przychodzące. |
| IsCaptionLanguageChangedListener |
Wywołanie zwrotne dla zdarzenia "isCaptionLanguageChanged" dla CallAdapterSubscribers . |
| IsCaptionsActiveChangedListener |
Wywołanie zwrotne dla zdarzenia "isCaptionsActiveChanged" dla CallAdapterSubscribers . |
| IsLocalScreenSharingActiveChangedListener |
Wywołanie zwrotne dla CallAdapterSubscribers "isLocalScreenSharingActiveChanged". |
| IsMutedChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "isMuted". |
| IsSpeakingChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "isSpeakingChanged". |
| IsSpokenLanguageChangedListener |
Wywołanie zwrotne dla zdarzenia "isSpokenLanguageChanged" dla CallAdapterSubscribers . |
| LoadingState |
Niezależnie od tego, czy strumień jest ładowany, czy nie. |
| LocalScreenShareView | |
| LocalVideoTileSize |
Różne tryby lokalnego kafelka wideo |
| LocalizationProviderProps |
Podziękowania dla LocalizationProvider. |
| LongPressTrigger |
Sposoby, w jakie można przyczepić się do długich pras. |
| MediaAccess |
Stan dostępu do multimediów audio/wideo |
| MediaDiagnosticChangedEvent |
Ładunek dla DiagnosticChangedEventListner, w którym nastąpiła zmiana w diagnostyce multimediów. |
| Message |
Dyskryminowany związek wszystkich wiadomości. Pole |
| MessageAttachedStatus |
Określ, czy komunikat czatu powinien być wyświetlany jako scalony z wiadomością przed / po niej.
Jeśli |
| MessageContentType |
Obsługiwane typy zawartości wiadomości czatu. |
| MessageDeletedListener |
Wywołanie zwrotne dla zdarzenia "messageDeleted" dla ChatAdapterSubscriberss . |
| MessageEditedListener |
Wywołanie zwrotne dla zdarzenia "messageEdited" dla ChatAdapterSubscriberss . |
| MessageProps |
Rekwizyty do renderowania pojedynczego komunikatu. Zobacz MessageRenderer. |
| MessageReadListener |
Wywołanie zwrotne dla ChatAdapterSubscribers zdarzenia "messageRead". |
| MessageReceivedListener |
Wywołanie zwrotne dla ChatAdapterSubscribers zdarzenia "messageReceived". |
| MessageRenderer |
Składnik do renderowania pojedynczego komunikatu. |
| MessageSentListener |
Wywołanie zwrotne dla ChatAdapterSubscribers zdarzenia "messageSent". |
| MessageStatus |
Stan po stronie klienta wysłanego komunikatu. Obejmuje stany przejściowe, które występują przed potwierdzeniem dostarczania komunikatów z zaplecza. |
| MessageThreadProps |
Podziękowania dla MessageThread. |
| MessageThreadSelector |
Typ selektora dla składnika MessageThread. |
| MicrophoneButtonSelector |
Typ selektora dla składnika MicrophoneButton. |
| NetworkDiagnosticChangedEvent |
Ładunek dla DiagnosticChangedEventListner, w którym nastąpiła zmiana w diagnostyce sieciowej. |
| NotificationStackSelector |
Typ selektora dla komponentu Powiadomienie . |
| NotificationTarget | |
| NotificationType |
Wszystkie powiadomienia, które mogą być wyświetlane w NotificationStack. |
| OnFetchChatProfileCallback |
Funkcja wywołania zwrotnego służy do dostarczania niestandardowych danych w celu zbudowania profilu dla użytkownika lub bota. |
| OnFetchProfileCallback |
Funkcja wywołania zwrotnego służy do dostarczania niestandardowych danych w celu zbudowania profilu dla użytkownika lub bota. |
| OnRenderAvatarCallback |
Niestandardowe renderowane wywołanie zwrotne, które umożliwia użytkownikom dostosowywanie renderowania składnika Persona. |
| OverflowGalleryPosition |
Różne tryby i pozycje galerii przepełnienia w VideoGallery |
| ParticipantListParticipant |
Uczestnicy wyświetlani w Lista uczestników. |
| ParticipantListProps |
Podziękowania dla ParticipantList. |
| ParticipantListSelector |
Typ selektora dla składnika ParticipantList. |
| ParticipantMenuItemsCallback |
Wywołanie zwrotne do udostępniania niestandardowych elementów menu dla każdego uczestnika w UczestnikLista. |
| ParticipantState |
Stan połączenia uczestnika połączenia. |
| ParticipantsAddedListener |
Wywołanie zwrotne dla ChatAdapterSubscribers "uczestnicyDodaj". |
| ParticipantsButtonSelector |
Typ selektora dla składnika ParticipantsButton. |
| ParticipantsJoinedListener |
Wywołanie zwrotne dla CallAdapterSubscribers "uczestnicyJoined" zdarzenie. |
| ParticipantsLeftListener |
Wywołanie zwrotne dla CallAdapterSubscribers wydarzenia "uczestnicyLeft". |
| ParticipantsRemovedListener |
Wywołanie zwrotne dla ChatAdapterSubscribers "uczestnicyRemoved" wydarzenie. |
| Profile |
Profil użytkownika lub bota. |
| RaiseHandButtonSelector |
Typ selektora dla komponentu RaiseHandButton . |
| RaisedHand |
Stan podniesionej ręki z zamówieniem |
| RaisedHandState |
Stan podniesionej ręki z zamówieniem |
| Reaction |
Stan reakcji z typem reakcji do renderowania |
| ReactionButtonReaction |
Typy reakcji dla przycisku Reakcja |
| ReactionSprite |
Typ obrazu ikonki animacji i powiązanych metadanych |
| ReactionState |
Tylko stan wersji z właściwościami pomocnika <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> interfejsu użytkownika receivedOn. Stan reakcji ze znacznikiem czasu, który pomaga interfejsowi użytkownika podjąć decyzję o odpowiednim renderowaniu reakcji. |
| ReadReceiptsBySenderId |
Tablica par klucz-wartość, która przechowuje nazwę wyświetlaną każdego nadawcy i ostatni komunikat odczytu |
| RealTimeTextInformation |
informacje wymagane dla każdego wiersza tekstu w czasie rzeczywistym |
| RealTimeTextReceivedListener |
Wywołanie zwrotne dla zdarzenia "realTimeTextReceived" dla CallAdapterSubscribers . |
| ResourceDetails |
Szczegółowe informacje wymagane do pobrania zasobu do pamięci podręcznej. |
| ResourceFetchResult |
Wynik zasobu pobranego z klienta stanowego |
| ScreenShareButtonSelector |
Typ selektora dla składnika ScreenShareButton. |
| Selector |
Zoptymalizowany selektor, który uściśli ClientState aktualizacje do rekwizytów dla składników React w tej bibliotece. |
| SendBoxSelector |
Typ selektora dla składnika SendBox. |
| SoundEffect |
Typ reprezentujący niestandardowy dźwięk, który ma być używany w zdarzeniu wywołującym |
| Spotlight |
Stan reflektora z kolejnością |
| SpotlightChangedListener |
Wywołanie zwrotne dla zdarzenia "spotlightChanged" dla CallAdapterSubscribers . |
| StartCallIdentifier |
Typy identyfikatorów do inicjowania połączenia przy użyciu adaptera CallAdapter |
| StartCaptionsButtonSelector |
Typ selektora składnika StartCaptionsButton . |
| StatefulCallClientArgs |
Argumenty do konstruowania elementu StatefulCallClient. |
| StatefulCallClientOptions |
Opcje konstruowania elementu StatefulCallClient za pomocą polecenia . |
| StatefulChatClientArgs |
Argumenty do konstruowania StatefulChatClient. |
| StatefulChatClientOptions |
Opcje konstruowania StatefulChatClient. |
| SupportedCaptionLanguage | |
| SupportedSpokenLanguage | |
| SystemMessage |
Dyskryminowany związek wszystkich komunikatów systemowych. Pole |
| TeamsAdapterOptions |
Opcjonalne parametry do tworzenia TeamsCallAdapter |
| TeamsCallAdapterArgs |
Argumenty do tworzenia implementacji Azure Communication Services elementu TeamsCallAdapter. |
| TeamsCallAdapterArgsCommon |
Wspólna część args do tworzenia implementacji Azure Communication Services TeamsCallAdapter. |
| TeamsIncomingCallManagement |
Serwer proxy <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> interfejsu. |
| TogetherModeParticipantSeatingState |
Reprezentuje pozycje siedzące uczestników w trybie Razem. |
| TopicChangedListener |
Wywołanie zwrotne dla ChatAdapterSubscribers zdarzenia "topicChanged". |
| TransferAcceptedListener |
Wywołanie zwrotne dla zdarzenia "transferRequested" dla CallAdapterSubscriberss . |
| TypingIndicatorSelector |
Typ selektora dla składnika TypingIndicator. |
| UpdateMessageCallback |
Funkcja wywołania zwrotnego jest uruchamiana po zaktualizowaniu komunikatu. |
| VideoBackgroundEffect |
Zawiera atrybuty wybranego efektu tła wideo |
| VideoBackgroundEffectsDependency |
Typ zależności, który ma zostać wstrzyknięty dla efektów tła wideo |
| VideoGalleryLayout | |
| VideoGalleryParticipant |
Stan uczestnika VideoGallery. |
| VideoGallerySelector |
Typ selektora dla składnika VideoGallery. |
| VideoGalleryTogetherModeParticipantPosition |
Interfejs reprezentujący pozycję uczestnika w trybie Razem. |
| ViewScalingMode |
Tryb skalowania VideoGalleryStream. |
Funkcje
| Call |
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-calling%23CallAgent> Składniki wywołujące z tego pakietu muszą być opakowane za pomocą CallAgentProvider. |
| Call |
A <xref:React.Context> , który przechowuje StatefulCallClient. Wywoływanie składników z tego pakietu musi być opakowane za pomocą CallClientProvider. |
| Call |
Konfigurowalny kompozyt interfejsu użytkownika do obsługi połączeń. |
| Call |
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-calling%23Call> Składniki wywołujące z tego pakietu muszą być opakowane za pomocą elementu CallProvider. |
| Call |
CallWithChatComposite łączy kluczowe komponenty, aby zapewnić pełną rozmowę z doświadczeniem czatu po wyjęciu z pudełka. |
| Camera |
Przycisk do włączania/wyłączania kamery. Może być używany z aplikacją ControlBar. |
| Captions |
Składnik służący do wyświetlania elementu CaptionsBanner z ikoną użytkownika, nazwą displayName i tekstem napisów. |
| Captions |
Moduł do ustawiania języków mówionych |
| Chat |
A <xref:React.Context> , który przechowuje StatefulChatClient. Składniki czatu z tego pakietu muszą być opakowane za pomocą elementu ChatClientProvider. |
| Chat |
Konfigurowalny interfejs użytkownika do korzystania z czatu. |
| Chat |
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-chat%23ChatThreadClient> Składniki czatu z tego pakietu muszą być opakowane za pomocą elementu ChatThreadClientProvider. |
| Control |
Pojemnik na różne przyciski do sterowania połączeniami. Używaj z różnymi przyciskami sterowania połączeniami w tej bibliotece, np. CameraButton lub własnymi wystąpieniami ControlBarButton bezpośrednio. |
| Control |
Domyślny przycisk stylizowany na pasek sterowania. Użyj tego składnika, aby utworzyć przyciski niestandardowe, które są stylizowane tak samo, jak inne przyciski dostarczane przez bibliotekę interfejsu użytkownika. |
| Devices |
Przycisk otwierający menu sterujące opcjami urządzenia. Może być używany z aplikacją ControlBar. |
| Dialpad(Dialpad |
Komponent umożliwiający użytkownikom wprowadzanie numeru telefonu poprzez kliknięcie na klawiaturę numeryczną / za pomocą klawiatury Zwróci pusty komponent dla stabilnych kompilacji |
| End |
Przycisk umożliwiający zakończenie trwającego połączenia. Może być używany z aplikacją ControlBar. |
| Error |
Składnik do wyświetlania komunikatów o błędach w interfejsie użytkownika. Wszystkie ciągi, które mogą być wyświetlane, są akceptowane jako ciągi , dzięki czemu można je zlokalizować. Aktywne błędy są wybierane przez activeErrorMessages. Ten komponent wewnętrznie śledzi odrzucone przez użytkownika.
Używa <xref:%40fluentui%2Freact%23MessageBar> elementu interfejsu użytkownika. |
| Fluent |
Dostawca do zastosowania motywu Fluent w komponentach reactowych tej biblioteki. |
| Grid |
Składnik do układania kafelków uczestników audio/wideo w połączeniu. |
| Hold |
przycisk do zawieszania lub wznawiania trwającego połączenia. Może być używany z ControlBar |
| Image |
Komponent do renderowania pełnoekranowego modalnego dla wybranego obrazu. |
| Incoming |
Składnik Powiadomienie, który ma być używany do reprezentowania połączeń przychodzących do użytkownika końcowego. Umożliwia użytkownikowi odebranie lub odrzucenie połączenia przychodzącego. |
| Incoming |
Wrapper do zarządzania wieloma połączeniami przychodzącymi |
| Localization |
Dostawca zapewniający zlokalizowane ciągi znaków dla komponentów reactowych tej biblioteki. |
| Message |
Komponent do wyświetlania stanu wysłanej wiadomości. Dodaje ikonę i podpowiedź odpowiadające statusowi wiadomości. |
| Message |
|
| Microphone |
Przycisk do włączania/wyłączania mikrofonu. Może być używany z aplikacją ControlBar. |
| Notification(Notification |
Składnik do wyświetlania komunikatów powiadomień w interfejsie użytkownika. |
| Notification |
Składnik do wyświetlania powiadomień w interfejsie użytkownika. Wszystkie ciągi, które mogą być wyświetlane, są akceptowane jako ciągi , dzięki czemu można je zlokalizować. Aktywne powiadomienia są wybierane przez activeNotifications. Ten komponent wewnętrznie śledzi odrzucone przez użytkownika.
|
| Participant |
Komponent do renderowania uczestnika rozmowy lub czatu. Wyświetla awatar uczestnika, nazwę wyświetlaną i status, a także opcjonalne ikony i menu kontekstowe. |
| Participant |
Komponent do renderowania wszystkich uczestników rozmów lub czatu. Domyślnie każdy uczestnik jest renderowany za pomocą elementu ParticipantItem. Zobacz <xref:ParticipantListProps.onRenderParticipant> , aby zastąpić. |
| Participants |
Przycisk do wyświetlania menu z uczestnikami rozmów lub czatu. Może być używany z aplikacją ControlBar. Ten przycisk zawiera elementy menu rozwijanego zdefiniowane za pomocą jego właściwości |
| Raise |
Przycisk do rozpoczynania / zatrzymywania udostępniania ekranu. Może być używany z aplikacją ControlBar. |
| Reaction |
Przycisk do wysyłania reakcji. Może być używany z aplikacją ControlBar. |
| Real |
Komponent do wyświetlania pojedynczego wiersza RealTimeText |
| Real |
komponent dla modalnego realTimeText |
| Screen |
Przycisk do rozpoczynania / zatrzymywania udostępniania ekranu. Może być używany z aplikacją ControlBar. |
| Send |
Komponent do pisania i wysyłania wiadomości. Obsługuje wysyłanie powiadomień o pisaniu, gdy użytkownik zacznie wprowadzać tekst. Obsługuje opcjonalny komunikat poniżej pola wprowadzania tekstu. |
| Start |
Przycisk do uruchamiania i zatrzymywania napisów Może być używany z ControlBar |
| Start |
przycisk do uruchamiania RealTimeText w oparciu o wymagania dostępności, tekstu w czasie rzeczywistym nie można wyłączyć, gdy jest włączony Może być używany z ControlBar |
| Stream |
Komponent narzędziowy do konwersji pliku HTMLElement ze strumieniem wideo na element JSX. Służy do konwertowania obiektu HTMLElement zwracanego przez interfejs API wywoływania bezobsługowego na składnik, który może być renderowany jako obiekt VideoTile. |
| Typing |
Komponent powiadamiający użytkownika lokalnego, gdy jeden lub więcej uczestników wątku czatu pisze. |
| Video |
VideoGallery reprezentuje układ kafelków wideo dla określonego połączenia. Wyświetla kafelek VideoTile dla użytkownika lokalnego, a także dla każdego uczestnika zdalnego, który dołączył do rozmowy. |
| Video |
Komponent służący do renderowania strumienia wideo dla pojedynczego uczestnika rozmowy. Używanie z elementem GridLayout w galerii wideo. |
| create |
Utwórz adapter CallAdapter wspierany przez Azure Communication Services. Jest to domyślna implementacja CallAdapter dostarczana przez tę bibliotekę. Uwaga: |
| create |
Utwórz adapter CallAdapter wspierany przez Azure Communication Services. Jest to domyślna implementacja CallAdapter dostarczana przez tę bibliotekę. Uwaga: |
| create |
Utwórz element CallAdapter przy użyciu podanego elementu StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API. |
| create |
Utwórz element CallAdapter przy użyciu podanego elementu StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API. |
| create |
Utwórz CallWithChatAdapter wspierany przez Azure Communication Services, aby podłączyć się do CallWithChatComposite. |
| create |
Utwórz element CallWithChatAdapter przy użyciu podanych parametrów StatefulChatClient i StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do StatefulChatClient i StatefulCallClient. Należy pamiętać, że chatThreadClient musi zostać utworzony przez StatefulChatClient za pośrednictwem interfejsu API chatClient.getChatThreadClient(chatThreadId). Rozważ użycie createAzureCommunicationCallWithChatAdapter w celu uzyskania prostszego interfejsu API. |
| create |
Utwórz adapter ChatAdapter wspierany przez Azure Communication Services. Jest to domyślna implementacja ChatAdapter dostarczana przez tę bibliotekę. |
| create |
Utwórz element ChatAdapter przy użyciu podanego elementu StatefulChatClient. Przydatne, jeśli chcesz zachować odwołanie do StatefulChatClient. Rozważ użycie createAzureCommunicationChatAdapter , aby uzyskać prostszy interfejs API. |
| create |
Utwórz domyślną implementację CallingHandlers dla połączenia zespołowego. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| create |
Utwórz domyślną implementację programu ChatHandlers. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. Zwrócony obiekt jest zapamiętywany, aby uniknąć rerenderingu, gdy jest używany jako rekwizyt dla komponentów React. |
| create |
Utwórz domyślną implementację TeamsCallingHandlers dla połączenia zespołowego. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| create |
Tworzy StatefulCallClient StatefulCallClient przez proxyCallClient <xref:%40azure%2Fcommunication-calling%23CallClient> z ProxyCallClient <xref:ProxyCallClient> , który następnie zezwala na dostęp do stanu w sposób deklaratywny. Ważne jest, aby użyć and <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent> i <xref:%40azure%2Fcommunication-calling%23Call> (i itp.), które są uzyskiwane z StatefulCallClient, aby ich zmiany stanu były prawidłowo proxy. |
| create |
Tworzy stanowy ChatClient StatefulChatClient przez proxyClient <xref:%40azure%2Fcommunication-chat%23ChatClient> z ProxyChatClient <xref:ProxyChatClient> , który następnie zezwala na dostęp do stanu w sposób deklaratywny. |
| create |
|
| create |
Utwórz element TeamsCallAdapter przy użyciu podanego elementu StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API. |
| from |
Odwrotna operacja toFlatCommunicationIdentifier. |
| get |
Pobierz selektor dla określonego komponentu. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| get |
Pobierz selektor dla określonego komponentu. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| load |
Funkcja loader dla CallComposite, której możesz użyć w swojej aplikacji. Ta funkcja załaduje CallComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework interfejsu użytkownika Node, który nie jest oparty na React. |
| load |
Podziękowania dla CallWithChatComposite, których możesz użyć w swojej aplikacji. Ta funkcja załaduje CallWithChatComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React. |
| load |
Funkcja loadera dla ChatComposite, której możesz użyć w swojej aplikacji. Ta funkcja załaduje ChatComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React. |
| load |
Funkcja loader dla elementu OutboundCallComposite, której można użyć w aplikacji. Ta funkcja załaduje CallComposite do podanego elementu HTML w celu wykonywania połączeń wychodzących. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React. |
| on |
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania. |
| on |
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania. |
| on |
Rozpoznawanie zależności dla efektów tła wideo. |
| on |
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania. |
| to |
Reprezentacja ciągu znaków .<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> Ta reprezentacja ciągu CommunicationIdentifier jest gwarantowana, że będzie stabilna dla unikatowego użytkownika komunikacji. Tak więc,
|
| use |
Niestandardowy hook React, aby uprościć tworzenie CallAdapter. Podobny do createAzureCommunicationCallAdapter, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie. Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia. |
| use |
Niestandardowy hook React, aby uprościć tworzenie CallWithChatAdapter. Podobny do createAzureCommunicationCallWithChatAdapter, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie. Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia. |
| use |
Niestandardowy hook React, aby uprościć tworzenie ChatAdapter. Podobny do createAzureCommunicationChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie. Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia. |
| use |
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23Call> od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. musisz wcześniej użyć CallProvider z obiektem Call, aby użyć tego punktu zaczepienia |
| use |
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23CallAgent> od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Punkt zaczepienia, aby uzyskać StatefulCallClient od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Punkt zaczepienia, aby uzyskać StatefulChatClient od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Hak do uzyskania <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Hook, aby uzyskać StatefulDeviceManager od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Główny hook, aby pobrać z tej biblioteki wszystkie haki niezbędne dla komponentu React. Aby wywołać ten punkt zaczepienia, komponent musi być opakowany w następujące dostawców:
Najprostsze zastosowanie komponentu wygląda następująco: Przykład
|
| use |
Hook, aby uzyskać selektor dla określonego komponentu. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23TeamsCall> od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. musisz wcześniej używać CallProvider z obiektem TeamsCall, aby korzystać z tego punktu zaczepienia |
| use |
Niestandardowy hook React, aby uprościć tworzenie TeamsCallAdapter. Podobny do <xref:createTeamsAzureCommunicationCallAdapter>, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie. Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia. |
| use |
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> od dostawcy. Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki. |
| use |
Hook React, aby uzyskać dostęp do motywu |
Szczegóły funkcji
CallAgentProvider(CallAgentProviderProps)
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-calling%23CallAgent>
Składniki wywołujące z tego pakietu muszą być opakowane za pomocą CallAgentProvider.
function CallAgentProvider(props: CallAgentProviderProps): Element
Parametry
- props
- CallAgentProviderProps
Zwraca
Element
CallClientProvider(CallClientProviderProps)
A <xref:React.Context> , który przechowuje StatefulCallClient.
Wywoływanie składników z tego pakietu musi być opakowane za pomocą CallClientProvider.
function CallClientProvider(props: CallClientProviderProps): Element
Parametry
- props
- CallClientProviderProps
Zwraca
Element
CallComposite(CallCompositeProps)
Konfigurowalny kompozyt interfejsu użytkownika do obsługi połączeń.
function CallComposite(props: CallCompositeProps): Element
Parametry
- props
- CallCompositeProps
Zwraca
Element
Uwagi
Minimalna szerokość/wysokość połączenia złożonego jest następująca:
- Mobilny: 17,5 REM x 21 REM (280 x 336 pikseli, z domyślnym REM na 16 pikseli)
- Komputer stacjonarny: 30REM x 22REM (480PX x 352px, z domyślnym REM na 16px)
CallProvider(CallProviderProps)
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-calling%23Call>
Składniki wywołujące z tego pakietu muszą być opakowane za pomocą elementu CallProvider.
function CallProvider(props: CallProviderProps): Element
Parametry
- props
- CallProviderProps
Zwraca
Element
CallWithChatComposite(CallWithChatCompositeProps)
CallWithChatComposite łączy kluczowe komponenty, aby zapewnić pełną rozmowę z doświadczeniem czatu po wyjęciu z pudełka.
function CallWithChatComposite(props: CallWithChatCompositeProps): Element
Parametry
Zwraca
Element
CameraButton(CameraButtonProps)
Przycisk do włączania/wyłączania kamery.
Może być używany z aplikacją ControlBar.
function CameraButton(props: CameraButtonProps): Element
Parametry
- props
- CameraButtonProps
Zwraca
Element
CaptionsBanner(CaptionsBannerProps)
Składnik służący do wyświetlania elementu CaptionsBanner z ikoną użytkownika, nazwą displayName i tekstem napisów.
function CaptionsBanner(props: CaptionsBannerProps): Element
Parametry
- props
- CaptionsBannerProps
Zwraca
Element
CaptionsSettingsModal(CaptionsSettingsModalProps)
Moduł do ustawiania języków mówionych
function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element
Parametry
Zwraca
Element
ChatClientProvider(ChatClientProviderProps)
A <xref:React.Context> , który przechowuje StatefulChatClient.
Składniki czatu z tego pakietu muszą być opakowane za pomocą elementu ChatClientProvider.
function ChatClientProvider(props: ChatClientProviderProps): Element
Parametry
- props
- ChatClientProviderProps
Zwraca
Element
ChatComposite(ChatCompositeProps)
Konfigurowalny interfejs użytkownika do korzystania z czatu.
function ChatComposite(props: ChatCompositeProps): Element
Parametry
- props
- ChatCompositeProps
Zwraca
Element
Uwagi
Minimalna szerokość i wysokość czatu wynosi odpowiednio 17,5 i 20 rem (280 i 320 pikseli, z domyślnym czasem 16 pikseli)
ChatThreadClientProvider(ChatThreadClientProviderProps)
A<xref:React.Context>, w którym przechowywany jest plik .<xref:%40azure%2Fcommunication-chat%23ChatThreadClient>
Składniki czatu z tego pakietu muszą być opakowane za pomocą elementu ChatThreadClientProvider.
function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element
Parametry
Zwraca
Element
ControlBar(ControlBarProps)
Pojemnik na różne przyciski do sterowania połączeniami.
Używaj z różnymi przyciskami sterowania połączeniami w tej bibliotece, np. CameraButton lub własnymi wystąpieniami ControlBarButton bezpośrednio.
function ControlBar(props: ControlBarProps): Element
Parametry
- props
- ControlBarProps
Zwraca
Element
ControlBarButton(ControlBarButtonProps)
Domyślny przycisk stylizowany na pasek sterowania.
Użyj tego składnika, aby utworzyć przyciski niestandardowe, które są stylizowane tak samo, jak inne przyciski dostarczane przez bibliotekę interfejsu użytkownika.
function ControlBarButton(props: ControlBarButtonProps): Element
Parametry
- props
- ControlBarButtonProps
Zwraca
Element
DevicesButton(DevicesButtonProps)
Przycisk otwierający menu sterujące opcjami urządzenia.
Może być używany z aplikacją ControlBar.
function DevicesButton(props: DevicesButtonProps): Element
Parametry
- props
- DevicesButtonProps
Zwraca
Element
Dialpad(DialpadProps)
Komponent umożliwiający użytkownikom wprowadzanie numeru telefonu poprzez kliknięcie na klawiaturę numeryczną / za pomocą klawiatury Zwróci pusty komponent dla stabilnych kompilacji
function Dialpad(props: DialpadProps): Element
Parametry
- props
- DialpadProps
Zwraca
Element
EndCallButton(EndCallButtonProps)
Przycisk umożliwiający zakończenie trwającego połączenia.
Może być używany z aplikacją ControlBar.
function EndCallButton(props: EndCallButtonProps): Element
Parametry
- props
- EndCallButtonProps
Zwraca
Element
ErrorBar(ErrorBarProps)
Składnik do wyświetlania komunikatów o błędach w interfejsie użytkownika. Wszystkie ciągi, które mogą być wyświetlane, są akceptowane jako ciągi , dzięki czemu można je zlokalizować. Aktywne błędy są wybierane przez activeErrorMessages.
Ten komponent wewnętrznie śledzi odrzucone przez użytkownika.
- Błędy, które mają skojarzoną sygnaturę czasową: Błąd jest wyświetlany ponownie w interfejsie użytkownika, jeśli wystąpi po odrzuceniu.
- Błędy, które nie mają sygnatury czasowej: Błąd jest odrzucany, dopóki nie zniknie z właściwości. Jeśli błąd wystąpi ponownie, zostanie wyświetlony w interfejsie użytkownika.
Używa <xref:%40fluentui%2Freact%23MessageBar> elementu interfejsu użytkownika.
function ErrorBar(props: ErrorBarProps): Element
Parametry
- props
- ErrorBarProps
Zwraca
Element
FluentThemeProvider(FluentThemeProviderProps)
Dostawca do zastosowania motywu Fluent w komponentach reactowych tej biblioteki.
function FluentThemeProvider(props: FluentThemeProviderProps): Element
Parametry
- props
- FluentThemeProviderProps
Zwraca
Element
Uwagi
Składniki w tej bibliotece składają się głównie z interfejsu użytkownika Fluent, kontrolek, mieszania kontrolek v8 i v9. Ten dostawca obsługuje stosowanie dowolnego motywu dostarczonego do podstawowych kontrolek interfejsu użytkownika Fluent. *
GridLayout(GridLayoutProps)
Składnik do układania kafelków uczestników audio/wideo w połączeniu.
function GridLayout(props: GridLayoutProps): Element
Parametry
- props
- GridLayoutProps
Zwraca
Element
HoldButton(HoldButtonProps)
przycisk do zawieszania lub wznawiania trwającego połączenia.
Może być używany z ControlBar
function HoldButton(props: HoldButtonProps): Element
Parametry
- props
- HoldButtonProps
właściwości przycisku wstrzymania.
Zwraca
Element
ImageOverlay(ImageOverlayProps)
Komponent do renderowania pełnoekranowego modalnego dla wybranego obrazu.
function ImageOverlay(props: ImageOverlayProps): Element
Parametry
- props
- ImageOverlayProps
Zwraca
Element
IncomingCallNotification(IncomingCallNotificationProps)
Składnik Powiadomienie, który ma być używany do reprezentowania połączeń przychodzących do użytkownika końcowego. Umożliwia użytkownikowi odebranie lub odrzucenie połączenia przychodzącego.
function IncomingCallNotification(props: IncomingCallNotificationProps): Element
Parametry
Zwraca
Element
IncomingCallStack(IncomingCallStackProps)
Wrapper do zarządzania wieloma połączeniami przychodzącymi
function IncomingCallStack(props: IncomingCallStackProps): Element
Parametry
- props
- IncomingCallStackProps
<xref:IncomingCallManagerProps>
Zwraca
Element
LocalizationProvider(LocalizationProviderProps)
Dostawca zapewniający zlokalizowane ciągi znaków dla komponentów reactowych tej biblioteki.
function LocalizationProvider(props: LocalizationProviderProps): Element
Parametry
Zwraca
Element
Uwagi
Komponenty będą domyślnie dostarczane zlokalizowane ciągi w języku angielskim (USA), jeśli ten dostawca nie jest używany.
MessageStatusIndicator(MessageStatusIndicatorProps)
Komponent do wyświetlania stanu wysłanej wiadomości.
Dodaje ikonę i podpowiedź odpowiadające statusowi wiadomości.
function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element
Parametry
Zwraca
Element
MessageThread(MessageThreadProps)
MessageThread Umożliwia łatwe tworzenie komponentu do renderowania wiadomości czatu, obsługi przewijania nowych/starych wiadomości oraz dostosowywania ikon i kontrolek wewnątrz wątku czatu.
function MessageThread(props: MessageThreadProps): Element
Parametry
- props
- MessageThreadProps
typu MessageThreadProps
Użytkownicy będą musieli podać co najmniej wiadomości czatu i identyfikator użytkownika, aby renderować komponent.MessageThread
Użytkownicy mogą również dostosowaćMessageThread, MessageStatusIndicatorJumpToNewMessageButtonLoadPreviousMessagesButton przekazując własny awatar, ikonę i zachowanie tych elementów sterujących.
MessageThread wewnętrznie używa komponentu Chat z @fluentui-contrib/chat. Szczegółowe informacje na temat tych komponentów można znaleźć tutaj.
Zwraca
Element
MicrophoneButton(MicrophoneButtonProps)
Przycisk do włączania/wyłączania mikrofonu.
Może być używany z aplikacją ControlBar.
function MicrophoneButton(props: MicrophoneButtonProps): Element
Parametry
- props
- MicrophoneButtonProps
Zwraca
Element
Notification(NotificationProps)
Składnik do wyświetlania komunikatów powiadomień w interfejsie użytkownika.
function Notification(props: NotificationProps): Element
Parametry
- props
- NotificationProps
Zwraca
Element
NotificationStack(NotificationStackProps)
Składnik do wyświetlania powiadomień w interfejsie użytkownika. Wszystkie ciągi, które mogą być wyświetlane, są akceptowane jako ciągi , dzięki czemu można je zlokalizować. Aktywne powiadomienia są wybierane przez activeNotifications.
Ten komponent wewnętrznie śledzi odrzucone przez użytkownika.
- Powiadomienia, które mają skojarzoną sygnaturę czasową: powiadomienie jest ponownie wyświetlane w interfejsie użytkownika, jeśli wystąpi po odrzuceniu.
- Powiadomienia, które nie mają sygnatury czasowej: Powiadomienie jest odrzucane, dopóki nie zniknie z właściwości. Jeśli powiadomienie będzie się powtarzać, zostanie wyświetlone w interfejsie użytkownika.
function NotificationStack(props: NotificationStackProps): Element
Parametry
- props
- NotificationStackProps
Zwraca
Element
ParticipantItem(ParticipantItemProps)
Komponent do renderowania uczestnika rozmowy lub czatu.
Wyświetla awatar uczestnika, nazwę wyświetlaną i status, a także opcjonalne ikony i menu kontekstowe.
function ParticipantItem(props: ParticipantItemProps): Element
Parametry
- props
- ParticipantItemProps
Zwraca
Element
ParticipantList(ParticipantListProps)
Komponent do renderowania wszystkich uczestników rozmów lub czatu.
Domyślnie każdy uczestnik jest renderowany za pomocą elementu ParticipantItem. Zobacz <xref:ParticipantListProps.onRenderParticipant> , aby zastąpić.
function ParticipantList(props: ParticipantListProps): Element
Parametry
- props
- ParticipantListProps
Zwraca
Element
ParticipantsButton(ParticipantsButtonProps)
Przycisk do wyświetlania menu z uczestnikami rozmów lub czatu.
Może być używany z aplikacją ControlBar.
Ten przycisk zawiera elementy menu rozwijanego zdefiniowane za pomocą jego właściwości menuProps. Domyślnie może wyświetlać liczbę uczestników zdalnych z pełną listą jako podmenu i opcją wyciszenia wszystkich uczestników, a także przycisk kopiowania do schowka do kopiowania adresu URL zaproszenia do rozmowy.
Można to menuProps w pełni przedefiniować, a jego właściwość jest typu IContextualMenuProps.
function ParticipantsButton(props: ParticipantsButtonProps): Element
Parametry
- props
- ParticipantsButtonProps
Zwraca
Element
RaiseHandButton(RaiseHandButtonProps)
Przycisk do rozpoczynania / zatrzymywania udostępniania ekranu.
Może być używany z aplikacją ControlBar.
function RaiseHandButton(props: RaiseHandButtonProps): Element
Parametry
- props
- RaiseHandButtonProps
Zwraca
Element
ReactionButton(ReactionButtonProps)
Przycisk do wysyłania reakcji.
Może być używany z aplikacją ControlBar.
function ReactionButton(props: ReactionButtonProps): Element
Parametry
- props
- ReactionButtonProps
Zwraca
Element
RealTimeText(RealTimeTextProps)
Komponent do wyświetlania pojedynczego wiersza RealTimeText
function RealTimeText(props: RealTimeTextProps): Element
Parametry
- props
- RealTimeTextProps
Zwraca
Element
RealTimeTextModal(RealTimeTextModalProps)
komponent dla modalnego realTimeText
function RealTimeTextModal(props: RealTimeTextModalProps): Element
Parametry
- props
- RealTimeTextModalProps
Zwraca
Element
ScreenShareButton(ScreenShareButtonProps)
Przycisk do rozpoczynania / zatrzymywania udostępniania ekranu.
Może być używany z aplikacją ControlBar.
function ScreenShareButton(props: ScreenShareButtonProps): Element
Parametry
- props
- ScreenShareButtonProps
Zwraca
Element
SendBox(SendBoxProps)
Komponent do pisania i wysyłania wiadomości.
Obsługuje wysyłanie powiadomień o pisaniu, gdy użytkownik zacznie wprowadzać tekst. Obsługuje opcjonalny komunikat poniżej pola wprowadzania tekstu.
function SendBox(props: SendBoxProps): Element
Parametry
- props
- SendBoxProps
Zwraca
Element
StartCaptionsButton(StartCaptionsButtonProps)
Przycisk do uruchamiania i zatrzymywania napisów
Może być używany z ControlBar
function StartCaptionsButton(props: StartCaptionsButtonProps): Element
Parametry
- props
- StartCaptionsButtonProps
Właściwości przycisku Rozpocznij podpisy.
Zwraca
Element
StartRealTimeTextButton(StartRealTimeTextButtonProps)
przycisk do uruchamiania RealTimeText w oparciu o wymagania dostępności, tekstu w czasie rzeczywistym nie można wyłączyć, gdy jest włączony
Może być używany z ControlBar
function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element
Parametry
właściwości przycisku uruchamiania RealTimeText.
Zwraca
Element
StreamMedia(StreamMediaProps)
Komponent narzędziowy do konwersji pliku HTMLElement ze strumieniem wideo na element JSX.
Służy do konwertowania obiektu HTMLElement zwracanego przez interfejs API wywoływania bezobsługowego na składnik, który może być renderowany jako obiekt VideoTile.
function StreamMedia(props: StreamMediaProps): Element
Parametry
- props
- StreamMediaProps
Zwraca
Element
TypingIndicator(TypingIndicatorProps)
Komponent powiadamiający użytkownika lokalnego, gdy jeden lub więcej uczestników wątku czatu pisze.
function TypingIndicator(props: TypingIndicatorProps): Element
Parametry
- props
- TypingIndicatorProps
Zwraca
Element
VideoGallery(VideoGalleryProps)
VideoGallery reprezentuje układ kafelków wideo dla określonego połączenia. Wyświetla kafelek VideoTile dla użytkownika lokalnego, a także dla każdego uczestnika zdalnego, który dołączył do rozmowy.
function VideoGallery(props: VideoGalleryProps): Element
Parametry
- props
- VideoGalleryProps
Zwraca
Element
VideoTile(VideoTileProps)
Komponent służący do renderowania strumienia wideo dla pojedynczego uczestnika rozmowy.
Używanie z elementem GridLayout w galerii wideo.
function VideoTile(props: VideoTileProps): Element
Parametry
- props
- VideoTileProps
Zwraca
Element
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)
Utwórz adapter CallAdapter wspierany przez Azure Communication Services.
Jest to domyślna implementacja CallAdapter dostarczana przez tę bibliotekę.
Uwaga: displayName może mieć maksymalnie 256 znaków.
function createAzureCommunicationCallAdapter(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
Parametry
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)
Utwórz adapter CallAdapter wspierany przez Azure Communication Services.
Jest to domyślna implementacja CallAdapter dostarczana przez tę bibliotekę.
Uwaga: displayName może mieć maksymalnie 256 znaków.
function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>
Parametry
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)
Utwórz element CallAdapter przy użyciu podanego elementu StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parametry
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- targetCallees
- options
- CommonCallAdapterOptions
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)
Utwórz element CallAdapter przy użyciu podanego elementu StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parametry
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)
Utwórz CallWithChatAdapter wspierany przez Azure Communication Services, aby podłączyć się do CallWithChatComposite.
function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationCallWithChatAdapterArgs
Zwraca
Promise<CallWithChatAdapter>
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)
Utwórz element CallWithChatAdapter przy użyciu podanych parametrów StatefulChatClient i StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do StatefulChatClient i StatefulCallClient. Należy pamiętać, że chatThreadClient musi zostać utworzony przez StatefulChatClient za pośrednictwem interfejsu API chatClient.getChatThreadClient(chatThreadId). Rozważ użycie createAzureCommunicationCallWithChatAdapter w celu uzyskania prostszego interfejsu API.
function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationCallWithChatAdapterFromClientArgs
Zwraca
Promise<CallWithChatAdapter>
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)
Utwórz adapter ChatAdapter wspierany przez Azure Communication Services.
Jest to domyślna implementacja ChatAdapter dostarczana przez tę bibliotekę.
function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationChatAdapterArgs
Zwraca
Promise<ChatAdapter>
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)
Utwórz element ChatAdapter przy użyciu podanego elementu StatefulChatClient.
Przydatne, jeśli chcesz zachować odwołanie do StatefulChatClient. Rozważ użycie createAzureCommunicationChatAdapter , aby uzyskać prostszy interfejs API.
function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>
Parametry
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
- chatAdapterOptions
- ChatAdapterOptions
Zwraca
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call, CallingHandlersOptions)
Utwórz domyślną implementację CallingHandlers dla połączenia zespołowego.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call, options?: CallingHandlersOptions): CallingHandlers
Parametry
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
- options
- CallingHandlersOptions
Zwraca
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)
Utwórz domyślną implementację programu ChatHandlers.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
Zwrócony obiekt jest zapamiętywany, aby uniknąć rerenderingu, gdy jest używany jako rekwizyt dla komponentów React.
function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers
Parametry
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Zwraca
createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })
Utwórz domyślną implementację TeamsCallingHandlers dla połączenia zespołowego.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers
Parametry
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- deviceManager
- StatefulDeviceManager
- call
- TeamsCall
- options
-
{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }
Zwraca
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)
Tworzy StatefulCallClient StatefulCallClient przez proxyCallClient <xref:%40azure%2Fcommunication-calling%23CallClient> z ProxyCallClient <xref:ProxyCallClient> , który następnie zezwala na dostęp do stanu w sposób deklaratywny.
Ważne jest, aby użyć and <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent> i <xref:%40azure%2Fcommunication-calling%23Call> (i itp.), które są uzyskiwane z StatefulCallClient, aby ich zmiany stanu były prawidłowo proxy.
function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient
Parametry
Zwraca
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)
Tworzy stanowy ChatClient StatefulChatClient przez proxyClient <xref:%40azure%2Fcommunication-chat%23ChatClient> z ProxyChatClient <xref:ProxyChatClient> , który następnie zezwala na dostęp do stanu w sposób deklaratywny.
function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient
Parametry
- options
- StatefulChatClientOptions
Zwraca
createTeamsCallAdapter(TeamsCallAdapterArgs)
function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>
Parametry
- args
- TeamsCallAdapterArgs
Zwraca
Promise<TeamsCallAdapter>
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)
Utwórz element TeamsCallAdapter przy użyciu podanego elementu StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do StatefulCallClient. Rozważ użycie createAzureCommunicationCallAdapter w celu uzyskania prostszego interfejsu API.
function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>
Parametry
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
Zwraca
Promise<TeamsCallAdapter>
fromFlatCommunicationIdentifier(string)
Odwrotna operacja toFlatCommunicationIdentifier.
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
Parametry
- id
-
string
Zwraca
getCallingSelector<Component>(Component)
Pobierz selektor dla określonego komponentu.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function getCallingSelector<Component>(component: Component): GetCallingSelector<Component>
Parametry
- component
-
Component
Zwraca
GetCallingSelector<Component>
getChatSelector<Component>(Component)
Pobierz selektor dla określonego komponentu.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function getChatSelector<Component>(component: Component): GetChatSelector<Component>
Parametry
- component
-
Component
Zwraca
GetChatSelector<Component>
loadCallComposite(CallCompositeLoaderProps, HTMLElement)
Funkcja loader dla CallComposite, której możesz użyć w swojej aplikacji. Ta funkcja załaduje CallComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework interfejsu użytkownika Node, który nie jest oparty na React.
function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parametry
- loaderArgs
- CallCompositeLoaderProps
- htmlElement
-
HTMLElement
Zwraca
Promise<undefined | CallAdapter>
loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)
Podziękowania dla CallWithChatComposite, których możesz użyć w swojej aplikacji. Ta funkcja załaduje CallWithChatComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React.
function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>
Parametry
- loaderArgs
- CallWithChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Zwraca
Promise<undefined | CallWithChatAdapter>
loadChatComposite(ChatCompositeLoaderProps, HTMLElement)
Funkcja loadera dla ChatComposite, której możesz użyć w swojej aplikacji. Ta funkcja załaduje ChatComposite do podanego elementu HTML. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React.
function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>
Parametry
- loaderArgs
- ChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Zwraca
Promise<undefined | ChatAdapter>
loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)
Funkcja loader dla elementu OutboundCallComposite, której można użyć w aplikacji. Ta funkcja załaduje CallComposite do podanego elementu HTML w celu wykonywania połączeń wychodzących. Najlepszym przypadkiem użycia tego jest framework Node UI, który nie jest oparty na React.
function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parametry
- loaderArgs
- OutboundCallCompositeLoaderProps
- htmlElement
-
HTMLElement
Zwraca
Promise<undefined | CallAdapter>
onResolveDeepNoiseSuppressionDependency()
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania.
function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>
Zwraca
Promise<DeepNoiseSuppressionEffectDependency>
onResolveDeepNoiseSuppressionDependencyLazy()
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania.
function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>
Zwraca
Promise<DeepNoiseSuppressionEffectDependency>
onResolveVideoEffectDependency()
Rozpoznawanie zależności dla efektów tła wideo.
function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>
Zwraca
Promise<VideoBackgroundEffectsDependency>
onResolveVideoEffectDependencyLazy()
Rozwiązywanie zależności dla efektów tła wideo przy użyciu leniwego ładowania.
function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>
Zwraca
Promise<VideoBackgroundEffectsDependency>
toFlatCommunicationIdentifier(CommunicationIdentifier)
Reprezentacja ciągu znaków .<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>
Ta reprezentacja ciągu CommunicationIdentifier jest gwarantowana, że będzie stabilna dla unikatowego użytkownika komunikacji. Tak więc,
- Może służyć do utrwalania tożsamości użytkownika w zewnętrznych bazach danych.
- może być używany jako klucze do mapy do przechowywania danych dla użytkownika.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string
Parametry
- identifier
- CommunicationIdentifier
Zwraca
string
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
Niestandardowy hook React, aby uprościć tworzenie CallAdapter.
Podobny do createAzureCommunicationCallAdapter, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie.
Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia.
function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
Parametry
- afterCreate
-
(adapter: CallAdapter) => Promise<CallAdapter>
- beforeDispose
-
(adapter: CallAdapter) => Promise<void>
Zwraca
undefined | CallAdapter
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)
Niestandardowy hook React, aby uprościć tworzenie CallWithChatAdapter.
Podobny do createAzureCommunicationCallWithChatAdapter, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie.
Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia.
function useAzureCommunicationCallWithChatAdapter(args: Partial<AzureCommunicationCallWithChatAdapterArgs>, afterCreate?: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, beforeDispose?: (adapter: CallWithChatAdapter) => Promise<void>): undefined | CallWithChatAdapter
Parametry
- args
- afterCreate
-
(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>
- beforeDispose
-
(adapter: CallWithChatAdapter) => Promise<void>
Zwraca
undefined | CallWithChatAdapter
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)
Niestandardowy hook React, aby uprościć tworzenie ChatAdapter.
Podobny do createAzureCommunicationChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie.
Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia.
function useAzureCommunicationChatAdapter(args: Partial<AzureCommunicationChatAdapterArgs>, afterCreate?: (adapter: ChatAdapter) => Promise<ChatAdapter>, beforeDispose?: (adapter: ChatAdapter) => Promise<void>): undefined | ChatAdapter
Parametry
- args
-
Partial<AzureCommunicationChatAdapterArgs>
- afterCreate
-
(adapter: ChatAdapter) => Promise<ChatAdapter>
- beforeDispose
-
(adapter: ChatAdapter) => Promise<void>
Zwraca
undefined | ChatAdapter
useCall()
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23Call> od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
musisz wcześniej użyć CallProvider z obiektem Call, aby użyć tego punktu zaczepienia
function useCall(): undefined | Call
Zwraca
undefined | Call
useCallAgent()
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23CallAgent> od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useCallAgent(): undefined | CallAgent
Zwraca
undefined | CallAgent
useCallClient()
Punkt zaczepienia, aby uzyskać StatefulCallClient od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useCallClient(): StatefulCallClient
Zwraca
useChatClient()
Punkt zaczepienia, aby uzyskać StatefulChatClient od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useChatClient(): StatefulChatClient
Zwraca
useChatThreadClient()
Hak do uzyskania <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useChatThreadClient(): ChatThreadClient
Zwraca
useDeviceManager()
Hook, aby uzyskać StatefulDeviceManager od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useDeviceManager(): undefined | StatefulDeviceManager
Zwraca
undefined | StatefulDeviceManager
usePropsFor<Component>(Component, "chat" | "calling")
Główny hook, aby pobrać z tej biblioteki wszystkie haki niezbędne dla komponentu React.
Aby wywołać ten punkt zaczepienia, komponent musi być opakowany w następujące dostawców:
W przypadku składników czatu: ChatClientProvider i ChatThreadClientProvider.
Dla komponentów wywołujących: CallClientProvider, CallAgentProvider i CallAgentProvider.
Najprostsze zastosowanie komponentu wygląda następująco:
Przykład
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>
Parametry
- component
-
Component
- type
-
"chat" | "calling"
Zwraca
ComponentProps<Component>
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")
Hook, aby uzyskać selektor dla określonego komponentu.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useSelector<ParamT>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), type?: "chat" | "calling"): (ParamT extends Selector ? ReturnType<ParamT> : undefined)
Parametry
- selector
-
ParamT
- selectorProps
-
(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)
- type
-
"chat" | "calling"
Zwraca
(ParamT extends Selector ? ReturnType<ParamT> : undefined)
useTeamsCall()
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23TeamsCall> od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
musisz wcześniej używać CallProvider z obiektem TeamsCall, aby korzystać z tego punktu zaczepienia
function useTeamsCall(): undefined | TeamsCall
Zwraca
undefined | TeamsCall
useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)
Niestandardowy hook React, aby uprościć tworzenie TeamsCallAdapter.
Podobny do <xref:createTeamsAzureCommunicationCallAdapter>, ale zajmuje się asynchronicznym tworzeniem adaptera wewnętrznie.
Zezwala na niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguły punktów zaczepienia i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Należy pamiętać, że należy zapamiętać argumenty, aby uniknąć ponownego tworzenia adaptera przy każdym renderowaniu. Zobacz storybook, aby zapoznać się z typowymi przykładami użycia.
function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter
Parametry
- args
-
Partial<TeamsCallAdapterArgs>
- afterCreate
-
(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>
- beforeDispose
-
(adapter: TeamsCallAdapter) => Promise<void>
Zwraca
undefined | TeamsCallAdapter
useTeamsCallAgent()
Hak do uzyskania <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> od dostawcy.
Przydatne podczas implementowania komponentu niestandardowego, który wykorzystuje dostawców wyeksportowanych z tej biblioteki.
function useTeamsCallAgent(): undefined | TeamsCallAgent
Zwraca
undefined | TeamsCallAgent
useTheme()
Hook React, aby uzyskać dostęp do motywu
function useTheme(): Theme
Zwraca
Theme