Sdílet prostřednictvím


@azure/communication-react package

Třídy

CallError

Při neúspěšných stavových metodách rozhraní API došlo k chybě.

ChatError

Chyba vyvolaná neúspěšnými metodami StatefulChatClient.

Rozhraní

AcceptedTransfer

Přenést stav funkce

ActiveErrorMessage

Aktivní chybové zprávy, které se mají zobrazit prostřednictvím chybového panelu.

ActiveNotification

Aktivní oznámení, která se mají zobrazovat prostřednictvím NotificationStack.

AdapterError

Chyba hlášená událostmi chyb a uložená ve stavu adaptéru

AdapterNotification

Notifikace ze stavu volajícího klienta uložená ve stavu adaptéru.

AdapterState

Funkce pro propojení se stavem složeného adaptéru

AttachmentMetadata

Datový model představující přílohu chatové zprávy, kde obsahuje ID pro jednoznačnou identifikaci přílohy, název, který představuje název souboru, a adresu URL pro stažení přílohy.

BaseCompositeProps

Vlastnosti společné pro všechny složené složky exportované z této knihovny

BaseCustomStyles

Základní fluent styly pro všechny komponenty exportované z tétobra.

BreakoutRoomsState

Stav odpočinkových místností

CallAdapter

Rozhraní adaptéru specifické pro identitu komunikace Azure, která rozšiřuje CommonCallAdapter.

CallAdapterCallManagement

Funkce pro správu aktuálního hovoru nebo zahájení nového hovoru

CallAdapterCallOperations

Funkce pro správu aktuálního volání

CallAdapterDeviceManagement

Funkce pro správu zařízení v rámci hovoru

CallAdapterSubscribers

Volejte složené události, ke kterým je možné se přihlásit.

CallAgentProviderProps

Argumenty pro inicializaci CallAgentProvider.

CallAgentState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23CallAgent> s výjimkou volání je přesunuta jako podřízená přímo CallClientState a není zahrnuta zde. Důvodem, proč má callAgent stav proxied, je poskytnout přístup k displayName. Nezarovnáme CallAgent.displayName a vložíme ho do CallClientState, protože by bylo nejednoznačné, že displayName je ve skutečnosti závislé na vytvoření nebo existenci CallAgent, aby byla k dispozici.

CallAndChatLocator

Argumenty pro použití v createAzureCommunicationCallWithChatAdapter připojit hovor s přidruženým vláknem chatu.

CallClientProviderProps

Argumenty pro inicializaci CallClientProvider.

CallClientState

Kontejner pro všechna data stavu proxied by StatefulCallClient. Volání, callsEnded, incomingCalls a incomingCallsEnded stavy se automaticky poskytnou, pokud byl vytvořen callAgent. Správce zařízení bude zpočátku prázdný, dokud se nezobrazí DeviceManagerState. Stav userId je poskytován jako pohodlí pro vývojáře a je zcela řízen a nastaven vývojářem.

CallCompositeLoaderProps

Props pro OutboundCallComposite , které můžete použít ve své aplikaci.

Obsahuje dvě možnosti: tašky:

CallCompositeProps

Rekvizity pro CallComposite.

CallCompositeStrings

Řetězce používané CallComposite přímo.

Tyto řetězce jsou kromě řetězců používaných komponentami z knihovny komponent.

CallFeatureStreamState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Představuje stav datového proudu funkcí volání.

CallInfoState

Stav pro sledování typů <xref:CallInfo> a <xref:TeamsCallInfo>

CallNotification
CallProviderProps

Argumenty pro inicializaci CallProvider.

CallState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient automaticky načte stav volání a přidá ho do stavu vystaveného službou StatefulCallClient.

CallSurveyImprovementSuggestions

Představuje část dotazníkového průzkumu s návrhy na zlepšení

CallWithChatAdapter

rozhraní CallWithChatComposite Adapter.

CallWithChatAdapterManagement

Funkce pro správu aktuálního hovoru pomocí chatu

CallWithChatAdapterState

CallWithChat State je kombinace stavových chatů a stavových volání klientů s určitým stavem specifickým pouze Pro CallWithChat Composite.

CallWithChatAdapterSubscriptions

Události volání a chatu, které lze přihlásit k odběru v CallWithChatAdapter.

CallWithChatAdapterUiState

Stav uživatelského rozhraní týkající se CallWithChatComposite.

CallWithChatClientState

Stav z back-endových služeb, které řídí CallWithChatComposite.

CallWithChatCompositeLoaderProps

Rekvizity pro CallWithChatComposite , které můžete použít ve své aplikaci.

Obsahuje dvě možnosti: tašky:

CallWithChatCompositeProps

Props požadované pro CallWithChatComposite

CallWithChatCompositeStrings

Řetězce používané CallWithChatComposite přímo.

Tyto řetězce jsou kromě řetězců používaných komponentami z knihovny komponent.

CallWithChatControlOptions

Možnosti přizpůsobení ovládacího panelu v prostředí volání s chatem.

CallingHandlers

Objekt obsahující všechny obslužné rutiny vyžadované pro volání komponent.

Volání souvisejících komponent z tohoto balíčku je možné vybrat relevantní obslužné rutiny z tohoto objektu. Viz <xref:useHandlers> a usePropsFor.

CallingTheme

Paleta vlastního motivu Fluent používaná voláním souvisejících komponent v této knihovně.

CameraButtonContextualMenuStyles

Styly nabídky CameraButton.

CameraButtonProps

Rekvizity pro komponentu CameraButton .

CameraButtonStrings

Řetězce CameraButtonu, které lze přepsat.

CameraButtonStyles

Styly pro CameraButton

CapabilitiesFeatureState

Pouze verze nástroje Pouze pro státní správu <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>

CapabilityChangedNotificationStrings

Řetězce pro oznámení o změně schopnosti

CaptionLanguageStrings

Jazykové řetězce titulků pro nastavení titulků modální

CaptionsBannerProps

CaptionsBanner Component Rekvizity.

CaptionsBannerStrings

Řetězce pro banner s titulky

CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps

CaptionsSettingsModální rekvizity komponent.

CaptionsSettingsModalStrings

Řetězce pro nastavení titulků Modální

ChatAdapterSubscribers

Složené události chatu, ke kterým je možné se přihlásit.

ChatAdapterThreadManagement

Funkce pro správu aktuálního vlákna chatu

ChatCompositeLoaderProps

Rekvizity pro ChatComposite, které můžete použít ve své aplikaci. Obsahuje možnosti pro ChatCompositeChatCompositeOptions.

ChatCompositeProps

Rekvizity pro ChatComposite.

ChatCompositeStrings

Řetězce používané ChatComposite přímo.

Tyto řetězce jsou kromě řetězců používaných komponentami z knihovny komponent.

ChatMessage

Chatovací zpráva.

CommonCallAdapter

rozhraní CallComposite Adapter.

CommonCallingHandlers

Objekt obsahující všechny obslužné rutiny vyžadované pro volání komponent.

Volání souvisejících komponent z tohoto balíčku je možné vybrat relevantní obslužné rutiny z tohoto objektu. Viz <xref:useHandlers> a usePropsFor.

ComponentLocale

Informace o národním prostředí pro všechny komponenty exportované z této knihovny

ComponentStrings

Řetězce používané všemi komponentami exportovanými z této knihovny.

CompositeLocale

Informace o národním prostředí pro všechny složené složky exportované z této knihovny

CompositeStrings

Řetězce použité ve složených složených souborech.

Tyto řetězce se používají přímo složenými složkami místo obsažených součástí.

ConferencePhoneInfo

Informace pro konferenční telefon info

ContentSystemMessage

Systémová zpráva s obsahem arbitary.

ControlBarButtonProps

Props pro ControlBarButton.

ControlBarButtonStrings

Řetězce ControlBarButton, které lze přepsat.

ControlBarProps

Props pro ControlBar.

CreateVideoStreamViewResult

Objekt vrácený po vytvoření místního nebo vzdáleného VideoStreamu. Obsahuje pomocné funkce pro manipulaci s vykreslením datového proudu.

CustomCallControlButtonCallbackArgs

Argumenty pro CustomCallControlButtonCallback.

CustomCallControlButtonProps

Odpověď z CustomCallControlButtonCallback. Zahrnuje základní rekvizity potřebné k vykreslení ControlBarButton nebo <xref:DrawerMenuItem>.

CustomCallControlButtonStrings

Řetězce pro CustomCallControlButtons

CustomMessage

Vlastní typ zprávy.

Vlastní zprávy se ve výchozím nastavení nevykreslují, ale aplikace pro ně můžou poskytovat vlastní vykreslovací moduly.

DevicesButtonContextualMenuStyles

Styly nabídky DevicesButton.

DevicesButtonProps

Props pro DevicesButton.

DevicesButtonStrings

Řetězce DevicesButton, které lze přepsat.

DevicesButtonStyles

Styly pro položky nabídky Tlačítka Zařízení

DiagnosticsCallFeatureState

Stav pouze proxy pro <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.

DialpadProps

Rekvizity pro komponentu Dialpad .

DialpadStrings

Řetězce číselníku , které lze přepsat.

DialpadStyles

Styly pro komponentu Číselník .

Disposable

Funkce pro správné rozložení složeného souboru

DtmfDialPadOptions

Možnosti pro určení chování vykreslování dtmfDialer v objektu CallComposite

EndCallButtonProps

Rekvizity pro EndCallButton.

EndCallButtonStrings

Řetězce EndCallButton, které lze přepsat.

ErrorBarProps

Props pro ErrorBar.

Kromě následujících ErrorBar předá všechny <xref:%40fluentui%2Freact%23IMessageBarProps> podkladové <xref:%40fluentui%2Freact%23MessageBar>.

ErrorBarStrings

Všechny řetězce, které mohou být zobrazeny v uživatelském rozhraní v ErrorBar.

FluentThemeProviderProps

Rekvizity pro FluentThemeProvider.

GridLayoutProps

Props pro GridLayout.

GridLayoutStyles

styly komponent GridLayout.

HoldButtonProps
HoldButtonStrings

Řetězce pro popisky tlačítek pro přidržení

HorizontalGalleryStyles

