Dela via


@azure/communication-react package

Klasser

CallError

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

ChatError

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

Gränssnitt

AcceptedTransfer

Tillstånd för överföringsfunktion

ActiveErrorMessage

Aktiva felmeddelanden som ska visas via ErrorBar.

ActiveNotification

Aktiva meddelanden som ska visas via NotificationStack.

AdapterError

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

AdapterNotification

Meddelande från samtalsklienttillståndet som lagras i korttillstånd.

AdapterState

Funktioner för att samverka med sammansatt adaptertillstånd.

AttachmentMetadata

Datamodell som representerar en bifogad fil i ett chattmeddelande där den innehåller ett ID för att unikt identifiera den bifogade filen, ett namn som representerar namnet på filen och en URL för att ladda ned den bifogade filen.

BaseCompositeProps

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

BaseCustomStyles

Grundläggande flytande formatrekvisita för alla komponenter som exporteras från detta libray.

BreakoutRoomsState

Tillstånd för smågrupper

CallAdapter

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

CallAdapterCallManagement

Funktioner för att hantera det aktuella anropet eller starta ett nytt anrop

CallAdapterCallOperations

Funktioner för att hantera det aktuella anropet.

CallAdapterDeviceManagement

Funktioner för att hantera enheter inom ett anrop.

CallAdapterSubscribers

Anropa sammansatta händelser som kan prenumereras på.

CallAgentProviderProps

Argument för att initiera en CallAgentProvider.

CallAgentState

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23CallAgent> förutom anrop flyttas till att vara ett underordnat 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.

CallAndChatLocator

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

CallClientProviderProps

Argument för att initiera en CallClientProvider.

CallClientState

Container för alla tillståndsdata som 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 styrt och inställt av utvecklaren.

CallCompositeLoaderProps

Rekvisita för OutboundCallComposite som du kan använda i ditt program.

Innehåller två alternativpåsar:

CallCompositeProps

Rekvisita för CallComposite.

CallCompositeStrings

Strängar som används av CallComposite direkt.

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

CallFeatureStreamState

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Representerar tillståndet för samtalsfunktionens ström.

CallInfoState

tillstånd för att spåra typerna <xref:CallInfo> och <xref:TeamsCallInfo>

CallNotification
CallProviderProps

Argument för att initiera en CallProvider.

CallState

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

CallSurveyImprovementSuggestions

Representerar den del av samtalsundersökningen som är föremål för förbättringsförslag

CallWithChatAdapter

CallWithChatComposite Adapter-gränssnittet.

CallWithChatAdapterManagement

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

CallWithChatAdapterState

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

CallWithChatAdapterSubscriptions

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

CallWithChatAdapterUiState

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

CallWithChatClientState

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

CallWithChatCompositeLoaderProps

Rekvisita för CallWithChatComposite som du kan använda i ditt program.

Innehåller två alternativpåsar:

CallWithChatCompositeProps

Rekvisita som krävs för CallWithChatComposite

CallWithChatCompositeStrings

Strängar som används av CallWithChatComposite direkt.

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

CallWithChatControlOptions

Anpassningsalternativ för kontrollfältet i samtal med chattupplevelse.

CallingHandlers

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 usePropsFor.

CallingTheme

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

CameraButtonContextualMenuStyles

Format för menyn CameraButton.

CameraButtonProps

Rekvisita för CameraButton komponent.

CameraButtonStrings

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

CameraButtonStyles

Format för CameraButton

CapabilitiesFeatureState

Endast tillståndsversion av <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>

CapabilityChangedNotificationStrings

Strängar för meddelande om ändrad funktion

CaptionLanguageStrings

Textningsspråksträngar för undertextinställning modal

CaptionsBannerProps

CaptionsRekvisita för bannerkomponent.

CaptionsBannerStrings

Strängar för banderoll för bildtexter

CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps

CaptionsSettingsRekvisita för modala komponenter.

CaptionsSettingsModalStrings

Strängar för bildtextinställning modal

ChatAdapterSubscribers

Chatta sammansatta händelser som kan prenumereras på.

ChatAdapterThreadManagement

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

ChatCompositeLoaderProps

Rekvisita för ChatComposite som du kan använda i ditt program. Innehåller alternativen för ChatCompositeChatCompositeOptions.

ChatCompositeProps

Rekvisita för ChatComposite.

ChatCompositeStrings

Strängar som används av ChatComposite direkt.

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

ChatMessage

Ett chattmeddelande.

CommonCallAdapter

CallComposite Adapter-gränssnittet.

CommonCallingHandlers

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 usePropsFor.

ComponentLocale

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

ComponentStrings

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

CompositeLocale

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

CompositeStrings

Strängar som används i kompositerna direkt.

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

ConferencePhoneInfo

Information för telefoninfo för konferens

ContentSystemMessage

Ett systemmeddelande med arbitary-innehåll.

ControlBarButtonProps

Rekvisita för ControlBarButton.

ControlBarButtonStrings

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

ControlBarProps

Rekvisita för ControlBar.

CreateVideoStreamViewResult

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

CustomCallControlButtonCallbackArgs

Argument för CustomCallControlButtonCallback.

CustomCallControlButtonProps

Svar från CustomCallControlButtonCallback. Innehåller de grundläggande rekvisita som krävs för att rendera en ControlBarButton eller <xref:DrawerMenuItem>.

CustomCallControlButtonStrings

Strängar för CustomCallControlButtons

CustomMessage

En anpassad meddelandetyp.

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

DevicesButtonContextualMenuStyles

Format för menyn DevicesButton.

DevicesButtonProps

Rekvisita för DevicesButton.

DevicesButtonStrings

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

DevicesButtonStyles

Format för menyalternativen Enheter.

DiagnosticsCallFeatureState

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

DialpadProps

Rekvisita för Dialpad-komponenten .

DialpadStrings

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

DialpadStyles

Stilar för Dialpad-komponenten .

Disposable

Funktioner för korrekt disponering av en sammansatt.

DtmfDialPadOptions

Alternativ för att fastställa återgivningsbeteendet för dtmfDialer i CallComposite

EndCallButtonProps

Rekvisita för EndCallButton.

EndCallButtonStrings

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

ErrorBarProps

Props för ErrorBar.

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

ErrorBarStrings

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

FluentThemeProviderProps

Rekvisita för FluentThemeProvider.

GridLayoutProps

Rekvisita för GridLayout.

GridLayoutStyles

GridLayout komponentformat.

HoldButtonProps
HoldButtonStrings

Strängar för etiketterna för hållknappen

HorizontalGalleryStyles

<xref:HorizontalGallery> komponentformat.

ImageOverlayProps

Rekvisita för ImageOverlay.

ImageOverlayStrings

Strängar med ImageOverlay som kan åsidosättas.

IncomingCallNotificationProps

Egenskaper för komponenten för avisering om inkommande samtal.

