@azure/communication-react package

Referencia

Clases

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

Interfaces

ActiveErrorMessage	Mensajes de error activos que se van a mostrar a través de ErrorBar.
AdapterError	Error notificado a través de eventos de error y almacenado en estado del 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 para la identidad de comunicación de Azure que amplía 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	Solo se mueve la versión de estado de <xref:%40azure%2Fcommunication-calling%23CallAgent> excepto que las llamadas se mueven para ser un elemento secundario directamente de CallClientState y no se incluyen aquí. La razón para tener el proxy de estado de CallAgent es proporcionar acceso a displayName. No aplanamos CallAgent.displayName y lo colocamos en CallClientState porque sería ambiguioso que displayName depende realmente de la creación o existencia de CallAgent para estar 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 que StatefulCallClient. Las llamadas, llamadasEnded, incomingCalls y los estados incomingCallsEnded se proporcionarán automáticamente si se ha creado un callAgent. DeviceManager estará vacío inicialmente hasta que se rellene DeviceManagerState. El estado userId se proporciona como una comodidad para el desarrollador y está completamente controlado y establecido por el desarrollador.
CallCompositeProps	Props for CallComposite.
CallCompositeStrings	Cadenas usadas por el CallComposite directamente. Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
CallProviderProps	Argumentos para inicializar un CallProvider.
CallState	Solo versión 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	interfaz del adaptador CallWithChatComposite.
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 el CallWithChatAdapter.
CallWithChatAdapterUiState	Estado de la interfaz de usuario que pertenece al CallWithChatComposite .
CallWithChatClientState	Estado de los servicios back-end que controla CallWithChatComposite.
CallWithChatCompositeProps	Propiedades necesarias para el callWithChatComposite de
CallWithChatCompositeStrings	Cadenas usadas por el CallWithChatComposite directamente. Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
CallWithChatControlOptions	CallWithChatComposite Controles de llamada para mostrar u ocultar botones en la barra de control de llamada.
CallingHandlers	Objeto que contiene todos los controladores necesarios para llamar a componentes. La llamada a componentes relacionados de este paquete puede seleccionar controladores relevantes de este objeto. Consulte <xref:useHandlers> y usePropsFor.
CallingTheme	Palet de temas de Fluent personalizado usado llamando a componentes relacionados en esta biblioteca.
CameraButtonContextualMenuStyles	Estilos del menú CameraButton de.
CameraButtonProps	Propiedades para 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	Props for ChatComposite.
ChatCompositeStrings	Las cadenas usadas por el ChatComposite directamente. Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes.
ChatMessage	Un mensaje de chat.
CommonCallAdapter	interfaz del adaptador de CallComposite.
CommonCallingHandlers	Objeto que contiene todos los controladores necesarios para llamar a componentes. La llamada a componentes relacionados de este paquete puede seleccionar controladores relevantes de este objeto. Consulte <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 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 de ControlBarButton.
ControlBarButtonStrings	Cadenas de controlBarButton que se pueden invalidar.
ControlBarProps	Propiedades de 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ú de DispositivosButton.
DevicesButtonProps	Propiedades para dispositivos de Button.
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 de EndCallButton.
EndCallButtonStrings	Cadenas de EndCallButton que se pueden invalidar.
ErrorBarProps	Propiedades de ErrorBar. Además de lo siguiente, ErrorBar reenvía todos los <xref:%40fluentui%2Freact%23IMessageBarProps> al <xref:%40fluentui%2Freact%23MessageBar>subyacente.
ErrorBarStrings	Todas las cadenas que se pueden mostrar en la interfaz de usuario del ErrorBar.
FluentThemeProviderProps	Propiedades de FluentThemeProvider.
GridLayoutProps	Propiedades de GridLayout.
GridLayoutStyles	Estilos de componentes GridLayout.
HorizontalGalleryStyles	<xref:HorizontalGallery> estilos de componentes.
IncomingCallState	Solo versión 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	Solo versión 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	Props for 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ú micrófono de.
MicrophoneButtonProps	Propiedades para MicrophoneButton.
MicrophoneButtonStrings	Cadenas de MicrophoneButton que se pueden invalidar.
MicrophoneButtonStyles	Estilos para MicrófonoButton
NetworkDiagnosticsState	Proxy de solo estado para <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice	Un dispositivo, por ejemplo, cámara, micrófono o altavoz, en la DispositivosButton control flotante.
ParticipantAddedSystemMessage	Mensaje del sistema que notifica que un participante se agregó al subproceso de chat.
ParticipantItemProps	Propiedades para ParticipantItem.
ParticipantItemStrings	Cadenas de ParticipantItem que se pueden invalidar.
ParticipantItemStyles	Estilos fluent para ParticipantItem.
ParticipantListItemStyles	Estilos del ParticipantList ParticipantItem.
ParticipantListStyles	Estilos del 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 ParticipantesButton.
RecordingCallFeature	Solo versión de 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	Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recuperará automáticamente RemoteParticipants y agregará su estado al estado expuesto por StatefulCallClient.
RemoteVideoStreamState	Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps	Propiedades de ScreenShareButton.
ScreenShareButtonStrings	Cadenas de ScreenShareButton que se pueden invalidar.
SendBoxProps	Propiedades de SendBox.
SendBoxStrings	Cadenas de SendBox que se pueden invalidar.
SendBoxStylesProps	Estilos fluent para <xref:Sendbox>.
StatefulCallClient	Define los métodos que permiten usar callClient <xref:%40azure%2Fcommunication-calling%23CallClient> 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: Se devuelven datos de las API de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Se devuelven datos de las API de <xref:%40azure%2Fcommunication-calling%23CallAgent>. Los agentes de escucha se adjuntan 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' Llamar a 'isMutedChanged' Llame a 'isScreenSharingOnChanged' Llame a "remoteParticipantsUpdated" Llame 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 encima 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	Solo versión de 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	Props for TypingIndicator.
TypingIndicatorStrings	Cadenas de TypingIndicator que se pueden invalidar.
TypingIndicatorStylesProps	Estilos fluent para typingIndicator.
VideoGalleryProps	Propiedades de VideoGallery.
VideoGalleryRemoteParticipant	Estado de un participante remoto en el 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 la VideoGallery.
VideoGalleryStyles	Estilos de componentes VideoGallery.
VideoStreamOptions	Opciones para controlar cómo se representan las secuencias de vídeo.
VideoStreamRendererViewState	Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Esta propiedad se agrega al estado expuesto por statefulCallClient createView y quitada 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 estado. `target` es una cadena definida por el adaptador para cada operación única realizada por el adaptador.
AreEqual	Compare si 2 componentes de react son exactamente iguales, el tipo de resultado será true/false.
AreParamEqual	Compare si las propiedades de 2 componentes de 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 el avatar de un usuario.
AvatarPersonaDataCallback	Función de devolución de llamada que se usa 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 de <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs	Argumentos para crear la implementación de Azure Communication Services de ChatAdapter.
CallAdapterCallEndedEvent	Carga útil de CallEndedListener que contiene detalles en la llamada finalizada.
CallAdapterClientState	estado commonCallAdapter inferido del back-end de Azure Communication Services.
CallAdapterLocator	Localizador usado por createAzureCommunicationCallAdapter para localizar 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 de.
CallCompositePage	Pantallas principales de la interfaz de usuario que se muestran en el callComposite de.
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 CallAdapterSubscribers evento "callEnded".
CallErrorBarSelector	Tipo de selector para componente errorBar.
CallErrorTarget	Tipo literal de cadena para todas las claves permitidas en {@Link CallErrors}.
CallErrors	Errores de 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 el <xref:newClearCallErrorsModifier>. Además, los errores se borran automáticamente cuando: El estado se borra. Las llamadas posteriores a los métodos de API relacionados se realizan correctamente. Consulte la documentación de los 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 CallAdapterSubscribers evento "callIdChanged".
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 el 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 componente CameraButton.
ChatAdapter	interfaz del adaptador de ChatComposite.
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 del back-end de Azure Communication Services.
ChatCompositeIcons	Iconos que se pueden invalidar para chatComposite.
ChatCompositeOptions	Características opcionales del ChatComposite.
ChatErrorBarSelector	Tipo de selector para 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 seleccionar controladores relevantes de este objeto. Consulte <xref:useHandlers> y usePropsFor.
ChatMessageWithStatus	Extensión para <xref:%40azure%2Fcommunication-chat%23ChatMessage> que almacena los metadatos solo del lado cliente para los mensajes de chat. TODO: el nombre tiene bitrotted. Cámbiele el nombre.
ChatParticipantListSelector	Tipo de selector para componente de 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 ayuda a ocultar los distintos 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 tipos más específicos.
ControlBarButtonStyles	Estilos para todas las implementaciones de controlBarButton de.
ControlBarLayout	Presenta diseños para el ControlBar.
CreateViewResult	Devuelve el resultado de createView.
CustomAvatarOptions	Opciones que se pueden insertar en la función `onRender` para personalizar un componente Avatar (`Persona`).
DeviceManagerState	Este tipo está diseñado para encapsular todo el estado dentro de <xref:%40azure%2Fcommunication-calling%23DeviceManager>. En el caso de los parámetros opcionales, es posible que no estén disponibles hasta que el usuario conceda permiso. Las cámaras, micrófonos, altavoces y deviceAccess estados estarán vacíos hasta que se llamen y completen <xref:%40azure%2Fcommunication-calling%23DeviceManager>las API getCameras, getMicrophones, getSpeakers y askDevicePermission correspondientes.
DevicesButtonSelector	Tipo de selector para componente DevicesButton.
DiagnosticChangedEventListner	Devolución de llamada para CallAdapterSubscribers evento "diagnosticChanged".
DisplayNameChangedListener	Devolución de llamada para CallAdapterSubscribers evento "displayNameChanged".
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 el 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 Evento CallAdapterSubscribers evento "isLocalScreenSharingActiveChanged".
IsMutedChangedListener	Devolución de llamada para evento CallAdapterSubscribers evento "isMuted".
IsSpeakingChangedListener	Devolución de llamada para evento CallAdapterSubscribers evento "isSpeakingChanged".
LoadingState	Indica si la secuencia se está cargando o no.
LocalizationProviderProps	Propiedades de LocalizationProvider.
MediaDiagnosticChangedEvent	Carga de DiagnosticChangedEventListner donde hay un cambio en un diagnóstico multimedia.
Message	Unión discriminada de todos los mensajes. El campo `messageType` se especializa en variantes de unión.
MessageAttachedStatus	Indica si se debe mostrar un mensaje de chat combinado con el mensaje antes o después de él. Resulta útil combinar muchos mensajes del mismo remitente en una única 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 ChatAdapterSubscribers evento "messageRead".
MessageReceivedListener	Devolución de llamada para chatAdapterSubscribers evento "messageReceived".
MessageRenderer	Componente para representar un único mensaje.
MessageSentListener	Devolución de llamada para chatAdapterSubscribers evento "messageSent".
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 de MessageThread.
MessageThreadSelector	Tipo de selector para componente MessageThread.
MicrophoneButtonSelector	Tipo de selector para componente de 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 persona.
ParticipantListParticipant	Los participantes se muestran en un ParticipantList.
ParticipantListProps	Propiedades de ParticipantList.
ParticipantListSelector	Tipo de selector para componente de 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 la llamada.
ParticipantsAddedListener	Devolución de llamada para ChatAdapterSubscribers evento "participantsAdded".
ParticipantsButtonSelector	Tipo de selector para componente ParticipantsButton.
ParticipantsJoinedListener	Devolución de llamada para CallAdapterSubscribers evento "participantsJoined".
ParticipantsLeftListener	Devolución de llamada para Evento CallAdapterSubscribers evento "participantsLeft".
ParticipantsRemovedListener	Devolución de llamada para evento chatAdapterSubscribers evento "participantsRemoved".
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 componente de ScreenShareButton.
Selector	Un selector optimizado que refina ClientState actualizaciones en propiedades para los componentes de React en esta biblioteca.
SendBoxSelector	Tipo de selector para componente de SendBox.
StatefulCallClientArgs	Argumentos para construir StatefulCallClient.
StatefulCallClientOptions	Opciones para construir StatefulCallClient con.
StatefulChatClientArgs	Argumentos para construir el StatefulChatClient.
StatefulChatClientOptions	Opciones para construir el StatefulChatClient de.
SystemMessage	Unión discriminada de todos los mensajes del sistema. El campo `systemMessageType` se especializa en variantes de unión.
TopicChangedListener	Devolución de llamada para ChatAdapterSubscribers evento "topicChanged".
TypingIndicatorSelector	Tipo de selector para componente de TypingIndicator.
UpdateMessageCallback	La función callback se ejecuta cuando se actualiza un mensaje.
VideoGalleryLayout
VideoGalleryLocalParticipant	Estado del participante local en el VideoGallery.
VideoGalleryParticipant	Estado de un participante en el VideoGallery.
VideoGallerySelector	Tipo de selector para componente de VideoGallery.
ViewScalingMode	Modo de escalado de un VideoGalleryStream.

