Partager via


@azure/communication-react package

Classes

CallError

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

ChatError

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

Interfaces

AcceptedTransfer

Transférer l’état de la fonction

ActiveErrorMessage

Messages d’erreur actifs à afficher via ErrorBar.

ActiveNotification

Les notifications actives seront affichées via NotificationStack.

AdapterError

Erreur signalée par le biais d’événements d’erreur et stockée dans l’état de l’adaptateur.

AdapterNotification

Notification de l’état du client d’appel stocké dans l’état de l’adaptateur.

AdapterState

Fonctionnalité permettant d’interagir avec l’état de l’adaptateur composite.

AttachmentMetadata

Modèle de données qui représente une pièce jointe de message de chat où elle contient un ID permettant d’identifier de manière unique la pièce jointe, un nom représentant le nom du fichier et une URL permettant de télécharger la pièce jointe.

BaseCompositeProps

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

BaseCustomStyles

Propriétés de styles Fluent de base pour tous les composants exportés à partir de cette balance.

BreakoutRoomsState

État des salles de répartition

CallAdapter

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

CallAdapterCallManagement

Fonctionnalité 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 au sein d’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 <xref:%40azure%2Fcommunication-calling%23CallAgent> sauf que les appels sont déplacés pour être un enfant directement de CallClientState et non inclus ici. La raison pour laquelle CallAgent est proxiqué est de fournir l’accès à displayName. Nous n’aplatisons pas CallAgent.displayName et nous l’avons placé dans CallClientState, car il serait ambiguïté 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 à 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 appels, appelsEnded, incomingCalls et les états incomingCallsEnded sont automatiquement fournis si un callAgent a été créé. DeviceManager sera vide initialement jusqu’à ce qu’il soit renseigné DeviceManagerState. L’état userId est fourni comme commodité pour le développeur et est complètement controlé et défini par le développeur.

CallCompositeLoaderProps

Props pour l’OutboundCallComposite que vous pouvez utiliser dans votre application.

Contient deux options de sacs :

CallCompositeProps

Accessoires pour CallComposite.

CallCompositeStrings

Chaînes utilisées par le CallComposite directement.

Ces chaînes sont en plus de celles utilisées par les composants de la bibliothèque de composants.

CallFeatureStreamState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Représente l’état du flux de fonctionnalités d’appel.

CallInfoState

État pour suivre les types <xref:CallInfo> et <xref:TeamsCallInfo>

CallNotification
CallProviderProps

Arguments pour initialiser un CallProvider.

CallState

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

CallSurveyImprovementSuggestions

Représente la partie suggestion d’amélioration de l’enquête d’appel

CallWithChatAdapter

l’interface de l’adaptateur CallWithChatComposite.

CallWithChatAdapterManagement

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

CallWithChatAdapterState

L’état CallWithChat est une combinaison de clients de conversation avec état et d’appel avec état spécifiques à l’état Composite CallWithChat uniquement.

CallWithChatAdapterSubscriptions

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

CallWithChatAdapterUiState

État de l’interface utilisateur relatif au CallWithChatComposite.

CallWithChatClientState

État à partir des services principaux qui pilotent CallWithChatComposite.

CallWithChatCompositeLoaderProps

Props pour le CallWithChatComposite que vous pouvez utiliser dans votre application.

Contient deux options de sacs :

CallWithChatCompositeProps

Props requises pour le CallWithChatComposite

CallWithChatCompositeStrings

Chaînes utilisées par l'CallWithChatComposite directement.

Ces chaînes sont en plus de celles utilisées par les composants de la bibliothèque de composants.

CallWithChatControlOptions

Options de personnalisation de la barre de contrôle lors des appels avec l’expérience de chat.

CallingHandlers

Objet contenant tous les gestionnaires requis pour les composants appelants.

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

CallingTheme

Palette de thèmes Fluent personnalisée utilisée par l’appel des composants associés dans cette bibliothèque.

CameraButtonContextualMenuStyles

Styles pour le menu CameraButton.

CameraButtonProps

Accessoires pour le composant CameraButton .

CameraButtonStrings

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

CameraButtonStyles

Styles pour CameraButton

CapabilitiesFeatureState

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

CapabilityChangedNotificationStrings

Chaînes de caractères pour la notification de modification de capacité

CaptionLanguageStrings

Chaînes de langue de sous-titres pour la définition de la modale de sous-titres

CaptionsBannerProps

LégendesAccessoires du composant Bannière.

CaptionsBannerStrings

Chaînes pour la bannière de sous-titres

CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps

Sous-titresParamètresAccessoires de composant modal.

CaptionsSettingsModalStrings

chaînes pour les sous-titres définition modale

ChatAdapterSubscribers

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

ChatAdapterThreadManagement

Fonctionnalité de gestion du thread de conversation actuel.

ChatCompositeLoaderProps

Props pour le ChatComposite que vous pouvez utiliser dans votre application. Contient les options pour ChatCompositeChatCompositeOptions.

ChatCompositeProps

Accessoires pour ChatComposite.

ChatCompositeStrings

Chaînes utilisées directement par le ChatComposite.

Ces chaînes sont en plus de celles utilisées par les composants de la bibliothèque de composants.

ChatMessage

Message de conversation.

CommonCallAdapter

interface CallComposite Adapter.

CommonCallingHandlers

Objet contenant tous les gestionnaires requis pour les composants appelants.

L’appel de composants associés à partir de ce package est en mesure de sélectionner des 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, au lieu des composants contenus.

ConferencePhoneInfo

Informations pour les informations téléphoniques de la conférence

ContentSystemMessage

Message système avec du contenu arbitaire.

ControlBarButtonProps

Accessoires pour ControlBarButton.

ControlBarButtonStrings

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

ControlBarProps

Accessoires pour ControlBar.

CreateVideoStreamViewResult

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

CustomCallControlButtonCallbackArgs

Arguments pour CustomCallControlButtonCallback.

CustomCallControlButtonProps

Réponse de CustomCallControlButtonCallback. Inclut les accessoires de base nécessaires au rendu d’un ControlBarButton ou <xref:DrawerMenuItem>d’un .

CustomCallControlButtonStrings

Chaînes pour CustomCallControlButtons

CustomMessage

Type de message personnalisé.

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

DevicesButtonContextualMenuStyles

Styles du menu DevicesButton.

DevicesButtonProps

Accessoires pour DevicesButton.

DevicesButtonStrings

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

DevicesButtonStyles

Styles des éléments de menu du bouton Appareils.

DiagnosticsCallFeatureState

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

DialpadProps

Accessoires pour le composant Dialpad .

DialpadStrings

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

DialpadStyles

Styles pour le composant Dialpad .

Disposable

Fonctionnalité permettant de supprimer correctement un composite.

DtmfDialPadOptions

Options permettant de déterminer le comportement de rendu de dtmfDialer dans le CallComposite

EndCallButtonProps

Accessoires pour EndCallButton.

EndCallButtonStrings

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

ErrorBarProps

Props pour ErrorBar.

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

ErrorBarStrings

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

FluentThemeProviderProps

Props pour FluentThemeProvider.

GridLayoutProps

Props pour GridLayout.

GridLayoutStyles

styles de composant GridLayout.

HoldButtonProps
HoldButtonStrings

Chaînes pour les étiquettes du bouton de maintien

HorizontalGalleryStyles

styles de composant <xref:HorizontalGallery>.