IncomingCallNotificationStrings

Strängar för komponenten för avisering om inkommande samtal.

IncomingCallNotificationStyles

Format för komponenten för avisering om inkommande samtal.

IncomingCallStackCall

Representerar ett aktivt inkommande samtal.

IncomingCallStackProps

Rekvisita för komponenten IncomingCallManager.

IncomingCallState

Tillstånd 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.

InlineImage

InlineImages tillstånd, vilket återspeglas i användargränssnittet.

InlineImageOptions

Alternativ för att visa infogad bild i scenariot med infogad bild.

JoinCallOptions

Alternativ för att ställa in mikrofon- och kameratillstånd när du går med i ett samtal true = slå på enheten när du går med i samtal false = stäng av enheten när du går med i samtalet 'behåll'/odefinierad = behåll enheter' föranropstillstånd

JumpToNewMessageButtonProps

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

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

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

LocalVideoStreamVideoEffectsState

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

LocalVideoTileOptions

Alternativ för den lokala videopanelen i den sammansatta samtalsbilden.

MediaAccessState

Tillstånd för medieåtkomst

MediaDiagnosticsState

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

MeetingConferencePhoneInfoModalStrings

Strängar för modal för telefoninfo

MessageCommon

Vanliga egenskaper för alla meddelandetyper.

MessageStatusIndicatorProps

Rekvisita för MessageStatusIndicator.

MessageStatusIndicatorStrings

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

MessageThreadStrings

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

MessageThreadStyles

Fluent-formatmallar för MessageThread.

MicrophoneButtonContextualMenuStyles

Format för menyn MicrophoneButton.

MicrophoneButtonProps

Rekvisita för MicrophoneButton.

MicrophoneButtonStrings

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

MicrophoneButtonStyles

Format för MicrophoneButton

NetworkDiagnosticsState

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

NotificationOptions

Alternativ för att styra meddelandena i den sammansatta bilden.

NotificationProps

Rekvisita för anmälan.

NotificationStackProps

Rekvisita för NotificationStack.

NotificationStackStrings

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

NotificationStrings

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

NotificationStyles

Format för meddelandekomponenten.

OptimalVideoCountFeatureState

Ange endast version av funktionen för optimal videoräkning <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>.

OptionsDevice

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

OutboundCallCompositeLoaderProps

Rekvisita för OutboundCallComposite som du kan använda i ditt program.

Innehåller två alternativpåsar:

PPTLiveCallFeatureState

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

ParticipantAddedSystemMessage

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

ParticipantItemProps

Rekvisita för ParticipantItem.

ParticipantItemStrings

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

ParticipantItemStyles

Fluent-format för ParticipantItem.

ParticipantListItemStyles

Format för ParticipantListParticipantItem.

ParticipantListStyles

Formatmallar för ParticipantList.

ParticipantRemovedSystemMessage

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

ParticipantsButtonContextualMenuStyles

Format för menyn DeltagareKnapp.

ParticipantsButtonProps

Rekvisita för ParticipantsButton.

ParticipantsButtonStrings

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

ParticipantsButtonStyles

Format props för deltagareButton.

RaiseHandButtonProps

Rekvisita för RaiseHandButton.

RaiseHandButtonStrings

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

RaiseHandCallFeature

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient lyssnar automatiskt efter uppräckta händer i anropet och uppdaterar tillståndet som exponeras av StatefulCallClient i enlighet med detta.

ReactionButtonProps

Rekvisita för ReactionButton.

ReactionButtonStrings

Reaction-strängar som kan åsidosättas.

ReactionResources

Gränssnitt för animering, sprite-bild och relaterade metadata

RealTimeTextCallFeatureState
RealTimeTextInfo
RealTimeTextModalProps

RealTimeTextModal Komponent Rekvisita.

RealTimeTextModalStrings

strängar för realTimeText modal

RealTimeTextProps

Rekvisita för en enda rad RealTimeText.

RealTimeTextStrings

Strängar för RTT

RecordingCallFeature

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

RemoteParticipantState

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.

RemoteVideoStreamState

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

RemoteVideoTileMenuOptions

Menyalternativ för fjärrvideopaneler i VideoGallery.

ScreenShareButtonProps

Rekvisita för ScreenShareButton.

ScreenShareButtonStrings

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

SendBoxProps

Rekvisita för SendBox-.

SendBoxStrings

Strängar av SendBox- som kan åsidosättas.

SendBoxStylesProps

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

SpokenLanguageStrings

Talade språksträngar för textningsinställning modal

SpotlightCallFeatureState

Endast tillståndsversion av <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>

SpotlightPromptStrings

Strängar som används i prompt relaterade till spotlight

SpotlightState

Spotlight-tillstånd med ordning

StartCaptionsAdapterOptions

Alternativ som skickas till adapter.startCaptions

StartCaptionsButtonProps
StartCaptionsButtonStrings

Strängar för etiketterna för hållknappen

StartRealTimeTextButtonProps

Rekvisita för komponenten StartRealTimeTextButton

StartRealTimeTextButtonStrings

Strängar för etiketterna för hållknappen

StatefulCallClient

Definierar de metoder som gör att CallClient-<xref:%40azure%2Fcommunication-calling%23CallClient> kan användas tillståndsfullt. Gränssnittet ger åtkomst till 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-kommunikationssamtalsobjekt:
    • 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"
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raisedHandEvent'
    • RaiseHandCallFeature 'sänktHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature "reaktion"
StatefulChatClient

