@azure/communication-react package

Fel som utlöses från misslyckade tillståndskänsliga API-metoder.

Fel som utlöses från misslyckade StatefulChatClient-metoder .

Aktiva felmeddelanden som ska visas via Felfältet.

Fel som rapporteras via felhändelser och lagras i adaptertillstånd.

Funktioner för gränssnitt med sammansatt adaptertillstånd.

Egenskaper som är gemensamma för alla sammansatta objekt som exporteras från det här biblioteket.

Grundläggande fluent stilar rekvisita för alla komponenter som exporteras från detta libray.

Ett nätverkskortsgränssnitt som är specifikt för Azure Communication-identitet som utökar CommonCallAdapter.

Funktioner för att hantera det aktuella samtalet eller starta ett nytt samtal

Funktioner för att hantera det aktuella anropet.

Funktioner för att hantera enheter i ett anrop.

Anropa sammansatta händelser som kan prenumereras på.

Argument för att initiera en CallAgentProvider.

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23CallAgent> utom anrop flyttas till att vara underordnad direkt till CallClientState och ingår inte här. Anledningen till att CallAgents tillstånd är proportionellt är att ge åtkomst till displayName. Vi plattar inte ut CallAgent.displayName och placerar det i CallClientState eftersom det skulle vara tvetydigt att displayName faktiskt är beroende av att CallAgent skapas/finns tillgängligt.

Argument för användning i createAzureCommunicationCallWithChatAdapter för att ansluta till ett samtal med en associerad chatttråd.

Argument för att initiera en CallClientProvider.

Container för alla tillståndsdata som proxieras av StatefulCallClient. Tillstånden calls, callsEnded, incomingCalls och incomingCallsEnded tillhandahålls automatiskt om en callAgent har skapats. DeviceManager kommer att vara tom tills den är ifylld, se DeviceManagerState. UserId-tillståndet tillhandahålls som en bekvämlighet för utvecklaren och är helt kontrollerat och konfigurerat av utvecklaren.

Rekvisita för CallComposite.

Strängar som används av CallComposite direkt.

Dessa strängar är utöver de som används av komponenterna från komponentbiblioteket.

Argument för att initiera en CallProvider.

Ange endast version av <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient hämtar automatiskt samtalets tillstånd och lägger till det i det tillstånd som exponeras av StatefulCallClient.

CallWithChatComposite Adaptergränssnitt.

Funktioner för att hantera det aktuella samtalet med chatt.

CallWithChat State är en kombination av tillståndskänsliga chatt- och tillståndskänsliga samtalsklienter med vissa tillstånd som är specifika endast för CallWithChat Composite.

Samtals- och chatthändelser som kan prenumereras på i CallWithChatAdapter.

Användargränssnittstillstånd som rör CallWithChatComposite.

Tillstånd från serverdelstjänsterna som kör CallWithChatComposite.

Rekvisita som krävs för CallWithChatComposite

Strängar som används av CallWithChatComposite direkt.

Dessa strängar är utöver de som används av komponenterna från komponentbiblioteket.

CallWithChatComposite Anropa kontroller för att visa eller dölja knappar i det anropande kontrollfältet.

Objekt som innehåller alla hanterare som krävs för att anropa komponenter.

Anropa relaterade komponenter från det här paketet kan välja ut relevanta hanterare från det här objektet. Se <xref:useHandlers> och användPropsFor.

Anpassad Fluent-temapall som används för att anropa relaterade komponenter i det här biblioteket.

Format för menyn CameraButton .

Rekvisita för CameraButton-komponent .

Strängar av CameraButton som kan åsidosättas.

Format för CameraButton

Chatta sammansatta händelser som kan prenumereras på.

Funktioner för att hantera den aktuella chatttråden.

Rekvisita för ChatComposite.

Strängar som används av ChatComposite direkt.

Dessa strängar är utöver de som används av komponenterna från komponentbiblioteket.

Ett chattmeddelande.

CallComposite Adaptergränssnitt.

Objekt som innehåller alla hanterare som krävs för att anropa komponenter.

Anropa relaterade komponenter från det här paketet kan välja ut relevanta hanterare från det här objektet. Se <xref:useHandlers> och användPropsFor.

Språkinformation för alla komponenter som exporteras från det här biblioteket.

Strängar som används av alla komponenter som exporteras från det här biblioteket.

