Delen via


@azure/communication-react package

Klassen

CallError

Fout opgetreden door mislukte stateful API-methoden.

ChatError

Er is een fout opgetreden vanwege mislukte StatefulChatClient-methoden .

Interfaces

ActiveErrorMessage

Actieve foutberichten die moeten worden weergegeven via de foutbalk.

AdapterError

Fout gerapporteerd via fout gebeurtenissen en opgeslagen in de adapterstatus.

AdapterState

Functionaliteit voor interfacing met de status van de samengestelde adapter.

BaseCompositeProps

Eigenschappen die gemeenschappelijk zijn voor alle samenstellingen die uit deze bibliotheek worden geëxporteerd.

BaseCustomStyles

Eenvoudige fluent-stijlen props voor alle onderdelen die uit deze bibliotheek zijn geëxporteerd.

CallAdapter

Een adapterinterface die specifiek is voor Azure Communication-identiteit die CommonCallAdapter uitbreidt.

CallAdapterCallManagement

Functionaliteit voor het beheren van de huidige oproep of het starten van een nieuwe oproep

CallAdapterCallOperations

Functionaliteit voor het beheren van de huidige aanroep.

CallAdapterDeviceManagement

Functionaliteit voor het beheren van apparaten binnen een gesprek.

CallAdapterSubscribers

Roep samengestelde gebeurtenissen aan waarop u zich kunt abonneren.

CallAgentProviderProps

Argumenten voor het initialiseren van een CallAgentProvider.

CallAgentState

Alleen statusversie van <xref:%40azure%2Fcommunication-calling%23CallAgent> behalve aanroepen wordt verplaatst naar een onderliggend element rechtstreeks van CallClientState en wordt hier niet opgenomen. De reden om de status van CallAgent te laten proxied is om toegang te bieden tot displayName. We maken CallAgent.displayName niet plat en plaatsen deze niet in CallClientState, omdat het onduidelijk zou zijn dat displayName eigenlijk afhankelijk is van het maken/bestaan van CallAgent om beschikbaar te zijn.

CallAndChatLocator

Argumenten voor gebruik in createAzureCommunicationCallWithChatAdapter om deel te nemen aan een gesprek met een gekoppelde chat-thread.

CallClientProviderProps

Argumenten voor het initialiseren van een CallClientProvider.

CallClientState

Container voor alle statusgegevens die door StatefulCallClient worden geproxied. De status oproepen, callsEnded, incomingCalls en incomingCallsEnded worden automatisch opgegeven als er een callAgent is gemaakt. De deviceManager is in eerste instantie leeg totdat DeviceManagerState wordt ingevuld. De status userId wordt opgegeven als een gemak voor de ontwikkelaar en wordt volledig beheerd en ingesteld door de ontwikkelaar.

CallCompositeProps

Props voor CallComposite.

CallCompositeStrings

Tekenreeksen die rechtstreeks door callcomposite worden gebruikt.

Deze tekenreeksen zijn een aanvulling op de tekenreeksen die worden gebruikt door de onderdelen uit de onderdeelbibliotheek.

CallProviderProps

Argumenten voor het initialiseren van een CallProvider.

CallState

Status alleen versie van <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient haalt automatisch de status van de oproep op en voegt deze toe aan de status die door StatefulCallClient wordt weergegeven.

CallWithChatAdapter

CallWithChatComposite Adapterinterface.

CallWithChatAdapterManagement

Functionaliteit voor het beheren van het huidige gesprek met chat.

CallWithChatAdapterState

CallWithChat State is een combinatie van Stateful Chat en Stateful Calling-clients met een bepaalde status die alleen specifiek is voor de CallWithChat Composite.

CallWithChatAdapterSubscriptions

Oproep- en chatgebeurtenissen waarop u zich kunt abonneren in de CallWithChatAdapter.

CallWithChatAdapterUiState

Ui-status met betrekking tot de CallWithChatComposite.

CallWithChatClientState

Status van de back-endservices die CallWithChatComposite aanstuurt.

CallWithChatCompositeProps

Vereiste props voor de CallWithChatComposite

CallWithChatCompositeStrings

Tekenreeksen die rechtstreeks door de CallWithChatComposite worden gebruikt.

Deze tekenreeksen zijn een aanvulling op de tekenreeksen die worden gebruikt door de onderdelen uit de onderdeelbibliotheek.

CallWithChatControlOptions

CallWithChatComposite Besturingselementen aanroepen om knoppen weer te geven of te verbergen op de aanroepbesturingsbalk.

CallingHandlers

Object met alle handlers die vereist zijn voor het aanroepen van onderdelen.

Aanroepende onderdelen uit dit pakket kunnen relevante handlers uit dit object kiezen. Zie <xref:useHandlers> en gebruikPropsFor.

CallingTheme

Aangepaste Fluent-themapallet dat wordt gebruikt voor het aanroepen van gerelateerde onderdelen in deze bibliotheek.

CameraButtonContextualMenuStyles

Stijlen voor het menu CameraButton .

CameraButtonProps

Props voor het onderdeel CameraButton .

CameraButtonStrings

Tekenreeksen van CameraButton die kunnen worden overschreven.

CameraButtonStyles

Stijlen voor CameraButton

ChatAdapterSubscribers

Samengestelde chatgebeurtenissen waarop u zich kunt abonneren.

ChatAdapterThreadManagement

Functionaliteit voor het beheren van de huidige chat-thread.

ChatCompositeProps

Props voor ChatComposite.

ChatCompositeStrings

Tekenreeksen die rechtstreeks door de ChatComposite worden gebruikt.

Deze tekenreeksen zijn een aanvulling op de tekenreeksen die worden gebruikt door de onderdelen uit de onderdeelbibliotheek.

ChatMessage

Een chatbericht.

CommonCallAdapter

OproepComposite Adapterinterface.

CommonCallingHandlers

Object met alle handlers die vereist zijn voor het aanroepen van onderdelen.

Aanroepende onderdelen uit dit pakket kunnen relevante handlers uit dit object kiezen. Zie <xref:useHandlers> en gebruikPropsFor.

ComponentLocale

Landinstellingen voor alle onderdelen die uit deze bibliotheek worden geëxporteerd.

ComponentStrings

Tekenreeksen die worden gebruikt door alle onderdelen die uit deze bibliotheek zijn geëxporteerd.

CompositeLocale

Landinstellingen voor alle samenstellingen die uit deze bibliotheek worden geëxporteerd.

CompositeStrings

Tekenreeksen die rechtstreeks in de samenstellingen worden gebruikt.

Deze tekenreeksen worden rechtstreeks door de samenstellingen gebruikt, in plaats van door de opgenomen onderdelen.

ContentSystemMessage

Een systeembericht met arbitaire inhoud.

ControlBarButtonProps

Props voor ControlBarButton.

ControlBarButtonStrings

Tekenreeksen van ControlBarButton die kunnen worden overschreven.

ControlBarProps

Props voor ControlBar.

CreateVideoStreamViewResult

Object geretourneerd na het maken van een lokale of externe VideoStream. Dit bevat helperfuncties om de weergave van de stroom te manipuleren.