<xref:HorizontalGallery> styly komponent.

ImageOverlayProps

Rekvizity pro ImageOverlay.

ImageOverlayStrings

Řetězce ImageOverlay , které lze přepsat.

IncomingCallNotificationProps

Vlastnosti součásti oznámení o příchozím hovoru.

IncomingCallNotificationStrings

Řetězce pro komponentu upozornění na příchozí hovor.

IncomingCallNotificationStyles

Styly pro komponentu upozornění na příchozí hovor.

IncomingCallStackCall

Představuje aktivní příchozí hovor.

IncomingCallStackProps

Návrhy pro komponentu IncomingCallManager.

IncomingCallState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient automaticky rozpozná příchozí volání a přidá jejich stav do stavu vystaveného StatefulCallClient.

InlineImage

Stav InlineImage, jak se odráží v uživatelském rozhraní.

InlineImageOptions

Možnosti zobrazení vloženého obrazu ve scénáři vloženého obrazu.

JoinCallOptions

Možnosti nastavení stavu mikrofonu a kamery při připojení k hovoru true = zapnutí zařízení při připojení k hovoru false = vypnutí zařízení při připojování k hovoru 'ponechat'/undefined = zachovat stav zařízení před voláním

JumpToNewMessageButtonProps

Argumenty pro <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

LocalVideoStreamVideoEffectsState

Uveďte pouze verzi souboru LocalVideoStream.<xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>

LocalVideoTileOptions

Možnosti pro dlaždici místního videa v poli Kompozitní volání.

MediaAccessState

Stav přístupu k médiím

MediaDiagnosticsState

Stav pouze proxy pro <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.

MeetingConferencePhoneInfoModalStrings

Řetězce pro modální informace o telefonu

MessageCommon

Společné vlastnosti všech typů zpráv

MessageStatusIndicatorProps

Props pro MessageStatusIndicator.

MessageStatusIndicatorStrings

Řetězce MessageStatusIndicator, které lze přepsat.

MessageThreadStrings

Řetězce MessageThread, které lze přepsat.

MessageThreadStyles

Fluent styly pro MessageThread.

MicrophoneButtonContextualMenuStyles

Styly pro nabídku MicrophoneButton.

MicrophoneButtonProps

Props pro MicrophoneButton.

MicrophoneButtonStrings

Řetězce MicrophoneButton, které lze přepsat.

MicrophoneButtonStyles

Styly pro MicrophoneButton

NetworkDiagnosticsState

Stav pouze proxy pro <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.

NotificationOptions

Možnosti pro ovládání oznámení v kompozitu.

NotificationProps

Rekvizity pro oznámení.

NotificationStackProps

Rekvizity pro NotificationStack.

NotificationStackStrings

Všechny řetězce, které mohou být zobrazeny v uživatelském rozhraní v zásobníku oznámení.

NotificationStrings

Všechny řetězce, které mohou být zobrazeny v uživatelském rozhraní v oznámení.

NotificationStyles

Styly pro komponentu oznámení.

OptimalVideoCountFeatureState

Uveďte pouze verzi funkce <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>optimálního počtu videí.

OptionsDevice

Zařízení, například fotoaparát, mikrofon nebo reproduktor, v informačním rámečku DevicesButton.

OutboundCallCompositeLoaderProps

Props pro OutboundCallComposite , které můžete použít ve své aplikaci.

Obsahuje dvě možnosti: tašky:

PPTLiveCallFeatureState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient bude automaticky naslouchat pptLive při volání a odpovídajícím způsobem aktualizuje stav vystavený StatefulCallClient .

ParticipantAddedSystemMessage

Systémová zpráva s oznámením, že účastník byl přidán do vlákna chatu.

ParticipantItemProps

Rekvizity pro ParticipantItem.

ParticipantItemStrings

Řetězce ParticipantItem, které lze přepsat.

ParticipantItemStyles

Fluent styly pro ParticipantItem.

ParticipantListItemStyles

Styly pro ParticipantListParticipantItem.

ParticipantListStyles

Styly pro Seznam účastníků.

ParticipantRemovedSystemMessage

Systémová zpráva s oznámením, že účastník byl odebrán z vlákna chatu.

ParticipantsButtonContextualMenuStyles

Styly nabídky ParticipantsButton.

ParticipantsButtonProps

Rekvizity pro ParticipantsButton.

ParticipantsButtonStrings

Řetězce ParticipantsButton, které lze přepsat.

ParticipantsButtonStyles

Styly pro ÚčastníciButton.

RaiseHandButtonProps

Rekvizity pro RaiseHandButton.

RaiseHandButtonStrings

Řetězce RaiseHandButton , které lze přepsat.

RaiseHandCallFeature

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient bude automaticky naslouchat zvednutým rukám při volání a odpovídajícím způsobem aktualizuje stav vystavený StatefulCallClient .

ReactionButtonProps

Rekvizity pro ReactionButton.

ReactionButtonStrings

Řetězce ReactionButton , které lze přepsat.

ReactionResources

Rozhraní pro animaci, obrázek sprajtu a související metadata

RealTimeTextCallFeatureState
RealTimeTextInfo
RealTimeTextModalProps

Rekvizity komponent RealTimeTextModal.

RealTimeTextModalStrings

řetězce pro modální text realTimeText

RealTimeTextProps

Rekvizity pro jeden řádek RealTimeTextu.

RealTimeTextStrings

Řetězce pro RTT

RecordingCallFeature

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient automaticky naslouchá stavu záznamu volání a odpovídajícím způsobem aktualizuje stav vystavený StatefulCall Client.

RemoteParticipantState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient automaticky načte RemoteParticipants a přidá jejich stav do stavu vystaveného StatefulCallClient.

RemoteVideoStreamState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

RemoteVideoTileMenuOptions

Možnosti nabídky pro dlaždice vzdáleného videa ve VideoGallery.

ScreenShareButtonProps

Props pro ScreenShareButton.

ScreenShareButtonStrings

Řetězce ScreenShareButton, které lze přepsat.

SendBoxProps

Props pro SendBox.

SendBoxStrings

Řetězce SendBox, které lze přepsat.

SendBoxStylesProps

Fluent styly pro <xref:Sendbox>.

SpokenLanguageStrings

Řetězce mluveného jazyka pro nastavení titulků Modal

SpotlightCallFeatureState

Pouze verze nástroje Pouze pro státní správu <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>

SpotlightPromptStrings

Řetězce použité ve výzvě související se Spotlightem

SpotlightState

Stav reflektoru s objednávkou

StartCaptionsAdapterOptions

Možnosti předané do adapter.startCaptions

StartCaptionsButtonProps
StartCaptionsButtonStrings

Řetězce pro popisky tlačítek pro přidržení

StartRealTimeTextButtonProps

Návrhy pro komponentu StartRealTimeTextButton

StartRealTimeTextButtonStrings

Řetězce pro popisky tlačítek pro přidržení

StatefulCallClient

Definuje metody, které umožňují použití <xref:%40azure%2Fcommunication-calling%23CallClient> CallClient stavově. Rozhraní poskytuje přístup kxied stavu a také umožňuje registraci obslužné rutiny pro události změny stavu. Definice stavu naleznete v tématu CallClientState.

Události změny stavu jsou řízeny:

  • Vrácená data z rozhraní API <xref:%40azure%2Fcommunication-calling%23DeviceManager>
  • Vrácená data z rozhraní API <xref:%40azure%2Fcommunication-calling%23CallAgent>
  • Naslouchací procesy se automaticky připojují k různým objektům volání komunikace Azure:
    • CallAgent 'příchozí hovor'
    • CallAgent callsUpdated
    • Správce zařízení 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesAktualizováno
    • DeviceManager selectedMicrophoneChanged
    • DeviceManager selectedSpeakerChanged
    • Volání stateChanged
    • Volání idChanged
    • Volání isMutedChanged
    • Volání isScreenSharingOnChanged
    • Volání remoteParticipantsUpdated
    • Volání localVideoStreamsUpdated
    • IncomingCall callEnded
    • RemoteParticipant stateChanged
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant displayNameChanged
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream isAvailableChanged
    • PřepisCallFeature 'isTranscriptionActiveChanged'
    • Funkce RecordingCallFeature "isRecordingActiveChanged"
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raisedHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature 'reakce'
StatefulChatClient