ImageOverlayProps

Accessoires pour ImageOverlay.

ImageOverlayStrings

Chaînes d’ImageOverlay qui peuvent être remplacées.

IncomingCallNotificationProps

Propriétés du composant de notification d’appel entrant.

IncomingCallNotificationStrings

Chaînes du composant de notification d’appel entrant.

IncomingCallNotificationStyles

Styles du composant de notification d’appel entrant.

IncomingCallStackCall

Représente un appel entrant actif.

IncomingCallStackProps

Props pour le composant IncomingCallManager.

IncomingCallState

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

InlineImage

InlineImage, tel qu’il est reflété dans l’interface utilisateur.

InlineImageOptions

Options d’affichage de l’image en ligne dans le scénario d’image en ligne.

JoinCallOptions

Options de réglage de l’état du microphone et de la caméra lors de la participation à un appel true = allumer l’appareil lors de la participation à l’appel false = éteindre l’appareil lors de la participation à l’appel 'keep'/undefined = conserver l’état de pré-appel des appareils

JumpToNewMessageButtonProps

Arguments pour <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

LocalVideoStreamVideoEffectsState

Version d’état uniquement des <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>fichiers .

LocalVideoTileOptions

Options pour la vignette vidéo locale dans le composite d’appel.

MediaAccessState

État de l’accès au support

MediaDiagnosticsState

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

MeetingConferencePhoneInfoModalStrings

Chaînes pour le modal d’informations sur le téléphone

MessageCommon

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

MessageStatusIndicatorProps

Props pour MessageStatusIndicator.

MessageStatusIndicatorStrings

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

MessageThreadStrings

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

MessageThreadStyles

Styles Fluent pour MessageThread.

MicrophoneButtonContextualMenuStyles

Styles du menu MicrophoneButton.

MicrophoneButtonProps

Accessoires pour MicrophoneButton.

MicrophoneButtonStrings

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

MicrophoneButtonStyles

Styles pour MicrophoneButton

NetworkDiagnosticsState

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

NotificationOptions

Options de contrôle des notifications dans le composite.

NotificationProps

Accessoires pour la notification.

NotificationStackProps

Props pour NotificationStack.

NotificationStackStrings

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

NotificationStrings

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

NotificationStyles

Styles du composant de notification.

OptimalVideoCountFeatureState

Version d’état uniquement de la fonction <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>de comptage optimal des vidéos.

OptionsDevice

Appareil, par exemple, caméra, microphone ou haut-parleur, dans le menu volant DevicesButton.

OutboundCallCompositeLoaderProps

Props pour l’OutboundCallComposite que vous pouvez utiliser dans votre application.

Contient deux options de sacs :

PPTLiveCallFeatureState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient écoutera automatiquement pptLive lors de l’appel et mettra à jour l’état exposé par StatefulCallClient en conséquence.

ParticipantAddedSystemMessage

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

ParticipantItemProps

Accessoires pour ParticipantItem.

ParticipantItemStrings

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

ParticipantItemStyles

Styles Fluent pour ParticipantItem.

ParticipantListItemStyles

Styles pour ParticipantListParticipantItem.

ParticipantListStyles

Styles du ParticipantList.

ParticipantRemovedSystemMessage

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

ParticipantsButtonContextualMenuStyles

Styles du menu ParticipantsButton.

ParticipantsButtonProps

Accessoires pour les participantsButton.

ParticipantsButtonStrings

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

ParticipantsButtonStyles

Styles Props pour ParticipantsButton.

RaiseHandButtonProps

Accessoires pour RaiseHandButton.

RaiseHandButtonStrings

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

RaiseHandCallFeature

État uniquement version de <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient écoutera automatiquement les mains levées lors de l’appel et mettra à jour l’état exposé par StatefulCallClient en conséquence.

ReactionButtonProps

Accessoires pour ReactionButton.

ReactionButtonStrings

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

ReactionResources

Interface pour l’image du sprite d’animation et les métadonnées associées

RealTimeTextCallFeatureState
RealTimeTextInfo
RealTimeTextModalProps

Props du composant RealTimeTextModal.

RealTimeTextModalStrings

chaînes pour la modale realTimeText

RealTimeTextProps

Props pour une seule ligne de RealTimeText.

RealTimeTextStrings

Cordes pour RTT

RecordingCallFeature

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

RemoteParticipantState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient récupère automatiquement remoteParticipants et ajoute son état à l’état exposé par StatefulCallClient.

RemoteVideoStreamState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

RemoteVideoTileMenuOptions

Options de menu pour les tuiles vidéo distantes dans VideoGallery.

ScreenShareButtonProps

Accessoires pour ScreenShareButton.

ScreenShareButtonStrings

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

SendBoxProps

Accessoires pour SendBox.

SendBoxStrings

Chaînes de sendBox qui peuvent être substituées.

SendBoxStylesProps

Styles Fluent pour <xref:Sendbox>.

SpokenLanguageStrings

Chaînes de langue parlée pour les sous-titres Définition modale

SpotlightCallFeatureState

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

SpotlightPromptStrings

Chaînes utilisées dans l’invite liée à spotlight

SpotlightState

État Spotlight avec ordre

StartCaptionsAdapterOptions

Options transmises à adapter.startCaptions

StartCaptionsButtonProps
StartCaptionsButtonStrings

Chaînes pour les étiquettes du bouton de maintien

StartRealTimeTextButtonProps

Accessoires pour le composant StartRealTimeTextButton

StartRealTimeTextButtonStrings

Chaînes pour les étiquettes du bouton de maintien

StatefulCallClient

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

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

  • Données retournées à partir de <xref:%40azure%2Fcommunication-calling%23DeviceManager> API.
  • Données retournées à partir de <xref:%40azure%2Fcommunication-calling%23CallAgent> API.
  • Les écouteurs sont automatiquement attachés à différents objets d’appel de communication Azure :
    • CallAgent 'incomingCall'
    • CallAgent 'callsUpdated'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Appeler 'stateChanged'
    • Appeler 'idChanged'
    • Appeler 'isMutedChanged'
    • Appelez 'isScreenSharingOnChanged'
    • Appelez « remoteParticipantsUpdated »
    • Appelez « localVideoStreamsUpdated »
    • IncomingCall 'calledEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raisedHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature 'réaction'
StatefulChatClient

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

L’interface permet d’accéder à l’état proxié et permet également d’inscrire un gestionnaire pour les événements de modification d’état.

StatefulDeviceManager

Définit les méthodes supplémentaires ajoutées par l’état en plus de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.

StopCaptionsAdapterOptions

Options transmises à adapter.stopCaptions

StreamMediaProps

Accessoires pour StreamMedia.

SurveyIssues

Textes correspondants à chaque numéro de l’appel

SurveyIssuesHeadingStrings

Textes correspondants à chaque catégorie d’enjeu de l’appel

SystemMessageCommon

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

TeamsCallAdapter

Une interface d’adaptateur spécifique à l’identité des équipes qui étend CommonCallAdapter.

TeamsCallingHandlers

Objet contenant tous les gestionnaires d’appels d’équipes requis pour l’appel des composants.

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

TeamsIncomingCallState

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

TogetherModeCallFeatureState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Représente l’état de la fonction du mode Ensemble.

TogetherModeSeatingPositionState

État uniquement version de <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>.

Représente la position assise d’un participant en mode Ensemble.