CustomMessage

Een aangepast berichttype.

Aangepaste berichten worden niet standaard weergegeven, maar toepassingen kunnen hiervoor aangepaste renderers bieden.

DevicesButtonContextualMenuStyles

Stijlen voor het menu ApparatenKnop .

DevicesButtonProps

Props voor DevicesButton.

DevicesButtonStrings

Tekenreeksen van ApparatenButton die kunnen worden overschreven.

DevicesButtonStyles

Stijlen voor de menu-items van de knop Apparaten.

DiagnosticsCallFeatureState

Status alleen proxy voor <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.

Disposable

Functionaliteit voor het correct verwijderen van een samengestelde.

EndCallButtonProps

Props voor EndCallButton.

EndCallButtonStrings

Tekenreeksen van EndCallButton die kunnen worden overschreven.

ErrorBarProps

Props voor ErrorBar.

Naast het volgende stuurt ErrorBar alles <xref:%40fluentui%2Freact%23IMessageBarProps> door naar de onderliggende <xref:%40fluentui%2Freact%23MessageBar>.

ErrorBarStrings

Alle tekenreeksen die kunnen worden weergegeven in de gebruikersinterface op de foutbalk.

FluentThemeProviderProps

Props voor FluentThemeProvider.

GridLayoutProps

Props voor GridLayout.

GridLayoutStyles

GridLayout Onderdeelstijlen.

HorizontalGalleryStyles

<xref:HorizontalGallery> Onderdeelstijlen.

IncomingCallState

Alleen statusversie van <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detecteert automatisch binnenkomende oproepen en voegt hun status toe aan de status die wordt weergegeven door StatefulCallClient.

JumpToNewMessageButtonProps

Argumenten voor <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Alleen statusversie van <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

MediaDiagnosticsState

Status alleen proxy voor <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.

MessageCommon

Algemene eigenschappen van alle berichttypen.

MessageStatusIndicatorProps

Props voor MessageStatusIndicator.

MessageStatusIndicatorStrings

Tekenreeksen van MessageStatusIndicator die kunnen worden overschreven.

MessageThreadStrings

Tekenreeksen van MessageThread die kunnen worden overschreven.

MessageThreadStyles

Fluent-stijlen voor MessageThread.

MicrophoneButtonContextualMenuStyles

Stijlen voor het menu MicrophoneButton .

MicrophoneButtonProps

Props voor MicrophoneButton.

MicrophoneButtonStrings

Tekenreeksen van MicrophoneButton die kunnen worden overschreven.

MicrophoneButtonStyles

Stijlen voor MicrophoneButton

NetworkDiagnosticsState

Status alleen proxy voor <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.

OptionsDevice

Een apparaat, bijvoorbeeld camera, microfoon of luidspreker, in de flyout ApparatenButton .

ParticipantAddedSystemMessage

Een systeembericht met de melding dat een deelnemer is toegevoegd aan de chat-thread.

ParticipantItemProps

Props voor ParticipantItem.

ParticipantItemStrings

Tekenreeksen van ParticipantItem die kunnen worden overschreven.

ParticipantItemStyles

Fluent-stijlen voor ParticipantItem.

ParticipantListItemStyles

Stijlen voor de ParticipantListParticipantItem.

ParticipantListStyles

Stijlen voor de ParticipantList.

ParticipantRemovedSystemMessage

Een systeembericht met de melding dat een deelnemer is verwijderd uit de chat-thread.

ParticipantsButtonContextualMenuStyles

Stijlen voor het menu ParticipantsButton .

ParticipantsButtonProps

Props voor ParticipantsButton.

ParticipantsButtonStrings

Tekenreeksen van ParticipantsButton die kunnen worden overschreven.

ParticipantsButtonStyles

Stijlen Props for ParticipantsButton.

RecordingCallFeature

Status alleen versie van <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient luistert automatisch naar de opnamestatus van het gesprek en werkt de status die door StatefulCallClient wordt weergegeven dienovereenkomstig bij.

RemoteParticipantState

Status alleen versie van <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient haalt automatisch RemoteParticipants op en voegt hun status toe aan de status die door StatefulCallClient wordt weergegeven.

RemoteVideoStreamState

Status alleen versie van <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

ScreenShareButtonProps

Props voor ScreenShareButton.

ScreenShareButtonStrings

Tekenreeksen van ScreenShareButton die kunnen worden overschreven.

SendBoxProps

Props voor SendBox.

SendBoxStrings

Tekenreeksen van SendBox die kunnen worden overschreven.

SendBoxStylesProps

Fluent-stijlen voor <xref:Sendbox>.

StatefulCallClient

Definieert de methoden waarmee CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> statefully kan worden gebruikt. De interface biedt toegang tot geproxiede status en maakt het ook mogelijk om een handler te registreren voor statuswijzigingsgebeurtenissen. Zie CallClientState voor statusdefinitie.

Statuswijzigingsevenementen worden aangestuurd door:

  • Geretourneerde gegevens van <xref:%40azure%2Fcommunication-calling%23DeviceManager> API's.
  • Geretourneerde gegevens van <xref:%40azure%2Fcommunication-calling%23CallAgent> API's.
  • Listeners die automatisch zijn gekoppeld aan verschillende Azure Communication-aanroepende objecten:
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Roep 'stateChanged' aan
    • Roep 'idChanged' aan
    • 'isMutedChanged' aanroepen
    • Roep 'isScreenSharingOnChanged' aan
    • Roep 'remoteParticipantsUpdated' aan
    • Roep 'localVideoStreamsUpdated' aan
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