Definierar de metoder som gör att {@Link @azure/communication-chat#ChatClient} kan användas med ett centraliserat genererat tillstånd.

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

StatefulDeviceManager

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

StopCaptionsAdapterOptions

Alternativ som skickas till adapter.stopCaptions

StreamMediaProps

Rekvisita för StreamMedia.

SurveyIssues

Motsvarande texter till varje utlysningsutgåva

SurveyIssuesHeadingStrings

Motsvarande texter till varje kategori av utlysningsärenden

SystemMessageCommon

Vanliga egenskaper för alla systemmeddelanden.

TeamsCallAdapter

Ett adaptergränssnitt som är specifikt för Teams-identitet som utökar CommonCallAdapter.

TeamsCallingHandlers

Objekt som innehåller alla teams anropshanterare 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 usePropsFor.

TeamsIncomingCallState

Endast tillståndsversion av <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall>

TogetherModeCallFeatureState

Tillstånd endast version av <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Representerar tillståndet för funktionen Tillsammans-läge.

TogetherModeSeatingPositionState

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

Representerar sittpositionen för en deltagare i Tillsammans-läge.

TogetherModeStreamOptions

Gränssnitt som representerar resultatet av en strömvy i Tillsammans-läge.

TogetherModeStreamViewResult

Gränssnitt som representerar resultatet av en strömvy i Tillsammans-läge.

TogetherModeStreamsState

Representerar strömmarna i Tillsammans-läge.

TopicUpdatedSystemMessage

Ett systemmeddelande som meddelar att chatttrådsavsnittet har uppdaterats.

TranscriptionCallFeature

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

TransferFeature

Tillstånd för överföringsfunktion

TypingIndicatorProps

Rekvisita för TypingIndicator.

TypingIndicatorStrings

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

TypingIndicatorStylesProps

Fluent-format för TypingIndicator.

VerticalGalleryControlBarStyles

Format för kontrollfältet i VerticalGallery-komponenten

VerticalGalleryStrings

Strängar för lokalisering av det vertikala galleriet.

VerticalGalleryStyles

Format för komponenten VerticalGallery

VideoBackgroundBlurEffect

Innehåller attraktionerna för den oskärpa videobakgrundseffekten

VideoBackgroundImage

Innehåller attributen för en bakgrundsbild som url, namn etc.

VideoBackgroundNoEffect

Innehåller instruktioner för att ta bort videobakgrundseffekt

VideoBackgroundReplacementEffect

Innehåller attributen för en vald ersättningsvideobakgrundseffekt

VideoGalleryLocalParticipant

Tillståndet för den lokala deltagaren i VideoGallery.

VideoGalleryProps

Rekvisita för VideoGallery.

VideoGalleryRemoteParticipant

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

VideoGalleryStream

Videoström av en deltagare i VideoGallery.

VideoGalleryStrings

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

VideoGalleryStyles

VideoGallery Komponentformat.

VideoGalleryTogetherModeSeatingInfo

Gränssnitt som representerar information om sittplatser i Tillsammans-läge.

VideoGalleryTogetherModeStreams

Gränssnitt som representerar strömmarna i Tillsammans-läge.

VideoStreamOptions

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

VideoStreamRendererViewState

Tillstånd 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.

VideoTileContextualMenuProps

Egenskaper för att visa snabbmeny för fjärranslutna VideoTile-komponenter i VideoGallery.

VideoTileDrawerMenuProps

Egenskaper för att visa lådmenyn på fjärrkontrollen VideoTile lång tryckning i VideoGallery.

VideoTileProps

Rekvisita för VideoTile.

VideoTileStrings

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

VideoTileStylesProps

Fluent-format för VideoTile.

VideoTilesOptions

Alternativ som gäller för alla videopaneler i VideoGallery

Typalias

AdapterErrors

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

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

AdapterNotifications

Kort lagrar det senaste meddelandet för varje mål.

AreEqual

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

AreParamEqual

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

AreTypeEqual

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

AvatarPersonaData

Anpassade dataattribut för att visa avatar för en användare.

AvatarPersonaDataCallback

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

AzureCommunicationCallAdapterArgs

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

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

AzureCommunicationCallAdapterOptions

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

AzureCommunicationCallWithChatAdapterArgs

Argument för skapaAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Argument för <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

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

AzureCommunicationOutboundCallAdapterArgs

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

Dessa argument används för att skapa scenarier med utgående samtal.

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

CallAdapterCallEndedEvent

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

CallAdapterClientState

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

CallAdapterLocator

Lokaliserare som används av skapaAzureCommunicationCallAdapter för att hitta anropet för att ansluta

CallAdapterState

CommonCallAdapter tillstånd.

CallAdapterUiState

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

CallCompositeIcons

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

CallCompositeOptions

Valfria funktioner i CallComposite.

CallCompositePage

Större gränssnittsskärmar som visas i CallComposite.

CallControlDisplayType

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

CallControlOptions

Anpassningsalternativ för kontrollfältet i samtalsmiljön.

CallEndedListener

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

CallErrorBarSelector

Väljaretyp för ErrorBar- komponent.

CallErrorTarget

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

CallErrors

Fel 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 finns i dokumentationen om enskilda tillståndskänsliga klientmetoder.
CallFeatureStreamName

Representerar namnet på samtalsfunktionsströmmen

CallIdChangedListener

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

CallNotifications
CallParticipantListParticipant

Anropa deltagarens tillstånd, vilket återspeglas i användargränssnittskomponenterna.

CallWithChatCompositeIcons

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

CallWithChatCompositeOptions

Valfria funktioner i CallWithChatComposite.

CallWithChatEvent

Händelser som utlöstes av CallWithChatAdapter.

CallingBaseSelectorProps

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

CallingHandlersOptions

Konfigurationsalternativ för att inkludera bakgrundsberoende av videoeffekt.

CallingReturnProps

Hjälptyp för usePropsFor.

CallingSounds

Typ för att representera en uppsättning ljud som ska användas för olika anropande händelser

CameraButtonSelector

Väljaretyp för komponenten CameraButton.

CancelEditCallback

Återuppringningsfunktionen körs när en meddelanderedigering avbryts.

CapabilitiesChangedListener

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

CaptionSettingsSelector

Väljartyp för komponenter för att ändra textningsspråk och talat språk

CaptionsBannerSelector

Väljartyp för CaptionsBanner-komponenten .

CaptionsInformation

Information som krävs för varje bildtextrad

CaptionsOptions

Alternativpåse för att starta textning

CaptionsReceivedListener

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

ChatAdapter

ChatComposite Adapter-gränssnittet.

ChatAdapterOptions

Alternativ för att konfigurera ChatAdapter.

ChatAdapterState

ChatAdapter tillstånd.

ChatAdapterUiState

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

ChatAttachmentType

Representerar typen av bilaga

ChatBaseSelectorProps

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

ChatClientProviderProps

Argument för att initiera en ChatClientProvider.

ChatClientState

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

ChatCompositeClientState

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

ChatCompositeIcons

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

ChatCompositeOptions

Valfria funktioner i ChatComposite.

ChatErrorBarSelector

Väljaretyp för ErrorBar- komponent.

ChatErrorTarget

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

ChatErrors

Fel som uppstått från API-anrop till Chat SDK.

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

ChatHandlers

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 usePropsFor.

ChatInitializedListener

Återanrop för <xref:CallWithChatAdapterSubscribers> händelsen "chatInitialized".

ChatMessageWithStatus

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.

ChatParticipantListSelector

Väljaretyp för komponenten ParticipantList.

ChatProfile

Profilen för en användare eller robot.

ChatReturnProps

Hjälptyp för usePropsFor.

ChatThreadClientProviderProps

Argument för att initiera en ChatThreadClientProvider.

ChatThreadClientState

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

ChatThreadProperties

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.

ClientState

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

Se även: CallClientState, ChatClientState.

Common

Returnera intersektera typ av 2 typer

CommonCallAdapterOptions

Vanliga valfria parametrar för att skapa useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) eller TeamsCallAdapter

CommonCallControlOptions

Anpassningsalternativ för kontrollfältet i samtalsmiljön.

CommonProperties

Returnera intersektera egenskaper för 2 typer

CommunicationParticipant

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

