Partager via

@azure/communication-react package

  • Référence

Classes

CallError

Erreur levée à partir des méthodes d’API avec état ayant échoué.
ChatError

Erreur levée à partir des méthodes StatefulChatClient ayant échoué.

Interfaces

ActiveErrorMessage

Messages d’erreur actifs à afficher via ErrorBar.
AdapterError

Erreur signalée via des événements d’erreur et stockée dans l’état de l’adaptateur.
AdapterState

Fonctionnalité d’interfaçage avec l’état de l’adaptateur composite.
BaseCompositeProps

Propriétés communes à tous les composites exportés à partir de cette bibliothèque.
BaseCustomStyles

Accessoires de styles Fluent de base pour tous les composants exportés à partir de ce libray.
CallAdapter

Interface d’adaptateur spécifique à l’identité Azure Communication qui étend CommonCallAdapter.
CallAdapterCallManagement

Fonctionnalités de gestion de l’appel actuel ou de démarrage d’un nouvel appel
CallAdapterCallOperations

Fonctionnalité de gestion de l’appel actuel.
CallAdapterDeviceManagement

Fonctionnalité de gestion des appareils dans un appel.
CallAdapterSubscribers

Appelez des événements composites auxquels vous pouvez vous abonner.
CallAgentProviderProps

Arguments pour initialiser un CallAgentProvider.
CallAgentState

La version d’état uniquement de à l’exception des <xref:%40azure%2Fcommunication-calling%23CallAgent> appels est déplacée pour être un enfant directement de CallClientState et n’est pas incluse ici. La raison pour laquelle l’état de CallAgent est proxié est de fournir l’accès à displayName. Nous n’aplatisons pas CallAgent.displayName et le mettons dans CallClientState, car il serait ambigu que displayName dépend réellement de la création/existence de CallAgent pour être disponible.
CallAndChatLocator

Arguments à utiliser dans createAzureCommunicationCallWithChatAdapter pour joindre un appel avec un thread de conversation associé.
CallClientProviderProps

Arguments pour initialiser un CallClientProvider.
CallClientState

Conteneur pour toutes les données d’état proxiées par StatefulCallClient. Les états appels, callsEnded, incomingCalls et incomingCallsEnded sont automatiquement fournis si un callAgent a été créé. DeviceManager sera vide initialement jusqu’à ce qu’il soit rempli, consultez DeviceManagerState. L’état userId est fourni à titre pratique pour le développeur et est entièrement controlé et défini par le développeur.
CallCompositeProps

Props pour CallComposite.
CallCompositeStrings

Chaînes utilisées directement par CallComposite .

Ces chaînes s’ajoutent à celles utilisées par les composants de la bibliothèque de composants.
CallProviderProps

Arguments pour initialiser un CallProvider.
CallState

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient récupère automatiquement l’état de l’appel et l’ajoute à l’état exposé par StatefulCallClient.
CallWithChatAdapter

CallWithChatComposite Interface de l’adaptateur.
CallWithChatAdapterManagement

Fonctionnalité de gestion de l’appel actuel avec conversation.
CallWithChatAdapterState

CallWithChat State est une combinaison de clients de conversation avec état et d’appel avec état avec un état spécifique à l’élément composite CallWithChat uniquement.
CallWithChatAdapterSubscriptions

Événements d’appel et de conversation auxquels vous pouvez vous abonner dans CallWithChatAdapter.
CallWithChatAdapterUiState

État de l’interface utilisateur relatif à CallWithChatComposite.
CallWithChatClientState

État des services back-end qui piloteNt CallWithChatComposite.
CallWithChatCompositeProps

Propriétés requises pour CallWithChatComposite
CallWithChatCompositeStrings

Chaînes utilisées directement par CallWithChatComposite .

Ces chaînes s’ajoutent à celles utilisées par les composants de la bibliothèque de composants.
CallWithChatControlOptions

CallWithChatComposite Appelez des contrôles pour afficher ou masquer des boutons dans la barre de contrôle d’appel.
CallingHandlers

Objet contenant tous les gestionnaires requis pour appeler des composants.

L’appel de composants associés à partir de ce package est en mesure de sélectionner les gestionnaires pertinents à partir de cet objet. Consultez <xref:useHandlers> et usePropsFor.
CallingTheme

Palette de thèmes Fluent personnalisée utilisée en appelant des composants associés dans cette bibliothèque.
CameraButtonContextualMenuStyles

Styles du menu CameraButton .
CameraButtonProps

Props pour le composant CameraButton .
CameraButtonStrings

Chaînes de CameraButton qui peuvent être remplacées.
CameraButtonStyles

Styles pour CameraButton
ChatAdapterSubscribers

Événements composites de conversation auxquels vous pouvez vous abonner.
ChatAdapterThreadManagement

Fonctionnalité de gestion du thread de conversation actuel.
ChatCompositeProps

Props pour ChatComposite.
ChatCompositeStrings

Chaînes utilisées directement par ChatComposite .

Ces chaînes s’ajoutent à celles utilisées par les composants de la bibliothèque de composants.
ChatMessage

Message de conversation.
CommonCallAdapter

CallComposite Interface de l’adaptateur.
CommonCallingHandlers

Objet contenant tous les gestionnaires requis pour appeler des composants.

L’appel de composants associés à partir de ce package est en mesure de sélectionner les gestionnaires pertinents à partir de cet objet. Consultez <xref:useHandlers> et usePropsFor.
ComponentLocale

Informations de paramètres régionaux pour tous les composants exportés à partir de cette bibliothèque.
ComponentStrings

Chaînes utilisées par tous les composants exportés à partir de cette bibliothèque.
CompositeLocale

Informations de paramètres régionaux pour tous les composites exportés à partir de cette bibliothèque.
CompositeStrings

Chaînes utilisées directement dans les composites.

Ces chaînes sont utilisées directement par les composites plutôt que par les composants contenus.
ContentSystemMessage

Message système avec un contenu arbitaire.
ControlBarButtonProps

Props pour ControlBarButton.
ControlBarButtonStrings

Chaînes de ControlBarButton qui peuvent être remplacées.
ControlBarProps

Props pour ControlBar.
CreateVideoStreamViewResult

Objet retourné après la création d’un VideoStream local ou distant. Il contient des fonctions d’assistance pour manipuler le rendu du flux.
CustomMessage

Type de message personnalisé.

Les messages personnalisés ne sont pas rendus par défaut, mais les applications peuvent leur fournir des renderers personnalisés.
DevicesButtonContextualMenuStyles

Styles pour le menu DevicesButton .
DevicesButtonProps

Props pour DevicesButton.
DevicesButtonStrings