Funciones

CallAgentProvider(CallAgentProviderProps)	Un <xref:React.Context> que almacena un <xref:%40azure%2Fcommunication-calling%23CallAgent>. La llamada a componentes de este paquete debe encapsularse con un CallAgentProvider.
CallClientProvider(CallClientProviderProps)	Un <xref:React.Context> que almacena un StatefulCallClient. Las llamadas a componentes de este paquete se deben encapsular con un CallClientProvider.
CallComposite(CallCompositeProps)	Un compuesto de interfaz de usuario personalizable para la experiencia de llamada.
CallProvider(CallProviderProps)	Un <xref:React.Context> que almacena un <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)	Botón para activar o desactivar la cámara. Se puede usar con ControlBar.
ChatClientProvider(ChatClientProviderProps)	Un <xref:React.Context> que almacena un StatefulChatClient. Los componentes de chat de este paquete se deben encapsular con un ChatClientProvider.
ChatComposite(ChatCompositeProps)	Una interfaz de usuario personalizable compuesta para la experiencia de chat.
ChatThreadClientProvider(ChatThreadClientProviderProps)	Un <xref:React.Context> que almacena un <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Los componentes de chat de este paquete se deben encapsular 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, CameraButtono sus propias instancias de ControlBarButton directamente.
ControlBarButton(ControlBarButtonProps)	Botón predeterminado con estilo para la barra de control de . 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 de para que se puedan localizar. Los errores activos se seleccionan mediante activeErrorMessages. Este componente realiza un seguimiento interno descartado 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> elemento de interfaz de usuario.
FluentThemeProvider(FluentThemeProviderProps)	Proveedor para aplicar un tema fluent en los componentes de react 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 de 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 mensajes nuevos o antiguos y personalizar iconos & controles dentro del subproceso de chat.
MicrophoneButton(MicrophoneButtonProps)	Un 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 estado, 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. Este `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 empieza 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. Use para convertir un HTMLElement devuelto por la API de llamada sin encabezado en un componente que se puede representar como un VideoTile.
TypingIndicator(TypingIndicatorProps)	Componente para notificar al usuario local cuando uno o varios participantes del 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 para un solo participante de llamada. Use con gridLayout de en un VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Cree una CallAdapter respaldada 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 de mediante el 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 conectar a la CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	Cree una CallWithChatAdapter mediante el 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 de mediante el 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 las repeticiones cuando se usa como propiedades para los componentes de React.
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 los <xref:%40azure%2Fcommunication-calling%23DeviceManager> y <xref:%40azure%2Fcommunication-calling%23CallAgent> y <xref:%40azure%2Fcommunication-calling%23Call> (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 forma 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 un <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 ver 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. De forma 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 ver 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. Al igual que crearAzureCommunicationChatAdapter, 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 ver ejemplos de uso típicos.
useCall()	Enlace para 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 para 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 para 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 componentes de chat: chatClientProvider y chatThreadClientProvider. Para llamar a componentes: CallClientProvider, callAgentProvider y CallAgentProvider. El uso más sencillo de un componente es similar al siguiente: de ejemplo de `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()	Enlace de React para acceder al tema