ComponentIcons

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

ComponentProps

Hjälptyp för usePropsFor.

ComponentSlotStyle

ComponentSlotStyle är en @fluentui/react-northstar typ. När vi har rört oss bort från det här paketet har vi använt den mer generiska IRawStyle-typen från fluent för interoperabilitet.

CompositeIcons

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.

ControlBarButtonStyles

Formatmallar för alla ControlBarButton implementeringar.

ControlBarLayout

Presentera layouter för ControlBar.

CreateDefaultCallingHandlers

Typ av createDefaultCallingHandlers.

CreateViewResult

Returnera resultat från createView.

CustomAvatarOptions

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

CustomCallControlButtonCallback

Ett återanrop som returnerar rekvisita för att återge en anpassad ControlBarButton och <xref:DrawerMenuItem>.

Svaret anger var den anpassade knappen ska placeras.

Prestandatips: Det här återanropet anropas bara när antingen återanropet eller dess argument ändras.

CustomCallControlButtonPlacement

Placering för en anpassad knapp som matas in i <xref:CommonCallControlBar>.

"primär": Placera knapparna till höger i mitten av kontrollfältet men före EndCallButton (vänster ände i rtl-läge). 'spill': Placera knapparna/knapparna i slutet av överflödesmenyn. 'sekundär': Placera knappen/knapparna på den vänstra änden av sidokontrollfältet (höger i rtl-läge).

Flera knappar som tilldelats samma placering läggs till i ordning. T.ex., om två knappar är placerade i "sekundär", kommer de båda att visas på vänster ände (höger ände i rtl-läge) i den ordning som anges.

Endast "primär" placering fungerar när äldre samtalskontroll är aktiverad i sammansatt samtal

DeclarativeCallAgent

DeclarativeCallAgent förlänger och ger fullmakter för <xref:%40azure%2Fcommunication-calling%23CallAgent>

DeclarativeTeamsCallAgent

DeclarativeTeamsCallAgent förlänger och ger fullmakter för <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>

DeepNoiseSuppressionEffectDependency

Beroende typ som ska matas in för djup brusreducering

DeviceManagerState

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

DevicesButtonSelector

Väljaretyp för komponenten DevicesButton.

DiagnosticChangedEventListner

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

DialpadMode

Lägen för knappsatskomponenten.

DisplayNameChangedListener

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

DtmfTone

DTMF-ton för PSTN-anrop.

EmptySelector

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.

ErrorType

Alla fel som kan visas i ErrorBar.

GetCallingSelector

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

GetChatSelector

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

HoldButtonSelector

Väljartyp för HoldButton-komponenten .

IncomingCallManagement

Detta innehåller en skrivskyddad matris som returnerar alla aktiva incomingCalls. Ett aktivt inkommande samtal är ett samtal som inte har besvarats, avvisats eller kopplats bort.

IncomingCallStackSelector

Väljare för att få aktiva och borttagna inkommande samtal.

IsCaptionLanguageChangedListener

Återanrop för CallAdapterSubscribers 'isCaptionLanguageChanged'-händelse.

IsCaptionsActiveChangedListener

Återanrop för CallAdapterSubscribers 'isCaptionsActiveChanged'-händelse.

IsLocalScreenSharingActiveChangedListener

Återanrop för CallAdapterSubscribers händelsen "isLocalScreenSharingActiveChanged".

IsMutedChangedListener

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

IsSpeakingChangedListener

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

IsSpokenLanguageChangedListener

Återanrop för CallAdapterSubscribers 'isSpokenLanguageChanged'-händelse.

LoadingState

Om strömmen läses in eller inte.

LocalScreenShareView
LocalVideoTileSize

Olika lägen för den lokala videorutan

LocalizationProviderProps

Rekvisita för LocalizationProvider.

LongPressTrigger

Metoder för hur longpress-hanterarna kan tiggered.

MediaAccess

Åtkomsttillstånd för ljud/videomedia

MediaDiagnosticChangedEvent

Nyttolast för DiagnosticChangedEventListner där en mediediagnostik ändras.

Message

Diskriminerad förening av alla meddelanden.

Det messageType fältet specialiserar sig på unionsvarianter.

MessageAttachedStatus

Ange om ett chattmeddelande ska visas sammanfogat med meddelandet före/efter det. Om truedu gör det visas meddelandet grupperat med meddelandet före det. "Topp" och "Nederkant" används för att indikera att meddelandet är början eller slutet av en grupp.

MessageContentType

Typer av chattmeddelandeinnehåll som stöds.

MessageDeletedListener

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

MessageEditedListener

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

MessageProps

Rekvisita för att återge ett enda meddelande.

Se MessageRenderer.

MessageReadListener

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

MessageReceivedListener

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

MessageRenderer

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

MessageSentListener

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

MessageStatus

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

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

MessageThreadProps

Rekvisita för MessageThread.

MessageThreadSelector

Väljaretyp för MessageThread komponent.

MicrophoneButtonSelector

Väljaretyp för komponenten MicrophoneButton.

NetworkDiagnosticChangedEvent

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

NotificationStackSelector

Väljartyp för meddelandekomponenten .

NotificationTarget
NotificationType

Alla meddelanden som kan visas i NotificationStack.

OnFetchChatProfileCallback

Återanropsfunktion som används för att tillhandahålla anpassade data för att skapa en profil för en användare eller robot.

OnFetchProfileCallback

Återanropsfunktion som används för att tillhandahålla anpassade data för att skapa en profil för en användare eller robot.

OnRenderAvatarCallback

Ett anpassat återanrop som gör det möjligt för användare att anpassa återgivningen av en Persona-komponent.

OverflowGalleryPosition

Olika lägen och positioner för överflödesgalleriet i VideoGallery

ParticipantListParticipant

Deltagare som visas i en ParticipantList.

ParticipantListProps

Rekvisita för ParticipantList.

ParticipantListSelector

Väljaretyp för komponenten ParticipantList.

ParticipantMenuItemsCallback

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

ParticipantState

Anslutningstillståndet för en samtalsdeltagare.

ParticipantsAddedListener

Återanrop till ChatAdapterSubscribers "participantsAdded"-händelse.

ParticipantsButtonSelector

Väljaretyp för komponenten ParticipantsButton.

ParticipantsJoinedListener

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

ParticipantsLeftListener

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

ParticipantsRemovedListener

Återanrop till ChatAdapterSubscribers "participantsRemoved"-händelse.

Profile

Profilen för en användare eller robot.

RaiseHandButtonSelector

Väljartyp för RaiseHandButton-komponenten .

RaisedHand

Tillstånd för upphöjd hand med ordning

RaisedHandState

Tillstånd för upphöjd hand med ordning

Reaction

Reaktionstillstånd med reaktionstyp som ska återges

ReactionButtonReaction

Reaktionstyper för reaktionsknappen

ReactionSprite