TogetherModeStreamOptions

Interface représentant le résultat d’une vue de flux en mode Ensemble.

TogetherModeStreamViewResult

Interface représentant le résultat d’une vue de flux en mode Ensemble.

TogetherModeStreamsState

Représente les flux en mode Ensemble.

TopicUpdatedSystemMessage

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

TranscriptionCallFeature

État uniquement 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.

TransferFeature

Transférer l’état de la fonction

TypingIndicatorProps

Accessoires pour TypingIndicator.

TypingIndicatorStrings

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

TypingIndicatorStylesProps

Styles Fluent pour TypingIndicator.

VerticalGalleryControlBarStyles

Styles de la barre de contrôle à l’intérieur du composant VerticalGallery

VerticalGalleryStrings

Chaînes pour la localisation de la galerie verticale.

VerticalGalleryStyles

Styles pour le composant VerticalGallery

VideoBackgroundBlurEffect

Contient les attibutes de l’effet d’arrière-plan vidéo flou

VideoBackgroundImage

Contient les attributs d’une image d’arrière-plan comme l’url, le nom, etc.

VideoBackgroundNoEffect

Contient les attibutes pour supprimer l’effet d’arrière-plan vidéo

VideoBackgroundReplacementEffect

Contient les attributs d’un effet d’arrière-plan vidéo de remplacement sélectionné

VideoGalleryLocalParticipant

État du participant local dans le VideoGallery.

VideoGalleryProps

Accessoires pour VideoGallery.

VideoGalleryRemoteParticipant

État d’un participant distant dans le VideoGallery.

VideoGalleryStream

Flux vidéo d’un participant dans VideoGallery.

VideoGalleryStrings

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

VideoGalleryStyles

Styles de composants VideoGallery.

VideoGalleryTogetherModeSeatingInfo

Interface représentant les informations sur les sièges en mode Together.

VideoGalleryTogetherModeStreams

Interface représentant les flux en mode Ensemble.

VideoStreamOptions

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

VideoStreamRendererViewState

État uniquement 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.

VideoTileContextualMenuProps

Propriétés d’affichage du menu contextuel pour les composants VideoTile distants dans VideoGallery.

VideoTileDrawerMenuProps

Propriétés permettant d’afficher le menu du tiroir sur le VideoTile distant à long terme dans VideoGallery.

VideoTileProps

Accessoires pour VideoTile.

VideoTileStrings

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

VideoTileStylesProps

Styles Fluent pour VideoTile.

VideoTilesOptions

Options qui s’appliquent à toutes les vignettes vidéo de la galerie vidéo

Alias de type

AdapterErrors

Les adaptateurs stockent la dernière erreur 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.

AdapterNotifications

Adaptateurs stocke la dernière notification pour chaque cible.

AreEqual

Comparer si 2 composants react sont exactement égaux, le type de résultat est true/false

AreParamEqual

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

AreTypeEqual

Comparer si deux types sont égaux, le type de résultat est true/false

AvatarPersonaData

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

AvatarPersonaDataCallback

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

AzureCommunicationCallAdapterArgs

Arguments pour la création de l’implémentation d’Azure Communication Services de CallAdapter.

Remarque : displayName peut comporter au maximum 256 caractères.

AzureCommunicationCallAdapterOptions

Paramètres optionnels à créer useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

AzureCommunicationCallWithChatAdapterArgs

Arguments pour createAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Arguments pour <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

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

AzureCommunicationOutboundCallAdapterArgs

Arguments pour la création de l’implémentation d’Azure Communication Services de CallAdapter.

Ces arguments sont utilisés pour créer des scénarios d’appel sortant.

Remarque : displayName peut comporter au maximum 256 caractères.

CallAdapterCallEndedEvent

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

CallAdapterClientState

CommonCallAdapter'état déduit à partir du serveur principal Azure Communication Services.

CallAdapterLocator

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

CallAdapterState

'état CommonCallAdapter.

CallAdapterUiState

CommonCallAdapter état à des fins d’interface utilisateur pures.

CallCompositeIcons

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

CallCompositeOptions

Fonctionnalités facultatives du CallComposite.

CallCompositePage

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

CallControlDisplayType

Type d’affichage de 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 CallAdapterSubscribers 'callEnded'.

CallErrorBarSelector

Type de sélecteur pour composant ErrorBar.

CallErrorTarget

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

CallErrors

Erreurs liées à partir d’appels d’API au Kit de développement logiciel (SDK) Appelant.

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

Les erreurs de cet objet peuvent être effacées à l’aide de la <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 sur les méthodes clientes avec état individuels pour plus d’informations sur le moment où les erreurs peuvent être effacées automatiquement.
CallFeatureStreamName

Représente le nom du flux de fonctionnalités d’appel

CallIdChangedListener

Rappel pour CallAdapterSubscribers 'callIdChanged'.

CallNotifications
CallParticipantListParticipant

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

CallWithChatCompositeIcons

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

CallWithChatCompositeOptions

Fonctionnalités facultatives du CallWithChatComposite.

CallWithChatEvent

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

CallingBaseSelectorProps

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

CallingHandlersOptions

Options de configuration pour inclure la dépendance de l’arrière-plan de l’effet vidéo.

CallingReturnProps

Type d’assistance pour usePropsFor.

CallingSounds

Type de représentation d’un ensemble de sons à utiliser pour différents événements d’appel

CameraButtonSelector

Type de sélecteur pour composant CameraButton.

CancelEditCallback

La fonction de rappel s’exécute lorsqu’une modification de message est annulée.

CapabilitiesChangedListener

Rappel de l’événement 'capabilitiesChanged' de CallAdapterSubscribers .

CaptionSettingsSelector

Type de sélecteur pour les composants pour la modification de la langue des sous-titres et de la langue parlée

CaptionsBannerSelector

Type de sélecteur pour le composant CaptionsBanner .

CaptionsInformation

Informations requises pour chaque ligne de sous-titrage

CaptionsOptions

Sac d’options pour commencer les sous-titres

CaptionsReceivedListener

Rappel pour l’événement 'captionsReceived' de CallAdapterSubscribers .

ChatAdapter

interface de l’adaptateur chatComposite.

ChatAdapterOptions

Options de configuration du ChatAdapter.

ChatAdapterState

état ChatAdapter.

ChatAdapterUiState

'état ChatAdapter à des fins d’interface utilisateur pures.

ChatAttachmentType

Représente le type de pièce jointe

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

ChatAdapter'état déduit à partir du serveur principal Azure Communication Services.

ChatCompositeIcons

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

ChatCompositeOptions

Fonctionnalités facultatives du ChatComposite.

ChatErrorBarSelector

Type de sélecteur pour composant ErrorBar.

ChatErrorTarget

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

ChatErrors

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

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

ChatHandlers

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

Les composants associés à la conversation à partir de ce package sont en mesure de sélectionner des gestionnaires pertinents à partir de cet objet. Consultez <xref:useHandlers> et usePropsFor.

ChatInitializedListener

Rappel de <xref:CallWithChatAdapterSubscribers> l’événement 'chatInitialized'.

ChatMessageWithStatus

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

TODO : Le nom a fait l’objet d’un bitrotté. Renommez-moi.

ChatParticipantListSelector

Type de sélecteur pour composant participantList.

ChatProfile

Le profil d’un utilisateur ou d’un bot.

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

Type d’intersection de retour de 2 types

CommonCallAdapterOptions