Definuje metody, které umožňují použití {@Link @azure/communication-chat#ChatClient} s centralizovaným vygenerovaným stavem.

Rozhraní poskytuje přístup kxied stavu a také umožňuje registraci obslužné rutiny pro události změny stavu.

StatefulDeviceManager

Definuje další metody přidané stavovým stavem nad <xref:%40azure%2Fcommunication-calling%23DeviceManager>.

StopCaptionsAdapterOptions

Možnosti předané do adapter.stopCaptions

StreamMediaProps

Props pro StreamMedia.

SurveyIssues

Odpovídající texty ke každému číslu výzvy

SurveyIssuesHeadingStrings

Odpovídající texty ke každé kategorii výzvy

SystemMessageCommon

Společné vlastnosti všech systémových zpráv

TeamsCallAdapter

Rozhraní adaptéru specifické pro identitu Teams, které rozšiřuje CommonCallAdapter.

TeamsCallingHandlers

Objekt obsahující všechny obslužné rutiny volání týmů potřebné pro volání komponent.

Volání souvisejících komponent z tohoto balíčku je možné vybrat relevantní obslužné rutiny z tohoto objektu. Viz <xref:useHandlers> a usePropsFor.

TeamsIncomingCallState

Pouze verze nástroje Pouze pro státní správu <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall>

TogetherModeCallFeatureState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StavovýHovorovýKlient. Představuje stav funkce Režim společně.

TogetherModeSeatingPositionState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>.

Představuje polohu účastníka v režimu Společně.

TogetherModeStreamOptions

Rozhraní představující výsledek zobrazení datového proudu v režimu Společně.

TogetherModeStreamViewResult

Rozhraní představující výsledek zobrazení datového proudu v režimu Společně.

TogetherModeStreamsState

Představuje datové proudy v režimu Společně.

TopicUpdatedSystemMessage

Systémová zpráva s oznámením, že téma vlákna chatu bylo aktualizováno.

TranscriptionCallFeature

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient automaticky naslouchá stavu přepisu volání a odpovídajícím způsobem aktualizuje stav vystavený StatefulCall Client.

TransferFeature

Přenést stav funkce

TypingIndicatorProps

Rekvizity pro TypingIndicator.

TypingIndicatorStrings

Řetězce TypingIndicator, které lze přepsat.

TypingIndicatorStylesProps

Fluent styly pro TypingIndicator.

VerticalGalleryControlBarStyles

Styly pro ovládací panel uvnitř komponenty VerticalGallery

VerticalGalleryStrings

Řetězce pro lokalizaci vertikální galerie.

VerticalGalleryStyles

Styly pro komponentu VerticalGallery

VideoBackgroundBlurEffect

Obsahuje vlastnosti efektu rozostření videa na pozadí

VideoBackgroundImage

Obsahuje atributy obrázku na pozadí, jako je url, jméno atd.

VideoBackgroundNoEffect

Obsahuje atributy pro odstranění efektu pozadí videa

VideoBackgroundReplacementEffect

Obsahuje atributy vybraného náhradního efektu pozadí videa

VideoGalleryLocalParticipant

Stav místního účastníka v VideoGallery.

VideoGalleryProps

Props pro VideoGallery.

VideoGalleryRemoteParticipant

Stav vzdáleného účastníka v VideoGallery.

VideoGalleryStream

Video stream účastníka v VideoGallery.

VideoGalleryStrings

Všechny řetězce, které mohou být zobrazeny v uživatelském rozhraní v VideoGallery.

VideoGalleryStyles

Styly komponent VideoGallery.

VideoGalleryTogetherModeSeatingInfo

Rozhraní představující informace o sezení v režimu Společně.

VideoGalleryTogetherModeStreams

Rozhraní reprezentující proudy v režimu Společně.

VideoStreamOptions

Možnosti pro řízení vykreslování streamů videa

VideoStreamRendererViewState

Stav pouze verze <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Tato vlastnost je přidána do stavu vystaveného StatefulCallClientcreateView a odebrána disposeView.

VideoTileContextualMenuProps

Vlastnosti pro zobrazení kontextové nabídky pro vzdálené komponenty VideoTile ve VideoGallery.

VideoTileDrawerMenuProps

Vlastnosti pro zobrazení nabídky zásuvky na vzdáleném VideoTile dlouhém dotyku ve VideoGallery.

VideoTileProps

Rekvizity pro VideoTile.

VideoTileStrings

Řetězce VideoTile , které lze přepsat.

VideoTileStylesProps

Fluent styly pro VideoTile.

VideoTilesOptions

Možnosti, které platí pro všechny dlaždice videa ve Videogalerii

Aliasy typu

AdapterErrors

Adaptéry ukládají nejnovější chybu pro každou operaci ve stavu.

target je řetězec definovaný adaptérem pro každou jedinečnou operaci prováděnou adaptérem.

AdapterNotifications

Adaptéry ukládají nejnovější oznámení pro každý cíl.

AreEqual

Porovnejte, jestli jsou 2 komponenty react přesné stejné, bude typ výsledku true nebo false.

AreParamEqual

Porovnejte, jestli jsou props 2 komponent react stejné, bude typ výsledku true nebo false.

AreTypeEqual

Porovnání, pokud jsou dva typy stejné, bude typ výsledku true/false.

AvatarPersonaData

Vlastní datové atributy pro zobrazení avatara pro uživatele.

AvatarPersonaDataCallback

Funkce zpětného volání, která slouží k poskytnutí vlastních dat k vytvoření avatara pro uživatele.

AzureCommunicationCallAdapterArgs

Argumenty pro vytvoření implementace služby Azure Communication Services CallAdapter.

Poznámka: displayName může mít maximálně 256 znaků.

AzureCommunicationCallAdapterOptions

Volitelné parametry k vytvoření useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

AzureCommunicationCallWithChatAdapterArgs

Argumenty pro createAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Argumenty pro <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

Argumenty pro vytvoření implementace služby Azure Communication Services ChatAdapter.

AzureCommunicationOutboundCallAdapterArgs

Argumenty pro vytvoření implementace služby Azure Communication Services CallAdapter.

Tyto argumenty se používají k vytvoření scénářů odchozích volání.

Poznámka: displayName může mít maximálně 256 znaků.

CallAdapterCallEndedEvent

Datová část pro CallEndedListener obsahující podrobnosti o ukončené volání.

CallAdapterClientState

stavu CommonCallAdapter odvozený z back-endu služby Azure Communication Services.

CallAdapterLocator

Lokátor používaný createAzureCommunicationCallAdapter k vyhledání volání pro připojení

CallAdapterState

stavu CommonCallAdapter.

CallAdapterUiState

stavu CommonCallAdapter pro účely čistého uživatelského rozhraní.

CallCompositeIcons

Ikony, které lze přepsat pro CallComposite.

CallCompositeOptions

Volitelné funkce CallComposite .

CallCompositePage

Hlavní obrazovky uživatelského rozhraní zobrazené v CallComposite .

CallControlDisplayType

Typ zobrazení řídicího panelu pro CallComposite .

CallControlOptions

Možnosti přizpůsobení řídicího panelu ve volajícím prostředí

CallEndedListener

Zpětné volání pro CallAdapterSubscribers události callEnded.

CallErrorBarSelector

Typ selektoru pro komponentu ErrorBar.

CallErrorTarget

Typ řetězcového literálu pro všechny přípustné klíče v {@Link CallErrors}.

CallErrors

Chyby volání rozhraní API do volající sady SDK

Každá vlastnost v objektu ukládá nejnovější chybu pro konkrétní metodu rozhraní API sady SDK.

Chyby z tohoto objektu lze vymazat pomocí <xref:newClearCallErrorsModifier>. Chyby se navíc automaticky vymažou v následujících případech:

  • Stav je vymazán.
  • Následná volání souvisejících metod rozhraní API jsou úspěšná. Podrobnosti o tom, kdy se chyby můžou automaticky vymazat, najdete v dokumentaci jednotlivých stavových metod klienta.
CallFeatureStreamName

Představuje název datového proudu funkce volání

CallIdChangedListener

Zpětné volání pro CallAdapterSubscribers události callIdChanged.

CallNotifications
CallParticipantListParticipant

Stav volajícího účastníka, jak se odráží v komponentách uživatelského rozhraní.

CallWithChatCompositeIcons

Ikony, které lze přepsat pro CallWithChatComposite.

CallWithChatCompositeOptions

Volitelné funkce CallWithChatComposite.

CallWithChatEvent

Události aktivované CallWithChatAdapter.

CallingBaseSelectorProps

Běžné props používané k odkazování na stav deklarativního klienta.

CallingHandlersOptions

Možnosti konfigurace pro zahrnutí závislosti na pozadí video efektu.

CallingReturnProps

Pomocný typ pro použítPropsFor.

CallingSounds

Typ pro reprezentaci sady zvuků, které se mají použít pro různé události volání

CameraButtonSelector

Typ selektoru pro komponentu CameraButton.

CancelEditCallback

Funkce zpětného volání se spustí, když je zrušena editace zprávy.

CapabilitiesChangedListener

Zpětné volání pro událost CallAdapterSubscribers 'capabilitiesChanged'.

CaptionSettingsSelector

Typ selektoru pro komponenty pro změnu jazyka titulků a mluveného jazyka

CaptionsBannerSelector

Typ selektoru pro komponentu CaptionsBanner .

CaptionsInformation

Informace požadované pro každý řádek popisku

CaptionsOptions

Taška s možnostmi pro úvodní titulky

CaptionsReceivedListener

Zpětné volání pro událost CallAdapterSubscribers 'captionsReceived'.

ChatAdapter

Rozhraní chatComposite Adapter.

ChatAdapterOptions

Možnosti konfigurace adaptéru ChatAdapter.

ChatAdapterState

stav chatadapter.

ChatAdapterUiState

stavu ChatAdapter pro účely čistého uživatelského rozhraní.

ChatAttachmentType

Představuje typ přílohy

ChatBaseSelectorProps

Běžné props pro selektory pro ChatClientState.

ChatClientProviderProps

Argumenty pro inicializaci ChatClientProvider.

ChatClientState

Centralizovaný stav pro <xref:%40azure%2Fcommunication-chat%23ChatClient>.

ChatCompositeClientState

stav ChatAdapter odvozený z back-endu služby Azure Communication Services.

ChatCompositeIcons

Ikony, které lze přepsat pro ChatComposite.

ChatCompositeOptions

Volitelné funkce ChatComposite.

ChatErrorBarSelector

Typ selektoru pro komponentu ErrorBar.

ChatErrorTarget

Typ řetězcového literálu pro všechny přípustné klíče v ChatErrors.

ChatErrors

Chyby z volání rozhraní API do chatovací sady SDK

Každá vlastnost v objektu ukládá nejnovější chybu pro konkrétní metodu rozhraní API sady SDK.

ChatHandlers

Objekt obsahující všechny obslužné rutiny vyžadované pro součásti chatu

Komponenty související s chatem z tohoto balíčku mohou vybrat relevantní obslužné rutiny z tohoto objektu. Viz <xref:useHandlers> a usePropsFor.

ChatInitializedListener

Zpětné volání pro <xref:CallWithChatAdapterSubscribers> událost 'chatInitialized'.

ChatMessageWithStatus

Rozšíření pro <xref:%40azure%2Fcommunication-chat%23ChatMessage>, které ukládá metadata pouze na straně klienta pro zprávy chatu.

Úkol: Název je bitrotted. Přejmenujte mě.

ChatParticipantListSelector

Typ selektoru pro komponentu ParticipantList.

ChatProfile

Profil uživatele nebo robota.

ChatReturnProps

Pomocný typ pro použítPropsFor.

ChatThreadClientProviderProps

Argumenty pro inicializaci ChatThreadClientProvider.

ChatThreadClientState

Centralizovaný stav pro <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

ChatThreadProperties

Vlastnosti vlákna chatu

Definujeme minimální typ, který nám pomůže skrýt různé typy používané podkladovým rozhraním API.

ClientState

Centralizovaný stav pro <xref:%40azure%2Fcommunication-calling%23CallClient> nebo <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Viz také: CallClientState, ChatClientState.

Common

Návrat typu průniku 2 typů

CommonCallAdapterOptions

Běžné volitelné parametry pro vytvoření useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) nebo TeamsCallAdapter