Typ för animering, sprite-bild och relaterade metadata

ReactionState

Ange endast version av <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> med UI-hjälprekvisita receivedOn. Reaktionstillstånd med en tidsstämpel som hjälper användargränssnittet att bestämma sig för att återge reaktionen i enlighet med detta.

ReadReceiptsBySenderId

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

RealTimeTextInformation

Information som krävs för varje rad med realtidstext

RealTimeTextReceivedListener

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

ResourceDetails

Information som krävs för att ladda ned en resurs som ska cachelagras.

ResourceFetchResult

Resultatet av resursen som laddats ned från den tillståndskänsliga klienten

ScreenShareButtonSelector

Välj typ för ScreenShareButton komponent.

Selector

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

SendBoxSelector

Väljaretyp för SendBox- komponent.

SoundEffect

Typ för att representera ett anpassat ljud som ska användas för en anropande händelse

Spotlight

Spotlight-tillstånd med ordning

SpotlightChangedListener

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

StartCallIdentifier

Identifierartyper för att initiera ett anrop med hjälp av CallAdapter

StartCaptionsButtonSelector

Väljartyp för StartCaptionsButton-komponenten .

StatefulCallClientArgs

Argument för att konstruera StatefulCallClient.

StatefulCallClientOptions

Alternativ för att konstruera StatefulCallClient med.

StatefulChatClientArgs

Argument för att konstruera StatefulChatClient.

StatefulChatClientOptions

Alternativ för att konstruera StatefulChatClient.

SupportedCaptionLanguage
SupportedSpokenLanguage
SystemMessage

Diskriminerade en union av alla systemmeddelanden.

Det systemMessageType fältet specialiserar sig på unionsvarianter.

TeamsAdapterOptions

Valfria parametrar för att skapa TeamsCallAdapter

TeamsCallAdapterArgs

Argument för att skapa Azure Communication Services-implementeringen av TeamsCallAdapter.

TeamsCallAdapterArgsCommon

Gemensam del av args för att skapa Azure Communication Services-implementeringen av TeamsCallAdapter.

TeamsIncomingCallManagement

Proxys gränssnittet <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> .

TogetherModeParticipantSeatingState

Representerar deltagarnas sittpositioner i Tillsammans-läge.

TopicChangedListener

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

TransferAcceptedListener

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

TypingIndicatorSelector

Väljaretyp för komponenten TypingIndicator.

UpdateMessageCallback

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

VideoBackgroundEffect

Innehåller attributen för en vald videobakgrundseffekt

VideoBackgroundEffectsDependency

Beroendetyp som ska injiceras för videobakgrundseffekter

VideoGalleryLayout
VideoGalleryParticipant

Tillståndet för en deltagare i VideoGallery.

VideoGallerySelector

Väljaretyp för komponenten VideoGallery.

VideoGalleryTogetherModeParticipantPosition

Gränssnitt som representerar en mötesdeltagares position i Tillsammans-läge.

ViewScalingMode

Skalningsläge för en VideoGalleryStream.

Funktioner

CallAgentProvider(CallAgentProviderProps)

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.

CallClientProvider(CallClientProviderProps)

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

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

CallComposite(CallCompositeProps)

En anpassningsbar gränssnittskomposit för samtalsupplevelse.

CallProvider(CallProviderProps)

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(CallWithChatCompositeProps)

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

CameraButton(CameraButtonProps)

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

Kan användas med ControlBar.

CaptionsBanner(CaptionsBannerProps)

En komponent för att visa en CaptionsBanner med användarikon, displayName och bildtext.

CaptionsSettingsModal(CaptionsSettingsModalProps)

En komponent för att ställa in talade språk

ChatClientProvider(ChatClientProviderProps)

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

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

ChatComposite(ChatCompositeProps)

En anpassningsbar gränssnittskomposit för chattupplevelsen.

ChatThreadClientProvider(ChatThreadClientProviderProps)

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.

ControlBar(ControlBarProps)

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

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

ControlBarButton(ControlBarButtonProps)

Standardknapp formaterad för ControlBar.

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

DevicesButton(DevicesButtonProps)

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

Kan användas med ControlBar.

Dialpad(DialpadProps)

En komponent för att tillåta användare att ange telefonnummer genom att klicka på knappsatsen/använda tangentbordet Den kommer att returnera en tom komponent för stabila byggen

EndCallButton(EndCallButtonProps)

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

Kan användas med ControlBar.

ErrorBar(ErrorBarProps)

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 efter att det har stängts.
  • Fel som inte har en 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> användargränssnittselement.

FluentThemeProvider(FluentThemeProviderProps)

Provider för att använda ett Fluent-tema i bibliotekets react-komponenter.

GridLayout(GridLayoutProps)

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

HoldButton(HoldButtonProps)

En knapp för att parkera eller återuppta ett pågående samtal.

Kan användas med ControlBar

ImageOverlay(ImageOverlayProps)

Komponent för att återge en modal helskärmsbild för en markerad bild.

IncomingCallNotification(IncomingCallNotificationProps)

En meddelandekomponent som ska användas för att representera inkommande samtal till slutanvändaren. Gör det möjligt för användaren att acceptera eller avvisa det inkommande samtalet.

IncomingCallStack(IncomingCallStackProps)

Wrapper för att hantera flera inkommande samtal

LocalizationProvider(LocalizationProviderProps)

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

MessageStatusIndicator(MessageStatusIndicatorProps)

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

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

MessageThread(MessageThreadProps)

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

MicrophoneButton(MicrophoneButtonProps)

En knapp för att aktivera/inaktivera mikrofonen.

Kan användas med ControlBar.

Notification(NotificationProps)

En komponent för att visa meddelanden i användargränssnittet.

NotificationStack(NotificationStackProps)

En komponent för att visa meddelanden i användargränssnittet. Alla strängar som kan visas accepteras som strängar så att de kan lokaliseras. Aktiva meddelanden väljs av activeNotifications.

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

  • Meddelanden som har en associerad tidsstämpel: Meddelandet visas i användargränssnittet igen om det inträffar efter att det har stängts.
  • Meddelanden som inte har en tidsstämpel: Meddelandet avvisas tills det försvinner från rekvisitan. Om meddelandet upprepas visas det i användargränssnittet.
ParticipantItem(ParticipantItemProps)

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

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

ParticipantList(ParticipantListProps)

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

Som standard återges varje deltagare med ParticipantItem. Se <xref:ParticipantListProps.onRenderParticipant> att åsidosätta.

ParticipantsButton(ParticipantsButtonProps)

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ärranslutna deltagare med den fullständiga listan som undermeny och ett alternativ för att stänga av ljudet för alla deltagare, samt en kopierings-till-Urklipp-knapp för att kopiera url:en för samtalsinbjudan. Den här menuProps kan omdefinieras helt och dess egenskap är av typen IContextualMenuProps.