Paramètres facultatifs courants à créer useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) ou TeamsCallAdapter

CommonCallControlOptions

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

CommonProperties

Retourner des propriétés d’intersection de 2 types

CommunicationParticipant

État d’une conversation ou d’appel du participant, comme indiqué 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.

ComponentSlotStyle

ComponentSlotStyle est un @fluentui/react-northstar type. Comme nous nous sommes éloignés de ce package, nous avons utilisé le type IRawStyle plus générique de fluent pour l’interopérabilité.

CompositeIcons

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

Consultez ChatCompositeIcons, CallCompositeIcons et CallWithChatCompositeIcons pour plus de types ciblés.

ControlBarButtonStyles

Styles pour toutes les implémentations ControlBarButton.

ControlBarLayout

Présentez les dispositions du ControlBar.

CreateDefaultCallingHandlers

Type de createDefaultCallingHandlers.

CreateViewResult

Retournez le résultat de createView.

CustomAvatarOptions

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

CustomCallControlButtonCallback

Un rappel qui renvoie les props pour afficher un ControlBarButton personnalisé et <xref:DrawerMenuItem>.

La réponse indique l’emplacement du bouton personnalisé.

Conseil de performance : Ce rappel n’est appelé que lorsque le rappel ou ses arguments changent.

CustomCallControlButtonPlacement

Emplacement d’un bouton personnalisé injecté dans le <xref:CommonCallControlBar>fichier .

'primary' : Placez le(s) bouton(s) à l’extrémité droite de la barre de contrôle centrale, mais avant le EndCallButton (extrémité gauche en mode rtl). 'overflow' : Placez le(s) bouton(s) à la fin du menu de débordement. 'secondaire' : Placez le(s) bouton(s) à l’extrémité gauche de la barre de commande latérale (à droite en mode rtl).

Plusieurs boutons affectés au même emplacement sont ajoutés dans l’ordre. Par exemple, si deux boutons sont placés en 'secondaire', ils apparaîtront tous les deux à l’extrémité gauche (extrémité droite en mode rtl) dans l’ordre fourni.

Seul le placement « principal » fonctionne lorsque le contrôle d’appel hérité est activé dans le composite d’appel

DeclarativeCallAgent

DeclarativeCallAgent étend et prostitue le <xref:%40azure%2Fcommunication-calling%23CallAgent>

DeclarativeTeamsCallAgent

DeclarativeTeamsCallAgent étend et prostitue le <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>

DeepNoiseSuppressionEffectDependency

Type de dépendance à injecter pour la suppression profonde du bruit

DeviceManagerState

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

DevicesButtonSelector

Type de sélecteur pour composant DevicesButton.

DiagnosticChangedEventListner

Rappel pour CallAdapterSubscribers 'diagnosticChanged'.

DialpadMode

Modes du composant de clavier.

DisplayNameChangedListener

Rappel pour CallAdapterSubscribers 'displayNameChanged'.

DtmfTone

Tonalité DTMF pour les appels RTC.

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

GetCallingSelector

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

GetChatSelector

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

HoldButtonSelector

Type de sélecteur pour le composant HoldButton .

IncomingCallManagement

Celui-ci contient un tableau en lecture seule qui renvoie tous les incomingCallsfichiers . Un appel entrant actif est un appel qui n’a pas reçu de réponse, qui n’a pas été refusé ou qui n’a pas été déconnecté.

IncomingCallStackSelector

Sélecteur pour obtenir les appels entrants actifs et supprimés.

IsCaptionLanguageChangedListener

Rappel pour l’événement CallAdapterSubscribers 'isCaptionLanguageChanged'.

IsCaptionsActiveChangedListener

Rappel de l’événement CallAdapterSubscribers 'isCaptionsActiveChanged'.

IsLocalScreenSharingActiveChangedListener

Rappel pour CallAdapterSubscribers 'isLocalScreenSharingActiveChanged'.

IsMutedChangedListener

Rappel pour CallAdapterSubscribers 'isMuted'.

IsSpeakingChangedListener

Rappel pour CallAdapterSubscribers 'isSpeakingChanged'.

IsSpokenLanguageChangedListener

Rappel de l’événement CallAdapterSubscribers 'isSpokenLanguageChanged'.

LoadingState

Indique si le flux est chargé ou non.

LocalScreenShareView
LocalVideoTileSize

Différents modes de la vignette vidéo locale

LocalizationProviderProps

Props pour LocalizationProvider.

LongPressTrigger

Modes de tigrage des manipulateurs de longpress.

MediaAccess

État d’accès aux médias audio/vidéo

MediaDiagnosticChangedEvent

Charge utile pour DiagnosticChangedEventListner où il existe une modification dans un diagnostic multimédia.

Message

Union discriminatoire de tous les messages.

Le champ messageType se spécialise dans les variantes syndicales.

MessageAttachedStatus

Indiquez si un message de conversation doit être fusionné avec le message avant/après. Si true, le message apparaîtra regroupé avec le message qui le précède. Les termes 'haut' et 'bas' sont utilisés pour indiquer que le message est le début ou la fin d’un groupe.

MessageContentType

Types de contenu de message de conversation pris en charge.

MessageDeletedListener

Rappel pour l’événement 'messageDeleted' de ChatAdapterSubscribers .

MessageEditedListener

Rappel pour l’événement 'messageEdited' de ChatAdapterSubscribers .

MessageProps

Props pour afficher un seul message.

Voir MessageRenderer.

MessageReadListener

Rappel pour ChatAdapterSubscribers 'messageRead'.

MessageReceivedListener

Rappel pour ChatAdapterSubscribers 'messageReceived'.

MessageRenderer

Composant permettant d’afficher un seul message.

MessageSentListener

Rappel pour ChatAdapterSubscribers 'messageSent'.

MessageStatus

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

Inclut les états transitionnels qui se produisent avant la remise des messages est confirmé à partir du serveur principal.

MessageThreadProps

Props pour MessageThread.

MessageThreadSelector

Type de sélecteur pour composant MessageThread.

MicrophoneButtonSelector

Type de sélecteur pour composant MicrophoneButton.

NetworkDiagnosticChangedEvent

Charge utile pour DiagnosticChangedEventListner où il existe une modification dans un diagnostic réseau.

NotificationStackSelector

Type de sélecteur pour le composant Notification .

NotificationTarget
NotificationType

Toutes les notifications qui peuvent être affichées dans la NotificationStack.

OnFetchChatProfileCallback

Fonction de rappel utilisée pour fournir des données personnalisées afin de créer le profil d’un utilisateur ou d’un bot.

OnFetchProfileCallback

Fonction de rappel utilisée pour fournir des données personnalisées afin de créer le profil d’un utilisateur ou d’un bot.

OnRenderAvatarCallback

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

OverflowGalleryPosition

Différents modes et positions de la galerie de débordement dans la VideoGallery

ParticipantListParticipant

Les participants affichés dans un ParticipantList.

ParticipantListProps

Accessoires pour ParticipantList.

ParticipantListSelector

Type de sélecteur pour 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 d’appel.

ParticipantsAddedListener

Rappel pour ChatAdapterSubscribers 'participantsAdded'.

ParticipantsButtonSelector

Type de sélecteur pour composant ParticipantsButton.

ParticipantsJoinedListener

Rappel pour CallAdapterSubscribers 'participantsJoined'.

ParticipantsLeftListener

