@azure/communication-react package
Klasy
CallError |
Błąd zgłoszony z metod interfejsu API stanowego niepowodzenia. |
ChatError |
Zwrócony błąd z nieudanych metod StatefulChatClient . |
Interfejsy
ActiveErrorMessage |
Aktywne komunikaty o błędach, które mają być wyświetlane za pomocą paska błędów. |
AdapterError |
Błąd zgłaszany za pośrednictwem zdarzeń błędów i przechowywany w stanie karty. |
AdapterState |
Funkcjonalność komunikacji ze stanem karty złożonej. |
BaseCompositeProps |
Właściwości wspólne dla wszystkich elementów złożonych wyeksportowanych z tej biblioteki. |
BaseCustomStyles |
Podstawowe rekwizyty stylów płynnych dla wszystkich składników wyeksportowanych z tej biblioteki. |
CallAdapter |
Interfejs adaptera specyficzny dla tożsamości usługi Azure Communication, który rozszerza usługę 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 subskrybować. |
CallAgentProviderProps |
Argumenty inicjowania obiektu CallAgentProvider. |
CallAgentState |
State only version of <xref:%40azure%2Fcommunication-calling%23CallAgent> except calls is moved to be a child directly of CallClientState and not included here . Powodem, dla którego stan callAgent jest proxied jest zapewnienie dostępu do displayName. Nie spłaszczamy obiektu CallAgent.displayName i umieszczamy go w callClientState, ponieważ byłoby niejednoznaczne, że właściwość displayName jest w rzeczywistości zależna od tworzenia/istnienia klasy CallAgent, aby była dostępna. |
CallAndChatLocator |
Argumenty do użycia w funkcji createAzureCommunicationCallWithChatAdapter w celu dołączenia do połączenia ze skojarzonym wątkiem czatu. |
CallClientProviderProps |
Argumenty inicjowania obiektu CallClientProvider. |
CallClientState |
Kontener dla wszystkich danych stanu proxied przez StatefulCallClient. Wywołania, wywołaniaEnded, incomingCalls i stany incomingCallsEnded zostaną automatycznie dostarczone, jeśli zostanie utworzone wywołanie agenta. Menedżer urządzenia będzie początkowo pusty, dopóki nie zostanie wypełniony, zobacz DeviceManagerState. Stan userId jest dostarczany jako wygoda dla dewelopera i jest całkowicie sterowany i ustawiany przez dewelopera. |
CallCompositeProps |
Rekwizyty dla CallComposite. |
CallCompositeStrings |
Ciągi używane bezpośrednio przez obiekt CallComposite . Te ciągi są dodatkiem do tych używanych przez składniki z biblioteki składników. |
CallProviderProps |
Argumenty inicjowania obiektu CallProvider. |
CallState |
State only version of <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient automatycznie pobierze stan wywołania i doda go do stanu uwidocznionego przez StatefulCallClient. |
CallWithChatAdapter |
CallWithChatComposite Interfejs adaptera. |
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 callWithChat Composite. |
CallWithChatAdapterSubscriptions |
Zdarzenia rozmów i czatów, które można subskrybować w callWithChatAdapter. |
CallWithChatAdapterUiState |
Stan interfejsu użytkownika odnoszący się do obiektu CallWithChatComposite. |
CallWithChatClientState |
Stan z usług zaplecza, które są napędzane CallWithChatComposite. |
CallWithChatCompositeProps |
Rekwizyty wymagane dla callWithChatComposite |
CallWithChatCompositeStrings |
Ciągi używane bezpośrednio przez obiekt CallWithChatComposite . Te ciągi są dodatkiem do tych używanych przez składniki z biblioteki składników. |
CallWithChatControlOptions |
CallWithChatComposite Wywoływanie kontrolek w celu wyświetlania lub ukrywania przycisków na pasku sterowania wywołującym. |
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 motywu Fluent używana przez wywoływanie powiązanych składników w tej bibliotece. |
CameraButtonContextualMenuStyles |
Style menu CameraButton . |
CameraButtonProps |
Rekwizyty składnika CameraButton . |
CameraButtonStrings |
Ciągi cameraButton, które można zastąpić. |
CameraButtonStyles |
Style dla elementu CameraButton |
ChatAdapterSubscribers |
Zdarzenia złożone czatu, do których można zasubskrybować. |
ChatAdapterThreadManagement |
Funkcje zarządzania bieżącym wątkiem czatu. |
ChatCompositeProps |
Rekwizyty 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ść na czacie. |
CommonCallAdapter |
CallComposite Interfejs adaptera. |
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 elementów 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 składniki złożone, a nie przez zawarte składniki. |
ContentSystemMessage |
Komunikat systemowy z zawartością arbitary. |
ControlBarButtonProps |
Rekwizyty controlBarButton. |
ControlBarButtonStrings |
Ciągi ControlBarButton , które można zastąpić. |
ControlBarProps |
Rekwizyty dla kontrolki ControlBar. |
CreateVideoStreamViewResult |
Obiekt zwrócony po utworzeniu lokalnej lub zdalnej usługi VideoStream. Zawiera to funkcje pomocnicze do manipulowania renderowaniem strumienia. |
CustomMessage |
Niestandardowy typ komunikatu. Komunikaty niestandardowe nie są domyślnie renderowane, ale aplikacje mogą udostępniać niestandardowe programy renderowane dla nich. |
DevicesButtonContextualMenuStyles |
Style menu DevicesButton . |
DevicesButtonProps |
Rekwizyty dla urządzeniaButton. |
DevicesButtonStrings |
Ciągi elementu DevicesButton , które można zastąpić. |
DevicesButtonStyles |
Style elementów menu przycisków Urządzenia. |
DiagnosticsCallFeatureState |
Tylko serwer proxy stanu dla programu <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>. |
Disposable |
Funkcje prawidłowego dysponowania złożonego. |
EndCallButtonProps |
Rekwizyty endCallButton. |
EndCallButtonStrings |
Ciągi EndCallButton , które można zastąpić. |
ErrorBarProps |
Rekwizyty dla elementu ErrorBar. Oprócz poniższego , pasek ErrorBar przekazuje wszystkie <xref:%40fluentui%2Freact%23IMessageBarProps> dane do bazowego <xref:%40fluentui%2Freact%23MessageBar>elementu . |
ErrorBarStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika na pasku Błędów. |
FluentThemeProviderProps |
Rekwizyty dla FluentThemeProvider. |
GridLayoutProps |
Rekwizyty dla GridLayout. |
GridLayoutStyles |
GridLayout Style składników. |
HorizontalGalleryStyles |
<xref:HorizontalGallery> Style składników. |
IncomingCallState |
Stan tylko wersja .<xref:%40azure%2Fcommunication-calling%23IncomingCall> Element StatefulCallClient automatycznie wykryje wywołania przychodzące i doda stan do stanu uwidocznionego przez element StatefulCallClient. |
JumpToNewMessageButtonProps |
Argumenty dla <xref:MessageThreadProps.onRenderJumpToNewMessageButton>. |
LocalVideoCameraCycleButtonProps | |
LocalVideoStreamState |
Stan tylko wersja .<xref:%40azure%2Fcommunication-calling%23LocalVideoStream> |
MediaDiagnosticsState |
Tylko serwer proxy stanu dla programu <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>. |
MessageCommon |
Typowe właściwości wszystkich typów komunikatów. |
MessageStatusIndicatorProps |
Props for MessageStatusIndicator. |
MessageStatusIndicatorStrings |
Ciągi modułu MessageStatusIndicator , które można zastąpić. |
MessageThreadStrings |
Ciągi messageThread , które można zastąpić. |
MessageThreadStyles |
Płynne style dla elementu MessageThread. |
MicrophoneButtonContextualMenuStyles |
Style menu MicrophoneButton . |
MicrophoneButtonProps |
Rekwizyty mikrofonu. |
MicrophoneButtonStrings |
Ciągi microphoneButton , które można zastąpić. |
MicrophoneButtonStyles |
Style elementu MicrophoneButton |
NetworkDiagnosticsState |
Stan tylko serwer proxy dla .<xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics> |
OptionsDevice |
Urządzenie, np. aparat, mikrofon lub głośnik, w wysuwanym okienku DevicesButton . |
ParticipantAddedSystemMessage |
Komunikat systemowy z powiadomieniem, że uczestnik został dodany do wątku czatu. |
ParticipantItemProps |
Rekwizyty uczestnika. |
ParticipantItemStrings |
Ciągi elementu Uczestnika , które można zastąpić. |
ParticipantItemStyles |
Style języka Fluent dla elementu uczestnika. |
ParticipantListItemStyles |
Style elementu Uczestnika listy uczestników. |
ParticipantListStyles |
Style listy uczestników. |
ParticipantRemovedSystemMessage |
Komunikat systemowy z powiadomieniem, że uczestnik został usunięty z wątku czatu. |
ParticipantsButtonContextualMenuStyles |
Style menu UczestnicyButton . |
ParticipantsButtonProps |
Rekwizyty dla uczestnikówButton. |
ParticipantsButtonStrings |
Ciągi elementów ParticipantsButton , które można zastąpić. |
ParticipantsButtonStyles |
Style Props for ParticipantsButton. |
RecordingCallFeature |
State only version of <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient będzie automatycznie nasłuchiwać stanu rejestrowania wywołania i odpowiednio zaktualizować stan uwidoczniony przez StatefulCallClient . |
RemoteParticipantState |
State only version of <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. Element StatefulCallClient automatycznie pobierze klasy RemoteParticipants i doda stan do stanu uwidocznionego przez statefulCallClient. |
RemoteVideoStreamState |
State only version of <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>. |
ScreenShareButtonProps |
Rekwizyty screenShareButton. |
ScreenShareButtonStrings |
Ciągi ScreenShareButton , które można zastąpić. |
SendBoxProps |
Rekwizyty dla SendBox. |
SendBoxStrings |
Ciągi SendBox , które można zastąpić. |
SendBoxStylesProps |
Style Fluent dla elementu <xref:Sendbox>. |
StatefulCallClient |
Definiuje metody, które umożliwiają używanie klasy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> w sposób stanowy. 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 wierzchu <xref:%40azure%2Fcommunication-calling%23DeviceManager>. |
StreamMediaProps |
Rekwizyty dla usługi StreamMedia. |
SystemMessageCommon |
Typowe właściwości wszystkich komunikatów systemowych. |
TopicUpdatedSystemMessage |
Komunikat systemowy z powiadomieniem, że temat wątku czatu został zaktualizowany. |
TranscriptionCallFeature |
Stan tylko wersja .<xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature> Element StatefulCallClient będzie automatycznie nasłuchiwać stanu transkrypcji wywołania i odpowiednio zaktualizować stan uwidoczniony przez element StatefulCallClient . |
TypingIndicatorProps |
Elementy props for TypingIndicator. |
TypingIndicatorStrings |
Ciągi typingIndicator , które można zastąpić. |
TypingIndicatorStylesProps |
Style fluent dla typingIndicator. |
VideoGalleryProps | |
VideoGalleryRemoteParticipant |
Stan uczestnika zdalnego w VideoGallery. |
VideoGalleryStream |
Strumień wideo uczestnika w VideoGallery. |
VideoGalleryStrings |
Wszystkie ciągi, które mogą być wyświetlane w interfejsie użytkownika w usłudze VideoGallery. |
VideoGalleryStyles |
VideoGallery Style składników. |
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 element StatefulCallClient przez element createView i usunięta przez element disposeView. |
VideoTileProps |
Rekwizyty dla VideoTile. |
VideoTileStylesProps |
Style fluent dla VideoTile. |
Aliasy typu
AdapterErrors |
Karty przechowują najnowszy błąd dla każdej operacji w stanie.
|
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, czy 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 tworzenia Azure Communication Services implementacji callAdapter. Uwaga: |
AzureCommunicationCallWithChatAdapterArgs |
Argumenty dla createAzureCommunicationCallWithChatAdapter |
AzureCommunicationCallWithChatAdapterFromClientArgs |
Argumenty dla <xref:createAzureCommunicationCallWithChatAdapterFromClient> |
AzureCommunicationChatAdapterArgs |
Argumenty tworzenia Azure Communication Services implementacji ChatAdapter. |
CallAdapterCallEndedEvent |
Ładunek elementu CallEndedListener zawierający szczegółowe informacje na temat zakończonego wywołania. |
CallAdapterClientState |
Stan CommonCallAdapter wywnioskowany z zaplecza Azure Communication Services. |
CallAdapterLocator |
Lokalizator używany przez polecenie createAzureCommunicationCallAdapter w celu zlokalizowania wywołania sprzężenia |
CallAdapterState | |
CallAdapterUiState |
Stan CommonCallAdapter dla czystych celów interfejsu użytkownika. |
CallCompositeIcons |
Ikony, które można zastąpić dla callComposite. |
CallCompositeOptions |
Funkcje opcjonalne obiektu CallComposite. |
CallCompositePage |
Główne ekrany interfejsu użytkownika wyświetlane w aplikacji CallComposite. |
CallControlDisplayType |
Typ wyświetlania paska sterowania dla callComposite. |
CallControlOptions |
Opcje dostosowywania paska sterowania w środowisku wywoływania. |
CallEndedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "callEnded". |
CallErrorBarSelector |
Typ selektora 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 wywołującego zestawu 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 elementu <xref:newClearCallErrorsModifier>. Ponadto błędy są automatycznie czyszczone, gdy:
|
CallIdChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "callIdChanged". |
CallParticipantListParticipant |
Wywoływanie stanu uczestnika, jak pokazano w składnikach interfejsu użytkownika. |
CallWithChatCompositeIcons |
Ikony, które można zastąpić dla CallWithChatComposite. |
CallWithChatCompositeOptions |
Funkcje opcjonalne obiektu CallWithChatComposite. |
CallWithChatEvent |
Zdarzenia wyzwolone przez CallWithChatAdapter. |
CallingBaseSelectorProps |
Typowe rekwizyty używane do odwoływania się do wywoływania stanu klienta deklaratywnego. |
CallingReturnProps |
Typ pomocnika usePropsFor. |
CameraButtonSelector |
Typ selektora składnika CameraButton . |
ChatAdapter |
ChatComposite Interfejs adaptera. |
ChatAdapterState | |
ChatAdapterUiState |
Stan ChatAdapter dla czystych celów interfejsu użytkownika. |
ChatBaseSelectorProps |
Typowe rekwizyty selektorów elementu ChatClientState. |
ChatClientProviderProps |
Argumenty inicjowania obiektu ChatClientProvider. |
ChatClientState |
Scentralizowany stan dla programu <xref:%40azure%2Fcommunication-chat%23ChatClient>. |
ChatCompositeClientState |
Stan ChatAdapter wywnioskowany z zaplecza Azure Communication Services. |
ChatCompositeIcons |
Ikony, które można zastąpić dla chatComposite. |
ChatCompositeOptions |
Funkcje opcjonalne obiektu ChatComposite. |
ChatErrorBarSelector |
Typ selektora składnika ErrorBar . |
ChatErrorTarget |
Typ literału ciągu dla wszystkich dozwolonych kluczy w usłudze 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. |
ChatMessageWithStatus |
Rozszerzenie do <xref:%40azure%2Fcommunication-chat%23ChatMessage> tego przechowuje metadane tylko po stronie klienta dla wiadomości czatu. TODO: Nazwa została bitrotted. Zmień nazwę mnie. |
ChatParticipantListSelector |
Typ selektora składnika ParticipantList . |
ChatReturnProps |
Typ pomocnika usePropsFor. |
ChatThreadClientProviderProps |
Argumenty inicjowania obiektu ChatThreadClientProvider. |
ChatThreadClientState |
Scentralizowany stan dla programu <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. |
ChatThreadProperties |
Właściwości wątku czatu. Definiujemy minimalną, która pomaga ukryć różne typy używane przez bazowy interfejs API. |
ClientState |
Stan scentralizowany dla lub <xref:%40azure%2Fcommunication-calling%23CallClient><xref:%40azure%2Fcommunication-chat%23ChatClient>. Zobacz również: CallClientState, ChatClientState. |
Common |
Zwracanie typu przeciętego 2 typów |
CommonProperties |
Zwracanie właściwości przecinających 2 typów |
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 usePropsFor. |
CompositeIcons |
Ikony, które można zastąpić w jednym z obiektów złożonych wyeksportowanych przez tę bibliotekę. Aby uzyskać więcej docelowych typów, zobacz ChatCompositeIcons, CallCompositeIcons i CallWithChatCompositeIcons . |
ControlBarButtonStyles |
Style dla wszystkich implementacji ControlBarButton . |
ControlBarLayout |
Prezentowanie układów dla kontrolki ControlBar. |
CreateViewResult |
Zwraca wynik z elementu createView. |
CustomAvatarOptions |
Opcje, które można wstrzyknąć do |
DeviceManagerState |
Ten typ ma hermetyzować cały stan wewnątrz <xref:%40azure%2Fcommunication-calling%23DeviceManager>elementu . W przypadku parametrów opcjonalnych mogą nie być dostępne, dopóki użytkownik nie przyzna uprawnień. Kamery, mikrofony, głośniki i stany deviceAccess będą puste do momentu <xref:%40azure%2Fcommunication-calling%23DeviceManager>wywołania i zakończenia odpowiednich interfejsów API getCameras, getMicrophones, getSpeakers i askDevicePermission API. |
DevicesButtonSelector |
Typ selektora dla składnika DevicesButton . |
DiagnosticChangedEventListner |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "diagnosticChanged". |
DisplayNameChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "displayNameChanged". |
EmptySelector |
Typ selektorów trywialnych, które nie zwracają żadnych danych. Używana jako domyślna wartość zwracana, jeśli parametr usePropsFor jest wywoływany dla składnika, który nie wymaga danych. |
ErrorType |
Wszystkie błędy, które można wyświetlić na pasku błędów. |
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. |
IsLocalScreenSharingActiveChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "isLocalScreenSharingActiveChanged". |
IsMutedChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "isMuted". |
IsSpeakingChangedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "isSpeakingChanged". |
LoadingState |
Niezależnie od tego, czy strumień jest ładowany, czy nie. |
LocalizationProviderProps |
Rekwizyty dla LocalizationProvider. |
MediaDiagnosticChangedEvent |
Ładunek dla diagnosticChangedEventListner , w którym nastąpiła zmiana w diagnostyce multimediów. |
Message |
Dyskryminowany związek wszystkich komunikatów. Pole |
MessageAttachedStatus |
Określ, czy wiadomość czatu powinna zostać scalona z komunikatem przed /po nim. Przydatne do scalania wielu komunikatów z tego samego nadawcy do pojedynczego bąbelka komunikatów. |
MessageContentType |
Obsługiwane typy zawartości wiadomości czatu. |
MessageProps |
Rekwizyty do renderowania pojedynczego komunikatu. Zobacz MessageRenderer. |
MessageReadListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "messageRead". |
MessageReceivedListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "messageReceived". |
MessageRenderer |
Składnik do renderowania pojedynczego komunikatu. |
MessageSentListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "messageSent ". |
MessageStatus |
Stan po stronie klienta wysłanej wiadomości. Obejmuje stany przejściowe, które występują przed potwierdzeniem dostarczania komunikatów z zaplecza. |
MessageThreadProps |
Rekwizyty dla messageThread. |
MessageThreadSelector |
Typ selektora składnika MessageThread . |
MicrophoneButtonSelector |
Typ selektora dla składnika MicrophoneButton . |
NetworkDiagnosticChangedEvent |
Ładunek dla diagnosticChangedEventListner , w którym nastąpiła zmiana w diagnostyce sieciowej. |
OnRenderAvatarCallback |
Niestandardowe renderowane wywołanie zwrotne, które umożliwia użytkownikom dostosowywanie renderowania składnika Persona. |
ParticipantListParticipant |
Uczestnicy wyświetlani w liście uczestników. |
ParticipantListProps |
Rekwizyty dla listy uczestników. |
ParticipantListSelector |
Typ selektora składnika ParticipantList . |
ParticipantMenuItemsCallback |
Wywołanie zwrotne do udostępniania niestandardowych elementów menu dla każdego uczestnika w liście uczestników. |
ParticipantState |
Stan połączenia uczestnika połączenia. |
ParticipantsAddedListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "uczestnicyDodaj". |
ParticipantsButtonSelector |
Typ selektora dla składnika ParticipantsButton . |
ParticipantsJoinedListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "participantsJoined". |
ParticipantsLeftListener |
Wywołanie zwrotne dla zdarzenia CallAdapterSubscribers "uczestnicyLeft". |
ParticipantsRemovedListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "uczestnicyRemoved". |
ReadReceiptsBySenderId |
Tablica par klucz-wartość, która przechowuje nazwę wyświetlaną każdego nadawcy i ostatni komunikat odczytu |
ScreenShareButtonSelector |
Typ selektora dla składnika ScreenShareButton . |
Selector |
Zoptymalizowany selektor, który uściśli aktualizację ClientState na rekwizyty dla składników React w tej bibliotece. |
SendBoxSelector |
Typ selektora składnika SendBox . |
StatefulCallClientArgs |
Argumenty do konstruowania elementu StatefulCallClient. |
StatefulCallClientOptions |
Opcje konstruowania elementu StatefulCallClient za pomocą polecenia . |
StatefulChatClientArgs |
Argumenty do konstruowania elementu StatefulChatClient. |
StatefulChatClientOptions |
Opcje konstruowania elementu StatefulChatClient. |
SystemMessage |
Dyskryminowany związek wszystkich komunikatów systemowych. Pole |
TopicChangedListener |
Wywołanie zwrotne dla zdarzenia ChatAdapterSubscribers "topicChanged". |
TypingIndicatorSelector | |
UpdateMessageCallback |
Funkcja wywołania zwrotnego jest uruchamiana po zaktualizowaniu komunikatu. |
VideoGalleryLayout | |
VideoGalleryLocalParticipant |
Stan lokalnego uczestnika w VideoGallery. |
VideoGalleryParticipant |
Stan uczestnika w VideoGallery. |
VideoGallerySelector |
Typ selektora dla składnika VideoGallery . |
ViewScalingMode |
Tryb skalowania elementu VideoGalleryStream. |
Funkcje
Call |
Element <xref:React.Context> , który przechowuje element <xref:%40azure%2Fcommunication-calling%23CallAgent>. Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallAgentProvider. |
Call |
Element <xref:React.Context> , który przechowuje element StatefulCallClient. Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallClientProvider. |
Call |
Dostosowywalny złożony interfejs użytkownika do wywoływania. |
Call |
Element <xref:React.Context> , który przechowuje element <xref:%40azure%2Fcommunication-calling%23Call>. Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallProvider. |
Call |
CallWithChatComposite łączy kluczowe składniki, aby zapewnić pełne połączenie z funkcją czatu. |
Camera |
Przycisk włączania/wyłączania aparatu. Może być używany z kontrolką ControlBar. |
Chat |
Element <xref:React.Context> , który przechowuje element StatefulChatClient. Składniki czatu z tego pakietu muszą być opakowane przy użyciu obiektu ChatClientProvider. |
Chat |
Dostosowywalny interfejs użytkownika złożony do obsługi czatu. |
Chat |
Element <xref:React.Context> , który przechowuje element <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Składniki czatu z tego pakietu muszą być opakowane za pomocą elementu ChatThreadClientProvider. |
Control |
Kontener dla różnych przycisków dla kontrolek wywołań. Użyj różnych przycisków sterowania wywołaniami w tej bibliotece, np. CameraButton lub własnych wystąpień kontrolki ControlBarButton bezpośrednio. |
Control |
Domyślny przycisk w stylu KontrolkaBar. Użyj tego składnika, aby utworzyć niestandardowe przyciski, które są stylizowane tak samo jak inne przyciski udostępniane przez bibliotekę interfejsu użytkownika. |
Devices |
Przycisk umożliwiający otwarcie menu, które kontroluje opcje urządzenia. Może być używany z kontrolką ControlBar. |
End |
Przycisk umożliwiający zakończenie trwającego połączenia. Może być używany z kontrolką ControlBar. |
Error |
Składnik do wyświetlania komunikatów o błędach w interfejsie użytkownika. Wszystkie ciągi, które można wyświetlić, są akceptowane jako ciągi , aby można je było lokalizować. Aktywne błędy są wybierane przez element activeErrorMessages. Ten składnik wewnętrznie śledzi odrzucone przez użytkownika.
Używa <xref:%40fluentui%2Freact%23MessageBar> elementu interfejsu użytkownika. |
Fluent |
Dostawca do stosowania motywu Fluent w składnikach react tej biblioteki. |
Grid |
Składnik do układania kafelków audio/wideo uczestników w wywołaniu. |
Localization |
Dostawca dostarczający zlokalizowane ciągi dla składników react tej biblioteki. |
Message |
Składnik do wyświetlania stanu wysłanego komunikatu. Dodaje ikonę i etykietkę narzędzia odpowiadającą stanowi komunikatu. |
Message |
|
Microphone |
Przycisk włączania/wyłączania mikrofonu. Może być używany z kontrolką ControlBar. |
Participant |
Składnik do renderowania uczestnika rozmowy lub czatu. Wyświetla awatar uczestnika, displayName i status, a także opcjonalne ikony i menu kontekstowe. |
Participant |
Składnik umożliwiający renderowanie wszystkich rozmów lub uczestników czatu. Domyślnie każdy uczestnik jest renderowany z elementem Uczestnika. Zobacz <xref:ParticipantListProps.onRenderParticipant> , aby zastąpić. |
Participants |
Przycisk umożliwiający wyświetlenie menu z połączeniami lub uczestnikami czatu. Może być używany z kontrolką ControlBar. Ten przycisk zawiera elementy menu rozwijanego zdefiniowane za pośrednictwem jego właściwości |
Screen |
Przycisk uruchamiania/zatrzymywania udostępniania ekranu. Może być używany z kontrolką ControlBar. |
Send |
Składnik do wpisywania i wysyłania komunikatów. Obsługuje wysyłanie powiadomienia o wpisywaniu podczas wpisywania tekstu przez użytkownika. Obsługuje opcjonalny komunikat poniżej pola wprowadzania tekstu. |
Stream |
Składnik narzędzia do konwertowania elementu HTMLElement ze strumieniem wideo na element JSX. Służy do konwertowania elementu HTML Zwracanego przez bezgłowy interfejs API wywołania do składnika, który może być renderowany jako Element VideoTile. |
Typing |
Składnik do powiadamiania użytkownika lokalnego, gdy co najmniej jeden uczestnik wątku czatu jest wpisywany. |
Video |
VideoGallery reprezentuje układ kafelków wideo dla określonego wywołania. Wyświetla on element VideoTile dla użytkownika lokalnego, a także dla każdego uczestnika zdalnego, który dołączył do połączenia. |
Video |
Składnik do renderowania strumienia wideo dla pojedynczego uczestnika wywołania. Używanie z funkcją GridLayout w galerii VideoGallery. |
create |
Utwórz obiekt CallAdapter wspierany przez Azure Communication Services. Jest to domyślna implementacja elementu CallAdapter dostarczonego przez tę bibliotekę. Uwaga: |
create |
Utwórz obiekt CallAdapter przy użyciu podanego elementu StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do elementu StatefulCallClient. Rozważ użycie polecenia createAzureCommunicationCallAdapter , aby uzyskać prostszy interfejs API. |
create |
Utwórz obiekt CallWithChatAdapter wspierany przez usługi Azure Communication, aby podłączyć element CallWithChatComposite. |
create |
Utwórz obiekt CallWithChatAdapter przy użyciu podanych elementów StatefulChatClient i StatefulCallClient. Przydatne, jeśli chcesz zachować odwołanie do statefulChatClient i StatefulCallClient. Rozważ użycie polecenia createAzureCommunicationCallWithChatAdapter , aby uzyskać prostszy interfejs API. |
create |
Utwórz element ChatAdapter wspierany przez Azure Communication Services. Jest to domyślna implementacja aplikacji ChatAdapter dostarczonej przez tę bibliotekę. |
create |
Utwórz obiekt ChatAdapter przy użyciu podanego elementu StatefulChatClient. Przydatne, jeśli chcesz zachować odwołanie do elementu StatefulChatClient. Rozważ użycie polecenia createAzureCommunicationChatAdapter , aby uzyskać prostszy interfejs API. |
create |
Utwórz domyślną implementację wywołań callHandlers dla zespołów. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
create |
Utwórz domyślną implementację programu ChatHandlers. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. Zwracany obiekt jest zapamiętywane, aby uniknąć rerenders, gdy są używane jako rekwizyty dla React Components. |
create |
Tworzy element StatefulCallClient StatefulCallClient przez serwer proxy CallClient za pomocą elementu ProxyCallClient <xref:%40azure%2Fcommunication-calling%23CallClient><xref:ProxyCallClient> , który następnie umożliwia dostęp do stanu w sposób deklaratywny. Ważne jest, aby używać elementów <xref:%40azure%2Fcommunication-calling%23DeviceManager> i i <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (i itp.), które są uzyskiwane z klasy StatefulCallClient, aby ich zmiany stanu były prawidłowo proxied. |
create |
Tworzy stanowy obiekt ChatClient StatefulChatClient przez serwer proxy ChatClient za pomocą elementu ProxyChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient><xref:ProxyChatClient> , który następnie umożliwia dostęp do stanu w sposób deklaratywny. |
from |
Odwrotna operacja toFlatCommunicationIdentifier. |
get |
Pobierz selektor dla określonego składnika. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
get |
Pobierz selektor dla określonego składnika. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
to |
Reprezentacja ciągu elementu <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Ta reprezentacja ciągu elementu CommunicationIdentifier gwarantuje stabilność dla unikatowego użytkownika komunikacji. Tak więc,
|
use |
Niestandardowy punkt zaczepienia React, który upraszcza tworzenie obiektu CallAdapter. Podobnie jak w przypadku polecenia createAzureCommunicationCallAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie. Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, aby zapoznać się z typowymi przykładami użycia. |
use |
Niestandardowy punkt zaczepienia React, który upraszcza tworzenie elementu CallWithChatAdapter. Podobnie jak w przypadku polecenia createAzureCommunicationCallWithChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie. Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, aby zapoznać się z typowymi przykładami użycia. |
use |
Niestandardowy hak React, aby uprościć tworzenie ChatAdapter. Podobnie jak w przypadku tworzeniaazureCommunicationChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie. Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane. Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, aby zapoznać się z typowymi przykładami użycia. |
use |
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-calling%23Call> od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. Aby użyć tego elementu zaczepienia, musisz wcześniej użyć obiektu CallProvider z obiektem Call |
use |
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-calling%23CallAgent> od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
Punkt zaczepienia w celu uzyskania elementu StatefulCallClient od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
Punkt zaczepienia w celu uzyskania elementu StatefulChatClient od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
Punkt zaczepienia w celu uzyskania elementu StatefulDeviceManager od dostawcy. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
Podstawowy punkt zaczepienia umożliwiający uzyskanie wszystkich punktów zaczepienia niezbędnych do React składnika z tej biblioteki. Aby wywołać ten punkt zaczepienia, składnik musi być opakowany pod następującymi dostawcami:
Najbardziej proste użycie składników wygląda następująco: Przykład
|
use |
Punkt zaczepienia w celu uzyskania selektora dla określonego składnika. Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki. |
use |
React punkt zaczepienia w celu uzyskania dostępu do motywu |
Szczegóły funkcji
CallAgentProvider(CallAgentProviderProps)
Element <xref:React.Context> , który przechowuje element <xref:%40azure%2Fcommunication-calling%23CallAgent>.
Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallAgentProvider.
function CallAgentProvider(props: CallAgentProviderProps): Element
Parametry
- props
- CallAgentProviderProps
Zwraca
Element
CallClientProvider(CallClientProviderProps)
Element <xref:React.Context> , który przechowuje element StatefulCallClient.
Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallClientProvider.
function CallClientProvider(props: CallClientProviderProps): Element
Parametry
- props
- CallClientProviderProps
Zwraca
Element
CallComposite(CallCompositeProps)
Dostosowywalny złożony interfejs użytkownika do wywoływania.
function CallComposite(props: CallCompositeProps): Element
Parametry
- props
- CallCompositeProps
Zwraca
Element
Uwagi
Wywołaj złożoną minimalną szerokość/wysokość są następujące:
- mobile: 17.5rem x 21rem (280px x 336px, z domyślnym rem na 16px)
- desktop: 30rem x 22rem (480 pikseli x 352px, z domyślnym rem na 16 pikseli)
CallProvider(CallProviderProps)
Element <xref:React.Context> , który przechowuje element <xref:%40azure%2Fcommunication-calling%23Call>.
Wywoływanie składników z tego pakietu musi być opakowane za pomocą obiektu CallProvider.
function CallProvider(props: CallProviderProps): Element
Parametry
- props
- CallProviderProps
Zwraca
Element
CallWithChatComposite(CallWithChatCompositeProps)
CallWithChatComposite łączy kluczowe składniki, aby zapewnić pełne połączenie z funkcją czatu.
function CallWithChatComposite(props: CallWithChatCompositeProps): Element
Parametry
Zwraca
Element
CameraButton(CameraButtonProps)
Przycisk włączania/wyłączania aparatu.
Może być używany z kontrolką ControlBar.
function CameraButton(props: CameraButtonProps): Element
Parametry
- props
- CameraButtonProps
Zwraca
Element
ChatClientProvider(ChatClientProviderProps)
Element <xref:React.Context> , który przechowuje element StatefulChatClient.
Składniki czatu z tego pakietu muszą być opakowane przy użyciu obiektu ChatClientProvider.
function ChatClientProvider(props: ChatClientProviderProps): Element
Parametry
- props
- ChatClientProviderProps
Zwraca
Element
ChatComposite(ChatCompositeProps)
Dostosowywalny interfejs użytkownika złożony do obsługi czatu.
function ChatComposite(props: ChatCompositeProps): Element
Parametry
- props
- ChatCompositeProps
Zwraca
Element
Uwagi
Minimalna szerokość i wysokość czatu to odpowiednio 17,5rem i 20rem (280 pikseli i 320 pikseli, z domyślnym rem na 16 pikseli)
ChatThreadClientProvider(ChatThreadClientProviderProps)
Element <xref:React.Context> , który przechowuje element <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)
Kontener dla różnych przycisków dla kontrolek wywołań.
Użyj różnych przycisków sterowania wywołaniami w tej bibliotece, np. CameraButton lub własnych wystąpień kontrolki ControlBarButton bezpośrednio.
function ControlBar(props: ControlBarProps): Element
Parametry
- props
- ControlBarProps
Zwraca
Element
ControlBarButton(ControlBarButtonProps)
Domyślny przycisk w stylu KontrolkaBar.
Użyj tego składnika, aby utworzyć niestandardowe przyciski, które są stylizowane tak samo jak inne przyciski udostępniane przez bibliotekę interfejsu użytkownika.
function ControlBarButton(props: ControlBarButtonProps): Element
Parametry
- props
- ControlBarButtonProps
Zwraca
Element
DevicesButton(DevicesButtonProps)
Przycisk umożliwiający otwarcie menu, które kontroluje opcje urządzenia.
Może być używany z kontrolką ControlBar.
function DevicesButton(props: DevicesButtonProps): Element
Parametry
- props
- DevicesButtonProps
Zwraca
Element
EndCallButton(EndCallButtonProps)
Przycisk umożliwiający zakończenie trwającego połączenia.
Może być używany z kontrolką 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 można wyświetlić, są akceptowane jako ciągi , aby można je było lokalizować. Aktywne błędy są wybierane przez element activeErrorMessages.
Ten składnik wewnętrznie śledzi odrzucone przez użytkownika.
- Błędy, które mają skojarzony znacznik czasu: błąd jest wyświetlany ponownie w interfejsie użytkownika, jeśli wystąpi po odrzuceniu.
- Błędy, które nie mają znacznika czasu: Błąd jest odrzucany, dopóki nie zniknie z rekwizytów. Jeśli błąd jest powtarzany, jest wyświetlany 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 stosowania motywu Fluent w składnikach react 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, a także kontrolek Fluent React Northstar. Ten dostawca obsługuje stosowanie dowolnego motywu dostarczonego zarówno do podstawowych kontrolek interfejsu użytkownika Fluent, jak i kontrolek Fluent React Northstar.
GridLayout(GridLayoutProps)
Składnik do układania kafelków audio/wideo uczestników w wywołaniu.
function GridLayout(props: GridLayoutProps): Element
Parametry
- props
- GridLayoutProps
Zwraca
Element
LocalizationProvider(LocalizationProviderProps)
Dostawca dostarczający zlokalizowane ciągi dla składników react tej biblioteki.
function LocalizationProvider(props: LocalizationProviderProps): Element
Parametry
Zwraca
Element
Uwagi
Składniki będą domyślnie udostępniane zlokalizowane ciągi w języku angielskim (USA), jeśli ten dostawca nie jest używany.
MessageStatusIndicator(MessageStatusIndicatorProps)
Składnik do wyświetlania stanu wysłanego komunikatu.
Dodaje ikonę i etykietkę narzędzia odpowiadającą stanowi komunikatu.
function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element
Parametry
Zwraca
Element
MessageThread(MessageThreadProps)
MessageThread
Umożliwia łatwe tworzenie składnika do renderowania wiadomości czatu, obsługę przewijania nowych/starych wiadomości i dostosowywanie ikon & 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 userId, aby renderować MessageThread
składnik.
Użytkownicy mogą również dostosowaćMessageThread
, przekazując własne awatary, MessageStatusIndicator
ikonę, JumpToNewMessageButton
LoadPreviousMessagesButton
i zachowanie tych kontrolek.
MessageThread
wewnętrznie używa Chat
składnika & Chat.Message
z klasy @fluentui/react-northstar
. Możesz wyewidencjonować szczegóły dotyczące tych dwóch składników.
Zwraca
Element
MicrophoneButton(MicrophoneButtonProps)
Przycisk włączania/wyłączania mikrofonu.
Może być używany z kontrolką ControlBar.
function MicrophoneButton(props: MicrophoneButtonProps): Element
Parametry
- props
- MicrophoneButtonProps
Zwraca
Element
ParticipantItem(ParticipantItemProps)
Składnik do renderowania uczestnika rozmowy lub czatu.
Wyświetla awatar uczestnika, displayName i status, a także opcjonalne ikony i menu kontekstowe.
function ParticipantItem(props: ParticipantItemProps): Element
Parametry
- props
- ParticipantItemProps
Zwraca
Element
ParticipantList(ParticipantListProps)
Składnik umożliwiający renderowanie wszystkich rozmów lub uczestników czatu.
Domyślnie każdy uczestnik jest renderowany z elementem Uczestnika. Zobacz <xref:ParticipantListProps.onRenderParticipant> , aby zastąpić.
function ParticipantList(props: ParticipantListProps): Element
Parametry
- props
- ParticipantListProps
Zwraca
Element
ParticipantsButton(ParticipantsButtonProps)
Przycisk umożliwiający wyświetlenie menu z połączeniami lub uczestnikami czatu.
Może być używany z kontrolką ControlBar.
Ten przycisk zawiera elementy menu rozwijanego zdefiniowane za pośrednictwem jego właściwości menuProps
. Domyślnie może wyświetlać liczbę uczestników zdalnych z pełną listą jako pod menu i opcję wyciszenia wszystkich uczestników, a także przycisk kopiowania do schowka, aby skopiować adres URL zaproszenia do wywołania.
Można to menuProps
w pełni zdefiniować, a jego właściwość jest typu IContextualMenuProps.
function ParticipantsButton(props: ParticipantsButtonProps): Element
Parametry
- props
- ParticipantsButtonProps
Zwraca
Element
ScreenShareButton(ScreenShareButtonProps)
Przycisk uruchamiania/zatrzymywania udostępniania ekranu.
Może być używany z kontrolką ControlBar.
function ScreenShareButton(props: ScreenShareButtonProps): Element
Parametry
- props
- ScreenShareButtonProps
Zwraca
Element
SendBox(SendBoxProps)
Składnik do wpisywania i wysyłania komunikatów.
Obsługuje wysyłanie powiadomienia o wpisywaniu podczas wpisywania tekstu przez użytkownika. Obsługuje opcjonalny komunikat poniżej pola wprowadzania tekstu.
function SendBox(props: SendBoxProps): Element
Parametry
- props
- SendBoxProps
Zwraca
Element
StreamMedia(StreamMediaProps)
Składnik narzędzia do konwertowania elementu HTMLElement ze strumieniem wideo na element JSX.
Służy do konwertowania elementu HTML Zwracanego przez bezgłowy interfejs API wywołania do składnika, który może być renderowany jako Element VideoTile.
function StreamMedia(props: StreamMediaProps): Element
Parametry
- props
- StreamMediaProps
Zwraca
Element
TypingIndicator(TypingIndicatorProps)
Składnik do powiadamiania użytkownika lokalnego, gdy co najmniej jeden uczestnik wątku czatu jest wpisywany.
function TypingIndicator(props: TypingIndicatorProps): Element
Parametry
- props
- TypingIndicatorProps
Zwraca
Element
VideoGallery(VideoGalleryProps)
VideoGallery reprezentuje układ kafelków wideo dla określonego wywołania. Wyświetla on element VideoTile dla użytkownika lokalnego, a także dla każdego uczestnika zdalnego, który dołączył do połączenia.
function VideoGallery(props: VideoGalleryProps): Element
Parametry
- props
- VideoGalleryProps
Zwraca
Element
VideoTile(VideoTileProps)
Składnik do renderowania strumienia wideo dla pojedynczego uczestnika wywołania.
Używanie z funkcją GridLayout w galerii VideoGallery.
function VideoTile(props: VideoTileProps): Element
Parametry
- props
- VideoTileProps
Zwraca
Element
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)
Utwórz obiekt CallAdapter wspierany przez Azure Communication Services.
Jest to domyślna implementacja elementu CallAdapter dostarczonego przez tę bibliotekę.
Uwaga: displayName
może mieć maksymalnie 256 znaków.
function createAzureCommunicationCallAdapter(__namedParameters: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
Parametry
- __namedParameters
- AzureCommunicationCallAdapterArgs
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)
Utwórz obiekt CallAdapter przy użyciu podanego elementu StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do elementu StatefulCallClient. Rozważ użycie polecenia createAzureCommunicationCallAdapter , aby uzyskać prostszy interfejs API.
function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, locator: CallAdapterLocator): Promise<CallAdapter>
Parametry
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
Zwraca
Promise<CallAdapter>
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)
Utwórz obiekt CallWithChatAdapter wspierany przez usługi Azure Communication, aby podłączyć element CallWithChatComposite.
function createAzureCommunicationCallWithChatAdapter(__namedParameters: AzureCommunicationCallWithChatAdapterArgs): Promise<CallWithChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationCallWithChatAdapterArgs
Zwraca
Promise<CallWithChatAdapter>
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)
Utwórz obiekt CallWithChatAdapter przy użyciu podanych elementów StatefulChatClient i StatefulCallClient.
Przydatne, jeśli chcesz zachować odwołanie do statefulChatClient i StatefulCallClient. Rozważ użycie polecenia createAzureCommunicationCallWithChatAdapter , aby uzyskać prostszy interfejs API.
function createAzureCommunicationCallWithChatAdapterFromClients(__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs): Promise<CallWithChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationCallWithChatAdapterFromClientArgs
Zwraca
Promise<CallWithChatAdapter>
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)
Utwórz element ChatAdapter wspierany przez Azure Communication Services.
Jest to domyślna implementacja aplikacji ChatAdapter dostarczonej przez tę bibliotekę.
function createAzureCommunicationChatAdapter(__namedParameters: AzureCommunicationChatAdapterArgs): Promise<ChatAdapter>
Parametry
- __namedParameters
- AzureCommunicationChatAdapterArgs
Zwraca
Promise<ChatAdapter>
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)
Utwórz obiekt ChatAdapter przy użyciu podanego elementu StatefulChatClient.
Przydatne, jeśli chcesz zachować odwołanie do elementu StatefulChatClient. Rozważ użycie polecenia createAzureCommunicationChatAdapter , aby uzyskać prostszy interfejs API.
function createAzureCommunicationChatAdapterFromClient(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): Promise<ChatAdapter>
Parametry
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Zwraca
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)
Utwórz domyślną implementację wywołań callHandlers dla zespołów.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call): CallingHandlers
Parametry
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
Zwraca
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)
Utwórz domyślną implementację programu ChatHandlers.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
Zwracany obiekt jest zapamiętywane, aby uniknąć rerenders, gdy są używane jako rekwizyty dla React Components.
function createDefaultChatHandlers(chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient): ChatHandlers
Parametry
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
Zwraca
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)
Tworzy element StatefulCallClient StatefulCallClient przez serwer proxy CallClient za pomocą elementu ProxyCallClient <xref:%40azure%2Fcommunication-calling%23CallClient><xref:ProxyCallClient> , który następnie umożliwia dostęp do stanu w sposób deklaratywny.
Ważne jest, aby używać elementów <xref:%40azure%2Fcommunication-calling%23DeviceManager> i i <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (i itp.), które są uzyskiwane z klasy StatefulCallClient, aby ich zmiany stanu były prawidłowo proxied.
function createStatefulCallClient(args: StatefulCallClientArgs, options?: StatefulCallClientOptions): StatefulCallClient
Parametry
Zwraca
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)
Tworzy stanowy obiekt ChatClient StatefulChatClient przez serwer proxy ChatClient za pomocą elementu ProxyChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient><xref:ProxyChatClient> , który następnie umożliwia dostęp do stanu w sposób deklaratywny.
function createStatefulChatClient(args: StatefulChatClientArgs, options?: StatefulChatClientOptions): StatefulChatClient
Parametry
- options
- StatefulChatClientOptions
Zwraca
fromFlatCommunicationIdentifier(string)
Odwrotna operacja toFlatCommunicationIdentifier.
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
Parametry
- id
-
string
Zwraca
getCallingSelector<Component>(Component)
Pobierz selektor dla określonego składnika.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z 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 składnika.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function getChatSelector<Component>(component: Component): GetChatSelector<Component>
Parametry
- component
-
Component
Zwraca
GetChatSelector<Component>
toFlatCommunicationIdentifier(CommunicationIdentifier)
Reprezentacja ciągu elementu <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.
Ta reprezentacja ciągu elementu CommunicationIdentifier gwarantuje stabilność 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 służyć jako klucze do mapy do przechowywania danych użytkownika.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string
Parametry
- identifier
- CommunicationIdentifier
Zwraca
string
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)
Niestandardowy punkt zaczepienia React, który upraszcza tworzenie obiektu CallAdapter.
Podobnie jak w przypadku polecenia createAzureCommunicationCallAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie.
Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, aby zapoznać się z typowymi przykładami użycia.
function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
Parametry
- args
-
Partial<AzureCommunicationCallAdapterArgs>
- 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 punkt zaczepienia React, który upraszcza tworzenie elementu CallWithChatAdapter.
Podobnie jak w przypadku polecenia createAzureCommunicationCallWithChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie.
Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, 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 hak React, aby uprościć tworzenie ChatAdapter.
Podobnie jak w przypadku tworzeniaazureCommunicationChatAdapter, ale zajmuje się asynchronicznym tworzeniem karty wewnętrznie.
Umożliwia niezdefiniowanie argumentów, dzięki czemu można przestrzegać reguł haków i przekazywać argumenty podczas ich tworzenia. Karta jest tworzona tylko wtedy, gdy wszystkie argumenty są zdefiniowane.
Pamiętaj, że należy zapamiętywać argumenty, aby uniknąć ponownego tworzenia karty na każdym renderowaniu. Zobacz scenariusz, 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()
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-calling%23Call> od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
Aby użyć tego elementu zaczepienia, musisz wcześniej użyć obiektu CallProvider z obiektem Call
function useCall(): undefined | Call
Zwraca
undefined | Call
useCallAgent()
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-calling%23CallAgent> od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function useCallAgent(): undefined | CallAgent
Zwraca
undefined | CallAgent
useCallClient()
Punkt zaczepienia w celu uzyskania elementu StatefulCallClient od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function useCallClient(): StatefulCallClient
Zwraca
useChatClient()
Punkt zaczepienia w celu uzyskania elementu StatefulChatClient od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function useChatClient(): StatefulChatClient
Zwraca
useChatThreadClient()
Punkt zaczepienia w celu uzyskania <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function useChatThreadClient(): ChatThreadClient
Zwraca
useDeviceManager()
Punkt zaczepienia w celu uzyskania elementu StatefulDeviceManager od dostawcy.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z dostawców wyeksportowanych z tej biblioteki.
function useDeviceManager(): undefined | StatefulDeviceManager
Zwraca
undefined | StatefulDeviceManager
usePropsFor<Component>(Component, "chat" | "calling")
Podstawowy punkt zaczepienia umożliwiający uzyskanie wszystkich punktów zaczepienia niezbędnych do React składnika z tej biblioteki.
Aby wywołać ten punkt zaczepienia, składnik musi być opakowany pod następującymi dostawcami:
W przypadku składników czatu: ChatClientProvider i ChatThreadClientProvider.
Do wywoływania składników: CallClientProvider, CallAgentProvider i CallAgentProvider.
Najbardziej proste użycie składników 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")
Punkt zaczepienia w celu uzyskania selektora dla określonego składnika.
Przydatne podczas implementowania składnika niestandardowego, który korzysta z 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)
useTheme()
React punkt zaczepienia w celu uzyskania dostępu do motywu
function useTheme(): Theme
Zwraca
Theme