RaiseHandButton(RaiseHandButtonProps)

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

Kan användas med ControlBar.

ReactionButton(ReactionButtonProps)

En knapp för att skicka reaktioner.

Kan användas med ControlBar.

RealTimeText(RealTimeTextProps)

En komponent för att visa en enda rad med RealTimeText

RealTimeTextModal(RealTimeTextModalProps)

en komponent för realTimeText modal

ScreenShareButton(ScreenShareButtonProps)

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

Kan användas med ControlBar.

SendBox(SendBoxProps)

Komponent för att skriva och skicka meddelanden.

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

StartCaptionsButton(StartCaptionsButtonProps)

En knapp för att starta eller stoppa textning

Kan användas med ControlBar

StartRealTimeTextButton(StartRealTimeTextButtonProps)

en knapp för att starta RealTimeText baserat på tillgänglighetskrav, realtidstext kan inte stängas av när den väl är på

Kan användas med ControlBar

StreamMedia(StreamMediaProps)

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 headless calling API till en komponent som kan renderas som en VideoTile-.

TypingIndicator(TypingIndicatorProps)

Komponent för att meddela den lokala användaren när en eller flera deltagare i chatttråden skriver.

VideoGallery(VideoGalleryProps)

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.

VideoTile(VideoTileProps)

En komponent för att återge videoströmmen för en enda samtalsdeltagare.

Använd med GridLayout i en VideoGallery-.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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.

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

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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.

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

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

Skapa en CallAdapter- med den angivna StatefulCallClient-.

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

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Skapa en CallAdapter- med den angivna StatefulCallClient-.

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

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Skapa en CallWithChatAdapter som backas upp av Azure Communication-tjänster för att ansluta till CallWithChatComposite.

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Skapa en CallWithChatAdapter- med hjälp av den angivna StatefulChatClient och StatefulCallClient.

Användbart om du vill behålla en referens till StatefulChatClient och StatefulCallClient. Observera att chatThreadClient måste skapas av StatefulChatClient via API:et chatClient.getChatThreadClient(chatThreadId). Överväg att använda skapaAzureCommunicationCallWithChatAdapter för ett enklare API.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Skapa en ChatAdapter som backas upp av Azure Communication Services.

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

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Skapa en ChatAdapter- med hjälp av den angivna StatefulChatClient-.

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

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

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.

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

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.

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

Skapa standardimplementeringen av TeamsCallingHandlers för teamanrop.

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

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

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

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

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

Skapa en TeamsCallAdapter med hjälp av den angivna StatefulCallClient.

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

fromFlatCommunicationIdentifier(string)

Omvänd åtgärd av toFlatCommunicationIdentifier.

getCallingSelector<Component>(Component)

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.

getChatSelector<Component>(Component)

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.

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Loader-funktion för CallComposite som du kan använda i ditt program. Den här funktionen läser in CallComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node ui-ramverk som inte är React-baserat.

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Rekvisita för CallWithChatComposite som du kan använda i ditt program. Den här funktionen läser in CallWithChatComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Loader-funktion för ChatComposite som du kan använda i ditt program. Den här funktionen läser in ChatComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Loader-funktion för OutboundCallComposite som du kan använda i ditt program. Den här funktionen läser in CallComposite i det angivna HTML-elementet för att göra utgående anrop. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

onResolveDeepNoiseSuppressionDependency()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

onResolveDeepNoiseSuppressionDependencyLazy()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

onResolveVideoEffectDependency()

Beroende upplösning för videobakgrundseffekter.

onResolveVideoEffectDependencyLazy()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

toFlatCommunicationIdentifier(CommunicationIdentifier)

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ålunda

  • Den kan användas för att bevara en användares identitet i externa databaser.
  • den kan användas som nycklar till en karta för att lagra data för användaren.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

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

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

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

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

useCall()

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

useCallAgent()

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.

useCallClient()

Hook för att få 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.

useChatClient()

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.

useChatThreadClient()

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.

useDeviceManager()

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.

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

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 följande leverantörer:

  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)}/>
    }
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

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.

useTeamsCall()

Hook för att få <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall objekt för att kunna använda den här kroken

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

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

Liknar <xref:createTeamsAzureCommunicationCallAdapter>, men tar hand om asynkront skapande av kortet internt.

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

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

useTeamsCallAgent()

Hook för att få <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> 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.

useTheme()

Reagera krok för att komma åt temat

Funktionsinformation

CallAgentProvider(CallAgentProviderProps)

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.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parametrar

Returer

Element

CallClientProvider(CallClientProviderProps)

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

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

function CallClientProvider(props: CallClientProviderProps): Element

Parametrar

Returer

Element

CallComposite(CallCompositeProps)

En anpassningsbar gränssnittskomposit för samtalsupplevelse.

function CallComposite(props: CallCompositeProps): Element

Parametrar

Returer

Element

Kommentarer

Anropet sammansatt min bredd/höjd är följande:

  • mobile: 17.5rem x 21rem (280px x 336px, med standard rem på 16px)
  • desktop: 30rem x 22rem (480px x 352px, med standard rem på 16px)

CallProvider(CallProviderProps)

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

function CallProvider(props: CallProviderProps): Element

Parametrar

Returer

Element

CallWithChatComposite(CallWithChatCompositeProps)

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

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parametrar

Returer

Element

CameraButton(CameraButtonProps)

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

Kan användas med ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parametrar

Returer

Element

CaptionsBanner(CaptionsBannerProps)

En komponent för att visa en CaptionsBanner med användarikon, displayName och bildtext.

function CaptionsBanner(props: CaptionsBannerProps): Element

Parametrar

Returer

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

En komponent för att ställa in talade språk

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

Parametrar

Returer

Element

ChatClientProvider(ChatClientProviderProps)

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

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

function ChatClientProvider(props: ChatClientProviderProps): Element

Parametrar

Returer

Element

ChatComposite(ChatCompositeProps)

En anpassningsbar gränssnittskomposit för chattupplevelsen.

function ChatComposite(props: ChatCompositeProps): Element

Parametrar

Returer

Element

Kommentarer