Detalles de la función

CallAgentProvider(CallAgentProviderProps)

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

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

function CallAgentProvider(props: CallAgentProviderProps): Element

Parámetros

props: CallAgentProviderProps

Devoluciones

Element

CallClientProvider(CallClientProviderProps)

Un <xref:React.Context> que almacena un 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)

Un compuesto de interfaz de usuario personalizable para la experiencia de llamada.

function CallComposite(props: CallCompositeProps): Element

Parámetros

props: CallCompositeProps

Devoluciones

Element

Comentarios

La llamada a ancho y 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 en 16px)

CallProvider(CallProviderProps)

Un <xref:React.Context> que almacena un <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)

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)

Un <xref:React.Context> que almacena un 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)

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

function ChatComposite(props: ChatCompositeProps): Element

Parámetros

props: ChatCompositeProps

Devoluciones

Element

Comentarios

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

ChatThreadClientProvider(ChatThreadClientProviderProps)

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

Los componentes de chat de este paquete se deben encapsular 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, CameraButtono 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 de .

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 de para que se puedan localizar. Los errores activos se seleccionan mediante activeErrorMessages.

Este componente realiza un seguimiento interno descartado 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> elemento de interfaz de usuario.

function ErrorBar(props: ErrorBarProps): Element

Parámetros