Chaînes de DevicesButton qui peuvent être remplacées.
DevicesButtonStyles

Styles pour les éléments de menu du bouton Appareils.
DiagnosticsCallFeatureState

Proxy d’état uniquement pour <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable

Fonctionnalité permettant de supprimer correctement un composite.
EndCallButtonProps

Props pour EndCallButton.
EndCallButtonStrings

Chaînes de EndCallButton qui peuvent être remplacées.
ErrorBarProps

Props pour ErrorBar.

En plus des éléments suivants, ErrorBar transfère tout <xref:%40fluentui%2Freact%23IMessageBarProps> au sous-jacent <xref:%40fluentui%2Freact%23MessageBar>.
ErrorBarStrings

Toutes les chaînes qui peuvent être affichées dans l’interface utilisateur dans errorBar.
FluentThemeProviderProps

Props pour FluentThemeProvider.
GridLayoutProps

Props pour GridLayout.
GridLayoutStyles

GridLayout Styles de composant.
HorizontalGalleryStyles

<xref:HorizontalGallery> Styles de composant.
IncomingCallState

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient détecte automatiquement les appels entrants et ajoute leur état à l’état exposé par StatefulCallClient.
JumpToNewMessageButtonProps

Arguments pour <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState

Proxy d’état uniquement pour <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon

Propriétés communes de tous les types de messages.
MessageStatusIndicatorProps

Props pour MessageStatusIndicator.
MessageStatusIndicatorStrings

Chaînes de MessageStatusIndicator qui peuvent être remplacées.
MessageThreadStrings

Chaînes de MessageThread qui peuvent être remplacées.
MessageThreadStyles

Styles Fluent pour MessageThread.
MicrophoneButtonContextualMenuStyles

Styles du menu MicrophoneButton .
MicrophoneButtonProps

Props pour MicrophoneButton.
MicrophoneButtonStrings

Chaînes de MicrophoneButton qui peuvent être remplacées.
MicrophoneButtonStyles

Styles pour MicrophoneButton
NetworkDiagnosticsState

Proxy d’état uniquement pour <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice

Un appareil, par exemple une caméra, un microphone ou un haut-parleur, dans le menu volant DevicesButton .
ParticipantAddedSystemMessage

Message système signalant qu’un participant a été ajouté au fil de conversation.
ParticipantItemProps

Props pour ParticipantItem.
ParticipantItemStrings

Chaînes de ParticipantItem qui peuvent être remplacées.
ParticipantItemStyles

Styles Fluent pour ParticipantItem.
ParticipantListItemStyles

Styles pour l’élément ParticipantListParticipantItem.
ParticipantListStyles

Styles pour participantList.
ParticipantRemovedSystemMessage

Message système signalant qu’un participant a été supprimé du fil de conversation.
ParticipantsButtonContextualMenuStyles

Styles pour le menu ParticipantsButton .
ParticipantsButtonProps

Props for ParticipantsButton.
ParticipantsButtonStrings

Chaînes de ParticipantsButton qui peuvent être remplacées.
ParticipantsButtonStyles

Styles Props for ParticipantsButton.
RecordingCallFeature

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient écoute automatiquement l’état d’enregistrement de l’appel et met à jour l’état exposé par StatefulCallClient en conséquence.
RemoteParticipantState

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient récupère automatiquement RemoteParticipants et ajoute leur état à l’état exposé par StatefulCallClient.
RemoteVideoStreamState

Version d’état uniquement de <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps

Props pour ScreenShareButton.
ScreenShareButtonStrings

Chaînes de ScreenShareButton qui peuvent être remplacées.
SendBoxProps

Props pour SendBox.
SendBoxStrings

Chaînes de SendBox qui peuvent être remplacées.
SendBoxStylesProps

Styles Fluent pour <xref:Sendbox>.
StatefulCallClient

Définit les méthodes qui permettent d’utiliser CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> avec état. L’interface fournit l’accès à l’état proxié et permet également d’inscrire un gestionnaire pour les événements de changement d’état. Pour la définition d’état, consultez CallClientState.

Les événements de changement d’état sont pilotés par :

  • Données retournées à partir d’API <xref:%40azure%2Fcommunication-calling%23DeviceManager> .
  • Données retournées à partir d’API <xref:%40azure%2Fcommunication-calling%23CallAgent> .
  • Écouteurs automatiquement attachés à différents objets azure communication appelant :
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Appeler 'stateChanged'
    • Appeler 'idChanged'
    • Appeler 'isMutedChanged'
    • Appelez 'isScreenSharingOnChanged'
    • Appeler 'remoteParticipantsUpdated'
    • Appelez 'localVideoStreamsUpdated'
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient

Définit les méthodes qui permettent d’utiliser {@Link @azure/communication-chat#ChatClient} avec un état généré centralisé.

L’interface fournit l’accès à l’état proxié et permet également d’inscrire un gestionnaire pour les événements de changement d’état.
StatefulDeviceManager

Définit les méthodes supplémentaires ajoutées par le avec état au-dessus de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps

Accessoires pour StreamMedia.
SystemMessageCommon

Propriétés communes de tous les messages système.
TopicUpdatedSystemMessage

Message système signalant que la rubrique du thread de conversation a été mise à jour.
TranscriptionCallFeature

État uniquement de la version de <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient écoute automatiquement l’état de transcription de l’appel et met à jour l’état exposé par StatefulCallClient en conséquence.
TypingIndicatorProps

Props pour TypingIndicator.
TypingIndicatorStrings

Chaînes de TypingIndicator qui peuvent être remplacées.
TypingIndicatorStylesProps

Styles Fluent pour TypingIndicator.
VideoGalleryProps

Accessoires pour VideoGallery.
VideoGalleryRemoteParticipant

État d’un participant distant dans videoGallery.
VideoGalleryStream

Flux vidéo d’un participant à VideoGallery.
VideoGalleryStrings

Toutes les chaînes qui peuvent être affichées sur l’interface utilisateur dans videoGallery.
VideoGalleryStyles

VideoGallery Styles de composants.
VideoStreamOptions

Options permettant de contrôler le rendu des flux vidéo.
VideoStreamRendererViewState

État uniquement de la version de <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Cette propriété est ajoutée à l’état exposé par StatefulCallClient par createView et supprimée par disposeView.
VideoTileProps

Props pour VideoTile.
VideoTileStylesProps

Styles Fluent pour VideoTile.

Alias de type

AdapterErrors

Les adaptateurs stockent l’erreur la plus récente pour chaque opération dans l’état .

target est une chaîne définie par l’adaptateur pour chaque opération unique effectuée par l’adaptateur.
AreEqual

Comparez si 2 composants react sont exactement égaux, le type de résultat sera true/false
AreParamEqual

Comparez si les propriétés de 2 composants react sont égales, le type de résultat sera true/false
AreTypeEqual

Comparez si deux types sont égaux, le type de résultat sera true/false
AvatarPersonaData

Attributs de données personnalisés pour l’affichage de l’avatar pour un utilisateur.
AvatarPersonaDataCallback

Fonction de rappel utilisée pour fournir des données personnalisées afin de créer un avatar pour un utilisateur.
AzureCommunicationCallAdapterArgs

Arguments pour créer l’implémentation Azure Communication Services de CallAdapter.

Remarque : displayName peut avoir un maximum de 256 caractères.
AzureCommunicationCallWithChatAdapterArgs

Arguments pour createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs

Arguments pour <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs

Arguments pour la création de l’implémentation Azure Communication Services de ChatAdapter.
CallAdapterCallEndedEvent

Charge utile pour CallEndedListener contenant des détails sur l’appel terminé.
CallAdapterClientState

État CommonCallAdapter déduit de Azure Communication Services back-end.
CallAdapterLocator

Localisateur utilisé par createAzureCommunicationCallAdapter pour localiser l’appel à joindre
CallAdapterState

État CommonCallAdapter .
CallAdapterUiState

État CommonCallAdapter à des fins d’interface utilisateur pures.
CallCompositeIcons

Icônes qui peuvent être remplacées pour CallComposite.
CallCompositeOptions

Fonctionnalités facultatives de CallComposite.
CallCompositePage

Principaux écrans d’interface utilisateur affichés dans CallComposite.
CallControlDisplayType

Type d’affichage de la barre de contrôle pour CallComposite.
CallControlOptions

Options de personnalisation de la barre de contrôle dans l’expérience d’appel.
CallEndedListener

Rappel pour l’événement CallAdapterSubscribers 'callEnded'.
CallErrorBarSelector

Type de sélecteur pour le composant ErrorBar .
CallErrorTarget

Type de littéral de chaîne pour toutes les clés autorisées dans {@Link CallErrors}.
CallErrors

Erreurs entre les appels d’API et le Kit de développement logiciel (SDK) d’appel.

Chaque propriété de l’objet stocke l’erreur la plus récente pour une méthode d’API sdk particulière.

Les erreurs de cet objet peuvent être effacées à l’aide de <xref:newClearCallErrorsModifier>. En outre, les erreurs sont automatiquement effacées lorsque :

  • L’état est effacé.
  • Les appels suivants aux méthodes d’API associées réussissent. Consultez la documentation des méthodes clientes avec état individuelles pour plus d’informations sur le moment où les erreurs peuvent être effacées automatiquement.
CallIdChangedListener

Rappel pour l’événement CallAdapterSubscribers 'callIdChanged'.
CallParticipantListParticipant

Appel de l’état du participant, comme indiqué dans les composants de l’interface utilisateur.
CallWithChatCompositeIcons

Icônes qui peuvent être remplacées pour CallWithChatComposite.
CallWithChatCompositeOptions

Fonctionnalités facultatives de CallWithChatComposite.
CallWithChatEvent

Événements déclenchés par CallWithChatAdapter.
CallingBaseSelectorProps

Propriétés courantes utilisées pour référencer l’appel de l’état du client déclaratif.
CallingReturnProps

Type d’assistance pour usePropsFor.
CameraButtonSelector

Type de sélecteur pour le composant CameraButton .
ChatAdapter

ChatComposite Interface de l’adaptateur.
ChatAdapterState

État ChatAdapter .
ChatAdapterUiState

État ChatAdapter à des fins d’interface utilisateur pures.
ChatBaseSelectorProps

Propriétés courantes pour les sélecteurs pour ChatClientState.
ChatClientProviderProps

Arguments pour initialiser un ChatClientProvider.
ChatClientState

État centralisé pour <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState

État ChatAdapter déduit de Azure Communication Services back-end.
ChatCompositeIcons

Icônes qui peuvent être remplacées pour ChatComposite.
ChatCompositeOptions

Fonctionnalités facultatives de ChatComposite.
ChatErrorBarSelector

Type de sélecteur pour le composant ErrorBar .
ChatErrorTarget

Type de littéral de chaîne pour toutes les clés autorisées dans ChatErrors.
ChatErrors

Erreurs liées aux appels d’API au Kit de développement logiciel (SDK) Chat.

Chaque propriété de l’objet stocke l’erreur la plus récente pour une méthode d’API sdk particulière.
ChatHandlers

Objet contenant tous les gestionnaires requis pour les composants de conversation.

Les composants liés aux conversations de ce package sont en mesure de sélectionner les gestionnaires pertinents à partir de cet objet. Consultez <xref:useHandlers> et usePropsFor.
ChatMessageWithStatus

Extension de <xref:%40azure%2Fcommunication-chat%23ChatMessage> qui stocke uniquement les métadonnées côté client pour les messages de conversation.

TODO : le nom a été bitrotté. Renommez-moi.
ChatParticipantListSelector

Type de sélecteur pour le composant ParticipantList .
ChatReturnProps

Type d’assistance pour usePropsFor.
ChatThreadClientProviderProps

Arguments pour initialiser un ChatThreadClientProvider.
ChatThreadClientState

État centralisé pour <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties

Propriétés d’un thread de conversation.

Nous définissons un minimum qui nous aide à masquer les différents types utilisés par l’API sous-jacente.
ClientState

État centralisé pour <xref:%40azure%2Fcommunication-calling%23CallClient> ou <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Voir aussi : CallClientState, ChatClientState.
Common

Retourner le type d’intersection de 2 types
CommonProperties

Retourner les propriétés d’intersection de 2 types
CommunicationParticipant

État d’un participant de conversation ou d’appel, tel que reflété dans l’interface utilisateur.
ComponentIcons

Icônes utilisées par les composants React exportés à partir de cette bibliothèque.
ComponentProps

Type d’assistance pour usePropsFor.
CompositeIcons

Icônes qui peuvent être remplacées dans l’un des composites exportés par cette bibliothèque.

Pour plus de types ciblés, consultez ChatCompositeIcons, CallCompositeIcons et CallWithChatCompositeIcons .
ControlBarButtonStyles

Styles pour toutes les implémentations ControlBarButton .
ControlBarLayout

Présentez les dispositions de controlBar.
CreateViewResult

Retourne le résultat de createView.
CustomAvatarOptions

Options qui peuvent être injectées dans la onRender fonction pour personnaliser un composant Avatar (Persona).
DeviceManagerState

Ce type est destiné à encapsuler tout l’état dans <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Pour les paramètres facultatifs, ils peuvent ne pas être disponibles tant que l’autorisation n’a pas été accordée par l’utilisateur. Les états caméras, microphones, haut-parleurs et deviceAccess sont vides jusqu’à ce que les API getCameras, getMicrophones, getSpeakers et askDevicePermission correspondantes <xref:%40azure%2Fcommunication-calling%23DeviceManager>soient appelées et terminées.
DevicesButtonSelector

Type de sélecteur pour le composant DevicesButton .
DiagnosticChangedEventListner

Rappel pour l’événement CallAdapterSubscribers 'diagnosticChanged'.
DisplayNameChangedListener

Rappel pour l’événement CallAdapterSubscribers 'displayNameChanged'.
EmptySelector

Type pour les sélecteurs trivials qui ne retournent aucune donnée.

Utilisé comme valeur de retour par défaut si usePropsFor est appelé pour un composant qui ne nécessite aucune donnée.
ErrorType

Toutes les erreurs qui peuvent être affichées dans la barre d’erreur.
GetCallingSelector

Type spécifique du sélecteur applicable à un composant donné.
GetChatSelector

Type spécifique du sélecteur applicable à un composant donné.
IsLocalScreenSharingActiveChangedListener

Rappel de l’événement CallAdapterSubscribers « isLocalScreenSharingActiveChanged ».
IsMutedChangedListener

Rappel pour l’événement CallAdapterSubscribers 'isMuted'.
IsSpeakingChangedListener

Rappel pour l’événement CallAdapterSubscribers 'isSpeakingChanged'.
LoadingState

Indique si le flux est en cours de chargement ou non.
LocalizationProviderProps

Props for LocalizationProvider.
MediaDiagnosticChangedEvent

Charge utile pour DiagnosticChangedEventListner où un diagnostic multimédia est modifié.
Message

Union discriminatoire de tous les messages.

Le messageType domaine se spécialise dans les variantes syndicales.
MessageAttachedStatus

Indique si un message de conversation doit être fusionné avec le message avant/après celui-ci.

Utile pour fusionner de nombreux messages du même expéditeur en une seule bulle de message.
MessageContentType

Types de contenu de message de conversation pris en charge.
MessageProps

Props pour afficher un seul message.

Consultez MessageRenderer.
MessageReadListener

Rappel de l’événement « messageRead » chatAdapterSubscribers .
MessageReceivedListener

Rappel pour l’événement « messageReceived » chatAdapterSubscribers .
MessageRenderer

Composant permettant d’afficher un message unique.
MessageSentListener

Rappel de l’événement « messageSent » chatAdapterSubscribers .
MessageStatus

État côté client d’un message envoyé.

Inclut les états de transition qui se produisent avant la confirmation de la remise des messages à partir du serveur principal.
MessageThreadProps

Props pour MessageThread.
MessageThreadSelector

Type de sélecteur pour le composant MessageThread .
MicrophoneButtonSelector

Type de sélecteur pour le composant MicrophoneButton .
NetworkDiagnosticChangedEvent

Charge utile pour DiagnosticChangedEventListner où un diagnostic réseau est modifié.
OnRenderAvatarCallback

Rappel rendu personnalisé qui permet aux utilisateurs de personnaliser le rendu d’un composant Persona.
ParticipantListParticipant

Participants affichés dans un ParticipantList.
ParticipantListProps

Props pour ParticipantList.
ParticipantListSelector

Type de sélecteur pour le composant ParticipantList .
ParticipantMenuItemsCallback

Rappel permettant de fournir des éléments de menu personnalisés pour chaque participant dans ParticipantList.
ParticipantState

État de connexion d’un participant à l’appel.
ParticipantsAddedListener

Rappel de l’événement ChatAdapterSubscribers « participantsAdded ».
ParticipantsButtonSelector

Type de sélecteur pour le composant ParticipantsButton .
ParticipantsJoinedListener

Rappel de l’événement CallAdapterSubscribers « participantsJoined ».
ParticipantsLeftListener

Rappel de l’événement CallAdapterSubscribers « participantsLeft ».
ParticipantsRemovedListener

Rappel de l’événement « participantsRemoved » chatAdapterSubscribers .
ReadReceiptsBySenderId

Tableau de paires clé-valeur qui stocke le nom complet et le message de dernière lecture de chaque expéditeur
ScreenShareButtonSelector

Type de sélecteur pour le composant ScreenShareButton .
Selector

Sélecteur optimisé qui affine les mises à jour ClientState en propriétés pour React Components dans cette bibliothèque.
SendBoxSelector

Type de sélecteur pour le composant SendBox .
StatefulCallClientArgs

Arguments pour construire l’objet StatefulCallClient.
StatefulCallClientOptions

Options à utiliser pour construire l’objet StatefulCallClient.
StatefulChatClientArgs

Arguments pour construire l’objet StatefulChatClient.
StatefulChatClientOptions

Options de construction de StatefulChatClient.
SystemMessage

Union discriminatoire de tous les messages système.

Le systemMessageType domaine se spécialise dans les variantes syndicales.
TopicChangedListener

Rappel pour l’événement « topicChanged » chatAdapterSubscribers .
TypingIndicatorSelector

Type de sélecteur pour le composant TypingIndicator .
UpdateMessageCallback

La fonction de rappel s’exécute lorsqu’un message est mis à jour.
VideoGalleryLayout
VideoGalleryLocalParticipant

État du participant local au VideoGallery.
VideoGalleryParticipant

État d’un participant au VideoGallery.
VideoGallerySelector

Type de sélecteur pour le composant VideoGallery .
ViewScalingMode

Mode de mise à l’échelle d’un VideoGalleryStream.

Fonctions

CallAgentProvider(CallAgentProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Les composants appelants de ce package doivent être encapsulés avec un CallAgentProvider.
CallClientProvider(CallClientProviderProps)

<xref:React.Context> qui stocke un StatefulCallClient.

Les composants appelants de ce package doivent être encapsulés avec un CallClientProvider.
CallComposite(CallCompositeProps)

Composite d’interface utilisateur personnalisable pour l’expérience d’appel.
CallProvider(CallProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-calling%23Call>.

Les composants appelants de ce package doivent être encapsulés avec un CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite regroupe des composants clés pour fournir un appel complet avec une expérience de conversation prête à l’emploi.
CameraButton(CameraButtonProps)

Bouton pour activer/désactiver l’appareil photo.

Peut être utilisé avec ControlBar.
ChatClientProvider(ChatClientProviderProps)

<xref:React.Context> qui stocke un StatefulChatClient.

Les composants de conversation de ce package doivent être encapsulés avec un ChatClientProvider.
ChatComposite(ChatCompositeProps)

Composite d’interface utilisateur personnalisable pour l’expérience de conversation.
ChatThreadClientProvider(ChatThreadClientProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Les composants de conversation de ce package doivent être encapsulés avec un ChatThreadClientProvider.
ControlBar(ControlBarProps)

Conteneur de différents boutons pour les contrôles d’appel.

Utilisez avec différents boutons de contrôle d’appel dans cette bibliothèque, par exemple , CameraButton ou vos propres instances de ControlBarButton directement.
ControlBarButton(ControlBarButtonProps)

Bouton par défaut stylé pour la barre de contrôle.

Utilisez ce composant pour créer des boutons personnalisés dont le style est identique à celui des autres boutons fournis par la bibliothèque d’interface utilisateur.
DevicesButton(DevicesButtonProps)

Bouton permettant d’ouvrir un menu qui contrôle les options de l’appareil.

Peut être utilisé avec ControlBar.
EndCallButton(EndCallButtonProps)

Bouton permettant de mettre fin à un appel en cours.

Peut être utilisé avec ControlBar.
ErrorBar(ErrorBarProps)

Composant pour afficher les messages d’erreur sur l’interface utilisateur. Toutes les chaînes qui peuvent être affichées sont acceptées en tant que chaînes afin qu’elles puissent être localisées. Les erreurs actives sont sélectionnées par activeErrorMessages.

Ce composant effectue le suivi interne des éléments ignorés par l’utilisateur.

  • Erreurs associées à un horodatage : l’erreur s’affiche à nouveau dans l’interface utilisateur si elle se produit après avoir été ignorée.
  • Erreurs qui n’ont pas d’horodatage : l’erreur est ignorée jusqu’à ce qu’elle disparaisse des propriétés. Si l’erreur se répète, elle est affichée dans l’interface utilisateur.

Utilise l’élément <xref:%40fluentui%2Freact%23MessageBar> d’interface utilisateur.
FluentThemeProvider(FluentThemeProviderProps)

Fournisseur pour appliquer un thème Fluent aux composants react de cette bibliothèque.
GridLayout(GridLayoutProps)

Composant permettant de disposer les vignettes des participants audio/vidéo dans un appel.
LocalizationProvider(LocalizationProviderProps)

Fournisseur pour fournir des chaînes localisées pour les composants react de cette bibliothèque.
MessageStatusIndicator(MessageStatusIndicatorProps)

Composant permettant d’afficher le status d’un message envoyé.

Ajoute une icône et une info-bulle correspondant au message status.
MessageThread(MessageThreadProps)

MessageThread vous permet de créer facilement un composant pour le rendu des messages de conversation, la gestion du comportement de défilement des nouveaux/anciens messages et la personnalisation des icônes & contrôles à l’intérieur du fil de conversation.
MicrophoneButton(MicrophoneButtonProps)

Bouton permettant d’activer/désactiver le microphone.

Peut être utilisé avec ControlBar.
ParticipantItem(ParticipantItemProps)

Composant permettant d’afficher un participant appelant ou de conversation.

Affiche l’avatar, displayName et status du participant, ainsi que les icônes facultatives et le menu contextuel.
ParticipantList(ParticipantListProps)

Composant pour afficher tous les participants appelants ou de conversation.

Par défaut, chaque participant est rendu avec ParticipantItem. Voir <xref:ParticipantListProps.onRenderParticipant> pour remplacer.
ParticipantsButton(ParticipantsButtonProps)

Bouton permettant d’afficher un menu avec des participants appelants ou de conversation.

Peut être utilisé avec ControlBar.

Ce bouton contient des éléments de menu déroulant définis par le biais de sa propriété menuProps. Par défaut, il peut afficher le nombre de participants distants avec la liste complète sous forme de sous-menu et une option permettant de désactiver le son de tous les participants, ainsi qu’un bouton copier dans le Presse-papiers pour copier l’URL de l’invitation à l’appel. Cela menuProps peut être entièrement redéfini et sa propriété est de type IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)

Bouton permettant de démarrer/arrêter le partage d’écran.

Peut être utilisé avec ControlBar.
SendBox(SendBoxProps)

Composant pour la saisie et l’envoi de messages.

Prend en charge l’envoi d’une notification de saisie lorsque l’utilisateur commence à entrer du texte. Prend en charge un message facultatif sous le champ d’entrée de texte.
StreamMedia(StreamMediaProps)

Composant utilitaire pour convertir un élément HTMLElement avec un flux vidéo en élément JSX.

Utilisez pour convertir un élément HTMLElement retourné par l’API d’appel sans tête en un composant qui peut être rendu en tant que VideoTile.
TypingIndicator(TypingIndicatorProps)

Composant pour avertir l’utilisateur local lorsqu’un ou plusieurs participants au fil de conversation tapent.
VideoGallery(VideoGalleryProps)

VideoGallery représente une disposition de vignettes vidéo pour un appel spécifique. Il affiche un VideoTile pour l’utilisateur local ainsi que pour chaque participant distant qui a rejoint l’appel.
VideoTile(VideoTileProps)

Composant permettant de restituer le flux vidéo pour un seul participant à l’appel.

Utilisez avec GridLayout dans un VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Créez un CallAdapter soutenu par Azure Communication Services.

Il s’agit de l’implémentation par défaut de CallAdapter fournie par cette bibliothèque.

Remarque : displayName peut avoir un maximum de 256 caractères.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Créez un CallAdapter à l’aide du StatefulCallClient fourni.

Utile si vous souhaitez conserver une référence à StatefulCallClient. Envisagez d’utiliser createAzureCommunicationCallAdapter pour une API plus simple.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Créez un CallWithChatAdapter avec l’aide d’Azure Communication Services pour le brancher à CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Créez un CallWithChatAdapter à l’aide de StatefulChatClient et StatefulCallClient fournis.

Utile si vous souhaitez conserver une référence à StatefulChatClient et StatefulCallClient. Envisagez d’utiliser createAzureCommunicationCallWithChatAdapter pour une API plus simple.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Créez un ChatAdapter soutenu par Azure Communication Services.

Il s’agit de l’implémentation par défaut de ChatAdapter fournie par cette bibliothèque.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Créez un ChatAdapter à l’aide du StatefulChatClient fourni.

Utile si vous souhaitez conserver une référence à StatefulChatClient. Envisagez d’utiliser createAzureCommunicationChatAdapter pour une API plus simple.
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call)

Créez l’implémentation par défaut de CallingHandlers pour l’appel teams.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Créez l’implémentation par défaut de ChatHandlers.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

L’objet retourné est mémorisé pour éviter les rerenders lorsqu’il est utilisé comme accessoires pour React Components.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Crée un StatefulCallClient StatefulCallClient en proxy callClient <xref:%40azure%2Fcommunication-calling%23CallClient> avec ProxyCallClient <xref:ProxyCallClient> , qui autorise ensuite l’accès à l’état de manière déclarative.

Il est important d’utiliser les <xref:%40azure%2Fcommunication-calling%23DeviceManager> et et <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (et etc.) obtenus à partir de StatefulCallClient pour que leurs modifications d’état soient correctement transmises.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Crée un ChatClient StatefulChatClient avec état en proxyant ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> avec ProxyChatClient <xref:ProxyChatClient> , qui autorise ensuite l’accès à l’état de manière déclarative.
fromFlatCommunicationIdentifier(string)

Opération inverse de toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)

Obtenez le sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
getChatSelector<Component>(Component)

Obtenez le sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
toFlatCommunicationIdentifier(CommunicationIdentifier)

Représentation sous forme de chaîne d'un <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Cette représentation sous forme de chaîne de CommunicationIdentifier est garantie stable pour un utilisateur communication unique. Donc

  • il peut être utilisé pour conserver l’identité d’un utilisateur dans des bases de données externes.
  • il peut être utilisé comme clés dans une carte pour stocker des données pour l’utilisateur.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Un hook de React personnalisé pour simplifier la création de CallAdapter.

Similaire à createAzureCommunicationCallAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)