Chat sammansatt min bredd och höjd är respektive 17,5rem och 20rem (280px och 320px, med standard rem på 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

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.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parametrar

Returer

Element

ControlBar(ControlBarProps)

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

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

function ControlBar(props: ControlBarProps): Element

Parametrar

Returer

Element

ControlBarButton(ControlBarButtonProps)

Standardknapp formaterad för ControlBar.

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

function ControlBarButton(props: ControlBarButtonProps): Element

Parametrar

Returer

Element

DevicesButton(DevicesButtonProps)

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

Kan användas med ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parametrar

Returer

Element

Dialpad(DialpadProps)

En komponent för att tillåta användare att ange telefonnummer genom att klicka på knappsatsen/använda tangentbordet Den kommer att returnera en tom komponent för stabila byggen

function Dialpad(props: DialpadProps): Element

Parametrar

props
DialpadProps

Returer

Element

EndCallButton(EndCallButtonProps)

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

Kan användas med ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parametrar

Returer

Element

ErrorBar(ErrorBarProps)

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 efter att det har stängts.
  • Fel som inte har en 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> användargränssnittselement.

function ErrorBar(props: ErrorBarProps): Element

Parametrar

Returer

Element

FluentThemeProvider(FluentThemeProviderProps)

Provider för att använda ett Fluent-tema i bibliotekets react-komponenter.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parametrar

Returer

Element

Kommentarer

Komponenterna i det här biblioteket består främst av Fluent UI, kontroller, blandning av v8- och v9-kontroller. Den här providern hanterar tillämpning av alla teman som tillhandahålls för de underliggande Fluent UI-kontrollerna. *

GridLayout(GridLayoutProps)

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

function GridLayout(props: GridLayoutProps): Element

Parametrar

Returer

Element

HoldButton(HoldButtonProps)

En knapp för att parkera eller återuppta ett pågående samtal.

Kan användas med ControlBar

function HoldButton(props: HoldButtonProps): Element

Parametrar

props
HoldButtonProps

Egenskaper för hållknappen.

Returer

Element

ImageOverlay(ImageOverlayProps)

Komponent för att återge en modal helskärmsbild för en markerad bild.

function ImageOverlay(props: ImageOverlayProps): Element

Parametrar

Returer

Element

IncomingCallNotification(IncomingCallNotificationProps)

En meddelandekomponent som ska användas för att representera inkommande samtal till slutanvändaren. Gör det möjligt för användaren att acceptera eller avvisa det inkommande samtalet.

function IncomingCallNotification(props: IncomingCallNotificationProps): Element

Parametrar

Returer

Element

IncomingCallStack(IncomingCallStackProps)

Wrapper för att hantera flera inkommande samtal

function IncomingCallStack(props: IncomingCallStackProps): Element

Parametrar

props
IncomingCallStackProps

<xref:IncomingCallManagerProps>

Returer

Element

LocalizationProvider(LocalizationProviderProps)

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

function LocalizationProvider(props: LocalizationProviderProps): Element

Parametrar

Returer

Element

Kommentarer

Komponenter tillhandahålls som standard lokaliserade strängar på engelska (USA) om den här providern inte används.

MessageStatusIndicator(MessageStatusIndicatorProps)

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

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

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parametrar

Returer

Element

MessageThread(MessageThreadProps)

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

function MessageThread(props: MessageThreadProps): Element

Parametrar

props
MessageThreadProps

av typen MessageThreadProps

Användarna måste ange minst chattmeddelanden och userId för att återge komponenten MessageThread. Användare kan också anpassa MessageThread genom att skicka in sin egen Avatar, MessageStatusIndicator-ikonen, JumpToNewMessageButton, LoadPreviousMessagesButton och beteendet för dessa kontroller.

MessageThread internt använder komponenten Chat från @fluentui-contrib/chat. Du kan kolla in detaljerna om dessa komponenter här.

Returer

Element

MicrophoneButton(MicrophoneButtonProps)

En knapp för att aktivera/inaktivera mikrofonen.

Kan användas med ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parametrar

Returer

Element

Notification(NotificationProps)

En komponent för att visa meddelanden i användargränssnittet.

function Notification(props: NotificationProps): Element

Parametrar

Returer

Element

NotificationStack(NotificationStackProps)

En komponent för att visa meddelanden i användargränssnittet. Alla strängar som kan visas accepteras som strängar så att de kan lokaliseras. Aktiva meddelanden väljs av activeNotifications.

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

  • Meddelanden som har en associerad tidsstämpel: Meddelandet visas i användargränssnittet igen om det inträffar efter att det har stängts.
  • Meddelanden som inte har en tidsstämpel: Meddelandet avvisas tills det försvinner från rekvisitan. Om meddelandet upprepas visas det i användargränssnittet.
function NotificationStack(props: NotificationStackProps): Element

Parametrar

Returer

Element

ParticipantItem(ParticipantItemProps)

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

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

function ParticipantItem(props: ParticipantItemProps): Element

Parametrar

Returer

Element

ParticipantList(ParticipantListProps)

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

Som standard återges varje deltagare med ParticipantItem. Se <xref:ParticipantListProps.onRenderParticipant> att åsidosätta.

function ParticipantList(props: ParticipantListProps): Element

Parametrar

Returer

Element

ParticipantsButton(ParticipantsButtonProps)

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ärranslutna deltagare med den fullständiga listan som undermeny och ett alternativ för att stänga av ljudet för alla deltagare, samt en kopierings-till-Urklipp-knapp för att kopiera url:en för samtalsinbjudan. Den här menuProps kan omdefinieras helt och dess egenskap är av typen IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parametrar

Returer

Element

RaiseHandButton(RaiseHandButtonProps)

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

Kan användas med ControlBar.

function RaiseHandButton(props: RaiseHandButtonProps): Element

Parametrar

Returer

Element

ReactionButton(ReactionButtonProps)

En knapp för att skicka reaktioner.

Kan användas med ControlBar.

function ReactionButton(props: ReactionButtonProps): Element

Parametrar

Returer

Element

RealTimeText(RealTimeTextProps)

En komponent för att visa en enda rad med RealTimeText

function RealTimeText(props: RealTimeTextProps): Element

Parametrar

Returer

Element

RealTimeTextModal(RealTimeTextModalProps)

en komponent för realTimeText modal

function RealTimeTextModal(props: RealTimeTextModalProps): Element

Parametrar

Returer

Element

ScreenShareButton(ScreenShareButtonProps)

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

Kan användas med ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parametrar

Returer

Element

SendBox(SendBoxProps)

Komponent för att skriva och skicka meddelanden.

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

function SendBox(props: SendBoxProps): Element

Parametrar

props
SendBoxProps

Returer

Element

StartCaptionsButton(StartCaptionsButtonProps)

En knapp för att starta eller stoppa textning

Kan användas med ControlBar

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

Parametrar

props
StartCaptionsButtonProps

Egenskaper för knappen Starta undertexter.

Returer

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

en knapp för att starta RealTimeText baserat på tillgänglighetskrav, realtidstext kan inte stängas av när den väl är på

Kan användas med ControlBar

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

Parametrar

props
StartRealTimeTextButtonProps

egenskaper för knappen starta RealTimeText.

Returer

Element

StreamMedia(StreamMediaProps)

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 headless calling API till en komponent som kan renderas som en VideoTile-.

function StreamMedia(props: StreamMediaProps): Element

Parametrar

Returer

Element

TypingIndicator(TypingIndicatorProps)

Komponent för att meddela den lokala användaren när en eller flera deltagare i chatttråden skriver.

function TypingIndicator(props: TypingIndicatorProps): Element

Parametrar

Returer

Element

VideoGallery(VideoGalleryProps)

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.

function VideoGallery(props: VideoGalleryProps): Element

Parametrar

Returer

Element

VideoTile(VideoTileProps)

En komponent för att återge videoströmmen för en enda samtalsdeltagare.

Använd med GridLayout i en VideoGallery-.

function VideoTile(props: VideoTileProps): Element

Parametrar

Returer

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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.

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

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

Parametrar

Returer

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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.

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

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

Parametrar

Returer

Promise<CallAdapter>

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

Skapa en CallAdapter- med den angivna StatefulCallClient-.

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

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

Parametrar

callClient
StatefulCallClient
callAgent
CallAgent
targetCallees

CommunicationIdentifier[]

Returer

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Skapa en CallAdapter- med den angivna StatefulCallClient-.

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

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

Parametrar

callClient
StatefulCallClient
callAgent
CallAgent

Returer

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Skapa en CallWithChatAdapter som backas upp av Azure Communication-tjänster för att ansluta till CallWithChatComposite.

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

Parametrar

Returer

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Skapa en CallWithChatAdapter- med hjälp av den angivna StatefulChatClient och StatefulCallClient.

Användbart om du vill behålla en referens till StatefulChatClient och StatefulCallClient. Observera att chatThreadClient måste skapas av StatefulChatClient via API:et chatClient.getChatThreadClient(chatThreadId). Överväg att använda skapaAzureCommunicationCallWithChatAdapter för ett enklare API.

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

Parametrar

Returer

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Skapa en ChatAdapter som backas upp av Azure Communication Services.

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

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

Parametrar

Returer

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Skapa en ChatAdapter- med hjälp av den angivna StatefulChatClient-.

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

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

Parametrar

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient
chatAdapterOptions
ChatAdapterOptions

Returer

Promise<ChatAdapter>

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

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.

function createDefaultCallingHandlers(callClient: StatefulCallClient, callAgent: undefined | CallAgent, deviceManager: undefined | StatefulDeviceManager, call: undefined | Call, options?: CallingHandlersOptions): CallingHandlers

Parametrar

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Returer

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

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.

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

Parametrar

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Returer

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

Skapa standardimplementeringen av TeamsCallingHandlers för teamanrop.

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

function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers

Parametrar

callClient
StatefulCallClient
callAgent
TeamsCallAgent
deviceManager
StatefulDeviceManager
call
TeamsCall
options

{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }

Returer

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

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

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

Parametrar

Returer

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

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

Parametrar

Returer

createTeamsCallAdapter(TeamsCallAdapterArgs)

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

Parametrar

Returer

Promise<TeamsCallAdapter>

createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Skapa en TeamsCallAdapter med hjälp av den angivna StatefulCallClient.

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

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

Parametrar

callClient
StatefulCallClient
callAgent
TeamsCallAgent

Returer

Promise<TeamsCallAdapter>

fromFlatCommunicationIdentifier(string)

Omvänd åtgärd av toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parametrar

id

string

Returer

getCallingSelector<Component>(Component)

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.

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

Parametrar

component

Component

Returer

GetCallingSelector<Component>

getChatSelector<Component>(Component)

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.

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

Parametrar

component

Component

Returer

GetChatSelector<Component>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Loader-funktion för CallComposite som du kan använda i ditt program. Den här funktionen läser in CallComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node ui-ramverk som inte är React-baserat.

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

Parametrar

htmlElement

HTMLElement

Returer

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Rekvisita för CallWithChatComposite som du kan använda i ditt program. Den här funktionen läser in CallWithChatComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

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

Parametrar

htmlElement

HTMLElement

Returer

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Loader-funktion för ChatComposite som du kan använda i ditt program. Den här funktionen läser in ChatComposite i det angivna HTML-elementet. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

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

Parametrar

htmlElement

HTMLElement

Returer

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Loader-funktion för OutboundCallComposite som du kan använda i ditt program. Den här funktionen läser in CallComposite i det angivna HTML-elementet för att göra utgående anrop. Det bästa användningsfallet för detta är i ett Node UI-ramverk som inte är React-baserat.

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

Parametrar

htmlElement

HTMLElement

Returer

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

Returer

onResolveDeepNoiseSuppressionDependencyLazy()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

Returer

onResolveVideoEffectDependency()

Beroende upplösning för videobakgrundseffekter.

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

Returer

onResolveVideoEffectDependencyLazy()

Beroende upplösning för videobakgrundseffekter med hjälp av lazy loading.

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

Returer

toFlatCommunicationIdentifier(CommunicationIdentifier)

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ålunda

  • Den kan användas för att bevara en användares identitet i externa databaser.
  • den kan användas som nycklar till en karta för att lagra data för användaren.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parametrar

Returer

string

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

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter

Parametrar

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

Returer

undefined | CallAdapter

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

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

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

Parametrar

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

Returer

undefined | CallWithChatAdapter

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

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

Liknar 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 in argument när de skapas. Adaptern skapas bara när alla argument har definierats.

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

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

Parametrar

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Returer

undefined | ChatAdapter

useCall()

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

function useCall(): undefined | Call

Returer

undefined | Call

useCallAgent()

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.

function useCallAgent(): undefined | CallAgent

Returer

undefined | CallAgent

useCallClient()

Hook för att få 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.

function useCallClient(): StatefulCallClient

Returer

useChatClient()

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.

function useChatClient(): StatefulChatClient

Returer

useChatThreadClient()

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.

function useChatThreadClient(): ChatThreadClient

Returer

useDeviceManager()

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.

function useDeviceManager(): undefined | StatefulDeviceManager

Returer

undefined | StatefulDeviceManager

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

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 följande leverantörer:

  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)}/>
    }
function usePropsFor<Component>(component: Component, type?: "chat" | "calling"): ComponentProps<Component>

Parametrar

component

Component

type

"chat" | "calling"

Returer

ComponentProps<Component>

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

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.

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

Parametrar

selector

ParamT

selectorProps

(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)

type

"chat" | "calling"

Returer

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

useTeamsCall()

Hook för att få <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall objekt för att kunna använda den här kroken

function useTeamsCall(): undefined | TeamsCall

Returer

undefined | TeamsCall

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

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

Liknar <xref:createTeamsAzureCommunicationCallAdapter>, men tar hand om asynkront skapande av kortet internt.

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

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

function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter

Parametrar

args

Partial<TeamsCallAdapterArgs>

afterCreate

(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>

beforeDispose

(adapter: TeamsCallAdapter) => Promise<void>

Returer

undefined | TeamsCallAdapter

useTeamsCallAgent()

Hook för att få <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> 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.

function useTeamsCallAgent(): undefined | TeamsCallAgent

Returer

undefined | TeamsCallAgent

useTheme()

Reagera krok för att komma åt temat

function useTheme(): Theme

Returer

Theme