Definieert de methoden waarmee {@Link @azure/communication-chat#ChatClient} kan worden gebruikt met een gecentraliseerde gegenereerde status.

De interface biedt toegang tot geproxiede status en maakt het ook mogelijk om een handler te registreren voor statuswijzigingsgebeurtenissen.

StatefulDeviceManager

Definieert de aanvullende methoden die zijn toegevoegd door de stateful boven <xref:%40azure%2Fcommunication-calling%23DeviceManager>op .

StreamMediaProps

Props voor StreamMedia.

SystemMessageCommon

Algemene eigenschappen van alle systeemberichten.

TopicUpdatedSystemMessage

Een systeembericht met de melding dat het onderwerp van de chat-thread is bijgewerkt.

TranscriptionCallFeature

Alleen statusversie van <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient luistert automatisch naar de transcriptiestatus van de oproep en werkt de status die door StatefulCallClient wordt weergegeven dienovereenkomstig bij.

TypingIndicatorProps

Props voor TypingIndicator.

TypingIndicatorStrings

Tekenreeksen van TypeIndicator die kunnen worden overschreven.

TypingIndicatorStylesProps

Fluent-stijlen voor TypingIndicator.

VideoGalleryProps

Props voor VideoGallery.

VideoGalleryRemoteParticipant

De status van een externe deelnemer in de VideoGallery.

VideoGalleryStream

Videostream van een deelnemer in VideoGallery.

VideoGalleryStrings

Alle tekenreeksen die kunnen worden weergegeven in de gebruikersinterface in de VideoGallery.

VideoGalleryStyles

VideoGallery Onderdeelstijlen.

VideoStreamOptions

Opties om te bepalen hoe videostreams worden weergegeven.

VideoStreamRendererViewState

Alleen statusversie van <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Deze eigenschap wordt toegevoegd aan de status die door StatefulCallClient wordt weergegeven door createView en verwijderd door disposeView.

VideoTileProps

Props voor VideoTile.

VideoTileStylesProps

Fluent-stijlen voor VideoTile.

Type-aliassen

AdapterErrors

Adapters slaat de meest recente fout op voor elke bewerking in de status.

target is een door een adapter gedefinieerde tekenreeks voor elke unieke bewerking die door de adapter wordt uitgevoerd.

AreEqual

Vergelijken als 2 react-onderdelen exact gelijk zijn, is het resultaattype waar/onwaar

AreParamEqual

Vergelijk of props van 2 react-componenten gelijk zijn, het resultaattype is waar/onwaar

AreTypeEqual

Vergelijken als twee typen gelijk zijn, is het resultaattype waar/onwaar

AvatarPersonaData

Aangepaste gegevenskenmerken voor het weergeven van avatars voor een gebruiker.

AvatarPersonaDataCallback

Callback-functie die wordt gebruikt om aangepaste gegevens te leveren voor het bouwen van een avatar voor een gebruiker.

AzureCommunicationCallAdapterArgs

Argumenten voor het maken van de Azure Communication Services implementatie van CallAdapter.

Opmerking: displayName mag maximaal 256 tekens bevatten.

AzureCommunicationCallWithChatAdapterArgs

Argumenten voor createAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Argumenten voor <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

Argumenten voor het maken van de Azure Communication Services implementatie van ChatAdapter.

CallAdapterCallEndedEvent

Payload voor CallEndedListener met details over de beëindigde oproep.

CallAdapterClientState

CommonCallAdapter-status afgeleid van Azure Communication Services back-end.

CallAdapterLocator

Locator die wordt gebruikt door createAzureCommunicationCallAdapter om de aanroep te vinden om lid te worden

CallAdapterState

CommonCallAdapter-status .

CallAdapterUiState

CommonCallAdapter-status voor pure ui-doeleinden.

CallCompositeIcons

Pictogrammen die kunnen worden overschreven voor CallComposite.

CallCompositeOptions

Optionele functies van CallComposite.

CallCompositePage

Belangrijke UI-schermen die worden weergegeven in de CallComposite.

CallControlDisplayType

Weergavetype besturingsbalk voor Oproepcomposite.

CallControlOptions

Aanpassingsopties voor de besturingsbalk in de oproepervaring.

CallEndedListener

Callback voor CallAdapterSubscribers 'callEnded'-gebeurtenis.

CallErrorBarSelector

Selectortype voor errorbar-onderdeel .

CallErrorTarget

Letterlijk tekenreekstype voor alle toegestane sleutels in {@Link CallErrors}.

CallErrors

Fouten die zijn gegenereerd vanuit API-aanroepen naar de aanroepende SDK.

Elke eigenschap in het object slaat de meest recente fout op voor een bepaalde SDK-API-methode.

Fouten van dit object kunnen worden gewist met behulp van de <xref:newClearCallErrorsModifier>. Bovendien worden fouten automatisch gewist wanneer:

  • De status is gewist.
  • Volgende aanroepen naar gerelateerde API-methoden slagen. Raadpleeg de documentatie van afzonderlijke stateful clientmethoden voor meer informatie over wanneer fouten automatisch kunnen worden gewist.
CallIdChangedListener

Callback voor CallAdapterSubscribers 'callIdChanged'-gebeurtenis.

CallParticipantListParticipant

De status van de deelnemer aanroepen, zoals wordt weergegeven in de onderdelen van de gebruikersinterface.

CallWithChatCompositeIcons

Pictogrammen die kunnen worden overschreven voor CallWithChatComposite.

CallWithChatCompositeOptions

Optionele functies van CallWithChatComposite.

CallWithChatEvent

Gebeurtenissen die zijn geactiveerd door de CallWithChatAdapter.

CallingBaseSelectorProps

Algemene props die worden gebruikt om te verwijzen naar de declaratieve clientstatus aanroepen.

CallingReturnProps

Helpertype voor usePropsFor.

CameraButtonSelector

Selectortype voor het onderdeel CameraButton .

ChatAdapter

ChatComposite Adapterinterface.

ChatAdapterState

ChatAdapter-status .

ChatAdapterUiState

ChatAdapter-status voor pure ui-doeleinden.

ChatBaseSelectorProps

Algemene props voor selectors voor ChatClientState.

ChatClientProviderProps

Argumenten voor het initialiseren van een ChatClientProvider.

ChatClientState

Gecentraliseerde status voor <xref:%40azure%2Fcommunication-chat%23ChatClient>.

ChatCompositeClientState

ChatAdapter-status afgeleid van Azure Communication Services back-end.

ChatCompositeIcons

Pictogrammen die kunnen worden overschreven voor ChatComposite.

ChatCompositeOptions

Optionele functies van de ChatComposite.

ChatErrorBarSelector

Selectortype voor errorbar-onderdeel .

ChatErrorTarget

Letterlijk type tekenreeks voor alle toegestane sleutels in ChatErrors.

ChatErrors

Fouten die afkomstig zijn van API-aanroepen naar de Chat SDK.

Elke eigenschap in het object slaat de meest recente fout voor een bepaalde SDK-API-methode op.

ChatHandlers

Object met alle handlers die vereist zijn voor chatonderdelen.

Chat-gerelateerde onderdelen uit dit pakket kunnen relevante handlers uit dit object kiezen. Zie <xref:useHandlers> en gebruikPropsFor.

ChatMessageWithStatus

Een extensie voor <xref:%40azure%2Fcommunication-chat%23ChatMessage> die alleen metagegevens aan de clientzijde voor chatberichten opslaat.

TODO: De naam is bitrotted. Wijzig de naam van mij.

ChatParticipantListSelector

Selectortype voor onderdeel ParticipantList .

ChatReturnProps

Helpertype voor usePropsFor.

ChatThreadClientProviderProps

Argumenten voor het initialiseren van een ChatThreadClientProvider.

ChatThreadClientState

Gecentraliseerde status voor <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

ChatThreadProperties

Eigenschappen van een chat-thread.

We definiëren een minimaal type waarmee we de verschillende typen kunnen verbergen die door de onderliggende API worden gebruikt.

ClientState

Gecentraliseerde status voor <xref:%40azure%2Fcommunication-calling%23CallClient> of <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Zie ook: CallClientState, ChatClientState.

Common

Intersecttype van 2 typen retourneren

CommonProperties

Intersect-eigenschappen van 2 typen retourneren

CommunicationParticipant

De status van een chat- of bellende deelnemer, zoals wordt weergegeven in de gebruikersinterface.

ComponentIcons

Pictogrammen die worden gebruikt door de React onderdelen die uit deze bibliotheek zijn geëxporteerd.

ComponentProps

Helpertype voor usePropsFor.

CompositeIcons

Pictogrammen die kunnen worden overschreven in een van de samenstellingen die door deze bibliotheek worden geëxporteerd.

Zie ChatCompositeIcons, CallCompositeIcons en CallWithChatCompositeIcons voor meer gerichte typen.

ControlBarButtonStyles

Stijlen voor alle ControlBarButton-implementaties .

ControlBarLayout

Indelingen presenteren voor de ControlBar.

CreateViewResult

Resultaat van createView retourneren.

CustomAvatarOptions

Opties die kunnen worden geïnjecteerd in de onRender functie voor het aanpassen van een Avatar-onderdeel (Persona).

DeviceManagerState

Dit type is bedoeld om alle statussen binnen <xref:%40azure%2Fcommunication-calling%23DeviceManager>in te kapselen. Voor optionele parameters zijn ze mogelijk pas beschikbaar als de gebruiker toestemming heeft verleend. De camera's, microfoons, luidsprekers en deviceAccess-statussen zijn leeg totdat de bijbehorende <xref:%40azure%2Fcommunication-calling%23DeviceManager>API's getCameras, getMicrophones, getSpeakers en askDevicePermission worden aangeroepen en voltooid.

DevicesButtonSelector

Selectortype voor het onderdeel ApparatenKnop .

DiagnosticChangedEventListner

Callback voor de gebeurtenis 'diagnosticChanged' van CallAdapterSubscribers .

DisplayNameChangedListener

Callback voor CallAdapterSubscribers 'displayNameChanged'-gebeurtenis.

EmptySelector

Een type voor triviale selectors die geen gegevens retourneren.

Wordt gebruikt als een standaard retourwaarde als usePropsFor wordt aangeroepen voor een onderdeel waarvoor geen gegevens zijn vereist.

ErrorType

Alle fouten die kunnen worden weergegeven op de foutbalk.

GetCallingSelector

Specifiek type van de selector die van toepassing is op een bepaald onderdeel.

GetChatSelector

Specifiek type van de selector die van toepassing is op een bepaald onderdeel.

IsLocalScreenSharingActiveChangedListener

Callback voor CallAdapterSubscribers 'isLocalScreenSharingActiveChanged'-gebeurtenis.

IsMutedChangedListener

Callback voor CallAdapterSubscribers 'isMuted'-gebeurtenis.

IsSpeakingChangedListener

Callback voor CallAdapterSubscribers 'isSpeakingChanged'-gebeurtenis.

LoadingState

Of de stream wordt geladen of niet.

LocalizationProviderProps

Props voor LocalizationProvider.

MediaDiagnosticChangedEvent

Nettolading voor DiagnosticChangedEventListner wanneer er een wijziging is in een mediadiagnose.

Message

Gediscrimineerde samenvoeging van alle berichten.

Het messageType veld is gespecialiseerd in vakbondsvarianten.

MessageAttachedStatus

Geef aan of een chatbericht moet worden weergegeven, samengevoegd met het bericht ervoor/erna.

Handig om veel berichten van dezelfde afzender samen te voegen in één berichtenballon.

MessageContentType

Ondersteunde typen chatberichtinhoud.

MessageProps

Props om één bericht weer te geven.

Zie MessageRenderer.

MessageReadListener

Callback voor de gebeurtenis 'messageRead' van ChatAdapterSubscribers .

MessageReceivedListener

Callback voor de gebeurtenis 'messageReceived' van ChatAdapterSubscribers .

MessageRenderer

Een onderdeel om één bericht weer te geven.

MessageSentListener

Callback voor De gebeurtenis messageSent van ChatAdapterSubscribers .

MessageStatus

Status aan de clientzijde van een verzonden bericht.

Bevat overgangsstatussen die optreden voordat de bezorging van berichten vanuit de back-end wordt bevestigd.

MessageThreadProps

Props voor MessageThread.

MessageThreadSelector

Selectortype voor messagethread-onderdeel .

MicrophoneButtonSelector

Selectortype voor het onderdeel MicrophoneButton .

NetworkDiagnosticChangedEvent

Nettolading voor DiagnosticChangedEventListner wanneer er een wijziging is in een netwerkdiagnose.

OnRenderAvatarCallback

Een aangepaste rendered callback waarmee gebruikers de weergave van een personaonderdeel kunnen aanpassen.

ParticipantListParticipant

Deelnemers worden weergegeven in een ParticipantList.

ParticipantListProps

Props voor ParticipantList.

ParticipantListSelector

Selectortype voor onderdeel ParticipantList .

ParticipantMenuItemsCallback

Een callback voor het opgeven van aangepaste menu-items voor elke deelnemer in ParticipantList.

ParticipantState

De verbindingsstatus van een gespreksdeelnemer.

ParticipantsAddedListener

Callback voor ChatAdapterSubscribers 'participantsAdded'-gebeurtenis.

ParticipantsButtonSelector

Selectortype voor het onderdeel ParticipantsButton .

ParticipantsJoinedListener

Callback voor CallAdapterSubscribers 'participantsJoined'-gebeurtenis.

ParticipantsLeftListener

Callback voor CallAdapterSubscribers 'participantsLeft'-gebeurtenis.

ParticipantsRemovedListener

Callback voor de gebeurtenis Deelnemersvernieuwing van ChatAdapterSubscribers .

ReadReceiptsBySenderId

Een matrix van sleutelwaardeparen waarin de weergavenaam en het laatst gelezen bericht van elke afzender worden opgeslagen

ScreenShareButtonSelector

Selectortype voor het onderdeel ScreenShareButton .

Selector

Een geoptimaliseerde selector die ClientState-updates verfijnt in props voor React-onderdelen in deze bibliotheek.

SendBoxSelector

Selectortype voor sendbox-onderdeel .

StatefulCallClientArgs

Argumenten voor het samenstellen van de StatefulCallClient.

StatefulCallClientOptions

Opties voor het maken van de StatefulCallClient met.

StatefulChatClientArgs

Argumenten voor het samenstellen van de StatefulChatClient.

StatefulChatClientOptions

Opties voor het maken van de StatefulChatClient.

SystemMessage

Gediscrimineerde samenvoeging van alle systeemberichten.

Het systemMessageType veld is gespecialiseerd in vakbondsvarianten.

TopicChangedListener

Callback voor de gebeurtenis 'topicChanged' van ChatAdapterSubscribers .

TypingIndicatorSelector

Selectortype voor het onderdeel TypingIndicator .

UpdateMessageCallback

Callback-functie wordt uitgevoerd wanneer een bericht wordt bijgewerkt.

VideoGalleryLayout
VideoGalleryLocalParticipant

De status van de lokale deelnemer in de VideoGallery.

VideoGalleryParticipant

De status van een deelnemer in de VideoGallery.

VideoGallerySelector

Selectortype voor het VideoGallery-onderdeel .

ViewScalingMode

Schaalmodus van een VideoGalleryStream.

Functies

CallAgentProvider(CallAgentProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-calling%23CallAgent>opslaat.

Aanroepende onderdelen uit dit pakket moeten worden verpakt met een CallAgentProvider.

CallClientProvider(CallClientProviderProps)

Een <xref:React.Context> die een StatefulCallClient opslaat.

Aanroepende onderdelen van dit pakket moeten worden verpakt met een CallClientProvider.

CallComposite(CallCompositeProps)

Een aanpasbare ui samengesteld voor de ervaring van het bellen.

CallProvider(CallProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-calling%23Call>opslaat.

Aanroepende onderdelen uit dit pakket moeten worden verpakt met een CallProvider.

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite brengt belangrijke onderdelen samen om een volledig gesprek te bieden met een out-of-the-box chat-ervaring.

CameraButton(CameraButtonProps)

Een knop om de camera in of uit te schakelen.

Kan worden gebruikt met ControlBar.

ChatClientProvider(ChatClientProviderProps)

Een <xref:React.Context> die een StatefulChatClient opslaat.

Chatonderdelen uit dit pakket moeten worden verpakt met een ChatClientProvider.

ChatComposite(ChatCompositeProps)

Een aanpasbare ui samengesteld voor de chatervaring.

ChatThreadClientProvider(ChatThreadClientProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>opslaat.

Chatonderdelen uit dit pakket moeten worden verpakt met een ChatThreadClientProvider.

ControlBar(ControlBarProps)

Een container voor verschillende knoppen voor oproepbesturingselementen.

Gebruik met verschillende aanroepbesturingsknoppen in deze bibliotheek, bijvoorbeeld CameraButton of rechtstreeks uw eigen exemplaren van ControlBarButton .

ControlBarButton(ControlBarButtonProps)

Standaardknop die is vormgegeven voor de ControlBar.

Gebruik dit onderdeel om aangepaste knoppen te maken die dezelfde stijl hebben als andere knoppen van de UI-bibliotheek.

DevicesButton(DevicesButtonProps)

Een knop om een menu te openen waarmee apparaatopties worden beheerd.

Kan worden gebruikt met ControlBar.

EndCallButton(EndCallButtonProps)

Een knop om een doorlopend gesprek te beëindigen.

Kan worden gebruikt met ControlBar.

ErrorBar(ErrorBarProps)

Een onderdeel om foutberichten weer te geven in de gebruikersinterface. Alle tekenreeksen die kunnen worden weergegeven, worden geaccepteerd als de tekenreeksen , zodat ze kunnen worden gelokaliseerd. Actieve fouten worden geselecteerd door activeErrorMessages.

Met dit onderdeel wordt intern bijgehouden dat door de gebruiker is gesloten.

  • Fouten met een gekoppeld tijdstempel: de fout wordt opnieuw weergegeven in de gebruikersinterface als deze optreedt nadat deze is gesloten.
  • Fouten die geen tijdstempel hebben: de fout wordt gesloten totdat deze uit de props verdwijnt. Als de fout zich opnieuw voordoet, wordt deze weergegeven in de gebruikersinterface.

Maakt gebruik van <xref:%40fluentui%2Freact%23MessageBar> ui-element.

FluentThemeProvider(FluentThemeProviderProps)

Provider voor het toepassen van een Fluent-thema op de react-onderdelen van deze bibliotheek.

GridLayout(GridLayoutProps)

Een onderdeel voor het opmaken van tegels voor audio-/videodeelnemers in een gesprek.

LocalizationProvider(LocalizationProviderProps)

Provider voor het leveren van gelokaliseerde tekenreeksen voor de react-onderdelen van deze bibliotheek.

MessageStatusIndicator(MessageStatusIndicatorProps)

Onderdeel om de status van een verzonden bericht weer te geven.

Hiermee voegt u een pictogram en knopinfo toe die overeenkomen met de berichtstatus.

MessageThread(MessageThreadProps)

MessageThread hiermee kunt u eenvoudig een onderdeel maken voor het weergeven van chatberichten, het afhandelen van schuifgedrag van nieuwe/oude berichten en het aanpassen van pictogrammen & besturingselementen in de chat-thread.

MicrophoneButton(MicrophoneButtonProps)

Een knop om de microfoon in of uit te schakelen.

Kan worden gebruikt met ControlBar.

ParticipantItem(ParticipantItemProps)

Onderdeel voor het weergeven van een gespreks- of chatdeelnemer.

Geeft de avatar, displayName en status van de deelnemer weer, evenals optionele pictogrammen en contextmenu.

ParticipantList(ParticipantListProps)

Onderdeel voor het weergeven van alle aanroepende of chatdeelnemers.

Standaard wordt elke deelnemer weergegeven met ParticipantItem. Zie <xref:ParticipantListProps.onRenderParticipant> om te overschrijven.

ParticipantsButton(ParticipantsButtonProps)

Een knop voor het weergeven van een menu met bellende of chatdeelnemers.

Kan worden gebruikt met ControlBar.

Deze knop bevat vervolgkeuzemenu-items die zijn gedefinieerd via de eigenschap menuProps. Standaard kan het aantal externe deelnemers worden weergegeven met de volledige lijst als submenu en een optie om alle deelnemers te dempen, evenals een knop voor kopiëren naar klembord om de URL van de oproepuitnodiging te kopiëren. Dit menuProps kan volledig opnieuw worden gedefinieerd en de eigenschap is van het type IContextualMenuProps.

ScreenShareButton(ScreenShareButtonProps)

Een knop om scherm delen te starten/stoppen.

Kan worden gebruikt met ControlBar.

SendBox(SendBoxProps)

Onderdeel voor het typen en verzenden van berichten.

Ondersteunt het verzenden van een melding over typen wanneer de gebruiker begint met het invoeren van tekst. Ondersteunt een optioneel bericht onder het tekstinvoerveld.

StreamMedia(StreamMediaProps)

Hulpprogrammaonderdeel voor het converteren van een HTMLElement met een videostream naar een JSX-element.

Gebruik om een HTMLElement dat wordt geretourneerd door de headless-API te converteren naar een onderdeel dat kan worden weergegeven als een VideoTile.

TypingIndicator(TypingIndicatorProps)

Onderdeel om lokale gebruikers te waarschuwen wanneer een of meer deelnemers in de chat-thread typen.

VideoGallery(VideoGalleryProps)

VideoGallery vertegenwoordigt een indeling van videotegels voor een specifiek gesprek. Er wordt een VideoTile weergegeven voor de lokale gebruiker en voor elke externe deelnemer die aan het gesprek heeft deelgenomen.

VideoTile(VideoTileProps)

Een onderdeel voor het weergeven van de videostream voor één gespreksdeelnemer.

Gebruiken met GridLayout in een VideoGallery.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Maak een CallAdapter die wordt ondersteund door Azure Communication Services.

Dit is de standaard implementatie van CallAdapter die door deze bibliotheek wordt geleverd.

Opmerking: displayName mag maximaal 256 tekens bevatten.

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Maak een CallAdapter met behulp van de opgegeven StatefulCallClient.

Handig als u een verwijzing naar StatefulCallClient wilt behouden. Overweeg het gebruik van createAzureCommunicationCallAdapter voor een eenvoudigere API.

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Maak een CallWithChatAdapter die wordt ondersteund door Azure Communication-services om u aan te sluiten op CallWithChatComposite.

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Maak een CallWithChatAdapter met behulp van de opgegeven StatefulChatClient en StatefulCallClient.

Handig als u een verwijzing naar StatefulChatClient en StatefulCallClient wilt behouden. Overweeg het gebruik van createAzureCommunicationCallWithChatAdapter voor een eenvoudigere API.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Maak een ChatAdapter die wordt ondersteund door Azure Communication Services.

Dit is de standaard implementatie van ChatAdapter die door deze bibliotheek wordt geleverd.

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Maak een ChatAdapter met behulp van de opgegeven StatefulChatClient.

Handig als u een verwijzing naar StatefulChatClient wilt behouden. Overweeg het gebruik van createAzureCommunicationChatAdapter voor een eenvoudigere API.

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

Maak de standaard implementatie van CallingHandlers voor teams-oproepen.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Maak de standaard implementatie van ChatHandlers.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

Het geretourneerde object wordt in een geheugen opgeslagen om te voorkomen dat er opnieuw wordt gelopen wanneer deze wordt gebruikt als props voor React-onderdelen.

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Hiermee maakt u een StatefulCallClient StatefulCallClient door een proxy te gebruiken voor CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> met ProxyCallClient <xref:ProxyCallClient> , waarmee vervolgens op een declaratieve manier toegang tot de status wordt toegestaan.

Het is belangrijk om de <xref:%40azure%2Fcommunication-calling%23DeviceManager> en <xref:%40azure%2Fcommunication-calling%23CallAgent> en <xref:%40azure%2Fcommunication-calling%23Call> (en etc.) te gebruiken die zijn verkregen uit de StatefulCallClient om ervoor te zorgen dat hun statuswijzigingen correct worden geproxied.

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Hiermee maakt u een stateful ChatClient StatefulChatClient door ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> te proxyn met ProxyChatClient <xref:ProxyChatClient> , die vervolgens toegang tot status op een declaratieve manier toestaat.

fromFlatCommunicationIdentifier(string)

Omgekeerde bewerking van toFlatCommunicationIdentifier.

getCallingSelector<Component>(Component)

Haal de selector op voor een opgegeven onderdeel.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

getChatSelector<Component>(Component)

Haal de selector op voor een opgegeven onderdeel.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

toFlatCommunicationIdentifier(CommunicationIdentifier)

Een tekenreeksweergave van een <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Deze tekenreeksweergave van CommunicationIdentifier is gegarandeerd stabiel voor een unieke Communication-gebruiker. Dus

  • het kan worden gebruikt om de identiteit van een gebruiker in externe databases te behouden.
  • het kan worden gebruikt als sleutels in een kaart om gegevens voor de gebruiker op te slaan.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Een aangepaste React hook om het maken van CallAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationCallAdapter, maar zorgt ervoor dat de adapter intern asynchroon wordt gemaakt.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie het verhalenboek voor typische gebruiksvoorbeelden.

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

Een aangepaste React hook om het maken van CallWithChatAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationCallWithChatAdapter, maar zorgt ervoor dat de adapter intern asynchroon wordt gemaakt.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie het verhalenboek voor typische gebruiksvoorbeelden.

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

Een aangepaste React hook om het maken van ChatAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationChatAdapter, maar zorgt intern voor asynchroon maken van de adapter.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie storybook voor typische gebruiksvoorbeelden.

useCall()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-calling%23Call> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

u moet callprovider eerder hebben gebruikt met een aanroepobject om deze hook te kunnen gebruiken

useCallAgent()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-calling%23CallAgent> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

useCallClient()

Hook om StatefulCallClient te verkrijgen van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

useChatClient()

Hook om StatefulChatClient op te halen bij de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

useChatThreadClient()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

useDeviceManager()

Hook om StatefulDeviceManager te verkrijgen van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

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

Primaire hook om alle haken op te halen die nodig zijn voor een React-onderdeel uit deze bibliotheek.

Als u deze hook wilt aanroepen, moet het onderdeel worden verpakt onder deze providers:

  1. Voor chatonderdelen: ChatClientProvider en ChatThreadClientProvider.

  2. Voor aanroepende onderdelen: CallClientProvider, CallAgentProvider en CallAgentProvider.

Het meest eenvoudige gebruik van een onderdeel ziet er als volgt uit:

Voorbeeld

    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")

Hook om een selector voor een opgegeven onderdeel te verkrijgen.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

useTheme()

React haak om toegang te krijgen tot thema

Functiedetails

CallAgentProvider(CallAgentProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-calling%23CallAgent>opslaat.

Aanroepende onderdelen uit dit pakket moeten worden verpakt met een CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parameters

Retouren

Element

CallClientProvider(CallClientProviderProps)

Een <xref:React.Context> die een StatefulCallClient opslaat.

Aanroepende onderdelen van dit pakket moeten worden verpakt met een CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parameters

Retouren

Element

CallComposite(CallCompositeProps)

Een aanpasbare ui samengesteld voor de ervaring van het bellen.

function CallComposite(props: CallCompositeProps): Element

Parameters

Retouren

Element

Opmerkingen

Minimumbreedte/hoogte van oproepcomposiet zijn als volgt:

  • mobiel: 17,5rem x 21rem (280px x 336px, met standaard rem bij 16px)
  • desktop: 30rem x 22rem (480px x 352px, met standaard rem bij 16px)

CallProvider(CallProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-calling%23Call>opslaat.

Aanroepende onderdelen uit dit pakket moeten worden verpakt met een CallProvider.

function CallProvider(props: CallProviderProps): Element

Parameters

Retouren

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite brengt belangrijke onderdelen samen om een volledig gesprek te bieden met een out-of-the-box chat-ervaring.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parameters

Retouren

Element

CameraButton(CameraButtonProps)

Een knop om de camera in of uit te schakelen.

Kan worden gebruikt met ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parameters

Retouren

Element

ChatClientProvider(ChatClientProviderProps)

Een <xref:React.Context> die een StatefulChatClient opslaat.

Chatonderdelen uit dit pakket moeten worden verpakt met een ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parameters

Retouren

Element

ChatComposite(ChatCompositeProps)

Een aanpasbare ui samengesteld voor de chatervaring.

function ChatComposite(props: ChatCompositeProps): Element

Parameters

Retouren

Element

Opmerkingen

De samengestelde minimale breedte en hoogte van chat zijn respectievelijk 17,5rem en 20rem (280px en 320px, met standaard rem bij 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

Een <xref:React.Context> die een <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>opslaat.

Chatonderdelen uit dit pakket moeten worden verpakt met een ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parameters

Retouren

Element

ControlBar(ControlBarProps)

Een container voor verschillende knoppen voor oproepbesturingselementen.

Gebruik met verschillende aanroepbesturingsknoppen in deze bibliotheek, bijvoorbeeld CameraButton of rechtstreeks uw eigen exemplaren van ControlBarButton .

function ControlBar(props: ControlBarProps): Element

Parameters

Retouren

Element

ControlBarButton(ControlBarButtonProps)

Standaardknop die is vormgegeven voor de ControlBar.

Gebruik dit onderdeel om aangepaste knoppen te maken die dezelfde stijl hebben als andere knoppen van de UI-bibliotheek.

function ControlBarButton(props: ControlBarButtonProps): Element

Parameters

Retouren

Element

DevicesButton(DevicesButtonProps)

Een knop om een menu te openen waarmee apparaatopties worden beheerd.

Kan worden gebruikt met ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parameters

Retouren

Element

EndCallButton(EndCallButtonProps)

Een knop om een doorlopend gesprek te beëindigen.

Kan worden gebruikt met ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parameters

Retouren

Element

ErrorBar(ErrorBarProps)

Een onderdeel om foutberichten weer te geven in de gebruikersinterface. Alle tekenreeksen die kunnen worden weergegeven, worden geaccepteerd als de tekenreeksen , zodat ze kunnen worden gelokaliseerd. Actieve fouten worden geselecteerd door activeErrorMessages.

Met dit onderdeel wordt intern bijgehouden dat door de gebruiker is gesloten.

  • Fouten met een gekoppeld tijdstempel: de fout wordt opnieuw weergegeven in de gebruikersinterface als deze optreedt nadat deze is gesloten.
  • Fouten die geen tijdstempel hebben: de fout wordt gesloten totdat deze uit de props verdwijnt. Als de fout zich opnieuw voordoet, wordt deze weergegeven in de gebruikersinterface.

Maakt gebruik van <xref:%40fluentui%2Freact%23MessageBar> ui-element.

function ErrorBar(props: ErrorBarProps): Element

Parameters

Retouren

Element

FluentThemeProvider(FluentThemeProviderProps)

Provider voor het toepassen van een Fluent-thema op de react-onderdelen van deze bibliotheek.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parameters

Retouren

Element

Opmerkingen

Onderdelen in deze bibliotheek zijn voornamelijk samengesteld uit Fluent UI, besturingselementen en ook uit Fluent React Northstar-besturingselementen. Deze provider zorgt ervoor dat elk thema wordt toegepast op zowel de onderliggende Fluent UI-besturingselementen als de Fluent React Northstar-besturingselementen.

GridLayout(GridLayoutProps)

Een onderdeel voor het opmaken van tegels voor audio-/videodeelnemers in een gesprek.

function GridLayout(props: GridLayoutProps): Element

Parameters

Retouren

Element

LocalizationProvider(LocalizationProviderProps)

Provider voor het leveren van gelokaliseerde tekenreeksen voor de react-onderdelen van deze bibliotheek.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parameters

Retouren

Element

Opmerkingen

Onderdelen krijgen standaard gelokaliseerde tekenreeksen in het Engels (VS) als deze provider niet wordt gebruikt.

MessageStatusIndicator(MessageStatusIndicatorProps)

Onderdeel om de status van een verzonden bericht weer te geven.

Hiermee voegt u een pictogram en knopinfo toe die overeenkomen met de berichtstatus.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parameters

Retouren

Element

MessageThread(MessageThreadProps)

MessageThread hiermee kunt u eenvoudig een onderdeel maken voor het weergeven van chatberichten, het afhandelen van schuifgedrag van nieuwe/oude berichten en het aanpassen van pictogrammen & besturingselementen in de chat-thread.

function MessageThread(props: MessageThreadProps): Element

Parameters

props
MessageThreadProps

van het type MessageThreadProps

Gebruikers moeten ten minste chatberichten en userId opgeven om het MessageThread onderdeel weer te geven. Gebruikers kunnen ook aanpassen MessageThread door hun eigen Avatar, MessageStatusIndicator pictogram, JumpToNewMessageButtonLoadPreviousMessagesButton en het gedrag van deze besturingselementen door te geven.

MessageThreadmaakt intern gebruik van Chat.Message het Chat &-onderdeel van @fluentui/react-northstar. U kunt de details over deze twee onderdelen bekijken.

Retouren

Element

MicrophoneButton(MicrophoneButtonProps)

Een knop om de microfoon in of uit te schakelen.

Kan worden gebruikt met ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parameters

Retouren

Element

ParticipantItem(ParticipantItemProps)

Onderdeel voor het weergeven van een gespreks- of chatdeelnemer.

Geeft de avatar, displayName en status van de deelnemer weer, evenals optionele pictogrammen en contextmenu.

function ParticipantItem(props: ParticipantItemProps): Element

Parameters

Retouren

Element

ParticipantList(ParticipantListProps)

Onderdeel voor het weergeven van alle aanroepende of chatdeelnemers.

Standaard wordt elke deelnemer weergegeven met ParticipantItem. Zie <xref:ParticipantListProps.onRenderParticipant> om te overschrijven.

function ParticipantList(props: ParticipantListProps): Element

Parameters

Retouren

Element

ParticipantsButton(ParticipantsButtonProps)

Een knop voor het weergeven van een menu met bellende of chatdeelnemers.

Kan worden gebruikt met ControlBar.

Deze knop bevat vervolgkeuzemenu-items die zijn gedefinieerd via de eigenschap menuProps. Standaard kan het aantal externe deelnemers worden weergegeven met de volledige lijst als submenu en een optie om alle deelnemers te dempen, evenals een knop voor kopiëren naar klembord om de URL van de oproepuitnodiging te kopiëren. Dit menuProps kan volledig opnieuw worden gedefinieerd en de eigenschap is van het type IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parameters

Retouren

Element

ScreenShareButton(ScreenShareButtonProps)

Een knop om scherm delen te starten/stoppen.

Kan worden gebruikt met ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parameters

Retouren

Element

SendBox(SendBoxProps)

Onderdeel voor het typen en verzenden van berichten.

Ondersteunt het verzenden van een melding over typen wanneer de gebruiker begint met het invoeren van tekst. Ondersteunt een optioneel bericht onder het tekstinvoerveld.

function SendBox(props: SendBoxProps): Element

Parameters

props
SendBoxProps

Retouren

Element

StreamMedia(StreamMediaProps)

Hulpprogrammaonderdeel voor het converteren van een HTMLElement met een videostream naar een JSX-element.

Gebruik om een HTMLElement dat wordt geretourneerd door de headless-API te converteren naar een onderdeel dat kan worden weergegeven als een VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Parameters

Retouren

Element

TypingIndicator(TypingIndicatorProps)

Onderdeel om lokale gebruikers te waarschuwen wanneer een of meer deelnemers in de chat-thread typen.

function TypingIndicator(props: TypingIndicatorProps): Element

Parameters

Retouren

Element

VideoGallery(VideoGalleryProps)

VideoGallery vertegenwoordigt een indeling van videotegels voor een specifiek gesprek. Er wordt een VideoTile weergegeven voor de lokale gebruiker en voor elke externe deelnemer die aan het gesprek heeft deelgenomen.

function VideoGallery(props: VideoGalleryProps): Element

Parameters

Retouren

Element

VideoTile(VideoTileProps)

Een onderdeel voor het weergeven van de videostream voor één gespreksdeelnemer.

Gebruiken met GridLayout in een VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parameters

Retouren

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Maak een CallAdapter die wordt ondersteund door Azure Communication Services.

Dit is de standaard implementatie van CallAdapter die door deze bibliotheek wordt geleverd.

Opmerking: displayName mag maximaal 256 tekens bevatten.

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

Parameters

Retouren

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Maak een CallAdapter met behulp van de opgegeven StatefulCallClient.

Handig als u een verwijzing naar StatefulCallClient wilt behouden. Overweeg het gebruik van createAzureCommunicationCallAdapter voor een eenvoudigere API.

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

Parameters

callClient
StatefulCallClient
callAgent
CallAgent

Retouren

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Maak een CallWithChatAdapter die wordt ondersteund door Azure Communication-services om u aan te sluiten op CallWithChatComposite.

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

Parameters

Retouren

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Maak een CallWithChatAdapter met behulp van de opgegeven StatefulChatClient en StatefulCallClient.

Handig als u een verwijzing naar StatefulChatClient en StatefulCallClient wilt behouden. Overweeg het gebruik van createAzureCommunicationCallWithChatAdapter voor een eenvoudigere API.

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

Parameters

Retouren

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Maak een ChatAdapter die wordt ondersteund door Azure Communication Services.

Dit is de standaard implementatie van ChatAdapter die door deze bibliotheek wordt geleverd.

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

Parameters

Retouren

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Maak een ChatAdapter met behulp van de opgegeven StatefulChatClient.

Handig als u een verwijzing naar StatefulChatClient wilt behouden. Overweeg het gebruik van createAzureCommunicationChatAdapter voor een eenvoudigere API.

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

Parameters

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Retouren

Promise<ChatAdapter>

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

Maak de standaard implementatie van CallingHandlers voor teams-oproepen.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

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

Parameters

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Retouren

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Maak de standaard implementatie van ChatHandlers.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

Het geretourneerde object wordt in een geheugen opgeslagen om te voorkomen dat er opnieuw wordt gelopen wanneer deze wordt gebruikt als props voor React-onderdelen.

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

Parameters

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Retouren

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Hiermee maakt u een StatefulCallClient StatefulCallClient door een proxy te gebruiken voor CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> met ProxyCallClient <xref:ProxyCallClient> , waarmee vervolgens op een declaratieve manier toegang tot de status wordt toegestaan.

Het is belangrijk om de <xref:%40azure%2Fcommunication-calling%23DeviceManager> en <xref:%40azure%2Fcommunication-calling%23CallAgent> en <xref:%40azure%2Fcommunication-calling%23Call> (en etc.) te gebruiken die zijn verkregen uit de StatefulCallClient om ervoor te zorgen dat hun statuswijzigingen correct worden geproxied.

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

Parameters

Retouren

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Hiermee maakt u een stateful ChatClient StatefulChatClient door ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> te proxyn met ProxyChatClient <xref:ProxyChatClient> , die vervolgens toegang tot status op een declaratieve manier toestaat.

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

Parameters

Retouren

fromFlatCommunicationIdentifier(string)

Omgekeerde bewerking van toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parameters

id

string

Retouren

getCallingSelector<Component>(Component)

Haal de selector op voor een opgegeven onderdeel.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

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

Parameters

component

Component

Retouren

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Haal de selector op voor een opgegeven onderdeel.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

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

Parameters

component

Component

Retouren

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Een tekenreeksweergave van een <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Deze tekenreeksweergave van CommunicationIdentifier is gegarandeerd stabiel voor een unieke Communication-gebruiker. Dus

  • het kan worden gebruikt om de identiteit van een gebruiker in externe databases te behouden.
  • het kan worden gebruikt als sleutels in een kaart om gegevens voor de gebruiker op te slaan.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parameters

Retouren

string

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

Een aangepaste React hook om het maken van CallAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationCallAdapter, maar zorgt ervoor dat de adapter intern asynchroon wordt gemaakt.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie het verhalenboek voor typische gebruiksvoorbeelden.

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

Parameters

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

Retouren

undefined | CallAdapter

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

Een aangepaste React hook om het maken van CallWithChatAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationCallWithChatAdapter, maar zorgt ervoor dat de adapter intern asynchroon wordt gemaakt.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie het verhalenboek voor typische gebruiksvoorbeelden.

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

Parameters

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

Retouren

undefined | CallWithChatAdapter

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

Een aangepaste React hook om het maken van ChatAdapter te vereenvoudigen.

Vergelijkbaar met createAzureCommunicationChatAdapter, maar zorgt intern voor asynchroon maken van de adapter.

Hiermee kunnen argumenten niet worden gedefinieerd, zodat u de regel-van-hooks kunt respecteren en argumenten kunt doorgeven wanneer ze worden gemaakt. De adapter wordt alleen gemaakt wanneer alle argumenten zijn gedefinieerd.

Houd er rekening mee dat u de argumenten moet onthouden om te voorkomen dat de adapter bij elke weergave opnieuw wordt gemaakt. Zie storybook voor typische gebruiksvoorbeelden.

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

Parameters

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Retouren

undefined | ChatAdapter

useCall()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-calling%23Call> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

u moet callprovider eerder hebben gebruikt met een aanroepobject om deze hook te kunnen gebruiken

function useCall(): undefined | Call

Retouren

undefined | Call

useCallAgent()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-calling%23CallAgent> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

function useCallAgent(): undefined | CallAgent

Retouren

undefined | CallAgent

useCallClient()

Hook om StatefulCallClient te verkrijgen van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

function useCallClient(): StatefulCallClient

Retouren

useChatClient()

Hook om StatefulChatClient op te halen bij de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

function useChatClient(): StatefulChatClient

Retouren

useChatThreadClient()

Hook om te verkrijgen <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

function useChatThreadClient(): ChatThreadClient

Retouren

useDeviceManager()

Hook om StatefulDeviceManager te verkrijgen van de provider.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

function useDeviceManager(): undefined | StatefulDeviceManager

Retouren

undefined | StatefulDeviceManager

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

Primaire hook om alle haken op te halen die nodig zijn voor een React-onderdeel uit deze bibliotheek.

Als u deze hook wilt aanroepen, moet het onderdeel worden verpakt onder deze providers:

  1. Voor chatonderdelen: ChatClientProvider en ChatThreadClientProvider.

  2. Voor aanroepende onderdelen: CallClientProvider, CallAgentProvider en CallAgentProvider.

Het meest eenvoudige gebruik van een onderdeel ziet er als volgt uit:

Voorbeeld

    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>

Parameters

component

Component

type

"chat" | "calling"

Retouren

ComponentProps<Component>

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

Hook om een selector voor een opgegeven onderdeel te verkrijgen.

Handig bij het implementeren van een aangepast onderdeel dat gebruikmaakt van de providers die uit deze bibliotheek worden geëxporteerd.

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

Parameters

selector

ParamT

selectorProps

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

type

"chat" | "calling"

Retouren

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

useTheme()

React haak om toegang te krijgen tot thema

function useTheme(): Theme

Retouren

Theme