CommonCallControlOptions

Možnosti přizpůsobení řídicího panelu ve volajícím prostředí

CommonProperties

Vrácení protínajících vlastností 2 typů

CommunicationParticipant

Stav chatu nebo volání účastníka, jak se odráží v uživatelském rozhraní.

ComponentIcons

Ikony používané komponentami Reactu exportovanými z této knihovny

ComponentProps

Pomocný typ pro použítPropsFor.

ComponentSlotStyle

ComponentSlotStyle je @fluentui/react-northstar typ. Protože jsme se od tohoto balíčku odklonili, použili jsme pro interoperabilitu obecnější typ IRawStyle od společnosti Fluent.

CompositeIcons

Ikony, které lze přepsat v některém ze složených souborů exportovaných touto knihovnou.

Další cílené typy najdete v ChatCompositeIcons, CallCompositeIcons a CallWithChatCompositeIcons.

ControlBarButtonStyles

Styly pro všechny implementace ControlBarButton.

ControlBarLayout

Prezentace rozložení pro ControlBar.

CreateDefaultCallingHandlers

Typ createDefaultCallingHandlers.

CreateViewResult

Vrátí výsledek z createView.

CustomAvatarOptions

Možnosti, které lze vložit do funkce onRender pro přizpůsobení komponenty Avatar (Persona).

CustomCallControlButtonCallback

Zpětné volání, které vrací props pro vykreslení vlastního ControlBarButton a <xref:DrawerMenuItem>.

Odpověď označuje, kam má být vlastní tlačítko umístěno.

Tip pro zvýšení výkonu: Toto zpětné volání je voláno pouze v případě, že se změní zpětné volání nebo jeho argumenty.

CustomCallControlButtonPlacement

Umístění vlastního tlačítka vloženého do souboru <xref:CommonCallControlBar>.

'primary': Umístěte tlačítko (tlačítka) na pravý konec prostředního ovládacího panelu, ale před tlačítko EndCallButton (levý konec v režimu rtl). 'přetečení': Umístěte tlačítka(a) na konec přetečené nabídky. 'sekundární': Umístěte tlačítko(a) na levý konec bočního ovládacího panelu (v režimu rtl vpravo).

Více tlačítek přiřazených ke stejnému umístění je připojeno v uvedeném pořadí. Např. pokud jsou dvě tlačítka umístěna v 'sekundárním', obě se zobrazí na levém konci (pravý konec v režimu rtl) v uvedeném pořadí.

Pouze "primární" umístění funguje, pokud je v kompozitním hovoru povoleno starší řízení hovorů

DeclarativeCallAgent

DeclarativeCallAgent rozšiřuje a zprostředkovává <xref:%40azure%2Fcommunication-calling%23CallAgent>

DeclarativeTeamsCallAgent

DeclarativeTeamsCallAgent rozšiřuje a zprostředkovává <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>

DeepNoiseSuppressionEffectDependency

Typ závislosti, který má být vložen pro hluboké potlačení šumu

DeviceManagerState

Tento typ je určen k zapouzdření veškerého stavu uvnitř <xref:%40azure%2Fcommunication-calling%23DeviceManager>. U volitelných parametrů nemusí být dostupné, dokud uživatel neudělí oprávnění. Kamery, mikrofony, reproduktory a stavy deviceAccess budou prázdné, dokud nebudou volána a dokončena odpovídající <xref:%40azure%2Fcommunication-calling%23DeviceManager>getCameras, getMicrophones, getSpeakers a askDevicePermission API.

DevicesButtonSelector

Typ selektoru pro komponentu DevicesButton.

DiagnosticChangedEventListner

Zpětné volání pro CallAdapterSubscribers události diagnosticChanged.

DialpadMode

Režimy komponenty číselníku.

DisplayNameChangedListener

Zpětné volání pro CallAdapterSubscribers události displayNameChanged.

DtmfTone

Tón DTMF pro volání do veřejné telefonní sítě.

EmptySelector

Typ pro triviální selektory, které nevracely žádná data.

Používá se jako výchozí návratová hodnota, pokud usePropsFor volá pro komponentu, která nevyžaduje žádná data.

ErrorType

Všechny chyby, které lze zobrazit v ErrorBar.

GetCallingSelector

Konkrétní typ selektoru použitelný pro danou komponentu

GetChatSelector

Konkrétní typ selektoru použitelný pro danou komponentu

HoldButtonSelector

Typ selektoru pro komponentu HoldButton .

IncomingCallManagement

Obsahuje pole pouze pro čtení, které vrací všechny aktivní incomingCallssoubory . Aktivní příchozí hovor je hovor, který nebyl přijat, odmítnut nebo odpojen.

IncomingCallStackSelector

Selector pro získání aktivních a odstraněných příchozích hovorů.

IsCaptionLanguageChangedListener

Zpětné volání pro událost CallAdapterSubscribers 'isCaptionLanguageChanged'.

IsCaptionsActiveChangedListener

Zpětné volání pro událost CallAdapterSubscribers isCaptionsActiveChanged.

IsLocalScreenSharingActiveChangedListener

Zpětné volání pro CallAdapterSubscribers události isLocalScreenSharingActiveChanged.

IsMutedChangedListener

Zpětné volání pro CallAdapterSubscribers události isMuted.

IsSpeakingChangedListener

Zpětné volání pro CallAdapterSubscribers události isSpeakingChanged.

IsSpokenLanguageChangedListener

Zpětné volání pro událost CallAdapterSubscribers 'isSpokenLanguageChanged'.

LoadingState

Bez ohledu na to, jestli se datový proud načítá nebo ne.

LocalScreenShareView
LocalVideoTileSize

Různé režimy dlaždice místního videa

LocalizationProviderProps

Props pro LocalizationProvider.

LongPressTrigger

Režimy, jak mohou být obslužné programy dlouhého tisku tyggerovány.

MediaAccess

Stav přístupu k médiím zvuku a videa

MediaDiagnosticChangedEvent

Datová část pro DiagnosticChangedEventListner kde došlo ke změně diagnostiky médií.

Message

Diskriminovaná sjednocení všech zpráv.

Pole messageType se specializuje na sjednocované varianty.

MessageAttachedStatus

Určete, zda má být zpráva chatu zobrazena se zprávou před /po ní. Pokud true, zpráva se zobrazí ve skupině se zprávou před ní. "top" a "bottom" se používají k označení, že zpráva je začátkem nebo koncem skupiny.

MessageContentType

Podporované typy obsahu chatových zpráv

MessageDeletedListener

Zpětné volání pro událost "messageDeleted" společnosti ChatAdapterSubscribers .

MessageEditedListener

Zpětné volání pro událost "messageEdited" ChatAdapterSubscribers .

MessageProps

Props k vykreslení jedné zprávy.

Viz MessageRenderer.

MessageReadListener

Zpětné volání pro ChatAdapterSubscribers události messageRead.

MessageReceivedListener

Zpětné volání pro ChatAdapterSubscribers události messageReceived.

MessageRenderer

Komponenta pro vykreslení jedné zprávy.

MessageSentListener

Zpětné volání pro ChatAdapterSubscribers události messageSent.

MessageStatus

Stav odeslané zprávy na straně klienta

Zahrnuje přechodné stavy, ke kterým dochází před potvrzením doručení zprávy z back-endu.

MessageThreadProps

Props pro MessageThread.

MessageThreadSelector

Typ selektoru pro komponentu MessageThread.

MicrophoneButtonSelector

Typ selektoru pro komponentu MicrophoneButton.

NetworkDiagnosticChangedEvent

Datová část pro DiagnosticChangedEventListner, kde došlo ke změně diagnostiky sítě.

NotificationStackSelector

Typ selektoru pro komponentu Oznámení .

NotificationTarget
NotificationType

Všechna oznámení, která lze zobrazit v zásobníku oznámení.

OnFetchChatProfileCallback

Funkce zpětného volání, která poskytuje vlastní data pro vytvoření profilu pro uživatele nebo robota.

OnFetchProfileCallback

Funkce zpětného volání, která poskytuje vlastní data pro vytvoření profilu pro uživatele nebo robota.

OnRenderAvatarCallback

Vlastní vykreslené zpětné volání, které uživatelům umožňuje přizpůsobit vykreslování komponenty Persona.

OverflowGalleryPosition

Různé režimy a pozice přelivové galerie ve Videogalerii

ParticipantListParticipant

Účastníci zobrazeni v Seznam účastníků.

ParticipantListProps

Rekvizity pro ParticipantList.

ParticipantListSelector

Typ selektoru pro komponentu ParticipantList.

ParticipantMenuItemsCallback

Zpětné volání pro poskytování vlastních položek nabídky pro každého účastníka v Seznam účastníků.

ParticipantState

Stav připojení účastníka hovoru.

ParticipantsAddedListener

Zpětné volání pro ChatAdapterSubscribers události "participantsAdded".

ParticipantsButtonSelector

Typ selektoru pro komponentu ParticipantsButton.

ParticipantsJoinedListener

Zpětné volání pro CallAdapterSubscribers události "participantsJoined".

ParticipantsLeftListener

Zpětné volání pro CallAdapterSubscribers události participantsLeft.

ParticipantsRemovedListener

Zpětné volání pro ChatAdapterSubscribers události participantsRemoved.

Profile

Profil uživatele nebo robota.

RaiseHandButtonSelector

Typ selektoru pro komponentu RaiseHandButton .

RaisedHand

Stav zvednuté ruky s řádem

RaisedHandState

Stav zvednuté ruky s řádem

Reaction

Reakční stav s typem reakce k vykreslení

ReactionButtonReaction

Typy reakcí pro tlačítko Reakce

ReactionSprite

Typ pro animaci, obrázek sprajtu a související metadata

ReactionState

Uveďte pouze verzi <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> s pomocnými vlastnostmi uživatelského rozhraní receivedOn. Stav reakce s časovým razítkem, které pomáhá uživatelskému rozhraní rozhodnout se odpovídajícím způsobem vykreslit reakci.