Språkinformation för alla sammansatta element som exporteras från det här biblioteket.

Strängar som används direkt i kompositerna.

Dessa strängar används av kompositerna direkt, i stället för av de inneslutna komponenterna.

Ett systemmeddelande med arbitary-innehåll.

Rekvisita för ControlBarButton.

Strängar av ControlBarButton som kan åsidosättas.

Props för ControlBar.

Objektet returnerades när ett lokalt eller fjärranslutet VideoStream skapades. Det här innehåller hjälpfunktioner för att manipulera strömmens återgivning.

En anpassad meddelandetyp.

Anpassade meddelanden återges inte som standard, men program kan tillhandahålla anpassade renderare för dem.

Format för menyn EnheterKnapp .

Props for DevicesButton.

Strängar av EnheterButton som kan åsidosättas.

Format för menyalternativen enheter.

Endast tillståndsproxy för <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.

Funktioner för korrekt disponering av en sammansatt.

Rekvisita för EndCallButton.

Strängar av EndCallButton som kan åsidosättas.

Props för ErrorBar.

Utöver följande vidarebefordrar ErrorBar alla <xref:%40fluentui%2Freact%23IMessageBarProps> till den underliggande <xref:%40fluentui%2Freact%23MessageBar>.

Alla strängar som kan visas i användargränssnittet i Felfältet.

Rekvisita för FluentThemeProvider.

Rekvisita för GridLayout.

Rutnätlayout Komponentformat.

<xref:HorizontalGallery> Komponentformat.

Ange endast version av <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient identifierar automatiskt inkommande samtal och lägger till deras tillstånd i det tillstånd som exponeras av StatefulCallClient.

Argument för <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

Ange endast version av <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

Endast tillståndsproxy för <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.

Vanliga egenskaper för alla meddelandetyper.

Props för MessageStatusIndicator.

Strängar av MessageStatusIndicator som kan åsidosättas.

Strängar av MessageThread som kan åsidosättas.

Fluent-formatmallar för MessageThread.

Format för menyn MicrophoneButton .

Rekvisita för MicrophoneButton.

Strängar av MicrophoneButton som kan åsidosättas.

Format för MicrophoneButton

Ange endast proxy för <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.

En enhet, t.ex. kamera, mikrofon eller högtalare, i den utfällbara menyn EnheterKnapp .

Ett systemmeddelande som meddelar att en deltagare har lagts till i chatttråden.

Props för ParticipantItem.

Strängar av ParticipantItem som kan åsidosättas.

Fluent-formatmallar för ParticipantItem.

Format för ParticipantListParticipantItem.

Format för ParticipantList.

Ett systemmeddelande som meddelar att en deltagare har tagits bort från chatttråden.

Format för menyn ParticipantsButton .

Rekvisita för ParticipantsButton.

Strängar av ParticipantsButton som kan åsidosättas.

Utformar props för ParticipantsButton.

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient lyssnar automatiskt efter inspelningstillståndet för anropet och uppdaterar tillståndet som exponeras av StatefulCallClient i enlighet med detta.

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient hämtar automatiskt RemoteParticipants och lägger till deras tillstånd i det tillstånd som exponeras av StatefulCallClient.

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

Rekvisita för ScreenShareButton.

Strängar av ScreenShareButton som kan åsidosättas.

Rekvisita för SendBox.

Strängar i SendBox som kan åsidosättas.

Fluent-formatmallar för <xref:Sendbox>.

Definierar de metoder som tillåter att CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> används tillståndsfullt. Gränssnittet ger åtkomst till ett proportionellt tillstånd och tillåter även registrering av en hanterare för tillståndsändringshändelser. Tillståndsdefinition finns i CallClientState.

Tillståndsändringshändelser drivs av:

• Returnerade data från <xref:%40azure%2Fcommunication-calling%23DeviceManager> API:er.
• Returnerade data från <xref:%40azure%2Fcommunication-calling%23CallAgent> API:er.
• Lyssnare ansluts automatiskt till olika azure communication-calling-objekt:
  • CallAgent "incomingCall"
  • CallAgent "callsUpdated"
  • DeviceManager "videoDevicesUpdated"
  • DeviceManager 'audioDevicesUpdated
  • DeviceManager "selectedMicrophoneChanged"
  • DeviceManager "selectedSpeakerChanged"
  • Anropa "stateChanged"
  • Anropa "idChanged"
  • Anropa "isMutedChanged"
  • Anropa "isScreenSharingOnChanged"
  • Anropa "remoteParticipantsUpdated"
  • Anropa "localVideoStreamsUpdated"
  • IncomingCall "callEnded"
  • RemoteParticipant "stateChanged"
  • RemoteParticipant "isMutedChanged"
  • RemoteParticipant "displayNameChanged"
  • RemoteParticipant "isSpeakingChanged"
  • RemoteParticipant "videoStreamsUpdated"
  • RemoteVideoStream "isAvailableChanged"
  • TranscriptionCallFeature "isTranscriptionActiveChanged"
  • RecordingCallFeature "isRecordingActiveChanged"

