@azure/communication-react package

Referencia

Clases

CallError	Error producido a partir de métodos de API con estado erróneos.
ChatError	Error producido por los métodos StatefulChatClient con errores.

Interfaces

ActiveErrorMessage	Mensajes de error activos que se mostrarán a través de ErrorBar.
AdapterError	Error notificado a través de eventos de error y almacenado en estado de adaptador.
AdapterState	Funcionalidad para interactuar con el estado del adaptador compuesto.
BaseCompositeProps	Propiedades comunes a todos los compuestos exportados desde esta biblioteca.
BaseCustomStyles	Propiedades básicas de estilos fluidos para todos los componentes exportados desde esta libray.
CallAdapter	Interfaz del adaptador específica de la identidad de comunicación de Azure que extiende CommonCallAdapter.
CallAdapterCallManagement	Funcionalidad para administrar la llamada actual o iniciar una nueva llamada
CallAdapterCallOperations	Funcionalidad para administrar la llamada actual.
CallAdapterDeviceManagement	Funcionalidad para administrar dispositivos dentro de una llamada.
CallAdapterSubscribers	Llame a eventos compuestos a los que se puede suscribir.
CallAgentProviderProps	Argumentos para inicializar un CallAgentProvider.
CallAgentState	La versión de solo estado de <xref:%40azure%2Fcommunication-calling%23CallAgent> excepto las llamadas se mueve para ser un elemento secundario directamente de CallClientState y no se incluye aquí. El motivo para tener el proxy de estado de CallAgent es proporcionar acceso a displayName. No se aplana CallAgent.displayName y lo colocamos en CallClientState porque sería ambiguioso que displayName depende realmente de la creación o existencia de CallAgent para que esté disponible.
CallAndChatLocator	Argumentos para su uso en createAzureCommunicationCallWithChatAdapter para unirse a una llamada con un subproceso de chat asociado.
CallClientProviderProps	Argumentos para inicializar un CallClientProvider.
CallClientState	Contenedor para todos los datos de estado proxy de StatefulCallClient. Las llamadas, llamadasEnded, incomingCalls y estados incomingCallsEnded se proporcionarán automáticamente si se ha creado un callAgent. DeviceManager estará vacío inicialmente hasta que se rellene, consulte DeviceManagerState. El estado userId se proporciona como una comodidad para el desarrollador y está completamente controlado y establecido por el desarrollador.
CallCompositeProps	Propiedades para CallComposite.
CallCompositeStrings	Cadenas usadas directamente por CallComposite . Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
CallProviderProps	Argumentos para inicializar un CallProvider.
CallState	Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recuperará automáticamente el estado de la llamada y lo agregará al estado expuesto por StatefulCallClient.
CallWithChatAdapter	CallWithChatComposite Interfaz del adaptador.
CallWithChatAdapterManagement	Funcionalidad para administrar la llamada actual con chat.
CallWithChatAdapterState	CallWithChat State es una combinación de clientes de chat con estado y llamadas con estado con algún estado específico del compuesto CallWithChat.
CallWithChatAdapterSubscriptions	Eventos de llamada y chat a los que se puede suscribir en CallWithChatAdapter.
CallWithChatAdapterUiState	Estado de la interfaz de usuario que pertenece al callWithChatComposite.
CallWithChatClientState	Estado de los servicios back-end que controlan CallWithChatComposite.
CallWithChatCompositeProps	Propiedades necesarias para CallWithChatComposite
CallWithChatCompositeStrings	Cadenas usadas directamente por CallWithChatComposite . Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
CallWithChatControlOptions	CallWithChatComposite Llame a los controles para mostrar u ocultar botones en la barra de control de llamada.
CallingHandlers	Objeto que contiene todos los controladores necesarios para llamar a componentes. Las llamadas a componentes relacionados de este paquete pueden elegir controladores relevantes de este objeto. Vea <xref:useHandlers> y usePropsFor.
CallingTheme	Palet de temas de Fluent personalizado que se usa mediante una llamada a componentes relacionados en esta biblioteca.
CameraButtonContextualMenuStyles	Estilos para el menú CameraButton .
CameraButtonProps	Propiedades para el componente CameraButton .
CameraButtonStrings	Cadenas de CameraButton que se pueden invalidar.
CameraButtonStyles	Estilos para CameraButton
ChatAdapterSubscribers	Eventos compuestos de chat a los que se puede suscribir.
ChatAdapterThreadManagement	Funcionalidad para administrar el subproceso de chat actual.
ChatCompositeProps	Propiedades para ChatComposite.
ChatCompositeStrings	Cadenas usadas directamente por ChatComposite . Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
ChatMessage	Un mensaje de chat.
CommonCallAdapter	CallComposite Interfaz del adaptador.
CommonCallingHandlers	Objeto que contiene todos los controladores necesarios para llamar a componentes. Las llamadas a componentes relacionados de este paquete pueden elegir controladores relevantes de este objeto. Vea <xref:useHandlers> y usePropsFor.
ComponentLocale	Información de configuración regional de todos los componentes exportados desde esta biblioteca.
ComponentStrings	Cadenas usadas por todos los componentes exportados desde esta biblioteca.
CompositeLocale	Información de configuración regional de todos los compuestos exportados desde esta biblioteca.
CompositeStrings	Cadenas usadas directamente en los compuestos. Estas cadenas las usan directamente los compuestos, en lugar de los componentes contenidos.
ContentSystemMessage	Mensaje del sistema con contenido arbitario.
ControlBarButtonProps	Propiedades para ControlBarButton.
ControlBarButtonStrings	Cadenas de ControlBarButton que se pueden invalidar.
ControlBarProps	Propiedades para ControlBar.
CreateVideoStreamViewResult	Objeto devuelto después de crear un VideoStream local o remoto. Contiene funciones auxiliares para manipular la representación de la secuencia.
CustomMessage	Tipo de mensaje personalizado. Los mensajes personalizados no se representan de forma predeterminada, pero las aplicaciones pueden proporcionar representadores personalizados para ellos.
DevicesButtonContextualMenuStyles	Estilos para el menú DispositivosButton .
DevicesButtonProps	Propiedades para DevicesButton.
DevicesButtonStrings	Cadenas de DevicesButton que se pueden invalidar.
DevicesButtonStyles	Estilos para los elementos de menú del botón Dispositivos.
DiagnosticsCallFeatureState	Proxy de solo estado para <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable	Funcionalidad para eliminar correctamente un compuesto.
EndCallButtonProps	Propiedades para EndCallButton.
EndCallButtonStrings	Cadenas de EndCallButton que se pueden invalidar.
ErrorBarProps	Propiedades de ErrorBar. Además de lo siguiente, ErrorBar reenvía todo <xref:%40fluentui%2Freact%23IMessageBarProps> al subyacente <xref:%40fluentui%2Freact%23MessageBar>.
ErrorBarStrings	Todas las cadenas que se pueden mostrar en la interfaz de usuario en errorBar.
FluentThemeProviderProps	Propiedades para FluentThemeProvider.
GridLayoutProps	Propiedades para GridLayout.
GridLayoutStyles	Gridlayout Estilos de componente.
HorizontalGalleryStyles	<xref:HorizontalGallery> Estilos de componente.
IncomingCallState	Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detectará automáticamente las llamadas entrantes y agregará su estado al estado expuesto por StatefulCallClient.
JumpToNewMessageButtonProps	Argumentos para <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState	Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState	Proxy de solo estado para <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon	Propiedades comunes de todos los tipos de mensajes.
MessageStatusIndicatorProps	Propiedades para MessageStatusIndicator.
MessageStatusIndicatorStrings	Cadenas de MessageStatusIndicator que se pueden invalidar.
MessageThreadStrings	Cadenas de MessageThread que se pueden invalidar.
MessageThreadStyles	Estilos fluent para MessageThread.
MicrophoneButtonContextualMenuStyles	Estilos para el menú MicrophoneButton .
MicrophoneButtonProps	Propiedades para MicrophoneButton.
MicrophoneButtonStrings	Cadenas de MicrophoneButton que se pueden invalidar.
MicrophoneButtonStyles	Estilos para MicrophoneButton
NetworkDiagnosticsState	Proxy de solo estado para <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice	Un dispositivo, por ejemplo, cámara, micrófono o altavoz, en el control flotante DevicesButton .
ParticipantAddedSystemMessage	Mensaje del sistema que notifica que se agregó un participante al subproceso de chat.
ParticipantItemProps	Propiedades de ParticipantItem.
ParticipantItemStrings	Cadenas de ParticipantItem que se pueden invalidar.
ParticipantItemStyles	Estilos fluent para ParticipantItem.
ParticipantListItemStyles	Estilos para participantList ParticipantItem.
ParticipantListStyles	Estilos para ParticipantList.
ParticipantRemovedSystemMessage	Mensaje del sistema que notifica que un participante se quitó del subproceso de chat.
ParticipantsButtonContextualMenuStyles	Estilos para el menú ParticipantesButton .
ParticipantsButtonProps	Propiedades para ParticipantsButton.
ParticipantsButtonStrings	Cadenas de ParticipantsButton que se pueden invalidar.
ParticipantsButtonStyles	Propiedades de estilos para ParticipantsButton.
RecordingCallFeature	Versión de solo estado de <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient escuchará automáticamente el estado de grabación de la llamada y actualizará el estado expuesto por StatefulCallClient en consecuencia.
RemoteParticipantState	Versión de solo estado de <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recuperará automáticamente RemoteParticipants y agregará su estado al estado expuesto por StatefulCallClient.
RemoteVideoStreamState	Versión de solo estado de <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps	Propiedades para ScreenShareButton.
ScreenShareButtonStrings	Cadenas de ScreenShareButton que se pueden invalidar.
SendBoxProps	Propiedades para SendBox.
SendBoxStrings	Cadenas de SendBox que se pueden invalidar.
SendBoxStylesProps	Estilos fluent para <xref:Sendbox>.
StatefulCallClient	Define los métodos que permiten que CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> se use con estado. La interfaz proporciona acceso al estado proxy y también permite registrar un controlador para eventos de cambio de estado. Para obtener la definición de estado, consulte CallClientState. Los eventos de cambio de estado se controlan mediante: Datos devueltos de <xref:%40azure%2Fcommunication-calling%23DeviceManager> las API. Datos devueltos de <xref:%40azure%2Fcommunication-calling%23CallAgent> las API. Agentes de escucha conectados automáticamente a varios objetos de llamada de comunicación de Azure: CallAgent 'incomingCall' CallAgent 'callsUpdated' DeviceManager "videoDevicesUpdated" DeviceManager 'audioDevicesUpdated DeviceManager "selectedMicrophoneChanged" DeviceManager 'selectedSpeakerChanged' Llamar a 'stateChanged' Llamar a 'idChanged' Llamada a 'isMutedChanged' Llamada a 'isScreenSharingOnChanged' Llamar a "remoteParticipantsUpdated" Llamada a "localVideoStreamsUpdated" IncomingCall 'callEnded' RemoteParticipant 'stateChanged' RemoteParticipant 'isMutedChanged' RemoteParticipant 'displayNameChanged' RemoteParticipant 'isSpeakingChanged' RemoteParticipant 'videoStreamsUpdated' RemoteVideoStream 'isAvailableChanged' TranscriptionCallFeature 'isTranscriptionActiveChanged' RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient	Define los métodos que permiten usar {@Link @azure/communication-chat#ChatClient} con un estado generado centralizado. La interfaz proporciona acceso al estado proxy y también permite registrar un controlador para eventos de cambio de estado.
StatefulDeviceManager	Define los métodos adicionales agregados por el con estado en la parte superior de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps	Propiedades de StreamMedia.
SystemMessageCommon	Propiedades comunes de todos los mensajes del sistema.
TopicUpdatedSystemMessage	Mensaje del sistema que notifica que se actualizó el tema del subproceso de chat.
TranscriptionCallFeature	Versión de solo estado de <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient escuchará automáticamente el estado de transcripción de la llamada y actualizará el estado expuesto por StatefulCallClient en consecuencia.
TypingIndicatorProps	Propiedades para TypingIndicator.
TypingIndicatorStrings	Cadenas de TypingIndicator que se pueden invalidar.
TypingIndicatorStylesProps	Estilos fluent para TypingIndicator.
VideoGalleryProps	Propiedades de VideoGallery.
VideoGalleryRemoteParticipant	El estado de un participante remoto en VideoGallery.
VideoGalleryStream	Secuencia de vídeo de un participante en VideoGallery.
VideoGalleryStrings	Todas las cadenas que se pueden mostrar en la interfaz de usuario de VideoGallery.
VideoGalleryStyles	VideoGallery Estilos de componente.
VideoStreamOptions	Opciones para controlar cómo se representan las secuencias de vídeo.
VideoStreamRendererViewState	Versión de solo estado de <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Esta propiedad se agrega al estado expuesto por StatefulCallClient mediante createView y quitado por disposeView.
VideoTileProps	Propiedades de VideoTile.
VideoTileStylesProps	Estilos fluent para VideoTile.