ReadReceiptsBySenderId

Pole párů klíč-hodnota, které ukládají zobrazované jméno každého odesílatele a poslední přečtenou zprávu

RealTimeTextInformation

Informace požadované pro každý řádek textu v reálném čase

RealTimeTextReceivedListener

Zpětné volání pro událost "realTimeTextReceived" společnosti CallAdapterSubscribers .

ResourceDetails

Podrobnosti potřebné ke stažení zdroje do mezipaměti.

ResourceFetchResult

Výsledek prostředku staženého ze stavového klienta

ScreenShareButtonSelector

Typ selektoru pro komponentu ScreenShareButton.

Selector

Optimalizovaný selektor, který zpřesňuje ClientState aktualizace do props pro součásti React v této knihovně.

SendBoxSelector

Typ selektoru pro komponentu SendBox.

SoundEffect

Typ pro reprezentaci vlastního zvuku pro použití pro událost volání

Spotlight

Stav reflektoru s objednávkou

SpotlightChangedListener

Zpětné volání pro událost CallAdapterSubscribers 'spotlightChanged'.

StartCallIdentifier

Typy identifikátorů pro zahájení volání pomocí CallAdapter

StartCaptionsButtonSelector

Typ selektoru pro komponentu StartCaptionsButton .

StatefulCallClientArgs

Argumenty pro sestavení StatefulCallClient.

StatefulCallClientOptions

Možnosti pro sestavení StatefulCallClient s.

StatefulChatClientArgs

Argumenty pro sestavení StatefulChatClient.

StatefulChatClientOptions

Možnosti pro vytvoření StatefulChatClient.

SupportedCaptionLanguage
SupportedSpokenLanguage
SystemMessage

Diskriminovaná sjednocení všech systémových zpráv.

Pole systemMessageType se specializuje na sjednocované varianty.

TeamsAdapterOptions

Volitelné parametry pro vytvoření TeamsCallAdapter

TeamsCallAdapterArgs

Argumenty pro vytvoření implementace TeamsCallAdapter v Azure Communication Services.

TeamsCallAdapterArgsCommon

Společná část argumentů pro vytvoření implementace Azure Communication Services TeamsCallAdapter.

TeamsIncomingCallManagement

Proxy <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> rozhraní.

TogetherModeParticipantSeatingState

Představuje pozice účastníků v režimu Společně.

TopicChangedListener

Zpětné volání pro ChatAdapterSubscribers události topicChanged.

TransferAcceptedListener

Zpětné volání pro událost "transferRequested" CallAdapterSubscribers .

TypingIndicatorSelector

Typ selektoru pro komponentu TypingIndicator.

UpdateMessageCallback

Funkce zpětného volání se spustí při aktualizaci zprávy.

VideoBackgroundEffect

Obsahuje atributy vybraného efektu pozadí videa

VideoBackgroundEffectsDependency

Typ závislosti, který má být vložen pro efekty pozadí videa

VideoGalleryLayout
VideoGalleryParticipant

Stav účastníka VideoGallery.

VideoGallerySelector

Typ selektoru pro komponentu VideoGallery.

VideoGalleryTogetherModeParticipantPosition

Rozhraní reprezentující pozici účastníka v režimu Společně.

ViewScalingMode

Režim škálování VideoGalleryStream.

Funkce

CallAgentProvider(CallAgentProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Volání komponent z tohoto balíčku musí být zabaleno CallAgentProvider.

CallClientProvider(CallClientProviderProps)

<xref:React.Context>, který ukládá StatefulCallClient .

Volání komponent z tohoto balíčku musí být zabaleno CallClientProvider.

CallComposite(CallCompositeProps)

Přizpůsobitelné uživatelské rozhraní složené pro prostředí volání.

CallProvider(CallProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-calling%23Call>.

Volání komponent z tohoto balíčku musí být zabaleno CallProvider.

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite spojuje klíčové komponenty, které poskytují kompletní hovor s chatovacím prostředím.

CameraButton(CameraButtonProps)

Tlačítko pro zapnutí nebo vypnutí kamery.

Lze použít s ControlBar.

CaptionsBanner(CaptionsBannerProps)

Komponenta pro zobrazení CaptionsBanner s ikonou uživatele, displayName a textem titulků.

CaptionsSettingsModal(CaptionsSettingsModalProps)

komponenta pro nastavení mluvených jazyků

ChatClientProvider(ChatClientProviderProps)

<xref:React.Context>, který ukládá StatefulChatClient.

Součásti chatu z tohoto balíčku musí být zabaleny ChatClientProvider.

ChatComposite(ChatCompositeProps)

Přizpůsobitelné uživatelské rozhraní složené pro prostředí chatu.

ChatThreadClientProvider(ChatThreadClientProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Součásti chatu z tohoto balíčku musí být zabaleny ChatThreadClientProvider.

ControlBar(ControlBarProps)

Kontejner pro různá tlačítka pro ovládací prvky volání.

V této knihovně můžete používat různá tlačítka ovládacích prvků volání, například CameraButton nebo vlastní instance ControlBarButton přímo.

ControlBarButton(ControlBarButtonProps)

Výchozí styl tlačítka pro ControlBar.

Pomocí této komponenty vytvořte vlastní tlačítka, která jsou ve stylu stejné jako ostatní tlačítka poskytovaná knihovnou uživatelského rozhraní.

DevicesButton(DevicesButtonProps)

Tlačítko pro otevření nabídky, která řídí možnosti zařízení.

Lze použít s ControlBar.

Dialpad(DialpadProps)

Komponenta, která uživatelům umožňuje zadat telefonní číslo kliknutím na číselník/pomocí klávesnice Vrátí prázdnou komponentu pro stabilní sestavení

EndCallButton(EndCallButtonProps)

Tlačítko pro ukončení probíhajícího hovoru

Lze použít s ControlBar.

ErrorBar(ErrorBarProps)

Komponenta pro zobrazení chybových zpráv v uživatelském rozhraní Všechny řetězce, které lze zobrazit, jsou přijímány jako řetězce, aby je bylo možné lokalizovat. Aktivní chyby jsou vybrány activeErrorMessages.

Tato komponenta interně sleduje zavřené uživatelem.

  • Chyby s přidruženým časovým razítkem: Chyba se znovu zobrazí v uživatelském rozhraní, pokud k ní dojde po zavření.
  • Chyby, které nemají časové razítko: Chyba se zavře, dokud z props nezmizí. Pokud se chyba opakuje, zobrazí se v uživatelském rozhraní.

Používá <xref:%40fluentui%2Freact%23MessageBar> prvek uživatelského rozhraní.

FluentThemeProvider(FluentThemeProviderProps)

Zprostředkovatel pro použití motivu Fluent v rámci komponent react této knihovny

GridLayout(GridLayoutProps)

Komponenta pro rozložení dlaždic účastníků zvuku nebo videa v hovoru.

HoldButton(HoldButtonProps)

tlačítko pro podržení nebo obnovení probíhajícího hovoru.

Lze použít s ovládacím panelem ControlBar

ImageOverlay(ImageOverlayProps)

Komponenta pro vykreslení modálního okna na celou obrazovku pro vybraný obraz.

IncomingCallNotification(IncomingCallNotificationProps)

Komponenta Oznámení, která má být použita k reprezentaci příchozích hovorů koncovému uživateli. Umožňuje uživateli přijmout nebo odmítnout příchozí hovor.

IncomingCallStack(IncomingCallStackProps)

Wrapper pro správu více příchozích hovorů

LocalizationProvider(LocalizationProviderProps)

Zprostředkovatel, který poskytuje lokalizované řetězce pro komponenty react této knihovny.

MessageStatusIndicator(MessageStatusIndicatorProps)

Komponenta pro zobrazení stavu odeslané zprávy

Přidá ikonu a popis odpovídající stavu zprávy.

MessageThread(MessageThreadProps)

MessageThread umožňuje snadno vytvořit komponentu pro vykreslování chatových zpráv, zpracování chování posouvání nových nebo starých zpráv a přizpůsobení ikon & ovládacích prvků uvnitř vlákna chatu.

MicrophoneButton(MicrophoneButtonProps)

Tlačítko pro zapnutí nebo vypnutí mikrofonu

Lze použít s ControlBar.

Notification(NotificationProps)

Komponenta pro zobrazení zpráv s oznámením v uživatelském rozhraní.

NotificationStack(NotificationStackProps)

Komponenta pro zobrazení oznámení v uživatelském rozhraní. Všechny řetězce, které lze zobrazit, jsou přijímány jako řetězce, aby je bylo možné lokalizovat. Aktivní notifikace jsou vybrány activeNotifications.

Tato komponenta interně sleduje zavřené uživatelem.

  • Oznámení, která mají přidružené časové razítko: Oznámení se znovu zobrazí v uživatelském rozhraní, pokud k němu dojde po zavření.
  • Oznámení, která nemají časové razítko: Oznámení je zavřeno, dokud nezmizí z rekvizit. Pokud se oznámení opakuje, zobrazí se v uživatelském rozhraní.
ParticipantItem(ParticipantItemProps)

Komponenta pro vykreslení volajícího nebo chatovacího účastníka

Zobrazí avatara, displayName a stav účastníka a také volitelné ikony a místní nabídku.

ParticipantList(ParticipantListProps)

Komponenta pro vykreslení všech účastníků volání nebo chatu

Ve výchozím nastavení se každý účastník zobrazí s ParticipantItem. Viz <xref:ParticipantListProps.onRenderParticipant> k přepsání.

ParticipantsButton(ParticipantsButtonProps)

Tlačítko pro zobrazení nabídky s volajícími nebo účastníky chatu

Lze použít s ControlBar.

Toto tlačítko obsahuje položky rozevírací nabídky definované prostřednictvím jeho vlastnosti menuProps. Ve výchozím nastavení může zobrazit počet vzdálených účastníků s úplným seznamem jako dílčí nabídka a možnost ztlumit všechny účastníky a tlačítko zkopírovat do schránky a zkopírovat adresu URL pozvánky na volání. Tento menuProps může být plně redefinován a jeho vlastnost je typu IContextualMenualProps.

RaiseHandButton(RaiseHandButtonProps)

Tlačítko pro spuštění nebo zastavení sdílení obrazovky

Lze použít s ControlBar.

ReactionButton(ReactionButtonProps)

Tlačítko pro odeslání reakce.

Lze použít s ControlBar.

RealTimeText(RealTimeTextProps)

Komponenta pro zobrazení jednoho řádku RealTimeText

RealTimeTextModal(RealTimeTextModalProps)

komponenta pro modální text realTimeText

ScreenShareButton(ScreenShareButtonProps)

Tlačítko pro spuštění nebo zastavení sdílení obrazovky

Lze použít s ControlBar.

SendBox(SendBoxProps)

Součást pro psaní a odesílání zpráv

Podporuje odesílání oznámení o psaní, když uživatel začne zadávat text. Podporuje volitelnou zprávu pod polem pro zadání textu.

StartCaptionsButton(StartCaptionsButtonProps)

Tlačítko pro spuštění nebo zastavení titulků

Lze použít s ovládacím panelem ControlBar

StartRealTimeTextButton(StartRealTimeTextButtonProps)

tlačítko pro spuštění RealTimeText na základě požadavku na přístupnost, po zapnutí nelze text v reálném čase vypnout

Lze použít s ovládacím panelem ControlBar

StreamMedia(StreamMediaProps)

Pomocná komponenta pro převod HTMLElement s video streamem na prvek JSX.

Slouží k převodu HTMLElement vrácené bezobrazovým voláním rozhraní API na komponentu, která se dá vykreslit jako VideoTile.

TypingIndicator(TypingIndicatorProps)

Komponenta, která upozorní místního uživatele, když jeden nebo více účastníků v chatovacím vlákně píše.

VideoGallery(VideoGalleryProps)

VideoGallery představuje rozložení dlaždic videa pro konkrétní volání. Zobrazí VideoTile pro místního uživatele i pro každého vzdáleného účastníka, který se připojil k hovoru.

VideoTile(VideoTileProps)

Komponenta pro vykreslení streamu videa pro jednoho účastníka hovoru.

Použití s GridLayout v VideoGallery.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Vytvořte CallAdapter zálohované službou Azure Communication Services.

Toto je výchozí implementace CallAdapter poskytovaná touto knihovnou.

Poznámka: displayName může mít maximálně 256 znaků.

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

Vytvořte CallAdapter zálohované službou Azure Communication Services.

Toto je výchozí implementace CallAdapter poskytovaná touto knihovnou.

Poznámka: displayName může mít maximálně 256 znaků.

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)

Vytvořte CallAdapter pomocí zadaného StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Vytvořte CallAdapter pomocí zadaného StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Vytvořte CallWithChatAdapter s podporou komunikačních služeb Azure, abyste se mohli připojit k CallWithChatComposite.

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Vytvořte CallWithChatAdapter pomocí poskytnutého StatefulChatClient a StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulChatClient a StatefulCallClient. Upozorňujeme, že chatThreadClient musí být vytvořen StatefulChatClient prostřednictvím rozhraní API chatClient.getChatThreadClient(chatThreadId). Zvažte použití createAzureCommunicationCallWithChatAdapter pro jednodušší rozhraní API.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Vytvořte ChatAdapter zálohovaný službou Azure Communication Services.

Toto je výchozí implementace ChatAdapter poskytovaná touto knihovnou.

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Vytvořte ChatAdapter pomocí poskytnutého StatefulChatClient.

Užitečné, pokud chcete zachovat odkaz na StatefulChatClient. Zvažte použití createAzureCommunicationChatAdapter pro jednodušší rozhraní API.

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

Vytvořte výchozí implementaci Volající obslužné rutiny pro volání týmů.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Vytvořte výchozí implementaci ChatHandlers.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

Vrácený objekt se zapisuje, aby se zabránilo rerenders při použití jako props pro React Components.

createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })

Vytvořte výchozí implementaci TeamsCallingHandlers pro volání týmů.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Vytvoří StatefulCallClient StatefulCallClient proxying CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> s proxyCallClient <xref:ProxyCallClient>, který pak umožňuje přístup k stavu deklarativním způsobem.

Je důležité použít <xref:%40azure%2Fcommunication-calling%23DeviceManager> a <xref:%40azure%2Fcommunication-calling%23CallAgent> a <xref:%40azure%2Fcommunication-calling%23Call> (a atd.), které jsou získány ze StatefulCallClient, aby se změny stavu správně proxiovaly.

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Vytvoří stavový ChatClient StatefulChatClient proxying ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> s proxyChatClient <xref:ProxyChatClient>, který pak umožňuje přístup k stavu deklarativním způsobem.

createTeamsCallAdapter(TeamsCallAdapterArgs)
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Vytvořte TeamsCallAdapter pomocí poskytnutého StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

fromFlatCommunicationIdentifier(string)

Reverzní operace toFlatCommunicationIdentifier.

getCallingSelector<Component>(Component)

Získejte selektor pro zadanou komponentu.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

getChatSelector<Component>(Component)

Získejte selektor pro zadanou komponentu.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Funkce Loader pro CallComposite, kterou můžete použít ve své aplikaci. Tato funkce načte CallComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní Node, který není založen na Reactu.

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Rekvizity pro CallWithChatComposite , které můžete použít ve své aplikaci. Tato funkce načte CallWithChatComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Funkce Loader pro ChatComposite, kterou můžete použít ve své aplikaci. Tato funkce načte ChatComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Funkce loader pro OutboundCallComposite , kterou můžete použít ve své aplikaci. Tato funkce načte CallComposite do poskytnutého elementu HTML pro odchozí volání. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

onResolveDeepNoiseSuppressionDependency()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

onResolveDeepNoiseSuppressionDependencyLazy()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

onResolveVideoEffectDependency()

Řešení závislostí pro efekty videa na pozadí.

onResolveVideoEffectDependencyLazy()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

toFlatCommunicationIdentifier(CommunicationIdentifier)

Řetězcové znázornění <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Toto řetězcové vyjádření CommunicationIdentifieru je zaručeno stabilní pro jedinečného uživatele komunikace. Tedy

  • Dá se použít k zachování identity uživatele v externích databázích.
  • lze ho použít jako klíče do mapy k ukládání dat pro uživatele.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Vlastní hook React pro zjednodušení vytváření CallAdapter.

Podobně jako createAzureCommunicationCallAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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

Vlastní hook React pro zjednodušení vytváření CallWithChatAdapter.

Podobně jako createAzureCommunicationCallWithChatAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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

Vlastní háček React pro zjednodušení vytváření ChatAdapter.

Podobně jako createAzureCommunicationChatAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

useCall()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23Call> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

K použití tohoto háku musíte dříve použít CallProvider s objektem Call.

useCallAgent()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23CallAgent> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useCallClient()

Připojte se k získání StatefulCallClient od zprostředkovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useChatClient()

Připojte se k získání StatefulChatClient od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useChatThreadClient()

Připojte se k získání <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useDeviceManager()

Připojte se k získání StatefulDeviceManager od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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

Primární háček pro získání všech háků nezbytných pro komponentu React z této knihovny.

Aby bylo možné tento háček volat, komponenta musí být zabalena pod těmito poskytovateli:

  1. Součásti chatu: ChatClientProvider a ChatThreadClientProvider.

  2. Pro volání komponent: CallClientProvider, CallAgentProvider a CallAgentProvider.

Nejjednodušší použití komponent vypadá takto:

příklad

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

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

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

Zahoďte a získejte selektor pro zadanou součást.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useTeamsCall()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23TeamsCall> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

k použití tohoto háku je nutné dříve použít CallProvider s objektem TeamsCall

useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)

Vlastní zásuvný modul React pro zjednodušení vytváření TeamsCallAdapter.

Podobné , <xref:createTeamsAzureCommunicationCallAdapter>ale interně se stará o asynchronní vytvoření adaptéru.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

useTeamsCallAgent()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

useTheme()

Reagujte háček pro přístup k tématu

Podrobnosti funkce