Un hook de React personnalisé pour simplifier la création de CallWithChatAdapter.

Similaire à createAzureCommunicationCallWithChatAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)

Un hook de React personnalisé pour simplifier la création de ChatAdapter.

Similaire à createAzureCommunicationChatAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.
useCall()

Hook à obtenir <xref:%40azure%2Fcommunication-calling%23Call> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

vous devez avoir déjà utilisé CallProvider avec un objet Call pour utiliser ce hook
useCallAgent()

Hook à obtenir <xref:%40azure%2Fcommunication-calling%23CallAgent> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
useCallClient()

Hook pour obtenir StatefulCallClient auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
useChatClient()

Hook pour obtenir StatefulChatClient auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
useChatThreadClient()

Hook à obtenir <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
useDeviceManager()

Hook pour obtenir StatefulDeviceManager à partir du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
usePropsFor<Component>(Component, "chat" | "calling")

Hook principal pour obtenir tous les hooks nécessaires pour un composant React à partir de cette bibliothèque.

Pour appeler ce hook, le composant doit être encapsulé sous ces fournisseurs :

  1. Pour les composants de conversation : ChatClientProvider et ChatThreadClientProvider.

  2. Pour les composants appelants : CallClientProvider, CallAgentProvider et CallAgentProvider.

L’utilisation la plus simple d’un composant ressemble à ceci :