props: ErrorBarProps

Devoluciones

Element

FluentThemeProvider(FluentThemeProviderProps)

Proveedor para aplicar un tema fluent en los componentes de react de esta biblioteca.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parámetros

props: FluentThemeProviderProps

Devoluciones

Element

Comentarios

Los componentes de esta biblioteca se componen principalmente de interfaz de usuario de Fluent, controles y también de controles northstar de Fluent React. 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 de 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 de 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 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 componente de MessageThread. Los usuarios también pueden personalizar MessageThread pasando su propio avatar, icono de MessageStatusIndicator, JumpToNewMessageButton, LoadPreviousMessagesButton y el comportamiento de estos controles.

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

Devoluciones

Element

MicrophoneButton(MicrophoneButtonProps)

Un 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 estado, 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. Este 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 empieza 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.

Use para convertir un HTMLElement devuelto por la API de llamada sin encabezado en un componente que se puede representar como un 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 del 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 para un solo participante de llamada.

Use con gridLayout de en un VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parámetros

props: VideoTileProps

Devoluciones

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Cree una CallAdapter respaldada 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 de mediante el 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 conectar a la CallWithChatComposite.

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

Parámetros

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

Devoluciones

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Cree una CallWithChatAdapter mediante el 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 de mediante el 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 las repeticiones cuando se usa como propiedades para los componentes de React.

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 los <xref:%40azure%2Fcommunication-calling%23DeviceManager> y <xref:%40azure%2Fcommunication-calling%23CallAgent> y <xref:%40azure%2Fcommunication-calling%23Call> (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 forma 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 un <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 ver 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.

De forma 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 ver 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.

Al igual que crearAzureCommunicationChatAdapter, 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 ver 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 para 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 para 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 para 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 componentes de chat: chatClientProvider y chatThreadClientProvider.
Para llamar a componentes: CallClientProvider, callAgentProvider y CallAgentProvider.

El uso más sencillo de un componente es similar al siguiente:

de ejemplo de

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

Enlace de React 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