CallAgentProvider(CallAgentProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Volání komponent z tohoto balíčku musí být zabaleno CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parametry

Návraty

Element

CallClientProvider(CallClientProviderProps)

<xref:React.Context>, který ukládá StatefulCallClient .

Volání komponent z tohoto balíčku musí být zabaleno CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parametry

Návraty

Element

CallComposite(CallCompositeProps)

Přizpůsobitelné uživatelské rozhraní složené pro prostředí volání.

function CallComposite(props: CallCompositeProps): Element

Parametry

Návraty

Element

Poznámky

Volání složené minimální šířky/výšky je následující:

  • mobile: 17.5rem x 21rem (280px x 336px, s výchozím rem na 16px)
  • desktop: 30rem x 22rem (480px x 352px, s výchozím rem na 16px)

CallProvider(CallProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-calling%23Call>.

Volání komponent z tohoto balíčku musí být zabaleno CallProvider.

function CallProvider(props: CallProviderProps): Element

Parametry

Návraty

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite spojuje klíčové komponenty, které poskytují kompletní hovor s chatovacím prostředím.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parametry

Návraty

Element

CameraButton(CameraButtonProps)

Tlačítko pro zapnutí nebo vypnutí kamery.

Lze použít s ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parametry

Návraty

Element

CaptionsBanner(CaptionsBannerProps)

Komponenta pro zobrazení CaptionsBanner s ikonou uživatele, displayName a textem titulků.

function CaptionsBanner(props: CaptionsBannerProps): Element

Parametry

Návraty

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

komponenta pro nastavení mluvených jazyků

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

Parametry

Návraty

Element

ChatClientProvider(ChatClientProviderProps)

<xref:React.Context>, který ukládá StatefulChatClient.

Součásti chatu z tohoto balíčku musí být zabaleny ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parametry

Návraty

Element

ChatComposite(ChatCompositeProps)

Přizpůsobitelné uživatelské rozhraní složené pro prostředí chatu.

function ChatComposite(props: ChatCompositeProps): Element

Parametry

Návraty

Element

Poznámky

Složená minimální šířka a výška chatu jsou v uvedeném pořadí 17,5rem a 20rem (280px a 320px, s výchozím rem na 16px).

ChatThreadClientProvider(ChatThreadClientProviderProps)

<xref:React.Context>, která ukládá <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Součásti chatu z tohoto balíčku musí být zabaleny ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parametry

Návraty

Element

ControlBar(ControlBarProps)

Kontejner pro různá tlačítka pro ovládací prvky volání.

V této knihovně můžete používat různá tlačítka ovládacích prvků volání, například CameraButton nebo vlastní instance ControlBarButton přímo.

function ControlBar(props: ControlBarProps): Element

Parametry

Návraty

Element

ControlBarButton(ControlBarButtonProps)

Výchozí styl tlačítka pro ControlBar.

Pomocí této komponenty vytvořte vlastní tlačítka, která jsou ve stylu stejné jako ostatní tlačítka poskytovaná knihovnou uživatelského rozhraní.

function ControlBarButton(props: ControlBarButtonProps): Element

Parametry

Návraty

Element

DevicesButton(DevicesButtonProps)

Tlačítko pro otevření nabídky, která řídí možnosti zařízení.

Lze použít s ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parametry

Návraty

Element

Dialpad(DialpadProps)

Komponenta, která uživatelům umožňuje zadat telefonní číslo kliknutím na číselník/pomocí klávesnice Vrátí prázdnou komponentu pro stabilní sestavení

function Dialpad(props: DialpadProps): Element

Parametry

props
DialpadProps

Návraty

Element

EndCallButton(EndCallButtonProps)

Tlačítko pro ukončení probíhajícího hovoru

Lze použít s ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parametry

Návraty

Element

ErrorBar(ErrorBarProps)

Komponenta pro zobrazení chybových zpráv v uživatelském rozhraní Všechny řetězce, které lze zobrazit, jsou přijímány jako řetězce, aby je bylo možné lokalizovat. Aktivní chyby jsou vybrány activeErrorMessages.

Tato komponenta interně sleduje zavřené uživatelem.

  • Chyby s přidruženým časovým razítkem: Chyba se znovu zobrazí v uživatelském rozhraní, pokud k ní dojde po zavření.
  • Chyby, které nemají časové razítko: Chyba se zavře, dokud z props nezmizí. Pokud se chyba opakuje, zobrazí se v uživatelském rozhraní.

Používá <xref:%40fluentui%2Freact%23MessageBar> prvek uživatelského rozhraní.

function ErrorBar(props: ErrorBarProps): Element

Parametry

Návraty

Element

FluentThemeProvider(FluentThemeProviderProps)

Zprostředkovatel pro použití motivu Fluent v rámci komponent react této knihovny

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parametry

Návraty

Element

Poznámky

Komponenty v této knihovně se skládají především z uživatelského rozhraní Fluent, ovládacích prvků, kombinování ovládacích prvků v8 a v9. Tento poskytovatel zpracovává použití jakéhokoli poskytnutého motivu na základní ovládací prvky uživatelského rozhraní Fluent. *

GridLayout(GridLayoutProps)

Komponenta pro rozložení dlaždic účastníků zvuku nebo videa v hovoru.

function GridLayout(props: GridLayoutProps): Element

Parametry

Návraty

Element

HoldButton(HoldButtonProps)

tlačítko pro podržení nebo obnovení probíhajícího hovoru.

Lze použít s ovládacím panelem ControlBar

function HoldButton(props: HoldButtonProps): Element

Parametry

props
HoldButtonProps

vlastnosti pro tlačítko Přidržet.

Návraty

Element

ImageOverlay(ImageOverlayProps)

Komponenta pro vykreslení modálního okna na celou obrazovku pro vybraný obraz.

function ImageOverlay(props: ImageOverlayProps): Element

Parametry

Návraty

Element

IncomingCallNotification(IncomingCallNotificationProps)

Komponenta Oznámení, která má být použita k reprezentaci příchozích hovorů koncovému uživateli. Umožňuje uživateli přijmout nebo odmítnout příchozí hovor.

function IncomingCallNotification(props: IncomingCallNotificationProps): Element

Parametry

Návraty

Element

IncomingCallStack(IncomingCallStackProps)

Wrapper pro správu více příchozích hovorů

function IncomingCallStack(props: IncomingCallStackProps): Element

Parametry

props
IncomingCallStackProps

<xref:IncomingCallManagerProps>

Návraty

Element

LocalizationProvider(LocalizationProviderProps)

Zprostředkovatel, který poskytuje lokalizované řetězce pro komponenty react této knihovny.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parametry

Návraty

Element

Poznámky

Komponenty budou ve výchozím nastavení poskytovány lokalizované řetězce v angličtině (USA), pokud se tento zprostředkovatel nepoužívá.

MessageStatusIndicator(MessageStatusIndicatorProps)

Komponenta pro zobrazení stavu odeslané zprávy

Přidá ikonu a popis odpovídající stavu zprávy.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parametry

Návraty

Element

MessageThread(MessageThreadProps)

MessageThread umožňuje snadno vytvořit komponentu pro vykreslování chatových zpráv, zpracování chování posouvání nových nebo starých zpráv a přizpůsobení ikon & ovládacích prvků uvnitř vlákna chatu.

function MessageThread(props: MessageThreadProps): Element

Parametry

props
MessageThreadProps

typu MessageThreadProps

Uživatelé budou muset poskytnout aspoň chatové zprávy a ID uživatele, aby vykreslili komponentu MessageThread. Uživatelé si také můžou přizpůsobit MessageThread předáním vlastního avatara, ikony MessageStatusIndicator, JumpToNewMessageButton, LoadPreviousMessagesButton a chování těchto ovládacích prvků.

MessageThread interně používá komponentu Chat z @fluentui-contrib/chat. Podrobnosti o těchto komponentách si můžete prohlédnout zde.

Návraty

Element

MicrophoneButton(MicrophoneButtonProps)

Tlačítko pro zapnutí nebo vypnutí mikrofonu

Lze použít s ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parametry

Návraty

Element

Notification(NotificationProps)

Komponenta pro zobrazení zpráv s oznámením v uživatelském rozhraní.

function Notification(props: NotificationProps): Element

Parametry

Návraty

Element

NotificationStack(NotificationStackProps)

Komponenta pro zobrazení oznámení v uživatelském rozhraní. Všechny řetězce, které lze zobrazit, jsou přijímány jako řetězce, aby je bylo možné lokalizovat. Aktivní notifikace jsou vybrány activeNotifications.

Tato komponenta interně sleduje zavřené uživatelem.

  • Oznámení, která mají přidružené časové razítko: Oznámení se znovu zobrazí v uživatelském rozhraní, pokud k němu dojde po zavření.
  • Oznámení, která nemají časové razítko: Oznámení je zavřeno, dokud nezmizí z rekvizit. Pokud se oznámení opakuje, zobrazí se v uživatelském rozhraní.
function NotificationStack(props: NotificationStackProps): Element

Parametry

Návraty

Element

ParticipantItem(ParticipantItemProps)

Komponenta pro vykreslení volajícího nebo chatovacího účastníka

Zobrazí avatara, displayName a stav účastníka a také volitelné ikony a místní nabídku.

function ParticipantItem(props: ParticipantItemProps): Element

Parametry

Návraty

Element

ParticipantList(ParticipantListProps)

Komponenta pro vykreslení všech účastníků volání nebo chatu

Ve výchozím nastavení se každý účastník zobrazí s ParticipantItem. Viz <xref:ParticipantListProps.onRenderParticipant> k přepsání.

function ParticipantList(props: ParticipantListProps): Element

Parametry

Návraty

Element

ParticipantsButton(ParticipantsButtonProps)

Tlačítko pro zobrazení nabídky s volajícími nebo účastníky chatu

Lze použít s ControlBar.

Toto tlačítko obsahuje položky rozevírací nabídky definované prostřednictvím jeho vlastnosti menuProps. Ve výchozím nastavení může zobrazit počet vzdálených účastníků s úplným seznamem jako dílčí nabídka a možnost ztlumit všechny účastníky a tlačítko zkopírovat do schránky a zkopírovat adresu URL pozvánky na volání. Tento menuProps může být plně redefinován a jeho vlastnost je typu IContextualMenualProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parametry

Návraty

Element

RaiseHandButton(RaiseHandButtonProps)

Tlačítko pro spuštění nebo zastavení sdílení obrazovky

Lze použít s ControlBar.

function RaiseHandButton(props: RaiseHandButtonProps): Element

Parametry

Návraty

Element

ReactionButton(ReactionButtonProps)

Tlačítko pro odeslání reakce.

Lze použít s ControlBar.

function ReactionButton(props: ReactionButtonProps): Element

Parametry

Návraty

Element

RealTimeText(RealTimeTextProps)

Komponenta pro zobrazení jednoho řádku RealTimeText

function RealTimeText(props: RealTimeTextProps): Element

Parametry

Návraty

Element

RealTimeTextModal(RealTimeTextModalProps)

komponenta pro modální text realTimeText

function RealTimeTextModal(props: RealTimeTextModalProps): Element

Parametry

Návraty

Element

ScreenShareButton(ScreenShareButtonProps)

Tlačítko pro spuštění nebo zastavení sdílení obrazovky

Lze použít s ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parametry

Návraty

Element

SendBox(SendBoxProps)

Součást pro psaní a odesílání zpráv

Podporuje odesílání oznámení o psaní, když uživatel začne zadávat text. Podporuje volitelnou zprávu pod polem pro zadání textu.

function SendBox(props: SendBoxProps): Element

Parametry

props
SendBoxProps

Návraty

Element

StartCaptionsButton(StartCaptionsButtonProps)

Tlačítko pro spuštění nebo zastavení titulků

Lze použít s ovládacím panelem ControlBar

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

Parametry

props
StartCaptionsButtonProps

vlastnosti pro tlačítko Úvodní titulky.

Návraty

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

tlačítko pro spuštění RealTimeText na základě požadavku na přístupnost, po zapnutí nelze text v reálném čase vypnout

Lze použít s ovládacím panelem ControlBar

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

Parametry

props
StartRealTimeTextButtonProps

pro tlačítko Spustit RealTimeText.

Návraty

Element

StreamMedia(StreamMediaProps)

Pomocná komponenta pro převod HTMLElement s video streamem na prvek JSX.

Slouží k převodu HTMLElement vrácené bezobrazovým voláním rozhraní API na komponentu, která se dá vykreslit jako VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Parametry

Návraty

Element

TypingIndicator(TypingIndicatorProps)

Komponenta, která upozorní místního uživatele, když jeden nebo více účastníků v chatovacím vlákně píše.

function TypingIndicator(props: TypingIndicatorProps): Element

Parametry

Návraty

Element

VideoGallery(VideoGalleryProps)

VideoGallery představuje rozložení dlaždic videa pro konkrétní volání. Zobrazí VideoTile pro místního uživatele i pro každého vzdáleného účastníka, který se připojil k hovoru.

function VideoGallery(props: VideoGalleryProps): Element

Parametry

Návraty

Element

VideoTile(VideoTileProps)

Komponenta pro vykreslení streamu videa pro jednoho účastníka hovoru.

Použití s GridLayout v VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parametry

Návraty

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Vytvořte CallAdapter zálohované službou Azure Communication Services.

Toto je výchozí implementace CallAdapter poskytovaná touto knihovnou.

Poznámka: displayName může mít maximálně 256 znaků.

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

Parametry

Návraty

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

Vytvořte CallAdapter zálohované službou Azure Communication Services.

Toto je výchozí implementace CallAdapter poskytovaná touto knihovnou.

Poznámka: displayName může mít maximálně 256 znaků.

function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>

Parametry

Návraty

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)

Vytvořte CallAdapter pomocí zadaného StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>

Parametry

callClient
StatefulCallClient
callAgent
CallAgent
targetCallees

CommunicationIdentifier[]

Návraty

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Vytvořte CallAdapter pomocí zadaného StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

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

Parametry

callClient
StatefulCallClient
callAgent
CallAgent

Návraty

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Vytvořte CallWithChatAdapter s podporou komunikačních služeb Azure, abyste se mohli připojit k CallWithChatComposite.

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

Parametry

Návraty

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Vytvořte CallWithChatAdapter pomocí poskytnutého StatefulChatClient a StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulChatClient a StatefulCallClient. Upozorňujeme, že chatThreadClient musí být vytvořen StatefulChatClient prostřednictvím rozhraní API chatClient.getChatThreadClient(chatThreadId). Zvažte použití createAzureCommunicationCallWithChatAdapter pro jednodušší rozhraní API.

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

Parametry

Návraty

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Vytvořte ChatAdapter zálohovaný službou Azure Communication Services.

Toto je výchozí implementace ChatAdapter poskytovaná touto knihovnou.

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

Parametry

Návraty

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Vytvořte ChatAdapter pomocí poskytnutého StatefulChatClient.

Užitečné, pokud chcete zachovat odkaz na StatefulChatClient. Zvažte použití createAzureCommunicationChatAdapter pro jednodušší rozhraní API.

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

Parametry

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient
chatAdapterOptions
ChatAdapterOptions

Návraty

Promise<ChatAdapter>

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

Vytvořte výchozí implementaci Volající obslužné rutiny pro volání týmů.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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

Návraty

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Vytvořte výchozí implementaci ChatHandlers.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

Vrácený objekt se zapisuje, aby se zabránilo rerenders při použití jako props pro React Components.

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

Parametry

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Návraty

createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })

Vytvořte výchozí implementaci TeamsCallingHandlers pro volání týmů.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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> }

Návraty

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Vytvoří StatefulCallClient StatefulCallClient proxying CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> s proxyCallClient <xref:ProxyCallClient>, který pak umožňuje přístup k stavu deklarativním způsobem.

Je důležité použít <xref:%40azure%2Fcommunication-calling%23DeviceManager> a <xref:%40azure%2Fcommunication-calling%23CallAgent> a <xref:%40azure%2Fcommunication-calling%23Call> (a atd.), které jsou získány ze StatefulCallClient, aby se změny stavu správně proxiovaly.

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

Parametry

Návraty

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Vytvoří stavový ChatClient StatefulChatClient proxying ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> s proxyChatClient <xref:ProxyChatClient>, který pak umožňuje přístup k stavu deklarativním způsobem.

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

Parametry

Návraty

createTeamsCallAdapter(TeamsCallAdapterArgs)

function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>

Parametry

Návraty

Promise<TeamsCallAdapter>

createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Vytvořte TeamsCallAdapter pomocí poskytnutého StatefulCallClient.

Užitečné, pokud chcete zachovat odkaz na StatefulCallClient. Zvažte použití createAzureCommunicationCallAdapter pro jednodušší rozhraní API.

function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>

Parametry

callClient
StatefulCallClient
callAgent
TeamsCallAgent

Návraty

Promise<TeamsCallAdapter>

fromFlatCommunicationIdentifier(string)

Reverzní operace toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parametry

id

string

Návraty

getCallingSelector<Component>(Component)

Získejte selektor pro zadanou komponentu.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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

Parametry

component

Component

Návraty

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Získejte selektor pro zadanou komponentu.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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

Parametry

component

Component

Návraty

GetChatSelector<Component>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Funkce Loader pro CallComposite, kterou můžete použít ve své aplikaci. Tato funkce načte CallComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní Node, který není založen na Reactu.

function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

Parametry

htmlElement

HTMLElement

Návraty

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Rekvizity pro CallWithChatComposite , které můžete použít ve své aplikaci. Tato funkce načte CallWithChatComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>

Parametry

htmlElement

HTMLElement

Návraty

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Funkce Loader pro ChatComposite, kterou můžete použít ve své aplikaci. Tato funkce načte ChatComposite do poskytnutého elementu HTML. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>

Parametry

htmlElement

HTMLElement

Návraty

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Funkce loader pro OutboundCallComposite , kterou můžete použít ve své aplikaci. Tato funkce načte CallComposite do poskytnutého elementu HTML pro odchozí volání. Nejlepší případ použití je v rámci uživatelského rozhraní uzlu, který není založen na Reactu.

function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

Parametry

htmlElement

HTMLElement

Návraty

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

Návraty

onResolveDeepNoiseSuppressionDependencyLazy()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

Návraty

onResolveVideoEffectDependency()

Řešení závislostí pro efekty videa na pozadí.

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

Návraty

onResolveVideoEffectDependencyLazy()

Řešení závislostí pro efekty videa na pozadí pomocí opožděného načítání.

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

Návraty

toFlatCommunicationIdentifier(CommunicationIdentifier)

Řetězcové znázornění <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Toto řetězcové vyjádření CommunicationIdentifieru je zaručeno stabilní pro jedinečného uživatele komunikace. Tedy

  • Dá se použít k zachování identity uživatele v externích databázích.
  • lze ho použít jako klíče do mapy k ukládání dat pro uživatele.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parametry

Návraty

string

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

Vlastní hook React pro zjednodušení vytváření CallAdapter.

Podobně jako createAzureCommunicationCallAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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>

Návraty

undefined | CallAdapter

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

Vlastní hook React pro zjednodušení vytváření CallWithChatAdapter.

Podobně jako createAzureCommunicationCallWithChatAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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

Parametry

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

Návraty

undefined | CallWithChatAdapter

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

Vlastní háček React pro zjednodušení vytváření ChatAdapter.

Podobně jako createAzureCommunicationChatAdapter, ale stará se o asynchronní vytvoření adaptéru interně.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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

Parametry

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Návraty

undefined | ChatAdapter

useCall()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23Call> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

K použití tohoto háku musíte dříve použít CallProvider s objektem Call.

function useCall(): undefined | Call

Návraty

undefined | Call

useCallAgent()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23CallAgent> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useCallAgent(): undefined | CallAgent

Návraty

undefined | CallAgent

useCallClient()

Připojte se k získání StatefulCallClient od zprostředkovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useCallClient(): StatefulCallClient

Návraty

useChatClient()

Připojte se k získání StatefulChatClient od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useChatClient(): StatefulChatClient

Návraty

useChatThreadClient()

Připojte se k získání <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useChatThreadClient(): ChatThreadClient

Návraty

useDeviceManager()

Připojte se k získání StatefulDeviceManager od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useDeviceManager(): undefined | StatefulDeviceManager

Návraty

undefined | StatefulDeviceManager

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

Primární háček pro získání všech háků nezbytných pro komponentu React z této knihovny.

Aby bylo možné tento háček volat, komponenta musí být zabalena pod těmito poskytovateli:

  1. Součásti chatu: ChatClientProvider a ChatThreadClientProvider.

  2. Pro volání komponent: CallClientProvider, CallAgentProvider a CallAgentProvider.

Nejjednodušší použití komponent vypadá takto:

příklad

    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"

Návraty

ComponentProps<Component>

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

Zahoďte a získejte selektor pro zadanou součást.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

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"

Návraty

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

useTeamsCall()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23TeamsCall> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

k použití tohoto háku je nutné dříve použít CallProvider s objektem TeamsCall

function useTeamsCall(): undefined | TeamsCall

Návraty

undefined | TeamsCall

useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)

Vlastní zásuvný modul React pro zjednodušení vytváření TeamsCallAdapter.

Podobné , <xref:createTeamsAzureCommunicationCallAdapter>ale interně se stará o asynchronní vytvoření adaptéru.

Umožňuje nedefinovat argumenty, abyste mohli respektovat pravidla háky a předávat argumenty při jejich vytváření. Adaptér se vytvoří pouze v případech, kdy jsou definovány všechny argumenty.

Všimněte si, že argumenty je nutné si zapamatovat, abyste se vyhnuli opětovnému vytvoření adaptéru na každém vykreslení. Příklady použití najdete v článku o typických příkladech použití.

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>

Návraty

undefined | TeamsCallAdapter

useTeamsCallAgent()

Připojte se k získání <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> od poskytovatele.

Užitečné při implementaci vlastní komponenty, která využívá zprostředkovatele exportované z této knihovny.

function useTeamsCallAgent(): undefined | TeamsCallAgent

Návraty

undefined | TeamsCallAgent

useTheme()

Reagujte háček pro přístup k tématu

function useTheme(): Theme

Návraty

Theme