Rappel pour CallAdapterSubscribers 'participantsLeft'.

ParticipantsRemovedListener

Rappel pour ChatAdapterSubscribers 'participantsRemoved'.

Profile

Le profil d’un utilisateur ou d’un bot.

RaiseHandButtonSelector

Type de sélecteur pour le composant RaiseHandButton .

RaisedHand

État de la main levée avec ordre

RaisedHandState

État de la main levée avec ordre

Reaction

État de réaction avec le type de réaction à rendre

ReactionButtonReaction

Types de réactions pour le bouton Réaction

ReactionSprite

Type d’image de sprite d’animation et métadonnées associées

ReactionState

Version d’état uniquement de avec les props d’assistance de l’interface <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> utilisateur receivedOn. État de réaction avec un horodatage qui aide l’interface utilisateur à décider de rendre la réaction en conséquence.

ReadReceiptsBySenderId

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

RealTimeTextInformation

Informations requises pour chaque ligne de texte en temps réel

RealTimeTextReceivedListener

Rappel pour l’événement 'realTimeTextReceived' de CallAdapterSubscribers .

ResourceDetails

Détails requis pour le téléchargement d’une ressource dans la mémoire cache.

ResourceFetchResult

Résultat de la ressource téléchargée à partir du client avec état

ScreenShareButtonSelector

Type de sélecteur pour composant ScreenShareButton.

Selector

Sélecteur optimisé qui affine ClientState mises à jour en props pour les composants React de cette bibliothèque.

SendBoxSelector

Type de sélecteur pour composant SendBox.

SoundEffect

Type de représentation d’un son personnalisé à utiliser pour un événement d’appel

Spotlight

État Spotlight avec ordre

SpotlightChangedListener

Rappel de l’événement 'spotlightChanged' de CallAdapterSubscribers .

StartCallIdentifier

Types d’identificateurs pour le lancement d’un appel à l’aide de CallAdapter

StartCaptionsButtonSelector

Type de sélecteur pour le composant StartCaptionsButton .

StatefulCallClientArgs

Arguments pour construire StatefulCallClient.

StatefulCallClientOptions

Options permettant de construire StatefulCallClient avec.

StatefulChatClientArgs

Arguments pour construire le statefulChatClient.

StatefulChatClientOptions

Options de construction du StatefulChatClient.

SupportedCaptionLanguage
SupportedSpokenLanguage
SystemMessage

Union discriminatoire de tous les messages système.

Le champ systemMessageType se spécialise dans les variantes syndicales.

TeamsAdapterOptions

Paramètres facultatifs pour créer TeamsCallAdapter

TeamsCallAdapterArgs

Arguments en faveur de la création de l’implémentation Azure Communication Services de TeamsCallAdapter.

TeamsCallAdapterArgsCommon

Partie commune de args pour créer l’implémentation Azure Communication Services de TeamsCallAdapter.

TeamsIncomingCallManagement

Proxy de l’interface <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> .

TogetherModeParticipantSeatingState

Représente les positions assises des participants en mode Ensemble.

TopicChangedListener

Rappel pour ChatAdapterSubscribers 'topicChanged'.

TransferAcceptedListener

Rappel de l’événement 'transferRequested' de CallAdapterSubscribers .

TypingIndicatorSelector

Type de sélecteur pour composant TypingIndicator.

UpdateMessageCallback

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

VideoBackgroundEffect

Contient les attributs d’un effet d’arrière-plan vidéo sélectionné

VideoBackgroundEffectsDependency

Type de dépendance à injecter pour les effets d’arrière-plan vidéo

VideoGalleryLayout
VideoGalleryParticipant

État d’un participant au VideoGallery.

VideoGallerySelector

Type de sélecteur pour composant VideoGallery.

VideoGalleryTogetherModeParticipantPosition

Interface représentant la position d’un participant en mode Ensemble.

ViewScalingMode

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

Functions

