@azure/communication-react package
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
| AcceptedTransfer |
Transferir el estado de la característica |
| ActiveErrorMessage |
Mensajes de error activos que se van a mostrar a través de ErrorBar. |
| ActiveNotification |
Las notificaciones activas se mostrarán a través de NotificationStack. |
| AdapterError |
Error notificado a través de eventos de error y almacenado en estado del adaptador. |
| AdapterNotification |
Notificación del estado del cliente de llamada almacenado en el estado del adaptador. |
| AdapterState |
Funcionalidad para interactuar con el estado del adaptador compuesto. |
| AttachmentMetadata |
Modelo de datos que representa un archivo adjunto de mensaje de chat donde contiene un ID para identificar de forma única los datos adjuntos, un nombre que representa el nombre del archivo y una dirección URL para descargar los datos adjuntos. |
| 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. |
| BreakoutRoomsState |
Estado de las salas para grupos pequeños |
| 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. |
| CallCompositeLoaderProps |
Props para OutboundCallComposite que puedes usar en tu aplicación. Contiene dos opciones de bolsas:
|
| CallCompositeProps |
Accesorios para CallComposite. |
| CallCompositeStrings |
Cadenas usadas por el CallComposite directamente. Estas cadenas se agregan a las usadas por los componentes de la biblioteca de componentes. |
| CallFeatureStreamState |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Representa el estado del flujo de características de llamada. |
| CallInfoState |
Estado para realizar un seguimiento de los tipos <xref:CallInfo> y <xref:TeamsCallInfo> |
| CallNotification | |
| 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. |
| CallSurveyImprovementSuggestions |
Representa la parte de sugerencia de mejora de la encuesta de llamadas. |
| 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. |
| CallWithChatCompositeLoaderProps |
Props para CallWithChatComposite que puedes usar en tu aplicación. Contiene dos opciones de bolsas:
|
| 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 |
Opciones de personalización para la barra de control en la experiencia de llamadas con chat. |
| 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 |
Paleta de temas Fluent personalizada que se utiliza 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 |
| CapabilitiesFeatureState |
Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature> |
| CapabilityChangedNotificationStrings |
Cadenas para la notificación de cambio de capacidad |
| CaptionLanguageStrings |
Cadenas de idioma de subtítulos para la configuración modal de subtítulos |
| CaptionsBannerProps |
SubtítulosAccesorios de componentes de banner. |
| CaptionsBannerStrings |
Cadenas para banner de subtítulos |
| CaptionsCallFeatureState | |
| CaptionsInfo | |
| CaptionsSettingsModalProps |
CaptionsSettingsProps de componentes modales. |
| CaptionsSettingsModalStrings |
Cadenas para la configuración modal de subtítulos |
| ChatAdapterSubscribers |
Eventos compuestos de chat a los que se puede suscribir. |
| ChatAdapterThreadManagement |
Funcionalidad para administrar el subproceso de chat actual. |
| ChatCompositeLoaderProps |
Props para el ChatComposite que puede usar en su aplicación. Contiene las opciones para ChatCompositeChatCompositeOptions. |
| ChatCompositeProps |
Accesorios para 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. |
| ConferencePhoneInfo |
Información para la información del teléfono de conferencia |
| 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. |
| CustomCallControlButtonCallbackArgs |
Argumentos para CustomCallControlButtonCallback. |
| CustomCallControlButtonProps |
Respuesta de CustomCallControlButtonCallback. Incluye las propiedades base necesarias para representar un ControlBarButton o <xref:DrawerMenuItem>. |
| CustomCallControlButtonStrings |
Cadenas para CustomCallControlButtons |
| 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>. |
| DialpadProps |
Accesorios para el componente Dialpad . |
| DialpadStrings |
Cadenas de teclado de marcado que se pueden anular. |
| DialpadStyles |
Estilos para el componente Teclado de marcado . |
| Disposable |
Funcionalidad para eliminar correctamente un compuesto. |
| DtmfDialPadOptions |
Opciones para determinar el comportamiento de representación de dtmfDialer en CallComposite |
| 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. |
| HoldButtonProps | |
| HoldButtonStrings |
Cadenas para las etiquetas del botón de retención |
| HorizontalGalleryStyles |
<xref:HorizontalGallery> estilos de componentes. |
| ImageOverlayProps |
Accesorios para ImageOverlay. |
| ImageOverlayStrings |
Cadenas de ImageOverlay que se pueden invalidar. |
| IncomingCallNotificationProps |
Propiedades del componente de notificación de llamadas entrantes. |
| IncomingCallNotificationStrings |
Cadenas para el componente de notificación de llamadas entrantes. |
| IncomingCallNotificationStyles |
Estilos para el componente de notificación de llamadas entrantes. |
| IncomingCallStackCall |
Representa una llamada entrante activa. |
| IncomingCallStackProps |
Props para el componente IncomingCallManager. |
| 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. |
| InlineImage |
Estado de InlineImage, tal como se refleja en la interfaz de usuario. |
| InlineImageOptions |
Opciones para mostrar la imagen en línea en el escenario de imagen en línea. |
| JoinCallOptions |
Opciones para configurar el estado del micrófono y la cámara al unirse a una llamada true = encender el dispositivo al unirse a la llamada false = apagar el dispositivo al unirse a la llamada 'keep'/undefined = retener el estado previo a la llamada de los dispositivos |
| JumpToNewMessageButtonProps |
Argumentos para <xref:MessageThreadProps.onRenderJumpToNewMessageButton>. |
| LocalVideoCameraCycleButtonProps | |
| LocalVideoStreamState |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>. |
| LocalVideoStreamVideoEffectsState |
Versión de solo estado de un <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>archivo . |
| LocalVideoTileOptions |
Opciones para el icono de vídeo local en el compuesto de llamadas. |
| MediaAccessState |
Estado de acceso a los medios |
| MediaDiagnosticsState |
Proxy de solo estado para <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>. |
| MeetingConferencePhoneInfoModalStrings |
Cadenas para el modal de información del teléfono |
| MessageCommon |
Propiedades comunes de todos los tipos de mensajes. |
| MessageStatusIndicatorProps |
Props para MessageStatusIndicator. |
| MessageStatusIndicatorStrings |
Cadenas de messageStatusIndicator que se pueden invalidar. |
| MessageThreadStrings | |
| 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>. |
| NotificationOptions |
Opciones para controlar las notificaciones en el compuesto. |
| NotificationProps |
Accesorios para la notificación. |
| NotificationStackProps |
Props para NotificationStack. |
| NotificationStackStrings |
Todas las cadenas que se pueden mostrar en la interfaz de usuario de NotificationStack. |
| NotificationStrings |
Todas las cadenas que se pueden mostrar en la interfaz de usuario en la notificación. |
| NotificationStyles |
Estilos para el componente de notificación. |
| OptimalVideoCountFeatureState |
Versión de solo estado de la función <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>de recuento de vídeo óptimo . |
| OptionsDevice |
Un dispositivo, por ejemplo, cámara, micrófono o altavoz, en la DispositivosButton control flotante. |
| OutboundCallCompositeLoaderProps |
Props para OutboundCallComposite que puedes usar en tu aplicación. Contiene dos opciones de bolsas:
|
| PPTLiveCallFeatureState |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient escuchará automáticamente pptLive en la llamada y actualizará el estado expuesto por StatefulCallClient en consecuencia. |
| 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 ParticipantListParticipantItem. |
| ParticipantListStyles |
Estilos del ParticipantList. |
| ParticipantRemovedSystemMessage |
Mensaje del sistema que notifica que un participante se quitó del subproceso de chat. |
| ParticipantsButtonContextualMenuStyles | |
| ParticipantsButtonProps |
Propiedades para ParticipantsButton. |
| ParticipantsButtonStrings |
Cadenas de ParticipantsButton que se pueden invalidar. |
| ParticipantsButtonStyles |
Propiedades de estilos para ParticipantesButton. |
| RaiseHandButtonProps |
Accesorios para RaiseHandButton. |
| RaiseHandButtonStrings |
Cadenas de RaiseHandButton que se pueden invalidar. |
| RaiseHandCallFeature |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient escuchará automáticamente las manos levantadas en la llamada y actualizará el estado expuesto por StatefulCallClient en consecuencia. |
| ReactionButtonProps |
Accesorios para ReactionButton. |
| ReactionButtonStrings |
Cadenas de ReactionButton que se pueden invalidar. |
| ReactionResources |
Interfaz para animación, sprite, imagen y metadatos relacionados |
| RealTimeTextCallFeatureState | |
| RealTimeTextInfo | |
| RealTimeTextModalProps |
Proposiciones del componente RealTimeTextModal. |
| RealTimeTextModalStrings |
strings para el modal realTimeText |
| RealTimeTextProps |
Accesorios para una sola línea de RealTimeText. |
| RealTimeTextStrings |
Cuerdas para RTT |
| 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>. |
| RemoteVideoTileMenuOptions |
Opciones de menú para mosaicos de vídeo remotos en VideoGallery. |
| 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>. |
| SpokenLanguageStrings |
Cadenas de idioma hablado para la configuración modal de subtítulos |
| SpotlightCallFeatureState |
Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature> |
| SpotlightPromptStrings |
Cadenas utilizadas en el mensaje relacionado con el foco |
| SpotlightState |
Estado de foco con orden |
| StartCaptionsAdapterOptions |
Opciones pasadas a adapter.startCaptions |
| StartCaptionsButtonProps | |
| StartCaptionsButtonStrings |
Cadenas para las etiquetas del botón de retención |
| StartRealTimeTextButtonProps |
Propiedades para el componente StartRealTimeTextButton |
| StartRealTimeTextButtonStrings |
Cadenas para las etiquetas del botón de retención |
| 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:
|
| 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>. |
| StopCaptionsAdapterOptions |
Opciones pasadas a adapter.stopCaptions |
| StreamMediaProps |
Propiedades de StreamMedia. |
| SurveyIssues |
Textos correspondientes a cada número de convocatoria |
| SurveyIssuesHeadingStrings |
Textos correspondientes a cada categoría de emisión de la convocatoria |
| SystemMessageCommon |
Propiedades comunes de todos los mensajes del sistema. |
| TeamsCallAdapter |
Una interfaz de adaptador específica para la identidad de Teams que extiende CommonCallAdapter. |
| TeamsCallingHandlers |
Objeto que contiene todos los controladores de llamadas de equipos 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. |
| TeamsIncomingCallState |
Versión solo de estado de <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> |
| TogetherModeCallFeatureState |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Representa el estado de la característica Modo Juntos. |
| TogetherModeSeatingPositionState |
Solo versión de estado de <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>. Representa la posición de asiento de un participante en el modo Juntos. |
| TogetherModeStreamOptions |
Interfaz que representa el resultado de una vista de flujo en modo conjunto. |
| TogetherModeStreamViewResult |
Interfaz que representa el resultado de una vista de flujo en modo conjunto. |
| TogetherModeStreamsState |
Representa las secuencias en modo Juntos. |
| 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. |
| TransferFeature |
Transferir el estado de la característica |
| TypingIndicatorProps |
Props para TypingIndicator. |
| TypingIndicatorStrings | |
| TypingIndicatorStylesProps |
Estilos fluent para typingIndicator. |
| VerticalGalleryControlBarStyles |
Estilos de la barra de control dentro del componente VerticalGallery |
| VerticalGalleryStrings |
Cadenas para la localización de la galería vertical. |
| VerticalGalleryStyles |
Estilos para el componente VerticalGallery |
| VideoBackgroundBlurEffect |
Contiene los atributos del efecto de fondo de video borroso |
| VideoBackgroundImage |
Contiene los atributos de una imagen de fondo como url, nombre, etc. |
| VideoBackgroundNoEffect |
Contiene los atributos para eliminar el efecto de fondo del video |
| VideoBackgroundReplacementEffect |
Contiene los atributos de un efecto de fondo de video de reemplazo seleccionado |
| VideoGalleryLocalParticipant |
Estado del participante local en el VideoGallery. |
| 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. |
| VideoGalleryTogetherModeSeatingInfo |
Interfaz que representa la información de los asientos en el modo Juntos. |
| VideoGalleryTogetherModeStreams |
Interfaz que representa los flujos en modo conjunto. |
| 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 statefulCallClientcreateView y quitada por disposeView. |
| VideoTileContextualMenuProps |
Propiedades para mostrar el menú contextual de los componentes remotos de VideoTile en VideoGallery. |
| VideoTileDrawerMenuProps |
Propiedades para mostrar el menú del cajón en el toque largo de VideoTile remoto en VideoGallery. |
| VideoTileProps |
Propiedades de VideoTile. |
| VideoTileStrings |
Cadenas de VideoTile que se pueden invalidar. |
| VideoTileStylesProps |
Estilos fluent para VideoTile. |
| VideoTilesOptions |
Opciones que se aplican a todos los mosaicos de vídeo de VideoGallery |
Alias de tipos
| AdapterErrors |
Los adaptadores almacenan el error más reciente para cada operación en estado.
|
| AdapterNotifications |
Los adaptadores almacenan la notificación más reciente para cada destino. |
| 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: |
| AzureCommunicationCallAdapterOptions |
Parámetros opcionales para crear useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) |
| AzureCommunicationCallWithChatAdapterArgs |
Argumentos para createAzureCommunicationCallWithChatAdapter |
| AzureCommunicationCallWithChatAdapterFromClientArgs |
Argumentos de <xref:createAzureCommunicationCallWithChatAdapterFromClient> |
| AzureCommunicationChatAdapterArgs |
Argumentos para crear la implementación de Azure Communication Services de ChatAdapter. |
| AzureCommunicationOutboundCallAdapterArgs |
Argumentos para crear la implementación de Azure Communication Services de CallAdapter. Estos argumentos se utilizan para crear escenarios de llamadas salientes. Nota: |
| 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:
|
| CallFeatureStreamName |
Representa el nombre de la secuencia de características de llamada |
| CallIdChangedListener |
Devolución de llamada para CallAdapterSubscribers evento "callIdChanged". |
| CallNotifications | |
| 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. |
| CallingHandlersOptions |
Opciones de configuración para incluir la dependencia de fondo del efecto de vídeo. |
| CallingReturnProps |
Tipo auxiliar para usePropsFor. |
| CallingSounds |
Tipo para representar un conjunto de sonidos que se van a usar para diferentes eventos de llamada |
| CameraButtonSelector |
Tipo de selector para componente CameraButton. |
| CancelEditCallback |
La función de devolución de llamada se ejecuta cuando se cancela la edición de un mensaje. |
| CapabilitiesChangedListener |
Devolución de llamada para el evento 'capabilitiesChanged' de CallAdapterSubscribers . |
| CaptionSettingsSelector |
Tipo de selector de componentes para cambiar el idioma de los subtítulos y el idioma hablado |
| CaptionsBannerSelector |
Tipo de selector para el componente CaptionsBanner . |
| CaptionsInformation |
Información requerida para cada línea de subtítulo |
| CaptionsOptions |
Bolsa de opciones para iniciar subtítulos |
| CaptionsReceivedListener |
Devolución de llamada para el evento 'captionsReceived' de CallAdapterSubscribers . |
| ChatAdapter |
interfaz del adaptador de ChatComposite. |
| ChatAdapterOptions |
Opciones para configurar el ChatAdapter. |
| ChatAdapterState |
estado de chatAdapter. |
| ChatAdapterUiState |
estado de chatAdapter con fines de interfaz de usuario puros. |
| ChatAttachmentType |
Representa el tipo de archivo adjunto |
| 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. |
| ChatInitializedListener |
Devolución de llamada para <xref:CallWithChatAdapterSubscribers> el evento 'chatInitialized'. |
| 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. |
| ChatProfile |
El perfil de un usuario o bot. |
| 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 |
| CommonCallAdapterOptions |
Parámetros opcionales comunes para crear useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) o TeamsCallAdapter |
| CommonCallControlOptions |
Opciones de personalización de la barra de control en la experiencia de llamada. |
| 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. |
| ComponentSlotStyle |
ComponentSlotStyle es un @fluentui/react-northstar tipo. A medida que nos hemos alejado de este paquete, hemos utilizado el tipo IRawStyle más genérico de fluent para la interoperabilidad. |
| 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. |
| CreateDefaultCallingHandlers |
Tipo de createDefaultCallingHandlers. |
| CreateViewResult |
Devuelve el resultado de createView. |
| CustomAvatarOptions |
Opciones que se pueden insertar en la función |
| CustomCallControlButtonCallback |
Una devolución de llamada que devuelve las propiedades para representar un ControlBarButton y <xref:DrawerMenuItem>un archivo . La respuesta indica dónde se debe colocar el botón personalizado. Sugerencia de rendimiento: Esta devolución de llamada solo se llama cuando la devolución de llamada o sus argumentos cambian. |
| CustomCallControlButtonPlacement |
Ubicación de un botón personalizado inyectado en el <xref:CommonCallControlBar>archivo . 'primary': Coloque los botones en el extremo derecho de la barra de control central, pero antes del EndCallButton (extremo izquierdo en el modo rtl). 'overflow': Coloque los botones al final del menú de desbordamiento. 'secondary': Coloque los botones en el extremo izquierdo de la barra de control lateral (derecha en el modo rtl). Varios botones a los que se les asigna la misma ubicación se anexan en orden. Por ejemplo, si se colocan dos botones en 'secundario', ambos aparecerán en el extremo izquierdo (extremo derecho en modo rtl) en el orden proporcionado. Solo la ubicación "principal" funciona cuando el control de llamadas heredado está habilitado en la composición de llamadas |
| DeclarativeCallAgent |
|
| DeclarativeTeamsCallAgent |
|
| DeepNoiseSuppressionEffectDependency |
Tipo de dependencia que se va a inyectar para la supresión profunda del ruido |
| 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". |
| DialpadMode |
Modos del componente del teclado de marcado. |
| DisplayNameChangedListener |
Devolución de llamada para CallAdapterSubscribers evento "displayNameChanged". |
| DtmfTone |
Tono DTMF para llamadas RTC. |
| 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. |
| HoldButtonSelector |
Tipo de selector para el componente HoldButton . |
| IncomingCallManagement |
Contiene una matriz de solo lectura que devuelve todos los |
| IncomingCallStackSelector |
Selector para obtener las llamadas entrantes activas y eliminadas. |
| IsCaptionLanguageChangedListener |
Devolución de llamada para el evento 'isCaptionLanguageChanged' de CallAdapterSubscribers . |
| IsCaptionsActiveChangedListener |
Devolución de llamada para el evento 'isCaptionsActiveChanged' de CallAdapterSubscribers . |
| 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". |
| IsSpokenLanguageChangedListener |
Devolución de llamada para el evento 'isSpokenLanguageChanged' de CallAdapterSubscribers . |
| LoadingState |
Indica si la secuencia se está cargando o no. |
| LocalScreenShareView | |
| LocalVideoTileSize |
Diferentes modos del mosaico de video local |
| LocalizationProviderProps |
Propiedades de LocalizationProvider. |
| LongPressTrigger |
Modos de cómo se pueden mover los manipuladores de prensas largas. |
| MediaAccess |
Estado de acceso a los medios de audio/vídeo |
| MediaDiagnosticChangedEvent |
Carga de DiagnosticChangedEventListner donde hay un cambio en un diagnóstico multimedia. |
| Message |
Unión discriminada de todos los mensajes. El campo |
| MessageAttachedStatus |
Indica si se debe mostrar un mensaje de chat combinado con el mensaje antes o después de él.
Si |
| MessageContentType |
Tipos admitidos de contenido de mensajes de chat. |
| MessageDeletedListener |
Devolución de llamada para el evento ChatAdapterSubscribers 'messageDeleted'. |
| MessageEditedListener |
Devolución de llamada para el evento ChatAdapterSubscribers 'messageEdited'. |
| 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. |
| NotificationStackSelector |
Tipo de selector para el componente Notificación . |
| NotificationTarget | |
| NotificationType |
Todas las notificaciones que se pueden mostrar en NotificationStack. |
| OnFetchChatProfileCallback |
Función de devolución de llamada utilizada para proporcionar datos personalizados para crear un perfil para un usuario o bot. |
| OnFetchProfileCallback |
Función de devolución de llamada utilizada para proporcionar datos personalizados para crear un perfil para un usuario o bot. |
| OnRenderAvatarCallback |
Devolución de llamada representada personalizada que permite a los usuarios personalizar la representación de un componente de persona. |
| OverflowGalleryPosition |
Diferentes modos y posiciones de la galería de desbordamiento en la VideoGallery |
| 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". |
| Profile |
El perfil de un usuario o bot. |
| RaiseHandButtonSelector |
Tipo de selector para el componente RaiseHandButton . |
| RaisedHand |
Estado de la mano levantada con orden |
| RaisedHandState |
Estado de la mano levantada con orden |
| Reaction |
Estado de reacción con el tipo de reacción que se va a representar |
| ReactionButtonReaction |
Tipos de reacciones para el botón Reacción |
| ReactionSprite |
Tipo de imagen de sprite de animación y metadatos relacionados |
| ReactionState |
Versión de solo estado de con la aplicación auxiliar de interfaz de <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> usuario props receivedOn. Estado de reacción con una marca de tiempo que ayuda a la interfaz de usuario a decidir representar la reacción en consecuencia. |
| ReadReceiptsBySenderId |
Matriz de pares clave-valor que almacena el nombre para mostrar de cada remitente y el último mensaje de lectura |
| RealTimeTextInformation |
Información necesaria para cada línea de texto en tiempo real |
| RealTimeTextReceivedListener |
Devolución de llamada para el evento ' realTimeTextReceived' de CallAdapterSubscribers . |
| ResourceDetails |
Detalles necesarios para descargar un recurso en caché. |
| ResourceFetchResult |
Resultado del recurso descargado del cliente con estado |
| 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. |
| SoundEffect |
Tipo para representar un sonido personalizado que se va a usar para un evento de llamada |
| Spotlight |
Estado de foco con orden |
| SpotlightChangedListener |
Devolución de llamada para el evento 'spotlightChanged' de CallAdapterSubscribers . |
| StartCallIdentifier |
Tipos de identificador para iniciar una llamada mediante CallAdapter |
| StartCaptionsButtonSelector |
Tipo de selector para el componente StartCaptionsButton . |
| StatefulCallClientArgs |
Argumentos para construir StatefulCallClient. |
| StatefulCallClientOptions |
Opciones para construir StatefulCallClient con. |
| StatefulChatClientArgs |
Argumentos para construir el StatefulChatClient. |
| StatefulChatClientOptions |
Opciones para construir el StatefulChatClient de. |
| SupportedCaptionLanguage | |
| SupportedSpokenLanguage | |
| SystemMessage |
Unión discriminada de todos los mensajes del sistema. El campo |
| TeamsAdapterOptions |
Parámetros opcionales para crear TeamsCallAdapter |
| TeamsCallAdapterArgs |
Argumentos para crear la implementación de Azure Communication Services de TeamsCallAdapter. |
| TeamsCallAdapterArgsCommon |
Parte común de los argumentos para crear la implementación de Azure Communication Services de TeamsCallAdapter. |
| TeamsIncomingCallManagement |
Proxy de la <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> interfaz. |
| TogetherModeParticipantSeatingState |
Representa las posiciones de los asientos de los participantes en el modo Juntos. |
| TopicChangedListener |
Devolución de llamada para ChatAdapterSubscribers evento "topicChanged". |
| TransferAcceptedListener |
Devolución de llamada para el evento 'transferRequested' de CallAdapterSubscribers . |
| TypingIndicatorSelector |
Tipo de selector para componente de TypingIndicator. |
| UpdateMessageCallback |
La función callback se ejecuta cuando se actualiza un mensaje. |
| VideoBackgroundEffect |
Contiene los atributos de un efecto de fondo de vídeo seleccionado |
| VideoBackgroundEffectsDependency |
Tipo de dependencia que se va a insertar para los efectos de fondo de vídeo |
| VideoGalleryLayout | |
| VideoGalleryParticipant |
Estado de un participante en el VideoGallery. |
| VideoGallerySelector |
Tipo de selector para componente de VideoGallery. |
| VideoGalleryTogetherModeParticipantPosition |
Interfaz que representa la posición de un participante en el modo Juntos. |
| ViewScalingMode |
Modo de escalado de un VideoGalleryStream. |
Funciones
| Call |
Un <xref:React.Context> que almacena un <xref:%40azure%2Fcommunication-calling%23CallAgent>. La llamada a componentes de este paquete debe encapsularse con un CallAgentProvider. |
| Call |
Un <xref:React.Context> que almacena un StatefulCallClient. Las llamadas a componentes de este paquete se deben encapsular con un CallClientProvider. |
| Call |
Un compuesto de interfaz de usuario personalizable para la experiencia de llamada. |
| Call |
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. |
| Call |
CallWithChatComposite reúne componentes clave para proporcionar una llamada completa con experiencia de chat lista para usar. |
| Camera |
Botón para activar o desactivar la cámara. Se puede usar con ControlBar. |
| Captions |
Un componente para mostrar un CaptionsBanner con el icono de usuario, displayName y texto de subtítulos. |
| Captions |
Un componente para establecer idiomas hablados |
| Chat |
Un <xref:React.Context> que almacena un StatefulChatClient. Los componentes de chat de este paquete se deben encapsular con un ChatClientProvider. |
| Chat |
Una interfaz de usuario personalizable compuesta para la experiencia de chat. |
| Chat |
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. |
| Control |
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. |
| Control |
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. |
| Devices |
Botón para abrir un menú que controla las opciones del dispositivo. Se puede usar con ControlBar. |
| Dialpad(Dialpad |
Un componente que permite a los usuarios ingresar el número de teléfono haciendo clic en el teclado de marcación / usando el teclado Devolverá el componente vacío para compilaciones estables |
| End |
Un botón para finalizar una llamada en curso. Se puede usar con ControlBar. |
| Error |
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.
Usa <xref:%40fluentui%2Freact%23MessageBar> elemento de interfaz de usuario. |
| Fluent |
Proveedor para aplicar un tema fluent en los componentes de react de esta biblioteca. |
| Grid |
Componente para diseñar iconos de participantes de audio y vídeo en una llamada. |
| Hold |
Un botón para mantener o reanudar una llamada en curso. Se puede usar con ControlBar |
| Image |
Componente para renderizar un modal de pantalla completa para una imagen seleccionada. |
| Incoming |
Componente de notificación que se va a utilizar para representar las llamadas entrantes al usuario final. Permite al usuario aceptar o rechazar la llamada entrante. |
| Incoming |
Wrapper para gestionar múltiples llamadas entrantes |
| Localization |
Proveedor para proporcionar cadenas localizadas para los componentes de react de esta biblioteca. |
| Message |
Componente para mostrar el estado de un mensaje enviado. Agrega un icono y información sobre herramientas correspondiente al estado del mensaje. |
| Message |
|
| Microphone |
Un botón para activar o desactivar el micrófono. Se puede usar con ControlBar. |
| Notification(Notification |
Componente para mostrar mensajes de notificación en la interfaz de usuario. |
| Notification |
Un componente para mostrar notificaciones en la interfaz de usuario. Todas las cadenas que se pueden mostrar se aceptan como cadenas de para que se puedan localizar. Las notificaciones activas se seleccionan mediante activeNotifications. Este componente realiza un seguimiento interno descartado por el usuario.
|
| Participant |
Componente para representar un participante de llamada o chat. Muestra el avatar del participante, displayName y estado, así como iconos opcionales y menú contextual. |
| Participant |
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. |
| Participants |
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 |
| Raise |
Un botón para iniciar o detener el uso compartido de pantalla. Se puede usar con ControlBar. |
| Reaction |
Un botón para enviar reacciones. Se puede usar con ControlBar. |
| Real |
Un componente para mostrar una sola línea de RealTimeText |
| Real |
un componente para el modal realTimeText |
| Screen |
Un botón para iniciar o detener el uso compartido de pantalla. Se puede usar con ControlBar. |
| Send |
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. |
| Start |
Un botón para iniciar o detener subtítulos Se puede usar con ControlBar |
| Start |
un botón para iniciar RealTimeText según los requisitos de accesibilidad, el texto en tiempo real no se puede desactivar una vez que está activado Se puede usar con ControlBar |
| Stream |
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. |
| Typing |
Componente para notificar al usuario local cuando uno o varios participantes del subproceso de chat están escribiendo. |
| Video |
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. |
| Video |
Componente para representar la secuencia de vídeo para un solo participante de llamada. Use con gridLayout de en un VideoGallery. |
| create |
Cree una CallAdapter respaldada por Azure Communication Services. Esta es la implementación predeterminada de callAdapter proporcionada por esta biblioteca. Nota: |
| create |
Cree una CallAdapter respaldada por Azure Communication Services. Esta es la implementación predeterminada de callAdapter proporcionada por esta biblioteca. Nota: |
| create |
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. |
| create |
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. |
| create |
Cree un callWithChatAdapter respaldado por Azure Communication Services para conectar a la CallWithChatComposite. |
| create |
Cree una CallWithChatAdapter mediante el StatefulChatClient y StatefulCallClient proporcionados. Útil si desea mantener una referencia a StatefulChatClient y StatefulCallClient. Tenga en cuenta que chatThreadClient debe ser creado por StatefulChatClient a través de la API chatClient.getChatThreadClient(chatThreadId). Considere la posibilidad de usar createAzureCommunicationCallWithChatAdapter para una API más sencilla. |
| create |
Cree un ChatAdapter respaldado por Azure Communication Services. Esta es la implementación predeterminada de chatAdapter proporcionada por esta biblioteca. |
| create |
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. |
| create |
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. |
| create |
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. |
| create |
Cree la implementación predeterminada de TeamsCallingHandlers para la llamada de Teams. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| create |
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. |
| create |
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. |
| create |
|
| create |
Cree un TeamsCallAdapter mediante el StatefulCallClient proporcionado. Útil si desea mantener una referencia a StatefulCallClient. Considere la posibilidad de usar createAzureCommunicationCallAdapter para una API más sencilla. |
| from |
Operación inversa de toFlatCommunicationIdentifier. |
| get |
Obtiene el selector de un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| get |
Obtiene el selector de un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| load |
Loader para el CallComposite que se puede utilizar en la aplicación. Esta función cargará CallComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React. |
| load |
Props para CallWithChatComposite que puedes usar en tu aplicación. Esta función cargará CallWithChatComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React. |
| load |
Función de cargador para el ChatComposite que puede usar en su aplicación. Esta función cargará el ChatComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React. |
| load |
Loader para OutboundCallComposite que puede usar en la aplicación. Esta función cargará CallComposite en el elemento HTML proporcionado para realizar llamadas salientes. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React. |
| on |
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida. |
| on |
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida. |
| on |
Resolución de dependencias para efectos de fondo de vídeo. |
| on |
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida. |
| to |
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í
|
| use |
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. |
| use |
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. |
| use |
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. |
| use |
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. |
| use |
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. |
| use |
Enlace para obtener statefulCallClient del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| use |
Enlace para obtener StatefulChatClient del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| use |
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. |
| use |
Enlace para obtener StatefulDeviceManager del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| use |
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:
El uso más sencillo de un componente es similar al siguiente: de ejemplo de
|
| use |
Enlace para obtener un selector para un componente especificado. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| use |
Enlace para obtener <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall para usar este enlace |
| use |
Un enlace de React personalizado para simplificar la creación de TeamsCallAdapter. Similar a <xref:createTeamsAzureCommunicationCallAdapter>, 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. |
| use |
Enlace para obtener <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> del proveedor. Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca. |
| use |
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
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
CaptionsBanner(CaptionsBannerProps)
Un componente para mostrar un CaptionsBanner con el icono de usuario, displayName y texto de subtítulos.
function CaptionsBanner(props: CaptionsBannerProps): Element
Parámetros
- props
- CaptionsBannerProps
Devoluciones
Element
CaptionsSettingsModal(CaptionsSettingsModalProps)
Un componente para establecer idiomas hablados
function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element
Parámetros
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
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
Dialpad(DialpadProps)
Un componente que permite a los usuarios ingresar el número de teléfono haciendo clic en el teclado de marcación / usando el teclado Devolverá el componente vacío para compilaciones estables
function Dialpad(props: DialpadProps): Element
Parámetros
- props
- DialpadProps
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 Fluent UI, controles, mezcla de controles v8 y v9. Este proveedor controla la aplicación de cualquier tema proporcionado a los controles de interfaz de usuario de Fluent subyacentes. *
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
HoldButton(HoldButtonProps)
Un botón para mantener o reanudar una llamada en curso.
Se puede usar con ControlBar
function HoldButton(props: HoldButtonProps): Element
Parámetros
- props
- HoldButtonProps
Propiedades del botón de retención.
Devoluciones
Element
ImageOverlay(ImageOverlayProps)
Componente para renderizar un modal de pantalla completa para una imagen seleccionada.
function ImageOverlay(props: ImageOverlayProps): Element
Parámetros
- props
- ImageOverlayProps
Devoluciones
Element
IncomingCallNotification(IncomingCallNotificationProps)
Componente de notificación que se va a utilizar para representar las llamadas entrantes al usuario final. Permite al usuario aceptar o rechazar la llamada entrante.
function IncomingCallNotification(props: IncomingCallNotificationProps): Element
Parámetros
Devoluciones
Element
IncomingCallStack(IncomingCallStackProps)
Wrapper para gestionar múltiples llamadas entrantes
function IncomingCallStack(props: IncomingCallStackProps): Element
Parámetros
- props
- IncomingCallStackProps
<xref:IncomingCallManagerProps>
Devoluciones
Element
LocalizationProvider(LocalizationProviderProps)
Proveedor para proporcionar cadenas localizadas para los componentes de react de esta biblioteca.
function LocalizationProvider(props: LocalizationProviderProps): Element
Parámetros
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
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 utiliza internamente el Chat componente de @fluentui-contrib/chat. Puede consultar los detalles sobre estos componentes aquí.
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
Notification(NotificationProps)
Componente para mostrar mensajes de notificación en la interfaz de usuario.
function Notification(props: NotificationProps): Element
Parámetros
- props
- NotificationProps
Devoluciones
Element
NotificationStack(NotificationStackProps)
Un componente para mostrar notificaciones en la interfaz de usuario. Todas las cadenas que se pueden mostrar se aceptan como cadenas de para que se puedan localizar. Las notificaciones activas se seleccionan mediante activeNotifications.
Este componente realiza un seguimiento interno descartado por el usuario.
- Notificaciones que tienen una marca de tiempo asociada: la notificación se vuelve a mostrar en la interfaz de usuario si se produce después de descartarse.
- Notificaciones que no tienen una marca de tiempo: la notificación se descarta hasta que desaparece de las propiedades. Si la notificación se repite, se muestra en la interfaz de usuario.
function NotificationStack(props: NotificationStackProps): Element
Parámetros
- props
- NotificationStackProps
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
RaiseHandButton(RaiseHandButtonProps)
Un botón para iniciar o detener el uso compartido de pantalla.
Se puede usar con ControlBar.
function RaiseHandButton(props: RaiseHandButtonProps): Element
Parámetros
- props
- RaiseHandButtonProps
Devoluciones
Element
ReactionButton(ReactionButtonProps)
Un botón para enviar reacciones.
Se puede usar con ControlBar.
function ReactionButton(props: ReactionButtonProps): Element
Parámetros
- props
- ReactionButtonProps
Devoluciones
Element
RealTimeText(RealTimeTextProps)
Un componente para mostrar una sola línea de RealTimeText
function RealTimeText(props: RealTimeTextProps): Element
Parámetros
- props
- RealTimeTextProps
Devoluciones
Element
RealTimeTextModal(RealTimeTextModalProps)
un componente para el modal realTimeText
function RealTimeTextModal(props: RealTimeTextModalProps): Element
Parámetros
- props
- RealTimeTextModalProps
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
StartCaptionsButton(StartCaptionsButtonProps)
Un botón para iniciar o detener subtítulos
Se puede usar con ControlBar
function StartCaptionsButton(props: StartCaptionsButtonProps): Element
Parámetros
- props
- StartCaptionsButtonProps
para el botón Iniciar subtítulos.
Devoluciones
Element
StartRealTimeTextButton(StartRealTimeTextButtonProps)
un botón para iniciar RealTimeText según los requisitos de accesibilidad, el texto en tiempo real no se puede desactivar una vez que está activado
Se puede usar con ControlBar
function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element
Parámetros
para el botón RealTimeText de inicio.
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(args: AzureCommunicationCallAdapterArgs): Promise<CallAdapter>
Parámetros
Devoluciones
Promise<CallAdapter>
createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)
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(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>
Parámetros
Devoluciones
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)
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, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parámetros
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- targetCallees
- options
- CommonCallAdapterOptions
Devoluciones
Promise<CallAdapter>
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)
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, options?: CommonCallAdapterOptions): Promise<CallAdapter>
Parámetros
- callClient
- StatefulCallClient
- callAgent
- CallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
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. Tenga en cuenta que chatThreadClient debe ser creado por StatefulChatClient a través de la API chatClient.getChatThreadClient(chatThreadId). 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, ChatAdapterOptions)
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, chatAdapterOptions?: ChatAdapterOptions): Promise<ChatAdapter>
Parámetros
- chatClient
- StatefulChatClient
- chatThreadClient
- ChatThreadClient
- chatAdapterOptions
- ChatAdapterOptions
Devoluciones
Promise<ChatAdapter>
createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call, CallingHandlersOptions)
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, options?: CallingHandlersOptions): CallingHandlers
Parámetros
- callClient
- StatefulCallClient
- callAgent
-
undefined | CallAgent
- deviceManager
-
undefined | StatefulDeviceManager
- call
-
undefined | Call
- options
- CallingHandlersOptions
Devoluciones
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
createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })
Cree la implementación predeterminada de TeamsCallingHandlers para la llamada de Teams.
Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers
Parámetros
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- deviceManager
- StatefulDeviceManager
- call
- TeamsCall
- options
-
{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }
Devoluciones
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
Devoluciones
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
Parámetros
- options
- StatefulChatClientOptions
Devoluciones
createTeamsCallAdapter(TeamsCallAdapterArgs)
function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>
Parámetros
- args
- TeamsCallAdapterArgs
Devoluciones
Promise<TeamsCallAdapter>
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)
Cree un TeamsCallAdapter 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 createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>
Parámetros
- callClient
- StatefulCallClient
- callAgent
- TeamsCallAgent
- locator
- CallAdapterLocator
- options
- CommonCallAdapterOptions
Devoluciones
Promise<TeamsCallAdapter>
fromFlatCommunicationIdentifier(string)
Operación inversa de toFlatCommunicationIdentifier.
function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier
Parámetros
- id
-
string
Devoluciones
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>
loadCallComposite(CallCompositeLoaderProps, HTMLElement)
Loader para el CallComposite que se puede utilizar en la aplicación. Esta función cargará CallComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React.
function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parámetros
- loaderArgs
- CallCompositeLoaderProps
- htmlElement
-
HTMLElement
Devoluciones
Promise<undefined | CallAdapter>
loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)
Props para CallWithChatComposite que puedes usar en tu aplicación. Esta función cargará CallWithChatComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React.
function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>
Parámetros
- loaderArgs
- CallWithChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Devoluciones
Promise<undefined | CallWithChatAdapter>
loadChatComposite(ChatCompositeLoaderProps, HTMLElement)
Función de cargador para el ChatComposite que puede usar en su aplicación. Esta función cargará el ChatComposite en el elemento HTML proporcionado. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React.
function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>
Parámetros
- loaderArgs
- ChatCompositeLoaderProps
- htmlElement
-
HTMLElement
Devoluciones
Promise<undefined | ChatAdapter>
loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)
Loader para OutboundCallComposite que puede usar en la aplicación. Esta función cargará CallComposite en el elemento HTML proporcionado para realizar llamadas salientes. El mejor caso de uso para esto es en un marco de interfaz de usuario de Node que no está basado en React.
function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>
Parámetros
- loaderArgs
- OutboundCallCompositeLoaderProps
- htmlElement
-
HTMLElement
Devoluciones
Promise<undefined | CallAdapter>
onResolveDeepNoiseSuppressionDependency()
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida.
function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>
Devoluciones
Promise<DeepNoiseSuppressionEffectDependency>
onResolveDeepNoiseSuppressionDependencyLazy()
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida.
function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>
Devoluciones
Promise<DeepNoiseSuppressionEffectDependency>
onResolveVideoEffectDependency()
Resolución de dependencias para efectos de fondo de vídeo.
function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>
Devoluciones
Promise<VideoBackgroundEffectsDependency>
onResolveVideoEffectDependencyLazy()
Resolución de dependencias para efectos de fondo de vídeo mediante carga diferida.
function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>
Devoluciones
Promise<VideoBackgroundEffectsDependency>
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 | AzureCommunicationOutboundCallAdapterArgs>, (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 | AzureCommunicationOutboundCallAdapterArgs>, afterCreate?: (adapter: CallAdapter) => Promise<CallAdapter>, beforeDispose?: (adapter: CallAdapter) => Promise<void>): undefined | CallAdapter
Parámetros
- 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
- 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
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
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
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)
useTeamsCall()
Enlace para obtener <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall para usar este enlace
function useTeamsCall(): undefined | TeamsCall
Devoluciones
undefined | TeamsCall
useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)
Un enlace de React personalizado para simplificar la creación de TeamsCallAdapter.
Similar a <xref:createTeamsAzureCommunicationCallAdapter>, 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 useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter
Parámetros
- args
-
Partial<TeamsCallAdapterArgs>
- afterCreate
-
(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>
- beforeDispose
-
(adapter: TeamsCallAdapter) => Promise<void>
Devoluciones
undefined | TeamsCallAdapter
useTeamsCallAgent()
Enlace para obtener <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent> del proveedor.
Resulta útil al implementar un componente personalizado que utiliza los proveedores exportados desde esta biblioteca.
function useTeamsCallAgent(): undefined | TeamsCallAgent
Devoluciones
undefined | TeamsCallAgent
useTheme()
Enlace de React para acceder al tema
function useTheme(): Theme
Devoluciones
Theme