Alias de tipos

AdapterErrors	Los adaptadores almacenan el error más reciente para cada operación en el estado. `target` es una cadena definida por el adaptador para cada operación única realizada por el adaptador.
AreEqual	Compare si dos componentes de React son iguales exactamente, el tipo de resultado será true/false.
AreParamEqual	Compare si las propiedades de 2 componentes react son iguales, el tipo de resultado será true/false.
AreTypeEqual	Compare si dos tipos son iguales, el tipo de resultado será true/false.
AvatarPersonaData	Atributos de datos personalizados para mostrar avatar para un usuario.
AvatarPersonaDataCallback	Función de devolución de llamada usada para proporcionar datos personalizados para crear un avatar para un usuario.
AzureCommunicationCallAdapterArgs	Argumentos para crear la implementación de Azure Communication Services de CallAdapter. Nota: `displayName` puede tener un máximo de 256 caracteres.
AzureCommunicationCallWithChatAdapterArgs	Argumentos para createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs	Argumentos para <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs	Argumentos para crear la implementación Azure Communication Services de ChatAdapter.
CallAdapterCallEndedEvent	Carga útil para CallEndedListener que contiene los detalles de la llamada finalizada.
CallAdapterClientState	Estado CommonCallAdapter inferido de Azure Communication Services back-end.
CallAdapterLocator	Localizador usado por createAzureCommunicationCallAdapter para buscar la llamada a unirse
CallAdapterState	Estado CommonCallAdapter .
CallAdapterUiState	Estado CommonCallAdapter con fines de interfaz de usuario puros.
CallCompositeIcons	Iconos que se pueden invalidar para CallComposite.
CallCompositeOptions	Características opcionales del callComposite.
CallCompositePage	Pantallas de interfaz de usuario principales que se muestran en CallComposite.
CallControlDisplayType	Tipo de presentación de la barra de control para CallComposite.
CallControlOptions	Opciones de personalización de la barra de control en la experiencia de llamada.
CallEndedListener	Devolución de llamada para el evento "callEnded" de CallAdapterSubscribers .
CallErrorBarSelector	Tipo de selector para el componente ErrorBar .
CallErrorTarget	Tipo literal de cadena para todas las claves permitidas en {@Link CallErrors}.
CallErrors	Errores en las llamadas API al SDK de llamadas. Cada propiedad del objeto almacena el error más reciente para un método de API de SDK determinado. Los errores de este objeto se pueden borrar mediante .<xref:newClearCallErrorsModifier> Además, los errores se borran automáticamente cuando: Se borra el estado. Las llamadas posteriores a los métodos de API relacionados se realizan correctamente. Consulte la documentación de métodos de cliente con estado individuales para obtener más información sobre cuándo se pueden borrar automáticamente los errores.
CallIdChangedListener	Devolución de llamada para el evento "callIdChanged" de CallAdapterSubscribers .
CallParticipantListParticipant	Llamar al estado del participante, como se refleja en los componentes de la interfaz de usuario.
CallWithChatCompositeIcons	Iconos que se pueden invalidar para CallWithChatComposite.
CallWithChatCompositeOptions	Características opcionales del callWithChatComposite.
CallWithChatEvent	Eventos desencadenados por CallWithChatAdapter.
CallingBaseSelectorProps	Propiedades comunes que se usan para hacer referencia a la llamada al estado de cliente declarativo.
CallingReturnProps	Tipo auxiliar para usePropsFor.
CameraButtonSelector	Tipo de selector para el componente CameraButton .
ChatAdapter	ChatComposite Interfaz del adaptador.
ChatAdapterState	Estado de ChatAdapter .
ChatAdapterUiState	Estado de ChatAdapter con fines de interfaz de usuario puros.
ChatBaseSelectorProps	Propiedades comunes para selectores para ChatClientState.
ChatClientProviderProps	Argumentos para inicializar un ChatClientProvider.
ChatClientState	Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState	Estado de ChatAdapter inferido de Azure Communication Services back-end.
ChatCompositeIcons	Iconos que se pueden invalidar para ChatComposite.
ChatCompositeOptions	Características opcionales del chatComposite.
ChatErrorBarSelector	Tipo de selector para el componente ErrorBar .
ChatErrorTarget	Tipo literal de cadena para todas las claves permitidas en ChatErrors.
ChatErrors	Errores de llamadas API al SDK de chat. Cada propiedad del objeto almacena el error más reciente para un método de API de SDK determinado.
ChatHandlers	Objeto que contiene todos los controladores necesarios para los componentes de chat. Los componentes relacionados con el chat de este paquete pueden elegir controladores relevantes de este objeto. Vea <xref:useHandlers> y usePropsFor.
ChatMessageWithStatus	Una extensión a <xref:%40azure%2Fcommunication-chat%23ChatMessage> que almacena solo los metadatos del lado cliente para los mensajes de chat. TODO: el nombre ha bitrotted. Cámbiele el nombre.
ChatParticipantListSelector	Tipo de selector para el componente ParticipantList .
ChatReturnProps	Tipo auxiliar para usePropsFor.
ChatThreadClientProviderProps	Argumentos para inicializar un chatThreadClientProvider.
ChatThreadClientState	Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties	Propiedades de un subproceso de chat. Definimos una mínima que nos ayude a ocultar los diferentes tipos usados por la API subyacente.
ClientState	Estado centralizado para <xref:%40azure%2Fcommunication-calling%23CallClient> o <xref:%40azure%2Fcommunication-chat%23ChatClient>. Consulte también: CallClientState, ChatClientState.
Common	Devolver el tipo de intersección de 2 tipos
CommonProperties	Devolver propiedades intersect de 2 tipos
CommunicationParticipant	Estado del participante chat o llamada, como se refleja en la interfaz de usuario.
ComponentIcons	Iconos usados por los componentes de React exportados desde esta biblioteca.
ComponentProps	Tipo auxiliar para usePropsFor.
CompositeIcons	Iconos que se pueden invalidar en uno de los compuestos exportados por esta biblioteca. Consulte ChatCompositeIcons, CallCompositeIcons y CallWithChatCompositeIcons para obtener más tipos de destino.
ControlBarButtonStyles	Estilos para todas las implementaciones de ControlBarButton .
ControlBarLayout	Presenta los diseños de la barra de control.
CreateViewResult	Devuelve el resultado de createView.
CustomAvatarOptions	Opciones que se pueden insertar en la `onRender` función para personalizar un componente Avatar (`Persona`).
DeviceManagerState	Este tipo está pensado para encapsular todo el estado dentro <xref:%40azure%2Fcommunication-calling%23DeviceManager>de . En el caso de los parámetros opcionales, es posible que no estén disponibles hasta que el usuario conceda permiso. Los estados de cámaras, micrófonos, altavoces y deviceAccess estarán vacíos hasta que se llamen y completen las <xref:%40azure%2Fcommunication-calling%23DeviceManager>API getCameras, getMicrophones, getSpeakers y askDevicePermission.
DevicesButtonSelector	Tipo de selector para el componente DevicesButton .
DiagnosticChangedEventListner	Devolución de llamada para el evento "diagnosticChanged" de CallAdapterSubscribers .
DisplayNameChangedListener	Devolución de llamada para el evento "displayNameChanged" de CallAdapterSubscribers .
EmptySelector	Tipo para selectores triviales que no devuelven datos. Se usa como valor devuelto predeterminado si se llama a usePropsFor para un componente que no requiere datos.
ErrorType	Todos los errores que se pueden mostrar en errorBar.
GetCallingSelector	Tipo específico del selector aplicable a un componente determinado.
GetChatSelector	Tipo específico del selector aplicable a un componente determinado.
IsLocalScreenSharingActiveChangedListener	Devolución de llamada para el evento "isLocalScreenSharingActiveChanged" de CallAdapterSubscribers .
IsMutedChangedListener	Devolución de llamada para el evento "isMuted" de CallAdapterSubscribers .
IsSpeakingChangedListener	Devolución de llamada para el evento "isSpeakingChanged" de CallAdapterSubscribers .
LoadingState	Si la secuencia se está cargando o no.
LocalizationProviderProps	Propiedades para LocalizationProvider.
MediaDiagnosticChangedEvent	Carga de DiagnosticChangedEventListner donde hay un cambio en un diagnóstico multimedia.
Message	Unión discriminada de todos los mensajes. El `messageType` campo se especializa en variantes de unión.
MessageAttachedStatus	Indique si se debe mostrar un mensaje de chat combinado con el mensaje antes y después de él. Resulta útil combinar muchos mensajes del mismo remitente en una sola burbuja de mensaje.
MessageContentType	Tipos admitidos de contenido de mensajes de chat.
MessageProps	Propiedades para representar un único mensaje. Consulte MessageRenderer.
MessageReadListener	Devolución de llamada para el evento "messageRead" de ChatAdapterSubscribers .
MessageReceivedListener	Devolución de llamada para el evento "messageReceived" de ChatAdapterSubscribers .
MessageRenderer	Componente para representar un único mensaje.
MessageSentListener	Devolución de llamada para el evento "messageSent" de ChatAdapterSubscribers .
MessageStatus	Estado del lado cliente de un mensaje enviado. Incluye estados transitorios que se producen antes de que se confirme la entrega de mensajes desde el back-end.
MessageThreadProps	Propiedades para MessageThread.
MessageThreadSelector	Tipo de selector para el componente MessageThread .
MicrophoneButtonSelector	Tipo de selector para el componente MicrophoneButton .
NetworkDiagnosticChangedEvent	Carga de DiagnosticChangedEventListner donde hay un cambio en un diagnóstico de red.
OnRenderAvatarCallback	Devolución de llamada representada personalizada que permite a los usuarios personalizar la representación de un componente de rol.
ParticipantListParticipant	Los participantes se muestran en una Lista de participantes.
ParticipantListProps	Propiedades de ParticipantList.
ParticipantListSelector	Tipo de selector para el componente ParticipantList .
ParticipantMenuItemsCallback	Devolución de llamada para proporcionar elementos de menú personalizados para cada participante de ParticipantList.
ParticipantState	Estado de conexión de un participante de llamada.
ParticipantsAddedListener	Devolución de llamada para el evento "participantsAdded" de ChatAdapterSubscribers .
ParticipantsButtonSelector	Tipo de selector para el componente ParticipantsButton .
ParticipantsJoinedListener	Devolución de llamada para el evento "participantsJoined" de CallAdapterSubscribers .
ParticipantsLeftListener	Devolución de llamada para el evento "participantsLeft" de CallAdapterSubscribers .
ParticipantsRemovedListener	Devolución de llamada para el evento "participantsRemoved" de ChatAdapterSubscribers .
ReadReceiptsBySenderId	Matriz de pares clave-valor que almacena el nombre para mostrar de cada remitente y el último mensaje de lectura.
ScreenShareButtonSelector	Tipo de selector para el componente ScreenShareButton .
Selector	Selector optimizado que refina las actualizaciones de ClientState en propiedades para React Componentes de esta biblioteca.
SendBoxSelector	Tipo de selector para el componente SendBox .
StatefulCallClientArgs	Argumentos para construir StatefulCallClient.
StatefulCallClientOptions	Opciones para construir StatefulCallClient con.
StatefulChatClientArgs	Argumentos para construir StatefulChatClient.
StatefulChatClientOptions	Opciones para construir StatefulChatClient.
SystemMessage	Unión discriminada de todos los mensajes del sistema. El `systemMessageType` campo se especializa en variantes de unión.
TopicChangedListener	Devolución de llamada para el evento "topicChanged" de ChatAdapterSubscribers .
TypingIndicatorSelector	Tipo de selector para el componente TypingIndicator .
UpdateMessageCallback	La función de devolución de llamada se ejecuta cuando se actualiza un mensaje.
VideoGalleryLayout
VideoGalleryLocalParticipant	El estado del participante local en VideoGallery.
VideoGalleryParticipant	El estado de un participante en VideoGallery.
VideoGallerySelector	Tipo de selector para el componente VideoGallery .
ViewScalingMode	Modo de escalado de videoGalleryStream.