CallAgentProvider(CallAgentProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallAgentProvider.

CallClientProvider(CallClientProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallClientProvider.

CallComposite(CallCompositeProps)

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

CallProvider(CallProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallProvider.

CallWithChatComposite(CallWithChatCompositeProps)

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

CameraButton(CameraButtonProps)

Un bouton pour allumer/éteindre l’appareil photo.

Peut être utilisé avec ControlBar.

CaptionsBanner(CaptionsBannerProps)

Composant permettant d’afficher un CaptionsBanner avec l’icône de l’utilisateur, displayName et le texte des légendes.

CaptionsSettingsModal(CaptionsSettingsModalProps)

un composant pour la mise en place des langues parlées

ChatClientProvider(ChatClientProviderProps)

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

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

ChatComposite(ChatCompositeProps)

Une interface utilisateur composite personnalisable pour l’expérience de chat.

ChatThreadClientProvider(ChatThreadClientProviderProps)

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

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

ControlBar(ControlBarProps)

Un conteneur pour divers boutons pour les commandes d’appel.

À utiliser avec divers boutons de contrôle d’appel de cette bibliothèque, par exemple, CameraButton ou vos propres instances de ControlBarButton directement.

ControlBarButton(ControlBarButtonProps)

Bouton par défaut stylisé 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.

Dialpad(DialpadProps)

Un composant permettant aux utilisateurs d’entrer un numéro de téléphone en cliquant sur le clavier / en utilisant le clavier. Il renverra un composant vide pour les versions stables.

EndCallButton(EndCallButtonProps)

Un bouton pour mettre fin à un appel en cours.

Peut être utilisé avec ControlBar.

ErrorBar(ErrorBarProps)

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

Ce composant effectue en interne le suivi des rejets 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 accessoires. Si l’erreur se reproduit, elle s’affiche dans l’interface utilisateur.

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

FluentThemeProvider(FluentThemeProviderProps)

Fournisseur pour appliquer un thème Fluent sur les composants réactifs de cette bibliothèque.

GridLayout(GridLayoutProps)

Un composant pour disposer les tuiles audio/vidéo des participants dans un appel.

HoldButton(HoldButtonProps)

un bouton pour mettre en attente ou reprendre un appel en cours.

Peut être utilisé avec ControlBar

ImageOverlay(ImageOverlayProps)

Composant permettant d’afficher une fenêtre modale en plein écran pour une image sélectionnée.

IncomingCallNotification(IncomingCallNotificationProps)

Composant de notification qui doit être utilisé pour représenter les appels entrants à l’utilisateur final. Permet à l’utilisateur d’accepter ou de refuser l’appel entrant.

IncomingCallStack(IncomingCallStackProps)

Wrapper pour gérer plusieurs appels entrants

LocalizationProvider(LocalizationProviderProps)

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

MessageStatusIndicator(MessageStatusIndicatorProps)

Composant permettant d’afficher l’état d’un message envoyé.

Ajoute une icône et une info-bulle correspondant à l’état du message.

MessageThread(MessageThreadProps)

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

MicrophoneButton(MicrophoneButtonProps)

Un bouton pour activer/désactiver le micro.

Peut être utilisé avec ControlBar.

Notification(NotificationProps)

Un composant pour afficher les messages de notification sur l’interface utilisateur.

NotificationStack(NotificationStackProps)

Un composant pour afficher les notifications sur l’interface utilisateur. Toutes les chaînes qui peuvent être affichées sont acceptées comme chaînes afin qu’elles puissent être localisées . Les notifications actives sont sélectionnées par activeNotifications.

Ce composant effectue en interne le suivi des rejets par l’utilisateur.

  • Notifications associées à un horodatage : la notification s’affiche à nouveau dans l’interface utilisateur si elle se produit après avoir été ignorée.
  • Notifications qui n’ont pas d’horodatage : la notification est ignorée jusqu’à ce qu’elle disparaisse des accessoires. Si la notification réapparaît, elle s’affiche dans l’interface utilisateur.
ParticipantItem(ParticipantItemProps)

Composant permettant de rendre un participant à l’appel ou au chat.

Affiche l’avatar, le nom d’affichage et le statut du participant, ainsi que les icônes facultatives et le menu contextuel.

ParticipantList(ParticipantListProps)

Composant pour afficher tous les participants à l’appel ou au chat.

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

ParticipantsButton(ParticipantsButtonProps)

Un bouton pour afficher un menu avec des participants qui appellent ou chattent.

Peut être utilisé avec ControlBar.

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

RaiseHandButton(RaiseHandButtonProps)

Un bouton pour démarrer/arrêter le partage d’écran.

Peut être utilisé avec ControlBar.

ReactionButton(ReactionButtonProps)

Un bouton pour envoyer des réactions.

Peut être utilisé avec ControlBar.

RealTimeText(RealTimeTextProps)

Composant permettant d’afficher une seule ligne de RealTimeText

RealTimeTextModal(RealTimeTextModalProps)

un composant pour realTimeText modal

ScreenShareButton(ScreenShareButtonProps)

Un bouton pour 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 à saisir du texte. Prend en charge un message facultatif sous le champ de saisie de texte.

StartCaptionsButton(StartCaptionsButtonProps)

un bouton pour démarrer ou arrêter les sous-titres

Peut être utilisé avec ControlBar

StartRealTimeTextButton(StartRealTimeTextButtonProps)

un bouton pour démarrer RealTimeText En fonction des exigences d’accessibilité, le texte en temps réel ne peut pas être désactivé une fois qu’il est activé

Peut être utilisé avec ControlBar

StreamMedia(StreamMediaProps)

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

Permet de convertir un HTMLElement renvoyé par l’API d’appel headless en un composant qui peut être rendu sous forme de VideoTile.

TypingIndicator(TypingIndicatorProps)

Composant permettant d’avertir l’utilisateur local lorsqu’un ou plusieurs participants du fil de discussion sont en train de taper.

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 d’afficher le flux vidéo d’un seul participant à un appel.

À utiliser avec GridLayout dans une VideoGallery.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Créez un CallAdapter basé sur Azure Communication Services.

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

Remarque : displayName peut comporter au maximum 256 caractères.

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

Créez un CallAdapter basé sur Azure Communication Services.

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

Remarque : displayName peut comporter au maximum 256 caractères.

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

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.

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

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 soutenu par les services de communication Azure pour le connecter à CallWithChatComposite.

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

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

Utile si vous souhaitez conserver une référence à StatefulChatClient et StatefulCallClient. Veuillez noter que chatThreadClient doit être créé par StatefulChatClient via l’API chatClient.getChatThreadClient(chatThreadId). Envisagez d’utiliser createAzureCommunicationCallWithChatAdapter pour une API plus simple.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Créez un ChatAdapter basé sur Azure Communication Services.

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

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

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, CallingHandlersOptions)

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

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 renvoyé est mémorisé pour éviter les rerendus lorsqu’il est utilisé comme props pour les composants React.

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

Créez l’implémentation par défaut de TeamsCallingHandlers pour l’appel d’équipes.

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

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Crée un StatefulCallClient StatefulCallClient en mandatant 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 <xref:%40azure%2Fcommunication-calling%23CallAgent> et <xref:%40azure%2Fcommunication-calling%23Call> (et etc.) qui sont obtenus à partir de StatefulCallClient pour que leurs changements d’état soient correctement proxy.

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

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

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

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

fromFlatCommunicationIdentifier(string)

Fonctionnement inverse de toFlatCommunicationIdentifier.

getCallingSelector<Component>(Component)

Obtenez le sélecteur d’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 d’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.

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Fonction de chargement pour le CallComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Props pour le CallWithChatComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallWithChatComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Fonction de chargement pour le ChatComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le ChatComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Fonction Loader pour l’OutboundCallComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallComposite dans l’élément HTML fourni pour effectuer des appels sortants. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

onResolveDeepNoiseSuppressionDependency()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

onResolveDeepNoiseSuppressionDependencyLazy()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

onResolveVideoEffectDependency()

Résolution de dépendance pour les effets d’arrière-plan vidéo.

onResolveVideoEffectDependencyLazy()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

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 unique de Communication. 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é dans une carte pour stocker des données pour l’utilisateur.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

Un hook 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Un hook 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Un hook 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

useCall()

Crochet à 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é le CallProvider avec un objet Call pour utiliser ce hook

useCallAgent()

Crochet à 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()

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

Crochet à 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()

pour obtenir StatefulDeviceManager 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.

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

Hook principal pour obtenir tous les hooks nécessaires à 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 chat : ChatClientProvider et ChatThreadClientProvider.

  2. Pour l’appel des composants : CallClientProvider, CallAgentProvider et CallAgentProvider.

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

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

Crochet permettant d’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.

useTeamsCall()

Crochet à obtenir <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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é le CallProvider avec un objet TeamsCall pour utiliser ce hook

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

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

Similaire à <xref:createTeamsAzureCommunicationCallAdapter>, 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

useTeamsCallAgent()

Crochet à obtenir <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> 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.

useTheme()

Hook React pour accéder au thème

Informations relatives à la fonction

CallAgentProvider(CallAgentProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Paramètres

Retours

Element

CallClientProvider(CallClientProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Paramètres

Retours

Element

CallComposite(CallCompositeProps)

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

function CallComposite(props: CallCompositeProps): Element

Paramètres

Retours

Element

Remarques

Les appels composite min largeur/hauteur sont les suivants :

  • Mobile : 17,5 REM x 21 REM (280 px x 336 px, avec REM par défaut à 16 px)
  • Ordinateur de bureau : 30 REM x 22 REM (480 px x 352 px, avec rem par défaut à 16 px)

CallProvider(CallProviderProps)

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

L’appel de composants à partir de ce package doit être encapsulé avec un CallProvider.

function CallProvider(props: CallProviderProps): Element

Paramètres

Retours

Element

CallWithChatComposite(CallWithChatCompositeProps)

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

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Paramètres

Retours

Element

CameraButton(CameraButtonProps)

Un bouton pour allumer/éteindre l’appareil photo.

Peut être utilisé avec ControlBar.

function CameraButton(props: CameraButtonProps): Element

Paramètres

Retours

Element

CaptionsBanner(CaptionsBannerProps)

Composant permettant d’afficher un CaptionsBanner avec l’icône de l’utilisateur, displayName et le texte des légendes.

function CaptionsBanner(props: CaptionsBannerProps): Element

Paramètres

Retours

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

un composant pour la mise en place des langues parlées

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

Paramètres

Retours

Element

ChatClientProvider(ChatClientProviderProps)

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

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

function ChatClientProvider(props: ChatClientProviderProps): Element

Paramètres

Retours

Element

ChatComposite(ChatCompositeProps)

Une interface utilisateur composite personnalisable pour l’expérience de chat.

function ChatComposite(props: ChatCompositeProps): Element

Paramètres

Retours

Element

Remarques

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

ChatThreadClientProvider(ChatThreadClientProviderProps)

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

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

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Paramètres

Retours

Element

ControlBar(ControlBarProps)

Un conteneur pour divers boutons pour les commandes d’appel.

À utiliser avec divers boutons de contrôle d’appel de cette bibliothèque, par exemple, CameraButton ou vos propres instances de ControlBarButton directement.

function ControlBar(props: ControlBarProps): Element

Paramètres

Retours

Element

ControlBarButton(ControlBarButtonProps)

Bouton par défaut stylisé 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

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

Retours

Element

Dialpad(DialpadProps)

Un composant permettant aux utilisateurs d’entrer un numéro de téléphone en cliquant sur le clavier / en utilisant le clavier. Il renverra un composant vide pour les versions stables.

function Dialpad(props: DialpadProps): Element

Paramètres

props
DialpadProps

Retours

Element

EndCallButton(EndCallButtonProps)

Un bouton pour mettre fin à un appel en cours.

Peut être utilisé avec ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Paramètres

Retours

Element

ErrorBar(ErrorBarProps)

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

Ce composant effectue en interne le suivi des rejets 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 accessoires. Si l’erreur se reproduit, elle s’affiche dans l’interface utilisateur.

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

function ErrorBar(props: ErrorBarProps): Element

Paramètres

Retours

Element

FluentThemeProvider(FluentThemeProviderProps)

Fournisseur pour appliquer un thème Fluent sur les composants réactifs de cette bibliothèque.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Paramètres

Retours

Element

Remarques

Les composants de cette bibliothèque sont principalement composés de Fluent UI, de contrôles, de mixage de contrôles v8 et v9. Ce fournisseur gère l’application de n’importe quel thème fourni aux contrôles d’interface utilisateur Fluent sous-jacents. *

GridLayout(GridLayoutProps)

Un composant pour disposer les tuiles audio/vidéo des participants dans un appel.

function GridLayout(props: GridLayoutProps): Element

Paramètres

Retours

Element

HoldButton(HoldButtonProps)

un bouton pour mettre en attente ou reprendre un appel en cours.

Peut être utilisé avec ControlBar

function HoldButton(props: HoldButtonProps): Element

Paramètres

props
HoldButtonProps

propriétés du bouton de mise en attente.

Retours

Element

ImageOverlay(ImageOverlayProps)

Composant permettant d’afficher une fenêtre modale en plein écran pour une image sélectionnée.

function ImageOverlay(props: ImageOverlayProps): Element

Paramètres

Retours

Element

IncomingCallNotification(IncomingCallNotificationProps)

Composant de notification qui doit être utilisé pour représenter les appels entrants à l’utilisateur final. Permet à l’utilisateur d’accepter ou de refuser l’appel entrant.

function IncomingCallNotification(props: IncomingCallNotificationProps): Element

Paramètres

Retours

Element

IncomingCallStack(IncomingCallStackProps)

Wrapper pour gérer plusieurs appels entrants

function IncomingCallStack(props: IncomingCallStackProps): Element

Paramètres

props
IncomingCallStackProps

<xref:IncomingCallManagerProps>

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

Retours

Element

Remarques

Les composants seront fournis par défaut sous forme de chaînes localisées en anglais (US) si ce fournisseur n’est pas utilisé.

MessageStatusIndicator(MessageStatusIndicatorProps)

Composant permettant d’afficher l’état d’un message envoyé.

Ajoute une icône et une info-bulle correspondant à l’état du message.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Paramètres

Retours

Element

MessageThread(MessageThreadProps)

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

function MessageThread(props: MessageThreadProps): Element

Paramètres

props
MessageThreadProps

de type MessageThreadProps

Les utilisateurs devront fournir au moins des messages de chat et userId pour afficher le MessageThread composant. Les utilisateurs peuvent également personnaliser MessageThread en transmettant leur propre avatar, MessageStatusIndicator leur icône JumpToNewMessageButtonLoadPreviousMessagesButton et le comportement de ces commandes.

MessageThread utilise en interne le Chat composant de @fluentui-contrib/chat. Vous pouvez consulter les détails sur ces composants ici.

Retours

Element

MicrophoneButton(MicrophoneButtonProps)

Un bouton pour activer/désactiver le micro.

Peut être utilisé avec ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Paramètres

Retours

Element

Notification(NotificationProps)

Un composant pour afficher les messages de notification sur l’interface utilisateur.

function Notification(props: NotificationProps): Element

Paramètres

Retours

Element

NotificationStack(NotificationStackProps)

Un composant pour afficher les notifications sur l’interface utilisateur. Toutes les chaînes qui peuvent être affichées sont acceptées comme chaînes afin qu’elles puissent être localisées . Les notifications actives sont sélectionnées par activeNotifications.

Ce composant effectue en interne le suivi des rejets par l’utilisateur.

  • Notifications associées à un horodatage : la notification s’affiche à nouveau dans l’interface utilisateur si elle se produit après avoir été ignorée.
  • Notifications qui n’ont pas d’horodatage : la notification est ignorée jusqu’à ce qu’elle disparaisse des accessoires. Si la notification réapparaît, elle s’affiche dans l’interface utilisateur.
function NotificationStack(props: NotificationStackProps): Element

Paramètres

Retours

Element

ParticipantItem(ParticipantItemProps)

Composant permettant de rendre un participant à l’appel ou au chat.

Affiche l’avatar, le nom d’affichage et le statut du participant, ainsi que les icônes facultatives et le menu contextuel.

function ParticipantItem(props: ParticipantItemProps): Element

Paramètres

Retours

Element

ParticipantList(ParticipantListProps)

Composant pour afficher tous les participants à l’appel ou au chat.

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

function ParticipantList(props: ParticipantListProps): Element

Paramètres

Retours

Element

ParticipantsButton(ParticipantsButtonProps)

Un bouton pour afficher un menu avec des participants qui appellent ou chattent.

Peut être utilisé avec ControlBar.

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

function ParticipantsButton(props: ParticipantsButtonProps): Element

Paramètres

Retours

Element

RaiseHandButton(RaiseHandButtonProps)

Un bouton pour démarrer/arrêter le partage d’écran.

Peut être utilisé avec ControlBar.

function RaiseHandButton(props: RaiseHandButtonProps): Element

Paramètres

Retours

Element

ReactionButton(ReactionButtonProps)

Un bouton pour envoyer des réactions.

Peut être utilisé avec ControlBar.

function ReactionButton(props: ReactionButtonProps): Element

Paramètres

Retours

Element

RealTimeText(RealTimeTextProps)

Composant permettant d’afficher une seule ligne de RealTimeText

function RealTimeText(props: RealTimeTextProps): Element

Paramètres

Retours

Element

RealTimeTextModal(RealTimeTextModalProps)

un composant pour realTimeText modal

function RealTimeTextModal(props: RealTimeTextModalProps): Element

Paramètres

Retours

Element

ScreenShareButton(ScreenShareButtonProps)

Un bouton pour démarrer/arrêter le partage d’écran.

Peut être utilisé avec ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Paramètres

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 à saisir du texte. Prend en charge un message facultatif sous le champ de saisie de texte.

function SendBox(props: SendBoxProps): Element

Paramètres

props
SendBoxProps

Retours

Element

StartCaptionsButton(StartCaptionsButtonProps)

un bouton pour démarrer ou arrêter les sous-titres

Peut être utilisé avec ControlBar

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

Paramètres

props
StartCaptionsButtonProps

Propriétés du bouton Démarrer les sous-titres.

Retours

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

un bouton pour démarrer RealTimeText En fonction des exigences d’accessibilité, le texte en temps réel ne peut pas être désactivé une fois qu’il est activé

Peut être utilisé avec ControlBar

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

Paramètres

props
StartRealTimeTextButtonProps

propriétés du bouton de démarrage RealTimeText.

Retours

Element

StreamMedia(StreamMediaProps)

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

Permet de convertir un HTMLElement renvoyé par l’API d’appel headless en un composant qui peut être rendu sous forme de VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Paramètres

Retours

Element

TypingIndicator(TypingIndicatorProps)

Composant permettant d’avertir l’utilisateur local lorsqu’un ou plusieurs participants du fil de discussion sont en train de taper.

function TypingIndicator(props: TypingIndicatorProps): Element

Paramètres

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

Retours

Element

VideoTile(VideoTileProps)

Composant permettant d’afficher le flux vidéo d’un seul participant à un appel.

À utiliser avec GridLayout dans une VideoGallery.

function VideoTile(props: VideoTileProps): Element

Paramètres

Retours

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Créez un CallAdapter basé sur Azure Communication Services.

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

Remarque : displayName peut comporter au maximum 256 caractères.

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

Paramètres

Retours

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

Créez un CallAdapter basé sur Azure Communication Services.

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

Remarque : displayName peut comporter au maximum 256 caractères.

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

Paramètres

Retours

Promise<CallAdapter>

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

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, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>

Paramètres

callClient
StatefulCallClient
callAgent
CallAgent
targetCallees

CommunicationIdentifier[]

Retours

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

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, options?: CommonCallAdapterOptions): Promise<CallAdapter>

Paramètres

callClient
StatefulCallClient
callAgent
CallAgent

Retours

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Créez un CallWithChatAdapter soutenu par les services de communication Azure pour le connecter à CallWithChatComposite.

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

Paramètres

Retours

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

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

Utile si vous souhaitez conserver une référence à StatefulChatClient et StatefulCallClient. Veuillez noter que chatThreadClient doit être créé par StatefulChatClient via l’API chatClient.getChatThreadClient(chatThreadId). Envisagez d’utiliser createAzureCommunicationCallWithChatAdapter pour une API plus simple.

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

Paramètres

Retours

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Créez un ChatAdapter basé sur 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

Retours

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

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, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>

Paramètres

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient
chatAdapterOptions
ChatAdapterOptions

Retours

Promise<ChatAdapter>

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

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

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, options?: CallingHandlersOptions): CallingHandlers

Paramètres

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Retours

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 renvoyé est mémorisé pour éviter les rerendus lorsqu’il est utilisé comme props pour les composants React.

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

Paramètres

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Retours

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

Créez l’implémentation par défaut de TeamsCallingHandlers pour l’appel d’équipes.

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

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

Paramètres

callClient
StatefulCallClient
callAgent
TeamsCallAgent
deviceManager
StatefulDeviceManager
call
TeamsCall
options

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

Retours

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Crée un StatefulCallClient StatefulCallClient en mandatant 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 <xref:%40azure%2Fcommunication-calling%23CallAgent> et <xref:%40azure%2Fcommunication-calling%23Call> (et etc.) qui sont obtenus à partir de StatefulCallClient pour que leurs changements d’état soient correctement proxy.

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

Paramètres

Retours

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Crée un ChatClient avec état StatefulChatClient en envoyant un proxy à 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

Retours

createTeamsCallAdapter(TeamsCallAdapterArgs)

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

Paramètres

Retours

Promise<TeamsCallAdapter>

createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Créez un TeamsCallAdapter à 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 createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>

Paramètres

callClient
StatefulCallClient
callAgent
TeamsCallAgent

Retours

Promise<TeamsCallAdapter>

fromFlatCommunicationIdentifier(string)

Fonctionnement inverse de toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Paramètres

id

string

Retours

getCallingSelector<Component>(Component)

Obtenez le sélecteur d’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 d’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>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Fonction de chargement pour le CallComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

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

Paramètres

htmlElement

HTMLElement

Retours

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Props pour le CallWithChatComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallWithChatComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

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

Paramètres

htmlElement

HTMLElement

Retours

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Fonction de chargement pour le ChatComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le ChatComposite dans l’élément HTML fourni. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

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

Paramètres

htmlElement

HTMLElement

Retours

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Fonction Loader pour l’OutboundCallComposite que vous pouvez utiliser dans votre application. Cette fonction chargera le CallComposite dans l’élément HTML fourni pour effectuer des appels sortants. Le meilleur cas d’utilisation pour cela est dans un cadre d’interface utilisateur Node qui n’est pas basé sur React.

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

Paramètres

htmlElement

HTMLElement

Retours

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

Retours

onResolveDeepNoiseSuppressionDependencyLazy()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

Retours

onResolveVideoEffectDependency()

Résolution de dépendance pour les effets d’arrière-plan vidéo.

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

Retours

onResolveVideoEffectDependencyLazy()

Résolution de dépendance pour les effets d’arrière-plan vidéo à l’aide du chargement différé.

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

Retours

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 unique de Communication. 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é dans une carte pour stocker des données pour l’utilisateur.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Paramètres

Retours

string

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

Un hook 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Paramètres

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 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Paramètres

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 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Paramètres

afterCreate

(adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose

(adapter: ChatAdapter) => Promise<void>

Retours

undefined | ChatAdapter

useCall()

Crochet à 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é le CallProvider avec un objet Call pour utiliser ce hook

function useCall(): undefined | Call

Retours

undefined | Call

useCallAgent()

Crochet à 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

useChatClient()

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

useChatThreadClient()

Crochet à 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

useDeviceManager()

pour obtenir StatefulDeviceManager 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 useDeviceManager(): undefined | StatefulDeviceManager

Retours

undefined | StatefulDeviceManager

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

Hook principal pour obtenir tous les hooks nécessaires à 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 chat : ChatClientProvider et ChatThreadClientProvider.

  2. Pour l’appel des composants : CallClientProvider, CallAgentProvider et CallAgentProvider.

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

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

Crochet permettant d’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)

useTeamsCall()

Crochet à obtenir <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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é le CallProvider avec un objet TeamsCall pour utiliser ce hook

function useTeamsCall(): undefined | TeamsCall

Retours

undefined | TeamsCall

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

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

Similaire à <xref:createTeamsAzureCommunicationCallAdapter>, 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 qu’ils sont créés. L’adaptateur n’est créé que lorsque tous les arguments sont définis.

Notez que vous devez mémoriser les arguments pour éviter de recréer l’adaptateur à chaque rendu. Voir le livre d’histoires pour des exemples d’utilisation typiques.

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

Paramètres

args

Partial<TeamsCallAdapterArgs>

afterCreate

(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>

beforeDispose

(adapter: TeamsCallAdapter) => Promise<void>

Retours

undefined | TeamsCallAdapter

useTeamsCallAgent()

Crochet à obtenir <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> 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 useTeamsCallAgent(): undefined | TeamsCallAgent

Retours

undefined | TeamsCallAgent

useTheme()

Hook React pour accéder au thème

function useTheme(): Theme

Retours

Theme