Exemple

    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 pour obtenir un sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.
useTheme()

React hook pour accéder au thème

Informations relatives à la fonction

CallAgentProvider(CallAgentProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Les composants appelants de ce package doivent être encapsulés avec un CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Paramètres

props
CallAgentProviderProps

Retours

Element

CallClientProvider(CallClientProviderProps)

<xref:React.Context> qui stocke un StatefulCallClient.

Les composants appelants de ce package doivent être encapsulés avec un CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Paramètres

props
CallClientProviderProps

Retours

Element

CallComposite(CallCompositeProps)

Composite d’interface utilisateur personnalisable pour l’expérience d’appel.

function CallComposite(props: CallCompositeProps): Element

Paramètres

props
CallCompositeProps

Retours

Element

Remarques

La largeur/hauteur minimale de l’appel composite est la suivante :

  • mobile : 17,5rem x 21rem (280 px x 336 px, avec rem par défaut à 16 px)
  • desktop : 30rem x 22rem (480px x 352px, avec rem par défaut à 16px)

CallProvider(CallProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-calling%23Call>.

Les composants appelants de ce package doivent être encapsulés avec un CallProvider.

function CallProvider(props: CallProviderProps): Element

Paramètres

props
CallProviderProps

Retours

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite regroupe des composants clés pour fournir un appel complet avec une expérience de conversation prête à l’emploi.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Paramètres

props
CallWithChatCompositeProps

Retours

Element

CameraButton(CameraButtonProps)

Bouton pour activer/désactiver l’appareil photo.

Peut être utilisé avec ControlBar.

function CameraButton(props: CameraButtonProps): Element

Paramètres

props
CameraButtonProps

Retours

Element

ChatClientProvider(ChatClientProviderProps)

<xref:React.Context> qui stocke un StatefulChatClient.

Les composants de conversation de ce package doivent être encapsulés avec un ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Paramètres

props
ChatClientProviderProps

Retours

Element

ChatComposite(ChatCompositeProps)

Composite d’interface utilisateur personnalisable pour l’expérience de conversation.

function ChatComposite(props: ChatCompositeProps): Element

Paramètres

props
ChatCompositeProps

Retours

Element

Remarques

La largeur et la hauteur minimales composites de conversation sont respectivement de 17,5rem et 20rem (280px et 320 px, avec rem par défaut à 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

<xref:React.Context> qui stocke un <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Les composants de conversation de ce package doivent être encapsulés avec un ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Paramètres

props
ChatThreadClientProviderProps

Retours

Element

ControlBar(ControlBarProps)

Conteneur de différents boutons pour les contrôles d’appel.

Utilisez avec différents boutons de contrôle d’appel dans cette bibliothèque, par exemple , CameraButton ou vos propres instances de ControlBarButton directement.

function ControlBar(props: ControlBarProps): Element

Paramètres

props
ControlBarProps

Retours

Element

ControlBarButton(ControlBarButtonProps)

Bouton par défaut stylé pour la barre de contrôle.

Utilisez ce composant pour créer des boutons personnalisés dont le style est identique à celui des autres boutons fournis par la bibliothèque d’interface utilisateur.

function ControlBarButton(props: ControlBarButtonProps): Element

Paramètres

props
ControlBarButtonProps

Retours

Element

DevicesButton(DevicesButtonProps)

Bouton permettant d’ouvrir un menu qui contrôle les options de l’appareil.

Peut être utilisé avec ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Paramètres

props
DevicesButtonProps

Retours

Element

EndCallButton(EndCallButtonProps)

Bouton permettant de mettre fin à un appel en cours.

Peut être utilisé avec ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Paramètres

props
EndCallButtonProps

Retours

Element

ErrorBar(ErrorBarProps)

Composant pour afficher les messages d’erreur sur l’interface utilisateur. Toutes les chaînes qui peuvent être affichées sont acceptées en tant que chaînes afin qu’elles puissent être localisées. Les erreurs actives sont sélectionnées par activeErrorMessages.

Ce composant effectue le suivi interne des éléments ignorés par l’utilisateur.

  • Erreurs associées à un horodatage : l’erreur s’affiche à nouveau dans l’interface utilisateur si elle se produit après avoir été ignorée.
  • Erreurs qui n’ont pas d’horodatage : l’erreur est ignorée jusqu’à ce qu’elle disparaisse des propriétés. Si l’erreur se répète, elle est affichée dans l’interface utilisateur.

Utilise l’élément <xref:%40fluentui%2Freact%23MessageBar> d’interface utilisateur.

function ErrorBar(props: ErrorBarProps): Element

Paramètres

props
ErrorBarProps

Retours

Element

FluentThemeProvider(FluentThemeProviderProps)

Fournisseur pour appliquer un thème Fluent aux composants react de cette bibliothèque.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Paramètres

props
FluentThemeProviderProps

Retours

Element

Remarques

Les composants de cette bibliothèque sont principalement composés de l’interface utilisateur Fluent, des contrôles, ainsi que des contrôles Fluent React Northstar. Ce fournisseur gère l’application de n’importe quel thème fourni aux contrôles Fluent UI sous-jacents, ainsi qu’aux contrôles Fluent React Northstar.

GridLayout(GridLayoutProps)

Composant permettant de disposer les vignettes des participants audio/vidéo dans un appel.

function GridLayout(props: GridLayoutProps): Element

Paramètres

props
GridLayoutProps

Retours

Element

LocalizationProvider(LocalizationProviderProps)

Fournisseur pour fournir des chaînes localisées pour les composants react de cette bibliothèque.

function LocalizationProvider(props: LocalizationProviderProps): Element

Paramètres

props
LocalizationProviderProps

Retours

Element

Remarques

Les composants seront fournis par défaut en anglais (États-Unis) des chaînes localisées si ce fournisseur n’est pas utilisé.

MessageStatusIndicator(MessageStatusIndicatorProps)

Composant permettant d’afficher le status d’un message envoyé.

Ajoute une icône et une info-bulle correspondant au message status.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Paramètres

props
MessageStatusIndicatorProps

Retours

Element

MessageThread(MessageThreadProps)

MessageThread vous permet de créer facilement un composant pour le rendu des messages de conversation, la gestion du comportement de défilement des nouveaux/anciens messages et la personnalisation des icônes & contrôles à l’intérieur du fil de conversation.

function MessageThread(props: MessageThreadProps): Element

Paramètres

props
MessageThreadProps

de type MessageThreadProps

Les utilisateurs devront fournir au moins des messages de conversation et userId pour afficher le MessageThread composant. Les utilisateurs peuvent également personnaliser MessageThread en passant leur propre Avatar, MessageStatusIndicator icône, JumpToNewMessageButton, LoadPreviousMessagesButton et le comportement de ces contrôles.

MessageThread utilise en interne le Chat composant & Chat.Message de @fluentui/react-northstar. Vous pouvez consulter les détails de ces deux composants.

Retours

Element

MicrophoneButton(MicrophoneButtonProps)

Bouton permettant d’activer/désactiver le microphone.

Peut être utilisé avec ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Paramètres

props
MicrophoneButtonProps

Retours

Element

ParticipantItem(ParticipantItemProps)

Composant permettant d’afficher un participant appelant ou de conversation.

Affiche l’avatar, displayName et status du participant, ainsi que les icônes facultatives et le menu contextuel.

function ParticipantItem(props: ParticipantItemProps): Element

Paramètres

props
ParticipantItemProps

Retours

Element

ParticipantList(ParticipantListProps)

Composant pour afficher tous les participants appelants ou de conversation.

Par défaut, chaque participant est rendu avec ParticipantItem. Voir <xref:ParticipantListProps.onRenderParticipant> pour remplacer.

function ParticipantList(props: ParticipantListProps): Element

Paramètres

props
ParticipantListProps

Retours

Element

ParticipantsButton(ParticipantsButtonProps)

Bouton permettant d’afficher un menu avec des participants appelants ou de conversation.

Peut être utilisé avec ControlBar.

Ce bouton contient des éléments de menu déroulant définis par le biais de sa propriété menuProps. Par défaut, il peut afficher le nombre de participants distants avec la liste complète sous forme de sous-menu et une option permettant de désactiver le son de tous les participants, ainsi qu’un bouton copier dans le Presse-papiers pour copier l’URL de l’invitation à l’appel. Cela menuProps peut être entièrement redéfini et sa propriété est de type IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Paramètres

props
ParticipantsButtonProps

Retours

Element

ScreenShareButton(ScreenShareButtonProps)

Bouton permettant de démarrer/arrêter le partage d’écran.

Peut être utilisé avec ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Paramètres

props
ScreenShareButtonProps

Retours

Element

SendBox(SendBoxProps)

Composant pour la saisie et l’envoi de messages.

Prend en charge l’envoi d’une notification de saisie lorsque l’utilisateur commence à entrer du texte. Prend en charge un message facultatif sous le champ d’entrée de texte.

function SendBox(props: SendBoxProps): Element

Paramètres

props
SendBoxProps

Retours

Element

StreamMedia(StreamMediaProps)

Composant utilitaire pour convertir un élément HTMLElement avec un flux vidéo en élément JSX.

Utilisez pour convertir un élément HTMLElement retourné par l’API d’appel sans tête en un composant qui peut être rendu en tant que VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Paramètres

props
StreamMediaProps

Retours

Element

TypingIndicator(TypingIndicatorProps)

Composant pour avertir l’utilisateur local lorsqu’un ou plusieurs participants au fil de conversation tapent.

function TypingIndicator(props: TypingIndicatorProps): Element

Paramètres

props
TypingIndicatorProps

Retours

Element

VideoGallery(VideoGalleryProps)

VideoGallery représente une disposition de vignettes vidéo pour un appel spécifique. Il affiche un VideoTile pour l’utilisateur local ainsi que pour chaque participant distant qui a rejoint l’appel.

function VideoGallery(props: VideoGalleryProps): Element

Paramètres

props
VideoGalleryProps

Retours

Element

VideoTile(VideoTileProps)

Composant permettant de restituer le flux vidéo pour un seul participant à l’appel.

Utilisez avec GridLayout dans un VideoGallery.

function VideoTile(props: VideoTileProps): Element

Paramètres

props
VideoTileProps

Retours

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Créez un CallAdapter soutenu par Azure Communication Services.

Il s’agit de l’implémentation par défaut de CallAdapter fournie par cette bibliothèque.

Remarque : displayName peut avoir un maximum de 256 caractères.

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

Paramètres

__namedParameters
AzureCommunicationCallAdapterArgs

Retours

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Créez un CallAdapter à l’aide du StatefulCallClient fourni.

Utile si vous souhaitez conserver une référence à StatefulCallClient. Envisagez d’utiliser createAzureCommunicationCallAdapter pour une API plus simple.

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

Paramètres

callClient
StatefulCallClient
callAgent
CallAgent
locator
CallAdapterLocator

Retours

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Créez un CallWithChatAdapter avec l’aide d’Azure Communication Services pour le brancher à CallWithChatComposite.

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

Paramètres

__namedParameters
AzureCommunicationCallWithChatAdapterArgs

Retours

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Créez un CallWithChatAdapter à l’aide de StatefulChatClient et StatefulCallClient fournis.

Utile si vous souhaitez conserver une référence à StatefulChatClient et StatefulCallClient. Envisagez d’utiliser createAzureCommunicationCallWithChatAdapter pour une API plus simple.

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

Paramètres

__namedParameters
AzureCommunicationCallWithChatAdapterFromClientArgs

Retours

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Créez un ChatAdapter soutenu par Azure Communication Services.

Il s’agit de l’implémentation par défaut de ChatAdapter fournie par cette bibliothèque.

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

Paramètres

__namedParameters
AzureCommunicationChatAdapterArgs

Retours

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Créez un ChatAdapter à l’aide du StatefulChatClient fourni.

Utile si vous souhaitez conserver une référence à StatefulChatClient. Envisagez d’utiliser createAzureCommunicationChatAdapter pour une API plus simple.

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

Paramètres

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Retours

Promise<ChatAdapter>

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

Créez l’implémentation par défaut de CallingHandlers pour l’appel teams.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

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

Paramètres

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Retours

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Créez l’implémentation par défaut de ChatHandlers.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

L’objet retourné est mémorisé pour éviter les rerenders lorsqu’il est utilisé comme accessoires pour React Components.

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

Paramètres

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Retours

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Crée un StatefulCallClient StatefulCallClient en proxy callClient <xref:%40azure%2Fcommunication-calling%23CallClient> avec ProxyCallClient <xref:ProxyCallClient> , qui autorise ensuite l’accès à l’état de manière déclarative.

Il est important d’utiliser les <xref:%40azure%2Fcommunication-calling%23DeviceManager> et et <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (et etc.) obtenus à partir de StatefulCallClient pour que leurs modifications d’état soient correctement transmises.

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

Paramètres

args
StatefulCallClientArgs

StatefulCallClientArgs

options
StatefulCallClientOptions

StatefulCallClientOptions

Retours

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Crée un ChatClient StatefulChatClient avec état en proxyant ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> avec ProxyChatClient <xref:ProxyChatClient> , qui autorise ensuite l’accès à l’état de manière déclarative.

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

Paramètres

args
StatefulChatClientArgs
options
StatefulChatClientOptions

Retours

StatefulChatClient

fromFlatCommunicationIdentifier(string)

Opération inverse de toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Paramètres

id

string

Retours

CommunicationIdentifier

getCallingSelector<Component>(Component)

Obtenez le sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

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

Paramètres

component

Component

Retours

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Obtenez le sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

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

Paramètres

component

Component

Retours

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Représentation sous forme de chaîne d'un <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Cette représentation sous forme de chaîne de CommunicationIdentifier est garantie stable pour un utilisateur communication unique. Donc

  • il peut être utilisé pour conserver l’identité d’un utilisateur dans des bases de données externes.
  • il peut être utilisé comme clés dans une carte pour stocker des données pour l’utilisateur.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Paramètres

identifier
CommunicationIdentifier

Retours

string

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

Un hook de React personnalisé pour simplifier la création de CallAdapter.

Similaire à createAzureCommunicationCallAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.

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

Paramètres

args

Partial<AzureCommunicationCallAdapterArgs>

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

Retours

undefined | CallAdapter

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

Un hook de React personnalisé pour simplifier la création de CallWithChatAdapter.

Similaire à createAzureCommunicationCallWithChatAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.

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

Paramètres

args

Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate

(adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose

(adapter: CallWithChatAdapter) => Promise<void>

Retours

undefined | CallWithChatAdapter

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

Un hook de React personnalisé pour simplifier la création de ChatAdapter.

Similaire à createAzureCommunicationChatAdapter, mais prend en charge la création asynchrone de l’adaptateur en interne.

Permet aux arguments d’être indéfinis afin que vous puissiez respecter la règle des crochets et passer les arguments au fur et à mesure de leur création. L’adaptateur est créé uniquement lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur sur chaque rendu. Consultez le storybook pour obtenir des exemples d’utilisation standard.

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

Paramètres

args

Partial<AzureCommunicationChatAdapterArgs>

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Retours

undefined | ChatAdapter

useCall()

Hook à obtenir <xref:%40azure%2Fcommunication-calling%23Call> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

vous devez avoir déjà utilisé CallProvider avec un objet Call pour utiliser ce hook

function useCall(): undefined | Call

Retours

undefined | Call

useCallAgent()

Hook à obtenir <xref:%40azure%2Fcommunication-calling%23CallAgent> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

function useCallAgent(): undefined | CallAgent

Retours

undefined | CallAgent

useCallClient()

Hook pour obtenir StatefulCallClient auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

function useCallClient(): StatefulCallClient

Retours

StatefulCallClient

useChatClient()

Hook pour obtenir StatefulChatClient auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

function useChatClient(): StatefulChatClient

Retours

StatefulChatClient

useChatThreadClient()

Hook à obtenir <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> auprès du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

function useChatThreadClient(): ChatThreadClient

Retours

ChatThreadClient

useDeviceManager()

Hook pour obtenir StatefulDeviceManager à partir du fournisseur.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

function useDeviceManager(): undefined | StatefulDeviceManager

Retours

undefined | StatefulDeviceManager

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

Hook principal pour obtenir tous les hooks nécessaires pour un composant React à partir de cette bibliothèque.

Pour appeler ce hook, le composant doit être encapsulé sous ces fournisseurs :

  1. Pour les composants de conversation : ChatClientProvider et ChatThreadClientProvider.

  2. Pour les composants appelants : CallClientProvider, CallAgentProvider et CallAgentProvider.

L’utilisation la plus simple d’un composant ressemble à ceci :

Exemple

    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>

Paramètres

component

Component

type

"chat" | "calling"

Retours

ComponentProps<Component>

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

Hook pour obtenir un sélecteur pour un composant spécifié.

Utile lors de l’implémentation d’un composant personnalisé qui utilise les fournisseurs exportés à partir de cette bibliothèque.

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

Paramètres

selector

ParamT

selectorProps

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

type

"chat" | "calling"

Retours

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

useTheme()

React hook pour accéder au thème

function useTheme(): Theme

Retours

Theme