Funciones

CallAgentProvider(CallAgentProviderProps)	que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-calling%23CallAgent>. La llamada a componentes de este paquete se debe encapsular con un CallAgentProvider.
CallClientProvider(CallClientProviderProps)	que <xref:React.Context> almacena statefulCallClient. Las llamadas a componentes de este paquete se deben encapsular con un CallClientProvider.
CallComposite(CallCompositeProps)	Una interfaz de usuario personalizable compuesta para la experiencia de llamada.
CallProvider(CallProviderProps)	que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-calling%23Call>. Las llamadas a componentes de este paquete se deben encapsular con un CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)	CallWithChatComposite reúne componentes clave para proporcionar una llamada completa con experiencia de chat lista para usar.
CameraButton(CameraButtonProps)	Un botón para activar o desactivar la cámara. Se puede usar con ControlBar.
ChatClientProvider(ChatClientProviderProps)	que <xref:React.Context> almacena statefulChatClient. Los componentes de chat de este paquete se deben encapsular con un ChatClientProvider.
ChatComposite(ChatCompositeProps)	Composición de interfaz de usuario personalizable para la experiencia de chat.
ChatThreadClientProvider(ChatThreadClientProviderProps)	que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Los componentes de chat de este paquete deben estar encapsulados con un chatThreadClientProvider.
ControlBar(ControlBarProps)	Un contenedor para varios botones para los controles de llamada. Use con varios botones de control de llamadas en esta biblioteca, por ejemplo, CameraButton o sus propias instancias de ControlBarButton directamente.
ControlBarButton(ControlBarButtonProps)	Botón predeterminado con estilo para la barra de control. Use este componente para crear botones personalizados con el mismo estilo que otros botones proporcionados por la biblioteca de interfaz de usuario.
DevicesButton(DevicesButtonProps)	Botón para abrir un menú que controla las opciones del dispositivo. Se puede usar con ControlBar.
EndCallButton(EndCallButtonProps)	Un botón para finalizar una llamada en curso. Se puede usar con ControlBar.
ErrorBar(ErrorBarProps)	Componente para mostrar mensajes de error en la interfaz de usuario. Todas las cadenas que se pueden mostrar se aceptan como cadenas para que se puedan localizar. ActiveErrorMessages selecciona los errores activos. Este componente realiza un seguimiento interno de los descartados por el usuario. Errores que tienen una marca de tiempo asociada: el error se muestra de nuevo en la interfaz de usuario si se produce después de descartarse. Errores que no tienen una marca de tiempo: el error se descarta hasta que desaparece de las propiedades. Si el error se repite, se muestra en la interfaz de usuario. Usa <xref:%40fluentui%2Freact%23MessageBar> el elemento de interfaz de usuario.
FluentThemeProvider(FluentThemeProviderProps)	Proveedor para aplicar un tema de Fluent en los componentes de reacción de esta biblioteca.
GridLayout(GridLayoutProps)	Componente para diseñar iconos de participantes de audio y vídeo en una llamada.
LocalizationProvider(LocalizationProviderProps)	Proveedor para proporcionar cadenas localizadas para los componentes react de esta biblioteca.
MessageStatusIndicator(MessageStatusIndicatorProps)	Componente para mostrar el estado de un mensaje enviado. Agrega un icono y información sobre herramientas correspondiente al estado del mensaje.
MessageThread(MessageThreadProps)	`MessageThread` permite crear fácilmente un componente para representar mensajes de chat, controlar el comportamiento de desplazamiento de los mensajes nuevos o antiguos y personalizar iconos & controles dentro del subproceso de chat.
MicrophoneButton(MicrophoneButtonProps)	Botón para activar o desactivar el micrófono. Se puede usar con ControlBar.
ParticipantItem(ParticipantItemProps)	Componente para representar un participante de llamada o chat. Muestra el avatar del participante, displayName y status, así como iconos opcionales y menú contextual.
ParticipantList(ParticipantListProps)	Componente para representar todos los participantes de llamadas o chat. De forma predeterminada, cada participante se representa con ParticipantItem. Consulte <xref:ParticipantListProps.onRenderParticipant> para invalidar.
ParticipantsButton(ParticipantsButtonProps)	Un botón para mostrar un menú con participantes de llamadas o chat. Se puede usar con ControlBar. Este botón contiene elementos de menú desplegable definidos a través de su propiedad `menuProps`. De forma predeterminada, puede mostrar el número de participantes remotos con la lista completa como submenú y una opción para silenciar a todos los participantes, así como un botón copiar en el Portapapeles para copiar la dirección URL de invitación de llamada. Esto `menuProps` se puede redefinir completamente y su propiedad es de tipo IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)	Un botón para iniciar o detener el uso compartido de pantalla. Se puede usar con ControlBar.
SendBox(SendBoxProps)	Componente para escribir y enviar mensajes. Admite el envío de notificaciones de escritura cuando el usuario comienza a escribir texto. Admite un mensaje opcional debajo del campo de entrada de texto.
StreamMedia(StreamMediaProps)	Componente de utilidad para convertir un HTMLElement con una secuencia de vídeo en un elemento JSX. Se usa para convertir un HTMLElement devuelto por la API de llamada sin encabezado en un componente que se puede representar como videoTile.
TypingIndicator(TypingIndicatorProps)	Componente para notificar al usuario local cuando uno o varios participantes en el subproceso de chat están escribiendo.
VideoGallery(VideoGalleryProps)	VideoGallery representa un diseño de iconos de vídeo para una llamada específica. Muestra un VideoTile para el usuario local, así como para cada participante remoto que se ha unido a la llamada.
VideoTile(VideoTileProps)	Componente para representar la secuencia de vídeo de un solo participante de llamada. Úselo con GridLayout en una clase VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Cree un CallAdapter respaldado por Azure Communication Services. Esta es la implementación predeterminada de CallAdapter proporcionada por esta biblioteca. Nota: `displayName` puede tener un máximo de 256 caracteres.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)	Cree un CallAdapter mediante statefulCallClient proporcionado. Útil si desea mantener una referencia a StatefulCallClient. Considere la posibilidad de usar createAzureCommunicationCallAdapter para una API más sencilla.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)	Cree un CallWithChatAdapter respaldado por Azure Communication Services para conectarse al callWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	Cree un CallWithChatAdapter con statefulChatClient y StatefulCallClient proporcionados. Útil si desea mantener una referencia a StatefulChatClient y StatefulCallClient. Considere la posibilidad de usar createAzureCommunicationCallWithChatAdapter para una API más sencilla.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)	Cree un chatAdapter respaldado por Azure Communication Services. Esta es la implementación predeterminada de ChatAdapter proporcionada por esta biblioteca.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)	Cree un ChatAdapter mediante statefulChatClient proporcionado. Útil si desea mantener una referencia a StatefulChatClient. Considere la posibilidad de usar createAzureCommunicationChatAdapter para una API más sencilla.
createDefaultCallingHandlers(StatefulCallClient, undefined \| CallAgent, undefined \| StatefulDeviceManager, undefined \| Call)	Cree la implementación predeterminada de CallingHandlers para la llamada de teams. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)	Cree la implementación predeterminada de ChatHandlers. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. El objeto devuelto se memoiza para evitar repeticiones cuando se usa como propiedades para React Componentes.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)	Crea un StatefulCallClient StatefulCallClient mediante el proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> con ProxyCallClient <xref:ProxyCallClient> que, a continuación, permite el acceso al estado de una manera declarativa. Es importante usar y <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> y (y, etc.) que se obtienen de StatefulCallClient para que sus cambios de estado se proxien correctamente.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)	Crea un ChatClient con estado StatefulChatClient mediante el proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> con ProxyChatClient <xref:ProxyChatClient> que, a continuación, permite el acceso al estado de una manera declarativa.
fromFlatCommunicationIdentifier(string)	Operación inversa de toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)	Obtiene el selector de un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
getChatSelector<Component>(Component)	Obtiene el selector de un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
toFlatCommunicationIdentifier(CommunicationIdentifier)	Representación de cadena de una estructura <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Se garantiza que esta representación de cadena de CommunicationIdentifier es estable para un usuario de comunicación único. Así, se puede usar para conservar la identidad de un usuario en bases de datos externas. se puede usar como claves en un mapa para almacenar datos para el usuario.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)	Un enlace de React personalizado para simplificar la creación de CallAdapter. De forma similar a createAzureCommunicationCallAdapter, pero se encarga de la creación asincrónica del adaptador internamente. Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos. Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)	Un enlace de React personalizado para simplificar la creación de CallWithChatAdapter. Similar a createAzureCommunicationCallWithChatAdapter, pero se encarga de la creación asincrónica del adaptador internamente. Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos. Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)	Un enlace de React personalizado para simplificar la creación de ChatAdapter. De forma similar a createAzureCommunicationChatAdapter, pero se encarga de la creación asincrónica del adaptador internamente. Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos. Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.
useCall()	Enlace que se va a obtener <xref:%40azure%2Fcommunication-calling%23Call> del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. Debe haber usado previamente callProvider con un objeto Call para usar este enlace.
useCallAgent()	Enlace que se va a obtener <xref:%40azure%2Fcommunication-calling%23CallAgent> del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
useCallClient()	Enlace para obtener StatefulCallClient del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
useChatClient()	Enlace para obtener StatefulChatClient del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
useChatThreadClient()	Enlace que se va a obtener <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
useDeviceManager()	Enlace para obtener StatefulDeviceManager del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
usePropsFor<Component>(Component, "chat" \| "calling")	Enlace principal para obtener todos los enlaces necesarios para un componente de React de esta biblioteca. Para llamar a este enlace, el componente debe encapsularse en estos proveedores: Para los componentes de chat: ChatClientProvider y ChatThreadClientProvider. Para llamar a componentes: CallClientProvider, CallAgentProvider y CallAgentProvider. El uso más sencillo de los componentes es similar al siguiente: Ejemplo `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")	Enlace para obtener un selector para un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
useTheme()	React enlace para acceder al tema

Detalles de la función

CallAgentProvider(CallAgentProviderProps)

que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-calling%23CallAgent>.

La llamada a componentes de este paquete se debe encapsular con un CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parámetros

props: CallAgentProviderProps

Devoluciones

Element

CallClientProvider(CallClientProviderProps)

que <xref:React.Context> almacena statefulCallClient.

Las llamadas a componentes de este paquete se deben encapsular con un CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parámetros

props: CallClientProviderProps

Devoluciones

Element

CallComposite(CallCompositeProps)

Una interfaz de usuario personalizable compuesta para la experiencia de llamada.

function CallComposite(props: CallCompositeProps): Element

Parámetros

props: CallCompositeProps

Devoluciones

Element

Comentarios

La llamada al ancho/alto mínimo compuesto es la siguiente:

mobile: 17,5rem x 21rem (280px x 336px, con rem predeterminado en 16px)
desktop: 30rem x 22rem (480px x 352px, con rem predeterminado a 16px)

CallProvider(CallProviderProps)

que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-calling%23Call>.

Las llamadas a componentes de este paquete se deben encapsular con un CallProvider.

function CallProvider(props: CallProviderProps): Element

Parámetros

props: CallProviderProps

Devoluciones

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite reúne componentes clave para proporcionar una llamada completa con experiencia de chat lista para usar.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parámetros

props: CallWithChatCompositeProps

Devoluciones

Element

CameraButton(CameraButtonProps)

Un botón para activar o desactivar la cámara.

Se puede usar con ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parámetros

props: CameraButtonProps

Devoluciones

Element

ChatClientProvider(ChatClientProviderProps)

que <xref:React.Context> almacena statefulChatClient.

Los componentes de chat de este paquete se deben encapsular con un ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parámetros

props: ChatClientProviderProps

Devoluciones

Element

ChatComposite(ChatCompositeProps)

Composición de interfaz de usuario personalizable para la experiencia de chat.

function ChatComposite(props: ChatCompositeProps): Element

Parámetros

props: ChatCompositeProps

Devoluciones

Element

Comentarios

El ancho y la altura compuestos de chat son respectivamente 17,5rem y 20rem (280px y 320px, con rem predeterminado en 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

que <xref:React.Context> almacena un objeto <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Los componentes de chat de este paquete deben estar encapsulados con un chatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parámetros

props: ChatThreadClientProviderProps

Devoluciones

Element

ControlBar(ControlBarProps)

Un contenedor para varios botones para los controles de llamada.

Use con varios botones de control de llamadas en esta biblioteca, por ejemplo, CameraButton o sus propias instancias de ControlBarButton directamente.

function ControlBar(props: ControlBarProps): Element

Parámetros

props: ControlBarProps

Devoluciones

Element

ControlBarButton(ControlBarButtonProps)

Botón predeterminado con estilo para la barra de control.

Use este componente para crear botones personalizados con el mismo estilo que otros botones proporcionados por la biblioteca de interfaz de usuario.

function ControlBarButton(props: ControlBarButtonProps): Element

Parámetros

props: ControlBarButtonProps

Devoluciones

Element

DevicesButton(DevicesButtonProps)

Botón para abrir un menú que controla las opciones del dispositivo.

Se puede usar con ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parámetros

props: DevicesButtonProps

Devoluciones

Element

EndCallButton(EndCallButtonProps)

Un botón para finalizar una llamada en curso.

Se puede usar con ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parámetros

props: EndCallButtonProps

Devoluciones

Element

ErrorBar(ErrorBarProps)

Componente para mostrar mensajes de error en la interfaz de usuario. Todas las cadenas que se pueden mostrar se aceptan como cadenas para que se puedan localizar. ActiveErrorMessages selecciona los errores activos.

Este componente realiza un seguimiento interno de los descartados por el usuario.

Errores que tienen una marca de tiempo asociada: el error se muestra de nuevo en la interfaz de usuario si se produce después de descartarse.
Errores que no tienen una marca de tiempo: el error se descarta hasta que desaparece de las propiedades. Si el error se repite, se muestra en la interfaz de usuario.

Usa <xref:%40fluentui%2Freact%23MessageBar> el elemento de interfaz de usuario.

function ErrorBar(props: ErrorBarProps): Element

Parámetros

props: ErrorBarProps

Devoluciones

Element

FluentThemeProvider(FluentThemeProviderProps)

Proveedor para aplicar un tema de Fluent en los componentes de reacción de esta biblioteca.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parámetros

props: FluentThemeProviderProps

Devoluciones

Element

Comentarios

Los componentes de esta biblioteca se componen principalmente de la interfaz de usuario de Fluent, los controles y también de los controles fluent React Northstar. Este proveedor controla la aplicación de cualquier tema proporcionado a los controles subyacentes de la interfaz de usuario de Fluent, así como a los controles Fluent React Northstar.

GridLayout(GridLayoutProps)

Componente para diseñar iconos de participantes de audio y vídeo en una llamada.

function GridLayout(props: GridLayoutProps): Element

Parámetros

props: GridLayoutProps

Devoluciones

Element

LocalizationProvider(LocalizationProviderProps)

Proveedor para proporcionar cadenas localizadas para los componentes react de esta biblioteca.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parámetros

props: LocalizationProviderProps

Devoluciones

Element

Comentarios

Los componentes se proporcionarán cadenas localizadas en inglés (EE. UU.) de forma predeterminada si no se usa este proveedor.

MessageStatusIndicator(MessageStatusIndicatorProps)

Componente para mostrar el estado de un mensaje enviado.

Agrega un icono y información sobre herramientas correspondiente al estado del mensaje.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parámetros

props: MessageStatusIndicatorProps

Devoluciones

Element

MessageThread(MessageThreadProps)

MessageThread permite crear fácilmente un componente para representar mensajes de chat, controlar el comportamiento de desplazamiento de los mensajes nuevos o antiguos y personalizar iconos & controles dentro del subproceso de chat.

function MessageThread(props: MessageThreadProps): Element

Parámetros

props: MessageThreadProps

de tipo MessageThreadProps

Los usuarios deberán proporcionar al menos mensajes de chat y userId para representar el MessageThread componente. Los usuarios también pueden personalizar MessageThread pasando su propio Avatar, MessageStatusIndicator icono, JumpToNewMessageButtonLoadPreviousMessagesButton y el comportamiento de estos controles.

MessageThread usa internamente el Chat componente & Chat.Message de @fluentui/react-northstar. Puede consultar los detalles sobre estos dos componentes.

Devoluciones

Element

MicrophoneButton(MicrophoneButtonProps)

Botón para activar o desactivar el micrófono.

Se puede usar con ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parámetros

props: MicrophoneButtonProps

Devoluciones

Element

ParticipantItem(ParticipantItemProps)

Componente para representar un participante de llamada o chat.

Muestra el avatar del participante, displayName y status, así como iconos opcionales y menú contextual.

function ParticipantItem(props: ParticipantItemProps): Element

Parámetros

props: ParticipantItemProps

Devoluciones

Element

ParticipantList(ParticipantListProps)

Componente para representar todos los participantes de llamadas o chat.

De forma predeterminada, cada participante se representa con ParticipantItem. Consulte <xref:ParticipantListProps.onRenderParticipant> para invalidar.

function ParticipantList(props: ParticipantListProps): Element

Parámetros

props: ParticipantListProps

Devoluciones

Element

ParticipantsButton(ParticipantsButtonProps)

Un botón para mostrar un menú con participantes de llamadas o chat.

Se puede usar con ControlBar.

Este botón contiene elementos de menú desplegable definidos a través de su propiedad menuProps. De forma predeterminada, puede mostrar el número de participantes remotos con la lista completa como submenú y una opción para silenciar a todos los participantes, así como un botón copiar en el Portapapeles para copiar la dirección URL de invitación de llamada. Esto menuProps se puede redefinir completamente y su propiedad es de tipo IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parámetros

props: ParticipantsButtonProps

Devoluciones

Element

ScreenShareButton(ScreenShareButtonProps)

Un botón para iniciar o detener el uso compartido de pantalla.

Se puede usar con ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parámetros

props: ScreenShareButtonProps

Devoluciones

Element

SendBox(SendBoxProps)

Componente para escribir y enviar mensajes.

Admite el envío de notificaciones de escritura cuando el usuario comienza a escribir texto. Admite un mensaje opcional debajo del campo de entrada de texto.

function SendBox(props: SendBoxProps): Element

Parámetros

props: SendBoxProps

Devoluciones

Element

StreamMedia(StreamMediaProps)

Componente de utilidad para convertir un HTMLElement con una secuencia de vídeo en un elemento JSX.

Se usa para convertir un HTMLElement devuelto por la API de llamada sin encabezado en un componente que se puede representar como videoTile.

function StreamMedia(props: StreamMediaProps): Element

Parámetros

props: StreamMediaProps

Devoluciones

Element

TypingIndicator(TypingIndicatorProps)

Componente para notificar al usuario local cuando uno o varios participantes en el subproceso de chat están escribiendo.

function TypingIndicator(props: TypingIndicatorProps): Element

Parámetros

props: TypingIndicatorProps

Devoluciones

Element

VideoGallery(VideoGalleryProps)

VideoGallery representa un diseño de iconos de vídeo para una llamada específica. Muestra un VideoTile para el usuario local, así como para cada participante remoto que se ha unido a la llamada.

function VideoGallery(props: VideoGalleryProps): Element

Parámetros

props: VideoGalleryProps

Devoluciones

Element

VideoTile(VideoTileProps)

Componente para representar la secuencia de vídeo de un solo participante de llamada.

Úselo con GridLayout en una clase VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parámetros

props: VideoTileProps

Devoluciones

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Cree un CallAdapter respaldado por Azure Communication Services.

Esta es la implementación predeterminada de CallAdapter proporcionada por esta biblioteca.

Nota: displayName puede tener un máximo de 256 caracteres.

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

Parámetros

__namedParameters: AzureCommunicationCallAdapterArgs

Devoluciones

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Cree un CallAdapter mediante statefulCallClient proporcionado.

Útil si desea mantener una referencia a StatefulCallClient. Considere la posibilidad de usar createAzureCommunicationCallAdapter para una API más sencilla.

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

Parámetros

callClient: StatefulCallClient

callAgent: CallAgent

locator: CallAdapterLocator

Devoluciones

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Cree un CallWithChatAdapter respaldado por Azure Communication Services para conectarse al callWithChatComposite.

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

Parámetros

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

Devoluciones

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Cree un CallWithChatAdapter con statefulChatClient y StatefulCallClient proporcionados.

Útil si desea mantener una referencia a StatefulChatClient y StatefulCallClient. Considere la posibilidad de usar createAzureCommunicationCallWithChatAdapter para una API más sencilla.

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

Parámetros

__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs

Devoluciones

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Cree un chatAdapter respaldado por Azure Communication Services.

Esta es la implementación predeterminada de ChatAdapter proporcionada por esta biblioteca.

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

Parámetros

__namedParameters: AzureCommunicationChatAdapterArgs

Devoluciones

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Cree un ChatAdapter mediante statefulChatClient proporcionado.

Útil si desea mantener una referencia a StatefulChatClient. Considere la posibilidad de usar createAzureCommunicationChatAdapter para una API más sencilla.

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

Parámetros

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Devoluciones

Promise<ChatAdapter>

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

Cree la implementación predeterminada de CallingHandlers para la llamada de teams.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

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

Parámetros

callClient: StatefulCallClient

callAgent: undefined | CallAgent

deviceManager: undefined | StatefulDeviceManager

call: undefined | Call

Devoluciones

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Cree la implementación predeterminada de ChatHandlers.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

El objeto devuelto se memoiza para evitar repeticiones cuando se usa como propiedades para React Componentes.

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

Parámetros

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Devoluciones

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Crea un StatefulCallClient StatefulCallClient mediante el proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> con ProxyCallClient <xref:ProxyCallClient> que, a continuación, permite el acceso al estado de una manera declarativa.

Es importante usar y <xref:%40azure%2Fcommunication-calling%23DeviceManager><xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> y (y, etc.) que se obtienen de StatefulCallClient para que sus cambios de estado se proxien correctamente.

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

Parámetros

args: StatefulCallClientArgs

StatefulCallClientArgs

options: StatefulCallClientOptions

StatefulCallClientOptions

Devoluciones

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Crea un ChatClient con estado StatefulChatClient mediante el proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> con ProxyChatClient <xref:ProxyChatClient> que, a continuación, permite el acceso al estado de una manera declarativa.

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

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parámetros

id: string

Devoluciones

CommunicationIdentifier

getCallingSelector<Component>(Component)

Obtiene el selector de un componente especificado.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

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

Parámetros

component: Component

Devoluciones

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Obtiene el selector de un componente especificado.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

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

Parámetros

component: Component

Devoluciones

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Representación de cadena de una estructura <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Se garantiza que esta representación de cadena de CommunicationIdentifier es estable para un usuario de comunicación único. Así,

se puede usar para conservar la identidad de un usuario en bases de datos externas.
se puede usar como claves en un mapa para almacenar datos para el usuario.

function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parámetros

identifier: CommunicationIdentifier

Devoluciones

string

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

Un enlace de React personalizado para simplificar la creación de CallAdapter.

De forma similar a createAzureCommunicationCallAdapter, pero se encarga de la creación asincrónica del adaptador internamente.

Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos.

Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.

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

Parámetros

args: Partial<AzureCommunicationCallAdapterArgs>

afterCreate: (adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose: (adapter: CallAdapter) => Promise<void>

Devoluciones

undefined | CallAdapter

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

Un enlace de React personalizado para simplificar la creación de CallWithChatAdapter.

Similar a createAzureCommunicationCallWithChatAdapter, pero se encarga de la creación asincrónica del adaptador internamente.

Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos.

Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.

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

Parámetros

args: Partial<AzureCommunicationCallWithChatAdapterArgs>

afterCreate: (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>

beforeDispose: (adapter: CallWithChatAdapter) => Promise<void>

Devoluciones

undefined | CallWithChatAdapter

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

Un enlace de React personalizado para simplificar la creación de ChatAdapter.

De forma similar a createAzureCommunicationChatAdapter, pero se encarga de la creación asincrónica del adaptador internamente.

Permite que los argumentos no estén definidos para que pueda respetar las reglas de enlace y pasar argumentos a medida que se crean. El adaptador solo se crea cuando se definen todos los argumentos.

Tenga en cuenta que debe memoizar los argumentos para evitar volver a crear el adaptador en cada representación. Consulte storybook para obtener ejemplos de uso típicos.

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

Parámetros

args: Partial<AzureCommunicationChatAdapterArgs>

afterCreate: (adapter: ChatAdapter) => Promise<ChatAdapter>

beforeDispose: (adapter: ChatAdapter) => Promise<void>

Devoluciones

undefined | ChatAdapter

useCall()

Enlace que se va a obtener <xref:%40azure%2Fcommunication-calling%23Call> del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

Debe haber usado previamente callProvider con un objeto Call para usar este enlace.

function useCall(): undefined | Call

Devoluciones

undefined | Call

useCallAgent()

Enlace que se va a obtener <xref:%40azure%2Fcommunication-calling%23CallAgent> del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

function useCallAgent(): undefined | CallAgent

Devoluciones

undefined | CallAgent

useCallClient()

Enlace para obtener StatefulCallClient del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

function useCallClient(): StatefulCallClient

Devoluciones

StatefulCallClient

useChatClient()

Enlace para obtener StatefulChatClient del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

function useChatClient(): StatefulChatClient

Devoluciones

StatefulChatClient

useChatThreadClient()

Enlace que se va a obtener <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

function useChatThreadClient(): ChatThreadClient

Devoluciones

ChatThreadClient

useDeviceManager()

Enlace para obtener StatefulDeviceManager del proveedor.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

function useDeviceManager(): undefined | StatefulDeviceManager

Devoluciones

undefined | StatefulDeviceManager

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

Enlace principal para obtener todos los enlaces necesarios para un componente de React de esta biblioteca.

Para llamar a este enlace, el componente debe encapsularse en estos proveedores:

Para los componentes de chat: ChatClientProvider y ChatThreadClientProvider.
Para llamar a componentes: CallClientProvider, CallAgentProvider y CallAgentProvider.

El uso más sencillo de los componentes es similar al siguiente:

Ejemplo

    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>

Parámetros

component: Component

type: "chat" | "calling"

Devoluciones

ComponentProps<Component>

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

Enlace para obtener un selector para un componente especificado.

Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.

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

Parámetros

selector: ParamT

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

type: "chat" | "calling"

Devoluciones

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

useTheme()

React enlace para acceder al tema

function useTheme(): Theme

Devoluciones

Theme

Compartir a través de

@azure/communication-react package

Clases

Interfaces

Alias de tipos

Funciones

Detalles de la función

CallAgentProvider(CallAgentProviderProps)

Parámetros

Devoluciones

CallClientProvider(CallClientProviderProps)

Parámetros

Devoluciones

CallComposite(CallCompositeProps)

Parámetros

Devoluciones

Comentarios

CallProvider(CallProviderProps)

Parámetros

Devoluciones

CallWithChatComposite(CallWithChatCompositeProps)

Parámetros

Devoluciones

CameraButton(CameraButtonProps)

Parámetros

Devoluciones

ChatClientProvider(ChatClientProviderProps)

Parámetros

Devoluciones

ChatComposite(ChatCompositeProps)

Parámetros

Devoluciones

Comentarios

ChatThreadClientProvider(ChatThreadClientProviderProps)

Parámetros

Devoluciones

ControlBar(ControlBarProps)

Parámetros

Devoluciones

ControlBarButton(ControlBarButtonProps)

Parámetros

Devoluciones

DevicesButton(DevicesButtonProps)

Parámetros

Devoluciones

EndCallButton(EndCallButtonProps)

Parámetros

Devoluciones

ErrorBar(ErrorBarProps)

Parámetros

Devoluciones

FluentThemeProvider(FluentThemeProviderProps)

Parámetros

Devoluciones

Comentarios

GridLayout(GridLayoutProps)

Parámetros

Devoluciones

LocalizationProvider(LocalizationProviderProps)

Parámetros

Devoluciones

Comentarios

MessageStatusIndicator(MessageStatusIndicatorProps)

Parámetros

Devoluciones

MessageThread(MessageThreadProps)

Parámetros

Devoluciones

MicrophoneButton(MicrophoneButtonProps)

Parámetros

Devoluciones

ParticipantItem(ParticipantItemProps)

Parámetros

Devoluciones

ParticipantList(ParticipantListProps)

Parámetros

Devoluciones

ParticipantsButton(ParticipantsButtonProps)

Parámetros

Devoluciones