Definierar de metoder som tillåter att {@Link @azure/communication-chat#ChatClient} används med ett centraliserat genererat tillstånd.

Gränssnittet ger åtkomst till ett proportionellt tillstånd och tillåter även registrering av en hanterare för tillståndsändringshändelser.

Definierar de ytterligare metoder som läggs till av den tillståndskänsliga ovanpå <xref:%40azure%2Fcommunication-calling%23DeviceManager>.

Rekvisita för StreamMedia.

Vanliga egenskaper för alla systemmeddelanden.

Ett systemmeddelande som meddelar att chatttrådsavsnittet har uppdaterats.

Ange endast version av <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient lyssnar automatiskt efter transkriptionstillstånd för samtalet och uppdaterar tillståndet som exponeras av StatefulCallClient i enlighet därmed.

Props for TypingIndicator.

Strängar av TypingIndicator som kan åsidosättas.

Fluent-format för att skrivaIndicator.

Rekvisita för VideoGallery.

Tillståndet för en fjärransluten deltagare i VideoGallery.

Videoström av en deltagare i VideoGallery.

Alla strängar som kan visas i användargränssnittet i VideoGallery.

VideoGallery Komponentformat.

Alternativ för att styra hur videoströmmar återges.

Ange endast version av <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Den här egenskapen läggs till i tillståndet som exponeras av StatefulCallClient av createView och tas bort av disposeView.

Rekvisita för VideoTile.

Fluent-format för VideoTile.

Kort lagrar det senaste felet för varje åtgärd i tillståndet .

target är en nätverkskortsdefinierad sträng för varje unik åtgärd som utförs av adaptern.

Jämför om 2 react-komponenter är exakt lika med, resultattypen är true/false

Jämför om rekvisita för 2 react-komponenter är lika, resultattypen är true/false

Jämför om två typer är lika, resultattypen blir true/false

Anpassade dataattribut för visning av avatar för en användare.

Återanropsfunktionen som används för att tillhandahålla anpassade data för att skapa en avatar för en användare.

Argument för att skapa Azure Communication Services implementering av CallAdapter.

displayName Obs! Får innehålla högst 256 tecken.

Argument för att skapaAzureCommunicationCallWithChatAdapter

Argument för <xref:createAzureCommunicationCallWithChatAdapterFromClient>

Argument för att skapa Azure Communication Services implementering av ChatAdapter.

Nyttolast för CallEndedListener som innehåller information om det avslutade samtalet.

CommonCallAdapter-tillstånd härleds från Azure Communication Services serverdel.

Positionerare som används av createAzureCommunicationCallAdapter för att hitta anropet till join

CommonCallAdapter-tillstånd .

CommonCallAdapter-tillstånd för rena användargränssnittsändamål.

Ikoner som kan åsidosättas för CallComposite.

Valfria funktioner i CallComposite.

Huvudskärmar för användargränssnittet som visas på CallComposite.

Visningstyp för kontrollfältet för CallComposite.

Anpassningsalternativ för kontrollfältet i samtalsupplevelsen.

Motringning för CallAdapterSubscribers "callEnded"-händelse.

Väljaretyp för ErrorBar-komponent .

Strängliteraltyp för alla tillåtna nycklar i {@Link CallErrors}.

Fel som skickas från API-anrop till anropande SDK.

Varje egenskap i objektet lagrar det senaste felet för en viss SDK API-metod.

Fel från det här objektet kan rensas med hjälp av <xref:newClearCallErrorsModifier>. Dessutom rensas fel automatiskt när:

• Tillståndet är avmarkerat.
• Efterföljande anrop till relaterade API-metoder lyckas. Mer information om när fel kan rensas automatiskt finns i dokumentationen om enskilda tillståndskänsliga klientmetoder.

Motringning för CallAdapterSubscribers "callIdChanged"-händelse.

Anropa deltagarens tillstånd enligt UI-komponenterna.

Ikoner som kan åsidosättas för CallWithChatComposite.

Valfria funktioner i CallWithChatComposite.

Händelser som utlöstes av CallWithChatAdapter.

Vanliga rekvisita som används för att referera till anrop av deklarativt klienttillstånd.

Hjälptyp för usePropsFor.

Väljaretyp för CameraButton-komponenten .

ChatComposite Adaptergränssnitt.

ChatAdapter-tillstånd .

ChatAdapter-tillstånd för rent användargränssnitt.

Vanliga rekvisita för väljare för ChatClientState.

Argument för att initiera en ChatClientProvider.

Centraliserat tillstånd för <xref:%40azure%2Fcommunication-chat%23ChatClient>.

ChatAdapter-tillstånd härleds från Azure Communication Services serverdel.

Ikoner som kan åsidosättas för ChatComposite.

Valfria funktioner i ChatComposite.

Väljaretyp för ErrorBar-komponent .

Strängliteraltyp för alla tillåtna nycklar i ChatErrors.

Fel som skickas från API-anrop till Chatt-SDK.

Varje egenskap i objektet lagrar det senaste felet för en viss SDK API-metod.

Objekt som innehåller alla hanterare som krävs för chattkomponenter.

Chattrelaterade komponenter från det här paketet kan välja ut relevanta hanterare från det här objektet. Se <xref:useHandlers> och användPropsFor.

Ett tillägg till <xref:%40azure%2Fcommunication-chat%23ChatMessage> som lagrar endast metadata på klientsidan för chattmeddelanden.

TODO: Namnet har bitrotted. Byt namn på mig.

Väljaretyp för ParticipantList-komponenten .

Hjälptyp för usePropsFor.

Argument för att initiera en ChatThreadClientProvider.

Centraliserat tillstånd för <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Egenskaper för en chatttråd.

Vi definierar en minimal som hjälper oss att dölja de olika typer som används av underliggande API.

Centraliserat tillstånd för <xref:%40azure%2Fcommunication-calling%23CallClient> eller <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Se även : CallClientState, ChatClientState.

Returnera intersect-typ av 2 typer

Returnera intersect-egenskaper för 2 typer

En chatt- eller samtalsdeltagares tillstånd, vilket visas i användargränssnittet.

Ikoner som används av React-komponenter som exporteras från det här biblioteket.

Hjälptyp för usePropsFor.

Ikoner som kan åsidosättas i någon av de kompositer som exporteras av det här biblioteket.

Mer måltyper finns i ChatCompositeIcons, CallCompositeIcons och CallWithChatCompositeIcons .

Format för alla ControlBarButton-implementeringar .

Presentera layouter för Kontrollfältet.

Returnera resultat från createView.

Alternativ som kan matas in i onRender funktionen för att anpassa en Avatar-komponent (Persona).

Den här typen är avsedd att kapsla in alla tillstånd i <xref:%40azure%2Fcommunication-calling%23DeviceManager>. För valfria parametrar är de kanske inte tillgängliga förrän behörigheten har beviljats av användaren. Kamerorna, mikrofonerna, högtalarna och deviceAccess-tillstånden kommer att vara tomma tills motsvarande <xref:%40azure%2Fcommunication-calling%23DeviceManager>getCameras, getMicrophones, getSpeakers och askDevicePermission-API:er anropas och slutförs.

Väljaretyp för DevicesButton-komponent .

Återanrop för CallAdapterSubscribers "diagnosticChanged"-händelse.

Motringning för CallAdapterSubscribers "displayNameChanged"-händelse.

En typ för triviala väljare som inte returnerar några data.

Används som standardvärde om usePropsFor anropas för en komponent som inte kräver några data.

Alla fel som kan visas i felfältet.

Specifik typ av väljare som gäller för en viss komponent.

Specifik typ av väljare som gäller för en viss komponent.

Motringning för CallAdapterSubscribers "isLocalScreenSharingActiveChanged"-händelse.

Motringning för CallAdapterSubscribers "isMuted"-händelse.

Motringning för CallAdapterSubscribers "isSpeakingChanged"-händelse.

Om strömmen läses in eller inte.

Props för LocalizationProvider.

Nyttolast för DiagnosticChangedEventListner där en mediediagnostik har ändrats.

Diskriminerad union av alla meddelanden.

Fältet messageType specialiserar sig på union varianter.

Ange om ett chattmeddelande ska visas sammanfogat med meddelandet före/efter det.

Användbart för att sammanfoga många meddelanden från samma avsändare till en enda meddelandebubbla.

Typer av chattmeddelandeinnehåll som stöds.

Rekvisita för att återge ett enda meddelande.

Se MessageRenderer.

Motringning för ChatAdapterSubscribers "messageRead"-händelse.

Motringning för ChatAdapterSubscribers "messageReceived"-händelse.

En komponent för att återge ett enda meddelande.

Motringning för ChatAdapterSubscribers "messageSent"-händelse.

Tillstånd på klientsidan för ett skickat meddelande.

Innehåller övergångstillstånd som inträffar innan meddelandeleverans bekräftas från serverdelen.

Rekvisita för MessageThread.

Väljartyp för MessageThread-komponenten .

Väljartyp för MicrophoneButton-komponent .

Nyttolast för DiagnosticChangedEventListner där en nätverksdiagnostik ändras.

Ett anpassat återanrop som gör att användarna kan anpassa återgivningen av en Persona-komponent.

Deltagare som visas i en Deltagarlista.

Props för ParticipantList.

Väljartyp för Komponenten ParticipantList .

Ett återanrop för att tillhandahålla anpassade menyalternativ för varje deltagare i ParticipantList.

Anslutningstillståndet för en samtalsdeltagare.

Återanrop för ChatAdapterSubscribers "participantsAdded"-händelse.

Väljartyp för Komponenten ParticipantsButton .

Återanrop till CallAdapterSubscribers "participantsJoined"-händelse.

Återanrop till CallAdapterSubscribers "participantsLeft"-händelse.

Återanrop för ChatAdapterSubscribers "participantsRemoved"-händelse.

En matris med nyckelvärdepar som lagrar varje avsändares visningsnamn och senaste lästa meddelande

Väljartyp för ScreenShareButton-komponent .

En optimerad väljare som förfinar ClientState-uppdateringar till rekvisita för React-komponenter i det här biblioteket.

Väljartyp för SendBox-komponent .

Argument för att konstruera StatefulCallClient.

Alternativ för att konstruera StatefulCallClient med.

Argument för att konstruera StatefulChatClient.

Alternativ för att konstruera StatefulChatClient.

Diskriminerad union av alla systemmeddelanden.

Fältet systemMessageType specialiserar sig på union varianter.

Motringning för ChatAdapterSubscribers "topicChanged"-händelse.

Typ av väljare för komponenten TypingIndicator .

Återanropsfunktionen körs när ett meddelande uppdateras.

Den lokala deltagarens tillstånd i VideoGallery.

Tillståndet för en deltagare i VideoGallery.

Typ av väljare för VideoGallery-komponenten .

Skalningsläge för en VideoGalleryStream.

En <xref:React.Context> som lagrar en <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Anropande komponenter från det här paketet måste omslutas med en CallAgentProvider.

En <xref:React.Context> som lagrar en StatefulCallClient.

Anropande komponenter från det här paketet måste omslutas med en CallClientProvider.

En anpassningsbar UI-komposit för samtalsupplevelse.

En <xref:React.Context> som lagrar en <xref:%40azure%2Fcommunication-calling%23Call>.

Anropande komponenter från det här paketet måste omslutas med en CallProvider.

CallWithChatComposite sammanför viktiga komponenter för att tillhandahålla ett fullständigt samtal med chattupplevelse direkt.

En knapp för att slå på/av kameran.

Kan användas med ControlBar.

En <xref:React.Context> som lagrar en StatefulChatClient.

Chattkomponenter från det här paketet måste omslutas med en ChatClientProvider.

En anpassningsbar UI-komposit för chattupplevelsen.

En <xref:React.Context> som lagrar en <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Chattkomponenter från det här paketet måste omslutas med en ChatThreadClientProvider.

En container för olika knappar för anropskontroller.

Använd med olika knappar för anropskontroll i det här biblioteket, t.ex. CameraButton eller dina egna instanser av ControlBarButton direkt.

Standardknapp formaterad för Kontrollfältet.

Använd den här komponenten för att skapa anpassade knappar som är formaterade på samma sätt som andra knappar som tillhandahålls av användargränssnittsbiblioteket.

En knapp för att öppna en meny som styr enhetsalternativ.

Kan användas med ControlBar.

En knapp för att avsluta ett pågående samtal.

Kan användas med ControlBar.

En komponent som visar felmeddelanden i användargränssnittet. Alla strängar som kan visas accepteras som strängar så att de kan lokaliseras. Aktiva fel väljs av activeErrorMessages.

Den här komponenten spårar internt avvisad av användaren.

• Fel som har en associerad tidsstämpel: Felet visas i användargränssnittet igen om det inträffar när det har stängts.
• Fel som inte har någon tidsstämpel: Felet avvisas tills det försvinner från rekvisitan. Om felet återkommer visas det i användargränssnittet.

Använder <xref:%40fluentui%2Freact%23MessageBar> UI-element.

Provider för att tillämpa ett Fluent-tema i bibliotekets react-komponenter.

En komponent för att lägga ut paneler för ljud-/videodeltagare i ett anrop.

Provider för att tillhandahålla lokaliserade strängar för bibliotekets react-komponenter.

Komponent för att visa status för ett skickat meddelande.

Lägger till en ikon och knappbeskrivning som motsvarar meddelandestatusen.

MessageThread Gör att du enkelt kan skapa en komponent för återgivning av chattmeddelanden, hantera rullningsbeteendet för nya/gamla meddelanden och anpassa ikoner & kontroller i chatttråden.

En knapp för att slå på/av mikrofonen.

Kan användas med ControlBar.

Komponent för att återge en samtals- eller chattdeltagare.

Visar deltagarens avatar, displayName och status samt valfria ikoner och snabbmeny.

Komponent för att återge alla samtals- eller chattdeltagare.

Som standard renderas varje deltagare med ParticipantItem. Se åsidosättning <xref:ParticipantListProps.onRenderParticipant> .

En knapp för att visa en meny med samtals- eller chattdeltagare.

Kan användas med ControlBar.

Den här knappen innehåller listrutemenyobjekt som definierats via dess egenskap menuProps. Som standard kan den visa antalet fjärrdeltagare med den fullständiga listan som undermeny och ett alternativ för att stänga av ljudet för alla deltagare, samt en knapp för att kopiera samtalsinbjudan till Urklipp för att kopiera url:en för samtalsinbjudan. Detta menuProps kan omdefinieras helt och dess egenskap är av typen IContextualMenuProps.

En knapp för att starta/stoppa skärmdelning.

Kan användas med ControlBar.

Komponent för att skriva och skicka meddelanden.

Stöd för att skicka skrivmeddelanden när användaren börjar ange text. Stöder ett valfritt meddelande under textinmatningsfältet.

Verktygskomponent för att konvertera en HTMLElement med en videoström till ett JSX-element.

Använd för att konvertera ett HTMLElement som returneras av huvudlöst anropande API till en komponent som kan renderas som en VideoTile.

Komponent som meddelar den lokala användaren när en eller flera deltagare i chatttråden skriver.

VideoGallery representerar en layout av videopaneler för ett specifikt anrop. Den visar en VideoTile för den lokala användaren samt för varje fjärrdeltagare som har anslutit till samtalet.

En komponent för att återge videoströmmen för en deltagare med ett enda samtal.

Använd med GridLayout i ett VideoGallery.

Skapa en CallAdapter som backas upp av Azure Communication Services.

Det här är standardimplementeringen av CallAdapter som tillhandahålls av det här biblioteket.

displayName Obs! Kan vara högst 256 tecken.

Skapa en CallAdapter med hjälp av den tillhandahållna StatefulCallClient.

Användbart om du vill behålla en referens till StatefulCallClient. Överväg att använda createAzureCommunicationCallAdapter för ett enklare API.

Skapa en CallWithChatAdapter som backas upp av Azure Communication Services för att ansluta till CallWithChatComposite.

Skapa en CallWithChatAdapter med hjälp av den tillhandahållna StatefulChatClient och StatefulCallClient.

Användbart om du vill behålla en referens till StatefulChatClient och StatefulCallClient. Överväg att använda createAzureCommunicationCallWithChatAdapter för ett enklare API.

Skapa en ChatAdapter som backas upp av Azure Communication Services.

Det här är standardimplementeringen av ChatAdapter som tillhandahålls av det här biblioteket.

Skapa en ChatAdapter med hjälp av den tillhandahållna StatefulChatClient.

Användbart om du vill behålla en referens till StatefulChatClient. Överväg att använda createAzureCommunicationChatAdapter för ett enklare API.

Skapa standardimplementeringen av CallingHandlers för teams-anrop.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Skapa standardimplementeringen av ChatHandlers.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Returnerade objekt pmiseras för att undvika avsändare när det används som rekvisita för React-komponenter.

Skapar en StatefulCallClient StatefulCallClient genom att proxyservern CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> med ProxyCallClient <xref:ProxyCallClient> som sedan tillåter åtkomst till tillstånd på ett deklarativt sätt.

Det är viktigt att använda och <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (och etc.) som erhålls från StatefulCallClient för att deras tillståndsändringar ska kunna proxieras korrekt.

Skapar en tillståndskänslig ChatClient StatefulChatClient genom att proxyservern ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> med ProxyChatClient <xref:ProxyChatClient> som sedan tillåter åtkomst till tillstånd på ett deklarativt sätt.

Omvänd åtgärd av toFlatCommunicationIdentifier.

Hämta väljaren för en angiven komponent.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Hämta väljaren för en angiven komponent.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

En strängrepresentation av en <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Den här strängrepresentationen av CommunicationIdentifier är garanterad stabil för en unik kommunikationsanvändare. Således

• Den kan användas för att bevara en användares identitet i externa databaser.
• Den kan användas som nycklar i en karta för att lagra data för användaren.

En anpassad React krok för att förenkla skapandet av CallAdapter.

Liknar att skapaAzureCommunicationCallAdapter, men tar hand om asynkron skapande av adaptern internt.

Tillåter att argumenten är odefinierade så att du kan respektera regeln för krokar och skicka argument när de skapas. Kortet skapas bara när alla argument har definierats.

Observera att du måste pmisera argumenten för att undvika att återskapa adaptern för varje återgivning. Se sagobok för vanliga användningsexempel.

En anpassad React krok för att förenkla skapandet av CallWithChatAdapter.

Liknar att skapaAzureCommunicationCallWithChatAdapter, men tar hand om asynkron skapande av adaptern internt.

Tillåter att argumenten är odefinierade så att du kan respektera regeln för krokar och skicka argument när de skapas. Kortet skapas bara när alla argument har definierats.

Observera att du måste pmisera argumenten för att undvika att återskapa adaptern för varje återgivning. Se sagobok för vanliga användningsexempel.

En anpassad React krok för att förenkla skapandet av ChatAdapter.

Liknar att skapaAzureCommunicationChatAdapter, men tar hand om asynkron skapande av adaptern internt.

Tillåter att argumenten är odefinierade så att du kan respektera regeln för krokar och skicka argument när de skapas. Kortet skapas bara när alla argument har definierats.

Observera att du måste pmisera argumenten för att undvika att återskapa adaptern för varje återgivning. Se sagobok för vanliga användningsexempel.

Hook för att få <xref:%40azure%2Fcommunication-calling%23Call> från leverantören.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

du måste tidigare ha använt CallProvider med ett samtalsobjekt för att använda den här kroken

Hook för att få <xref:%40azure%2Fcommunication-calling%23CallAgent> från leverantören.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Hook för att hämta StatefulCallClient från providern.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Anslut för att hämta StatefulChatClient från providern.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Hook för att få <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> från leverantören.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Hook för att hämta StatefulDeviceManager från providern.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

Primär krok för att få alla krokar som krävs för en React komponent från det här biblioteket.

För att anropa den här kroken måste komponenten omslutas under dessa providrar:

1. För chattkomponenter: ChatClientProvider och ChatThreadClientProvider.

2. För att anropa komponenter: CallClientProvider, CallAgentProvider och CallAgentProvider.

Den enklaste användningen av komponenter ser ut så här:

Exempel

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

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

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

Krok för att hämta en väljare för en angiven komponent.

Användbart när du implementerar en anpassad komponent som använder de leverantörer som exporteras från det här biblioteket.

React hook to access-tema