@azure/communication-react package

Referência

Classes

CallError	Erro gerado a partir de métodos de API com falha com monitoração de estado.
ChatError	Erro gerado a partir de métodos StatefulChatClient com falha .

Interfaces

ActiveErrorMessage	Mensagens de erro ativas a serem mostradas através ErrorBar.
AdapterError	Erro reportado através de eventos de erro e armazenado no estado do adaptador.
AdapterState	Funcionalidade para interface com o estado do adaptador composto.
BaseCompositeProps	Propriedades comuns a todos os compósitos exportados desta biblioteca.
BaseCustomStyles	Adereços básicos de estilos fluentes para todos os componentes exportados a partir desta libray.
CallAdapter	Uma interface de adaptador específica para a identidade de Comunicação do Azure que se estende CommonCallAdapter.
CallAdapterCallManagement	Funcionalidade para gerenciar a chamada atual ou iniciar uma nova chamada
CallAdapterCallOperations	Funcionalidade para gerenciar a chamada atual.
CallAdapterDeviceManagement	Funcionalidade para gerenciar dispositivos em uma chamada.
CallAdapterSubscribers	Chame eventos compostos que podem ser assinados.
CallAgentProviderProps	Argumentos para inicializar um CallAgentProvider.
CallAgentState	A versão somente de estado do <xref:%40azure%2Fcommunication-calling%23CallAgent> exceto chamadas é movida para ser um filho diretamente de CallClientState e não está incluída aqui. O motivo para ter o estado do CallAgent por proxy é fornecer acesso a displayName. Não nivelamos o CallAgent.displayName e o colocamos em CallClientState porque seria ambíguo que displayName dependesse da criação/existência do CallAgent para estar disponível.
CallAndChatLocator	Os argumentos para uso no createAzureCommunicationCallWithChatAdapter ingressar em uma chamada com um thread de bate-papo associado.
CallClientProviderProps	Argumentos para inicializar um CallClientProvider.
CallClientState	Contêiner para todos os dados de estado por proxy por StatefulCallClient. Os estados calls, callsEnded, incomingCalls e incomingCallsEnded serão fornecidos automaticamente se um callAgent tiver sido criado. O deviceManager ficará vazio inicialmente até ser preenchido consulte DeviceManagerState. O estado userId é fornecido como uma conveniência para o desenvolvedor e é completamente controlado e definido pelo desenvolvedor.
CallCompositeProps	Props para CallComposite.
CallCompositeStrings	As cadeias de caracteres usadas pelo CallComposite diretamente. Essas cadeias de caracteres são adicionais às usadas pelos componentes da biblioteca de componentes.
CallProviderProps	Argumentos para inicializar um CallProvider.
CallState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recuperará automaticamente o estado da chamada e adicioná-lo-á ao estado exposto por StatefulCallClient.
CallWithChatAdapter	interface do adaptador de CallWithChatComposto.
CallWithChatAdapterManagement	Funcionalidade para gerenciar a chamada atual com chat.
CallWithChatAdapterState	O Estado CallWithChat é uma combinação de clientes Stateful Chat e Stateful Calling com algum estado específico apenas para o CallWithChat Composto.
CallWithChatAdapterSubscriptions	Eventos de chamada e bate-papo que podem ser inscritos no CallWithChatAdapter.
CallWithChatAdapterUiState	Estado da interface do usuário pertencente ao CallWithChatComposite.
CallWithChatClientState	Estado dos serviços de back-end que dirigem CallWithChatComposite.
CallWithChatCompositeProps	Adereços necessários para o CallWithChatComposite
CallWithChatCompositeStrings	As cadeias de caracteres usadas pelo CallWithChatComposite diretamente. Essas cadeias de caracteres são adicionais às usadas pelos componentes da biblioteca de componentes.
CallWithChatControlOptions	controles CallWithChatComposite Call para mostrar ou ocultar botões na barra de controle de chamada.
CallingHandlers	Objeto que contém todos os manipuladores necessários para chamar componentes. Chamar componentes relacionados deste pacote é capaz de selecionar manipuladores relevantes deste objeto. Consulte <xref:useHandlers> e usePropsFor.
CallingTheme	Palete de tema Fluent personalizada usada chamando componentes relacionados nesta biblioteca.
CameraButtonContextualMenuStyles	Estilos para o menu CameraButton.
CameraButtonProps	Props para componente CameraButton.
CameraButtonStrings	Strings de CameraButton que podem ser substituídas.
CameraButtonStyles	Estilos para CameraButton
ChatAdapterSubscribers	Eventos compostos de bate-papo que podem ser inscritos.
ChatAdapterThreadManagement	Funcionalidade para gerenciar o thread de bate-papo atual.
ChatCompositeProps	Props para ChatComposite.
ChatCompositeStrings	As cadeias de caracteres usadas pelo ChatComposite diretamente. Essas cadeias de caracteres são adicionais às usadas pelos componentes da biblioteca de componentes.
ChatMessage	Uma mensagem de chat.
CommonCallAdapter	interface do adaptador de CallComposto.
CommonCallingHandlers	Objeto que contém todos os manipuladores necessários para chamar componentes. Chamar componentes relacionados deste pacote é capaz de selecionar manipuladores relevantes deste objeto. Consulte <xref:useHandlers> e usePropsFor.
ComponentLocale	Informações de localidade para todos os componentes exportados desta biblioteca.
ComponentStrings	Strings usadas por todos os componentes exportados desta biblioteca.
CompositeLocale	Informações de localidade para todos os compósitos exportados desta biblioteca.
CompositeStrings	Strings usadas diretamente nos compósitos. Essas cadeias de caracteres são usadas pelos compósitos diretamente, em vez de pelos componentes contidos.
ContentSystemMessage	Uma mensagem do sistema com conteúdo arbitrário.
ControlBarButtonProps	Props para ControlBarButton.
ControlBarButtonStrings	Cadeias de caracteres de ControlBarButton que podem ser substituídas.
ControlBarProps	Props para ControlBar.
CreateVideoStreamViewResult	Objeto retornado após a criação de um VideoStream local ou remoto. Isso contém funções auxiliares para manipular a renderização do fluxo.
CustomMessage	Um tipo de mensagem personalizada. As mensagens personalizadas não são renderizadas por padrão, mas os aplicativos podem fornecer renderizadores personalizados para elas.
DevicesButtonContextualMenuStyles	Estilos para o menu DevicesButton.
DevicesButtonProps	Props para DevicesButton.
DevicesButtonStrings	Strings de DevicesButton que podem ser substituídas.
DevicesButtonStyles	Estilos para os itens de menu do botão Dispositivos.
DiagnosticsCallFeatureState	Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable	Funcionalidade para descartar corretamente um composto.
EndCallButtonProps	Props para EndCallButton.
EndCallButtonStrings	Cadeias de caracteres de EndCallButton que podem ser substituídas.
ErrorBarProps	Props para ErrorBar. Além do seguinte, ErrorBar encaminha todos os <xref:%40fluentui%2Freact%23IMessageBarProps> para o <xref:%40fluentui%2Freact%23MessageBar>subjacente.
ErrorBarStrings	Todas as cadeias de caracteres que podem ser mostradas na interface do usuário no ErrorBar.
FluentThemeProviderProps	Props para FluentThemeProvider.
GridLayoutProps	Props para GridLayout.
GridLayoutStyles	GridLayout estilos de componentes.
HorizontalGalleryStyles	<xref:HorizontalGallery> Estilos de componentes.
IncomingCallState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detetará automaticamente chamadas de entrada e adicionará seu estado ao estado exposto por StatefulCallClient.
JumpToNewMessageButtonProps	Argumentos a favor <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState	Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.
MessageCommon	Propriedades comuns de todos os tipos de mensagem.
MessageStatusIndicatorProps	Props para MessageStatusIndicator.
MessageStatusIndicatorStrings	Cadeias de caracteres de MessageStatusIndicator que podem ser substituídas.
MessageThreadStrings	Cadeias de caracteres de MessageThread que podem ser substituídas.
MessageThreadStyles	Estilos fluentes para MessageThread.
MicrophoneButtonContextualMenuStyles	Estilos para o menu MicrophoneButton.
MicrophoneButtonProps	Props para MicrophoneButton.
MicrophoneButtonStrings	Strings de MicrophoneButton que podem ser substituídas.
MicrophoneButtonStyles	Estilos para MicrophoneButton
NetworkDiagnosticsState	Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.
OptionsDevice	Um dispositivo, por exemplo, câmera, microfone ou alto-falante, no submenu DevicesButton.
ParticipantAddedSystemMessage	Uma mensagem do sistema notificando que um participante foi adicionado ao tópico de bate-papo.
ParticipantItemProps	Props para ParticipantItem.
ParticipantItemStrings	Cadeias de caracteres de ParticipantItem que podem ser substituídas.
ParticipantItemStyles	Estilos fluentes para ParticipantItem.
ParticipantListItemStyles	Estilos para o ParticipantList ParticipantItem.
ParticipantListStyles	Estilos para o ParticipantList.
ParticipantRemovedSystemMessage	Uma mensagem do sistema notificando que um participante foi removido do tópico de bate-papo.
ParticipantsButtonContextualMenuStyles	Estilos para o menu ParticipantsButton.
ParticipantsButtonProps	Props para ParticipantsButton.
ParticipantsButtonStrings	Strings of ParticipantsButton que podem ser substituídas.
ParticipantsButtonStyles	Estilos Props para participantesButton.
RecordingCallFeature	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient escutará automaticamente o estado de gravação da chamada e atualizará o estado exposto por StatefulCallClient de acordo.
RemoteParticipantState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recuperará automaticamente RemoteParticipants e adicionará seu estado ao estado exposto por StatefulCallClient.
RemoteVideoStreamState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps	Props para ScreenShareButton.
ScreenShareButtonStrings	Cadeias de caracteres de ScreenShareButton que podem ser substituídas.
SendBoxProps	Props para SendBox.
SendBoxStrings	Strings de SendBox que podem ser substituídas.
SendBoxStylesProps	Estilos fluentes para <xref:Sendbox>.
StatefulCallClient	Define os métodos que permitem que o CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> seja usado com monitoração de estado. A interface fornece acesso ao estado proxy e também permite registrar um manipulador para eventos de alteração de estado. Para obter a definição de estado, consulte CallClientState. Os eventos de alteração de estado são impulsionados por: Dados retornados de <xref:%40azure%2Fcommunication-calling%23DeviceManager> APIs. Dados retornados de <xref:%40azure%2Fcommunication-calling%23CallAgent> APIs. Ouvintes automaticamente anexados a vários objetos de chamada de comunicação do Azure: CallAgent 'incomingCall' CallAgent 'chamadasAtualizado' DeviceManager 'videoDevicesUpdated' DeviceManager 'audioDevicesUpdated DeviceManager 'selectedMicrophoneChanged' DeviceManager 'selectedSpeakerChanged' Chamar 'stateChanged' Chamada 'idChanged' Chamada 'isMutedChanged' Chamada 'isScreenSharingOnChanged' Ligue para 'remoteParticipantsUpdated' Ligue para 'localVideoStreamsUpdated' IncomingCall 'callEnded' RemoteParticipant 'stateChanged' RemoteParticipant 'isMutedChanged' RemoteParticipant 'displayNameChanged' RemoteParticipant 'isSpeakingChanged' RemoteParticipant 'videoStreamsUpdated' RemoteVideoStream 'isAvailableChanged' TranscriptionCallFeature 'isTranscriptionActiveChanged' RecordingCallFeature 'isRecordingActiveChanged'
StatefulChatClient	Define os métodos que permitem que {@Link @azure/communication-chat#ChatClient} seja usado com um estado gerado centralizado. A interface fornece acesso ao estado proxy e também permite registrar um manipulador para eventos de alteração de estado.
StatefulDeviceManager	Define os métodos adicionais adicionados pelo stateful sobre <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps	Props para StreamMedia.
SystemMessageCommon	Propriedades comuns de todas as mensagens do sistema.
TopicUpdatedSystemMessage	Uma mensagem do sistema notificando que o tópico do thread de bate-papo foi atualizado.
TranscriptionCallFeature	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient escutará automaticamente o estado de transcrição da chamada e atualizará o estado exposto por StatefulCallClient de acordo.
TypingIndicatorProps	Props para TypingIndicator.
TypingIndicatorStrings	Strings de TypingIndicator que podem ser substituídas.
TypingIndicatorStylesProps	Estilos fluentes para TypingIndicator.
VideoGalleryProps	Props para VideoGallery.
VideoGalleryRemoteParticipant	O estado de um participante remoto na VideoGallery.
VideoGalleryStream	Fluxo de vídeo de um participante VideoGallery.
VideoGalleryStrings	Todas as cadeias de caracteres que podem ser mostradas na interface do usuário no VideoGallery.
VideoGalleryStyles	VideoGallery estilos de componentes.
VideoStreamOptions	Opções para controlar como os fluxos de vídeo são renderizados.
VideoStreamRendererViewState	Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Essa propriedade é adicionada ao estado exposto por StatefulCallClient pelo createView e removida por disposeView.
VideoTileProps	Props para VideoTile.
VideoTileStylesProps	Estilos fluentes para VideoTile.

Aliases de Tipo

AdapterErrors	Adaptadores armazena o erro mais recente para cada operação no estado. `target` é uma cadeia de caracteres definida pelo adaptador para cada operação exclusiva executada pelo adaptador.
AreEqual	Compare se 2 componentes react são exatamente iguais, o tipo de resultado será verdadeiro/falso
AreParamEqual	Compare se os suportes de 2 componentes react são iguais, o tipo de resultado será verdadeiro/falso
AreTypeEqual	Compare se dois tipos são iguais, o tipo de resultado será verdadeiro/falso
AvatarPersonaData	Atributos de dados personalizados para exibir avatar para um usuário.
AvatarPersonaDataCallback	Função de retorno de chamada usada para fornecer dados personalizados para construir um avatar para um usuário.
AzureCommunicationCallAdapterArgs	Argumentos para criar a implementação dos Serviços de Comunicação do Azure de CallAdapter. Nota: `displayName` pode ter no máximo 256 caracteres.
AzureCommunicationCallWithChatAdapterArgs	Argumentos para createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs	Argumentos a favor <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs	Argumentos para criar a implementação dos Serviços de Comunicação do Azure de ChatAdapter.
CallAdapterCallEndedEvent	Payload para CallEndedListener contendo detalhes sobre a chamada finalizada.
CallAdapterClientState	estado de CommonCallAdapter inferido do back-end dos Serviços de Comunicação do Azure.
CallAdapterLocator	Localizador usado por createAzureCommunicationCallAdapter para localizar a chamada para ingressar
CallAdapterState	CommonCallAdapter estado.
CallAdapterUiState	CommonCallAdapter estado para fins puros da interface do usuário.
CallCompositeIcons	Ícones que podem ser substituídos por CallComposite.
CallCompositeOptions	Recursos opcionais do CallComposite.
CallCompositePage	Principais telas da interface do usuário mostradas no CallComposite.
CallControlDisplayType	Tipo de exibição da barra de controle para CallComposite.
CallControlOptions	Opções de personalização para a barra de controle na experiência de chamada.
CallEndedListener	Retorno de chamada para CallAdapterSubscribers evento 'callEnded'.
CallErrorBarSelector	Tipo de seletor para componente ErrorBar.
CallErrorTarget	Tipo literal de cadeia de caracteres para todas as chaves permitidas em {@Link CallErrors}.
CallErrors	Erros relacionados a chamadas de API para o SDK de chamada. Cada propriedade no objeto armazena o erro mais recente para um método de API SDK específico. Os erros deste objeto podem ser eliminados usando o <xref:newClearCallErrorsModifier>. Além disso, os erros são automaticamente eliminados quando: O Estado está liberado. As chamadas subsequentes para métodos de API relacionados são bem-sucedidas. Consulte a documentação de métodos de cliente com monitoração de estado individuais para obter detalhes sobre quando os erros podem ser apagados automaticamente.
CallIdChangedListener	Retorno de chamada para CallAdapterSubscribers evento 'callIdChanged'.
CallParticipantListParticipant	Chamando o estado do participante, conforme refletido nos componentes da interface do usuário.
CallWithChatCompositeIcons	Ícones que podem ser substituídos por CallWithChatComposite.
CallWithChatCompositeOptions	Recursos opcionais do CallWithChatComposite.
CallWithChatEvent	Eventos disparados pelo CallWithChatAdapter.
CallingBaseSelectorProps	Props comuns usados para fazer referência ao estado declarativo do cliente de chamada.
CallingReturnProps	Tipo de auxiliar para usePropsFor.
CameraButtonSelector	Tipo de seletor para componente CameraButton.
ChatAdapter	interface do adaptador de ChatComposto.
ChatAdapterState	ChatAdapter estado.
ChatAdapterUiState	ChatAdapter estado para fins de interface do usuário pura.
ChatBaseSelectorProps	Props comuns para seletores para ChatClientState.
ChatClientProviderProps	Argumentos para inicializar um ChatClientProvider.
ChatClientState	Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState	ChatAdapter estado inferido do back-end dos Serviços de Comunicação do Azure.
ChatCompositeIcons	Ícones que podem ser substituídos por ChatComposite.
ChatCompositeOptions	Recursos opcionais do ChatComposite.
ChatErrorBarSelector	Tipo de seletor para componente ErrorBar.
ChatErrorTarget	Tipo literal de cadeia de caracteres para todas as chaves permitidas no ChatErrors.
ChatErrors	Erros relacionados a chamadas de API para o SDK de bate-papo. Cada propriedade no objeto armazena o erro mais recente para um método de API SDK específico.
ChatHandlers	Objeto que contém todos os manipuladores necessários para componentes de chat. Os componentes relacionados ao bate-papo deste pacote são capazes de selecionar manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.
ChatMessageWithStatus	Uma extensão para <xref:%40azure%2Fcommunication-chat%23ChatMessage> que armazena metadados apenas do lado do cliente para mensagens de chat. TODO: O nome atrapalhou. Renomeie-me.
ChatParticipantListSelector	Tipo de seletor para componente ParticipantList.
ChatReturnProps	Tipo de auxiliar para usePropsFor.
ChatThreadClientProviderProps	Argumentos para inicializar um ChatThreadClientProvider.
ChatThreadClientState	Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.
ChatThreadProperties	Propriedades de um thread de chat. Definimos um mínimo que nos ajuda a ocultar os diferentes tipos usados pela API subjacente.
ClientState	Estado centralizado para <xref:%40azure%2Fcommunication-calling%23CallClient> ou <xref:%40azure%2Fcommunication-chat%23ChatClient>. Consulte também: CallClientState ChatClientState.
Common	Tipo de interseção de retorno de 2 tipos
CommonProperties	Retornar propriedades de interseção de 2 tipos
CommunicationParticipant	O estado de um participante de Chat ou Chamada, conforme refletido na interface do usuário.
ComponentIcons	Ícones usados pelos componentes do React exportados desta biblioteca.
ComponentProps	Tipo de auxiliar para usePropsFor.
CompositeIcons	Ícones que podem ser substituídos em um dos compósitos exportados por esta biblioteca. Consulte ChatCompositeIcons CallCompositeIcons e CallWithChatCompositeIcons para obter tipos mais direcionados.
ControlBarButtonStyles	Estilos para todas as implementações ControlBarButton .
ControlBarLayout	Apresentar layouts para o ControlBar.
CreateViewResult	Retornar resultado de createView.
CustomAvatarOptions	Opções que podem ser injetadas na função `onRender` para personalizar um componente Avatar (`Persona`).
DeviceManagerState	Este tipo destina-se a encapsular todo o estado dentro <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Para parâmetros opcionais, eles podem não estar disponíveis até que a permissão seja concedida pelo usuário. As câmeras, microfones, alto-falantes e estados deviceAccess ficarão vazios até que as APIs getCameras, getMicrophones, getSpeakers e askDevicePermission correspondentes do <xref:%40azure%2Fcommunication-calling%23DeviceManager>sejam chamadas e concluídas.
DevicesButtonSelector	Tipo de seletor para componente DevicesButton.
DiagnosticChangedEventListner	Retorno de chamada para CallAdapterSubscribers evento 'diagnosticChanged'.
DisplayNameChangedListener	Retorno de chamada para CallAdapterSubscribers evento 'displayNameChanged'.
EmptySelector	Um tipo para seletores triviais que não retornam dados. Usado como um valor de retorno padrão se usePropsFor for chamado para um componente que não requer dados.
ErrorType	Todos os erros que podem ser mostrados no ErrorBar.
GetCallingSelector	Tipo específico do seletor aplicável a um determinado componente.
GetChatSelector	Tipo específico do seletor aplicável a um determinado componente.
IsLocalScreenSharingActiveChangedListener	Retorno de chamada para CallAdapterSubscribers evento 'isLocalScreenSharingActiveChanged'.
IsMutedChangedListener	Retorno de chamada para CallAdapterSubscribers evento 'isMuted'.
IsSpeakingChangedListener	Retorno de chamada para CallAdapterSubscribers evento 'isSpeakingChanged'.
LoadingState	Se o fluxo está carregando ou não.
LocalizationProviderProps	Props para LocalizationProvider.
MediaDiagnosticChangedEvent	Carga útil para DiagnosticChangedEventListner onde há uma alteração em um diagnóstico de mídia.
Message	União discriminada de todas as mensagens. O campo `messageType` é especializado em variantes de união.
MessageAttachedStatus	Indique se uma mensagem de chat deve ser exibida mesclada com a mensagem antes / depois dela. Útil para mesclar muitas mensagens do mesmo remetente em um único balão de mensagem.
MessageContentType	Tipos suportados de conteúdo de mensagens de chat.
MessageProps	Props para renderizar uma única mensagem. Consulte MessageRenderer.
MessageReadListener	Retorno de chamada para ChatAdapterSubscribers evento 'messageRead'.
MessageReceivedListener	Retorno de chamada para ChatAdapterSubscribers evento 'messageReceived'.
MessageRenderer	Um componente para renderizar uma única mensagem.
MessageSentListener	Retorno de chamada para ChatAdapterSubscribers evento 'messageSent'.
MessageStatus	Estado do lado do cliente de uma mensagem enviada. Inclui estados de transição que ocorrem antes da entrega de mensagens ser confirmada a partir do back-end.
MessageThreadProps	Props para MessageThread.
MessageThreadSelector	Tipo de seletor para componente MessageThread.
MicrophoneButtonSelector	Tipo de seletor para componente MicrophoneButton.
NetworkDiagnosticChangedEvent	Carga útil para DiagnosticChangedEventListner onde há uma alteração em um diagnóstico de rede.
OnRenderAvatarCallback	Um retorno de chamada renderizado personalizado que permite aos usuários personalizar a renderização de um componente Persona.
ParticipantListParticipant	Os participantes exibidos em uma Lista de Participantes.
ParticipantListProps	Props para ParticipantList.
ParticipantListSelector	Tipo de seletor para componente ParticipantList.
ParticipantMenuItemsCallback	Um retorno de chamada para fornecer itens de menu personalizados para cada participante em Lista de Participantes.
ParticipantState	O estado de conexão de um participante da chamada.
ParticipantsAddedListener	Retorno de chamada para ChatAdapterSubscribers evento 'participantsAdded'.
ParticipantsButtonSelector	Tipo de seletor para componente ParticipantsButton.
ParticipantsJoinedListener	Retorno de chamada para CallAdapterSubscribers evento 'participantsJoined'.
ParticipantsLeftListener	Retorno de chamada para CallAdapterSubscribers evento 'participantsLeft'.
ParticipantsRemovedListener	Retorno de chamada para ChatAdapterSubscribers evento 'participantsRemoved'.
ReadReceiptsBySenderId	Uma matriz de pares de valores de chave que armazena o nome de exibição e a última mensagem lida de cada remetente
ScreenShareButtonSelector	Tipo de seletor para componente ScreenShareButton.
Selector	Um seletor otimizado que refina ClientState atualizações em props para componentes React nesta biblioteca.
SendBoxSelector	Tipo de seletor para componente SendBox.
StatefulCallClientArgs	Argumentos para construir o StatefulCallClient.
StatefulCallClientOptions	Opções para construir o StatefulCallClient com.
StatefulChatClientArgs	Argumentos para construir o StatefulChatClient.
StatefulChatClientOptions	Opções para construir o StatefulChatClient.
SystemMessage	União discriminada de todas as mensagens do sistema. O campo `systemMessageType` é especializado em variantes de união.
TopicChangedListener	O retorno de chamada para ChatAdapterSubscribers evento 'topicChanged'.
TypingIndicatorSelector	Tipo de seletor para componente TypingIndicator.
UpdateMessageCallback	A função de retorno de chamada é executada quando uma mensagem é atualizada.
VideoGalleryLayout
VideoGalleryLocalParticipant	O estado do participante local na VideoGallery.
VideoGalleryParticipant	O estado de um participante na VideoGallery.
VideoGallerySelector	Tipo de seletor para componente VideoGallery.
ViewScalingMode	Modo de dimensionamento de um VideoGalleryStream.

Funções

CallAgentProvider(CallAgentProviderProps)	Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-calling%23CallAgent>. Chamar componentes deste pacote deve ser encapsulado com um CallAgentProvider.
CallClientProvider(CallClientProviderProps)	Um <xref:React.Context> que armazena um StatefulCallClient. Chamar componentes deste pacote deve ser encapsulado com um CallClientProvider.
CallComposite(CallCompositeProps)	Um composto de interface do usuário personalizável para a experiência de chamada.
CallProvider(CallProviderProps)	Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-calling%23Call>. Os componentes de chamada deste pacote devem ser encapsulados com um CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)	O CallWithChatComposite reúne componentes-chave para fornecer uma chamada completa com experiência de bate-papo pronta para uso.
CameraButton(CameraButtonProps)	Um botão para ligar / desligar a câmara. Pode ser usado com ControlBar.
ChatClientProvider(ChatClientProviderProps)	Um <xref:React.Context> que armazena um StatefulChatClient. Os componentes de chat deste pacote devem ser empacotados com um ChatClientProvider.
ChatComposite(ChatCompositeProps)	Um composto de interface do usuário personalizável para a experiência de bate-papo.
ChatThreadClientProvider(ChatThreadClientProviderProps)	Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Os componentes de chat deste pacote devem ser empacotados com um ChatThreadClientProvider.
ControlBar(ControlBarProps)	Um contêiner para vários botões para controles de chamada. Use com vários botões de controle de chamada nesta biblioteca, por exemplo, CameraButtonou suas próprias instâncias de ControlBarButton diretamente.
ControlBarButton(ControlBarButtonProps)	Botão padrão estilizado para o ControlBar. Use este componente para criar botões personalizados com o mesmo estilo de outros botões fornecidos pela Biblioteca da Interface do Usuário.
DevicesButton(DevicesButtonProps)	Um botão para abrir um menu que controla as opções do dispositivo. Pode ser usado com ControlBar.
EndCallButton(EndCallButtonProps)	Um botão para encerrar uma chamada em andamento. Pode ser usado com ControlBar.
ErrorBar(ErrorBarProps)	Um componente para mostrar mensagens de erro na interface do usuário. Todas as cadeias de caracteres que podem ser mostradas são aceitas como as strings para que possam ser localizadas. Os erros ativos são selecionados por activeErrorMessages. Este componente rastreia internamente descartado pelo usuário. Erros que têm um carimbo de data/hora associado: o erro é mostrado na interface do usuário novamente se ocorrer depois de ser descartado. Erros que não têm um carimbo de data/hora: O erro é descartado até desaparecer dos adereços. Se o erro se repetir, ele será mostrado na interface do usuário. Usa <xref:%40fluentui%2Freact%23MessageBar> elemento da interface do usuário.
FluentThemeProvider(FluentThemeProviderProps)	Provedor para aplicar um tema Fluent nos componentes react desta biblioteca.
GridLayout(GridLayoutProps)	Um componente para dispor blocos de participantes de áudio/vídeo em uma chamada.
LocalizationProvider(LocalizationProviderProps)	Provedor para fornecer cadeias de caracteres localizadas para os componentes react desta biblioteca.
MessageStatusIndicator(MessageStatusIndicatorProps)	Componente para exibir o status de uma mensagem enviada. Adiciona um ícone e uma dica de ferramenta correspondentes ao status da mensagem.
MessageThread(MessageThreadProps)	`MessageThread` permite que você crie facilmente um componente para renderizar mensagens de bate-papo, lidar com o comportamento de rolagem de mensagens novas/antigas e personalizar ícones & controles dentro do thread de bate-papo.
MicrophoneButton(MicrophoneButtonProps)	Um botão para ligar / desligar o microfone. Pode ser usado com ControlBar.
ParticipantItem(ParticipantItemProps)	Componente para renderizar um participante de chamada ou bate-papo. Exibe o avatar, displayName e status do participante, bem como ícones opcionais e menu de contexto.
ParticipantList(ParticipantListProps)	Componente para renderizar todos os participantes de chamadas ou bate-papo. Por padrão, cada participante é renderizado com ParticipantItem. Consulte <xref:ParticipantListProps.onRenderParticipant> substituir.
ParticipantsButton(ParticipantsButtonProps)	Um botão para mostrar um menu com participantes de chamadas ou bate-papo. Pode ser usado com ControlBar. Este botão contém itens de menu suspenso definidos por meio de sua propriedade `menuProps`. Por padrão, ele pode exibir o número de participantes remotos com a lista completa como submenu e uma opção para silenciar todos os participantes, bem como um botão copiar para a área de transferência para copiar o URL do convite de chamada. Este `menuProps` pode ser totalmente redefinido e sua propriedade é do tipo IContextualMenuProps.
ScreenShareButton(ScreenShareButtonProps)	Um botão para iniciar / parar o compartilhamento de tela. Pode ser usado com ControlBar.
SendBox(SendBoxProps)	Componente para digitação e envio de mensagens. Suporta o envio de notificação de digitação quando o usuário começa a inserir texto. Suporta uma mensagem opcional abaixo do campo de entrada de texto.
StreamMedia(StreamMediaProps)	Componente utilitário para converter um HTMLElement com um fluxo de vídeo em um elemento JSX. Use para converter um HTMLElement retornado pela API de chamada sem cabeça em um componente que pode ser renderizado como um VideoTile.
TypingIndicator(TypingIndicatorProps)	Componente para notificar o usuário local quando um ou mais participantes no thread de bate-papo estão digitando.
VideoGallery(VideoGalleryProps)	VideoGallery representa um layout de blocos de vídeo para uma chamada específica. Ele exibe um VideoTile para o usuário local, bem como para cada participante remoto que se juntou à chamada.
VideoTile(VideoTileProps)	Um componente para renderizar o fluxo de vídeo para um participante de uma única chamada. Use com GridLayout em um VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Crie um CallAdapter apoiado pelos Serviços de Comunicação do Azure. Esta é a implementação padrão do CallAdapter fornecido por esta biblioteca. Nota: `displayName` pode ter no máximo 256 caracteres.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)	Crie um CallAdapter usando oStatefulCallClient fornecido pelo StatefulCall. Útil se você quiser manter uma referência a StatefulCallClient. Considere usar createAzureCommunicationCallAdapter para uma API mais simples.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)	Crie um CallWithChatAdapter apoiado pelos serviços de Comunicação do Azure para se conectar ao CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	Crie um CallWithChatAdapter usando o StatefulChatClient fornecido e StatefulCallClient. Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.
createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)	Crie um ChatAdapter apoiado pelos Serviços de Comunicação do Azure. Esta é a implementação padrão do ChatAdapter fornecido por esta biblioteca.
createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)	Crie um ChatAdapter usando o StatefulChatClient fornecido. Útil se você quiser manter uma referência a StatefulChatClient. Considere usar createAzureCommunicationChatAdapter para uma API mais simples.
createDefaultCallingHandlers(StatefulCallClient, undefined \| CallAgent, undefined \| StatefulDeviceManager, undefined \| Call)	Crie a implementação padrão de CallingHandlers para chamadas de equipes. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)	Crie a implementação padrão do ChatHandlers. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca. O objeto retornado é memorizado para evitar rerenderizações quando usado como suporte para componentes do React.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)	Cria um StatefulCallClient StatefulCallClient fazendo proxy de <xref:%40azure%2Fcommunication-calling%23CallClient> CallClient com ProxyCallClient <xref:ProxyCallClient> que, em seguida, permite o acesso ao estado de forma declarativa. É importante usar o <xref:%40azure%2Fcommunication-calling%23DeviceManager> e <xref:%40azure%2Fcommunication-calling%23CallAgent> e <xref:%40azure%2Fcommunication-calling%23Call> (e etc.) que são obtidos do StatefulCallClient para que suas alterações de estado sejam procuradas corretamente.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)	Cria um StatefulChatClient StatefulChatClient por proxy de ChatClient com ProxyChatClient que permite o acesso ao estado de forma declarativa.
fromFlatCommunicationIdentifier(string)	Operação inversa de toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)	Obtenha o seletor para um componente especificado. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
getChatSelector<Component>(Component)	Obtenha o seletor para um componente especificado. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
toFlatCommunicationIdentifier(CommunicationIdentifier)	Uma representação de cadeia de caracteres de um <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Esta representação de cadeia de caracteres de CommunicationIdentifier é garantidamente estável para um usuário de comunicação exclusivo. Assim, Ele pode ser usado para persistir a identidade de um usuário em bancos de dados externos. ele pode ser usado como chaves em um mapa para armazenar dados para o usuário.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)	Um gancho React personalizado para simplificar a criação de CallAdapter. Semelhante a createAzureCommunicationCallAdapter, mas cuida da criação assíncrona do adaptador internamente. Permite que os argumentos sejam indefinidos para que você possa respeitar a regra de ganchos e passar argumentos à medida que são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)	Um gancho React personalizado para simplificar a criação de CallWithChatAdapter. Semelhante ao createAzureCommunicationCallWithChatAdapter, mas cuida da criação assíncrona do adaptador internamente. Permite que os argumentos sejam indefinidos para que você possa respeitar a regra de ganchos e passar argumentos à medida que são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)	Um gancho React personalizado para simplificar a criação de ChatAdapter. Semelhante a createAzureCommunicationChatAdapter, mas cuida da criação assíncrona do adaptador internamente. Permite que os argumentos sejam indefinidos para que você possa respeitar a regra de ganchos e passar argumentos à medida que são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.
useCall()	Gancho para obter <xref:%40azure%2Fcommunication-calling%23Call> do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca. você deve ter usado anteriormente o CallProvider com um objeto Call para usar esse gancho
useCallAgent()	Gancho para obter <xref:%40azure%2Fcommunication-calling%23CallAgent> do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
useCallClient()	Gancho para obter StatefulCallClient do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
useChatClient()	Gancho para obter StatefulChatClient do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
useChatThreadClient()	Gancho para obter <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
useDeviceManager()	Gancho para obter StatefulDeviceManager do provedor. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
usePropsFor<Component>(Component, "chat" \| "calling")	Gancho principal para obter todos os ganchos necessários para um componente React desta biblioteca. Para chamar esse gancho, o componente precisa ser encapsulado sob estes provedores: Para componentes de chat: ChatClientProvider e ChatThreadClientProvider. Para chamar componentes: CallClientProvider, CallAgentProvider e CallAgentProvider. O uso mais simples de um componente se parece com: Exemplo `import { ParticipantList, usePropsFor } from '@azure/communication-react'; const App = (): JSX.Element => { // ... code to setup Providers ... return <ParticipantList {...usePropsFor(ParticipantList)}/> }`
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" \| "calling")	Gancho para obter um seletor para um componente especificado. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
useTheme()	Gancho de reação para acessar o tema

Detalhes de Função

CallAgentProvider(CallAgentProviderProps)

Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-calling%23CallAgent>.

Chamar componentes deste pacote deve ser encapsulado com um CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parâmetros

props: CallAgentProviderProps

Devoluções

Element

CallClientProvider(CallClientProviderProps)

Um <xref:React.Context> que armazena um StatefulCallClient.

Chamar componentes deste pacote deve ser encapsulado com um CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parâmetros

props: CallClientProviderProps

Devoluções

Element

CallComposite(CallCompositeProps)

Um composto de interface do usuário personalizável para a experiência de chamada.

function CallComposite(props: CallCompositeProps): Element

Parâmetros

props: CallCompositeProps

Devoluções

Element

Observações

A largura/altura mínima composta da chamada é a seguinte:

Móvel: 17.5REM x 21REM (280px x 336px, com REM padrão em 16px)
Área de trabalho: 30REM x 22REM (480px x 352px, com REM padrão em 16px)

CallProvider(CallProviderProps)

Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-calling%23Call>.

Os componentes de chamada deste pacote devem ser encapsulados com um CallProvider.

function CallProvider(props: CallProviderProps): Element

Parâmetros

props: CallProviderProps

Devoluções

Element

CallWithChatComposite(CallWithChatCompositeProps)

O CallWithChatComposite reúne componentes-chave para fornecer uma chamada completa com experiência de bate-papo pronta para uso.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parâmetros

props: CallWithChatCompositeProps

Devoluções

Element

CameraButton(CameraButtonProps)

Um botão para ligar / desligar a câmara.

Pode ser usado com ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parâmetros

props: CameraButtonProps

Devoluções

Element

ChatClientProvider(ChatClientProviderProps)

Um <xref:React.Context> que armazena um StatefulChatClient.

Os componentes de chat deste pacote devem ser empacotados com um ChatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parâmetros

props: ChatClientProviderProps

Devoluções

Element

ChatComposite(ChatCompositeProps)

Um composto de interface do usuário personalizável para a experiência de bate-papo.

function ChatComposite(props: ChatCompositeProps): Element

Parâmetros

props: ChatCompositeProps

Devoluções

Element

Observações

A largura mínima e a altura compostas do chat são, respectivamente, 17,5rem e 20rem (280px e 320px, com rem padrão em 16px)

ChatThreadClientProvider(ChatThreadClientProviderProps)

Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

Os componentes de chat deste pacote devem ser empacotados com um ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parâmetros

props: ChatThreadClientProviderProps

Devoluções

Element

ControlBar(ControlBarProps)

Um contêiner para vários botões para controles de chamada.

Use com vários botões de controle de chamada nesta biblioteca, por exemplo, CameraButtonou suas próprias instâncias de ControlBarButton diretamente.

function ControlBar(props: ControlBarProps): Element

Parâmetros

props: ControlBarProps

Devoluções

Element

ControlBarButton(ControlBarButtonProps)

Botão padrão estilizado para o ControlBar.

Use este componente para criar botões personalizados com o mesmo estilo de outros botões fornecidos pela Biblioteca da Interface do Usuário.

function ControlBarButton(props: ControlBarButtonProps): Element

Parâmetros

props: ControlBarButtonProps

Devoluções

Element

DevicesButton(DevicesButtonProps)

Um botão para abrir um menu que controla as opções do dispositivo.

Pode ser usado com ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parâmetros

props: DevicesButtonProps

Devoluções

Element

EndCallButton(EndCallButtonProps)

Um botão para encerrar uma chamada em andamento.

Pode ser usado com ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parâmetros

props: EndCallButtonProps

Devoluções

Element

ErrorBar(ErrorBarProps)

Um componente para mostrar mensagens de erro na interface do usuário. Todas as cadeias de caracteres que podem ser mostradas são aceitas como as strings para que possam ser localizadas. Os erros ativos são selecionados por activeErrorMessages.

Este componente rastreia internamente descartado pelo usuário.

Erros que têm um carimbo de data/hora associado: o erro é mostrado na interface do usuário novamente se ocorrer depois de ser descartado.
Erros que não têm um carimbo de data/hora: O erro é descartado até desaparecer dos adereços. Se o erro se repetir, ele será mostrado na interface do usuário.

Usa <xref:%40fluentui%2Freact%23MessageBar> elemento da interface do usuário.

function ErrorBar(props: ErrorBarProps): Element

Parâmetros

props: ErrorBarProps

Devoluções

Element

FluentThemeProvider(FluentThemeProviderProps)

Provedor para aplicar um tema Fluent nos componentes react desta biblioteca.

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parâmetros

props: FluentThemeProviderProps

Devoluções

Element

Observações

Os componentes desta biblioteca são compostos principalmente de Fluent UI, controles e também de controles Fluent React Northstar. Este provedor lida com a aplicação de qualquer tema fornecido aos controles Fluent UI subjacentes, bem como aos controles Fluent React Northstar.

GridLayout(GridLayoutProps)

Um componente para dispor blocos de participantes de áudio/vídeo em uma chamada.

function GridLayout(props: GridLayoutProps): Element

Parâmetros

props: GridLayoutProps

Devoluções

Element

LocalizationProvider(LocalizationProviderProps)

Provedor para fornecer cadeias de caracteres localizadas para os componentes react desta biblioteca.

function LocalizationProvider(props: LocalizationProviderProps): Element

Parâmetros

props: LocalizationProviderProps

Devoluções

Element

Observações

Os componentes serão fornecidos cadeias de caracteres localizadas em inglês (EUA) por padrão se esse provedor não for usado.

MessageStatusIndicator(MessageStatusIndicatorProps)

Componente para exibir o status de uma mensagem enviada.

Adiciona um ícone e uma dica de ferramenta correspondentes ao status da mensagem.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parâmetros

props: MessageStatusIndicatorProps

Devoluções

Element

MessageThread(MessageThreadProps)

MessageThread permite que você crie facilmente um componente para renderizar mensagens de bate-papo, lidar com o comportamento de rolagem de mensagens novas/antigas e personalizar ícones & controles dentro do thread de bate-papo.

function MessageThread(props: MessageThreadProps): Element

Parâmetros

props: MessageThreadProps

do tipo MessageThreadProps

Os usuários precisarão fornecer pelo menos mensagens de bate-papo e userId para renderizar o componente MessageThread. Os usuários também podem personalizar MessageThread passando seu próprio Avatar, ícone de MessageStatusIndicator, JumpToNewMessageButton, LoadPreviousMessagesButton e o comportamento desses controles.

MessageThread usa internamente o componente Chat & Chat.Message do @fluentui/react-northstar. Você pode conferir os detalhes sobre esses dois componentes.

Devoluções

Element

MicrophoneButton(MicrophoneButtonProps)

Um botão para ligar / desligar o microfone.

Pode ser usado com ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parâmetros

props: MicrophoneButtonProps

Devoluções

Element

ParticipantItem(ParticipantItemProps)

Componente para renderizar um participante de chamada ou bate-papo.

Exibe o avatar, displayName e status do participante, bem como ícones opcionais e menu de contexto.

function ParticipantItem(props: ParticipantItemProps): Element

Parâmetros

props: ParticipantItemProps

Devoluções

Element

ParticipantList(ParticipantListProps)

Componente para renderizar todos os participantes de chamadas ou bate-papo.

Por padrão, cada participante é renderizado com ParticipantItem. Consulte <xref:ParticipantListProps.onRenderParticipant> substituir.

function ParticipantList(props: ParticipantListProps): Element

Parâmetros

props: ParticipantListProps

Devoluções

Element

ParticipantsButton(ParticipantsButtonProps)

Um botão para mostrar um menu com participantes de chamadas ou bate-papo.

Pode ser usado com ControlBar.

Este botão contém itens de menu suspenso definidos por meio de sua propriedade menuProps. Por padrão, ele pode exibir o número de participantes remotos com a lista completa como submenu e uma opção para silenciar todos os participantes, bem como um botão copiar para a área de transferência para copiar o URL do convite de chamada. Este menuProps pode ser totalmente redefinido e sua propriedade é do tipo IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parâmetros

props: ParticipantsButtonProps

Devoluções

Element

ScreenShareButton(ScreenShareButtonProps)

Um botão para iniciar / parar o compartilhamento de tela.

Pode ser usado com ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parâmetros

props: ScreenShareButtonProps

Devoluções

Element

SendBox(SendBoxProps)

Componente para digitação e envio de mensagens.

Suporta o envio de notificação de digitação quando o usuário começa a inserir texto. Suporta uma mensagem opcional abaixo do campo de entrada de texto.

function SendBox(props: SendBoxProps): Element

Parâmetros

props: SendBoxProps

Devoluções

Element

StreamMedia(StreamMediaProps)

Componente utilitário para converter um HTMLElement com um fluxo de vídeo em um elemento JSX.

Use para converter um HTMLElement retornado pela API de chamada sem cabeça em um componente que pode ser renderizado como um VideoTile.

function StreamMedia(props: StreamMediaProps): Element

Parâmetros

props: StreamMediaProps

Devoluções

Element

TypingIndicator(TypingIndicatorProps)

Componente para notificar o usuário local quando um ou mais participantes no thread de bate-papo estão digitando.

function TypingIndicator(props: TypingIndicatorProps): Element

Parâmetros

props: TypingIndicatorProps

Devoluções

Element

VideoGallery(VideoGalleryProps)

VideoGallery representa um layout de blocos de vídeo para uma chamada específica. Ele exibe um VideoTile para o usuário local, bem como para cada participante remoto que se juntou à chamada.

function VideoGallery(props: VideoGalleryProps): Element

Parâmetros

props: VideoGalleryProps

Devoluções

Element

VideoTile(VideoTileProps)

Um componente para renderizar o fluxo de vídeo para um participante de uma única chamada.

Use com GridLayout em um VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parâmetros

props: VideoTileProps

Devoluções

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

Crie um CallAdapter apoiado pelos Serviços de Comunicação do Azure.

Esta é a implementação padrão do CallAdapter fornecido por esta biblioteca.

Nota: displayName pode ter no máximo 256 caracteres.

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

Parâmetros

__namedParameters: AzureCommunicationCallAdapterArgs

Devoluções

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Crie um CallAdapter usando oStatefulCallClient fornecido pelo StatefulCall.

Útil se você quiser manter uma referência a StatefulCallClient. Considere usar createAzureCommunicationCallAdapter para uma API mais simples.

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

Parâmetros

callClient: StatefulCallClient

callAgent: CallAgent

locator: CallAdapterLocator

Devoluções

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Crie um CallWithChatAdapter apoiado pelos serviços de Comunicação do Azure para se conectar ao CallWithChatComposite.

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

Parâmetros

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

Devoluções

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Crie um CallWithChatAdapter usando o StatefulChatClient fornecido e StatefulCallClient.

Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.

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

Parâmetros

__namedParameters: AzureCommunicationCallWithChatAdapterFromClientArgs

Devoluções

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Crie um ChatAdapter apoiado pelos Serviços de Comunicação do Azure.

Esta é a implementação padrão do ChatAdapter fornecido por esta biblioteca.

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

Parâmetros

__namedParameters: AzureCommunicationChatAdapterArgs

Devoluções

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient)

Crie um ChatAdapter usando o StatefulChatClient fornecido.

Útil se você quiser manter uma referência a StatefulChatClient. Considere usar createAzureCommunicationChatAdapter para uma API mais simples.

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

Parâmetros

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Devoluções

Promise<ChatAdapter>

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

Crie a implementação padrão de CallingHandlers para chamadas de equipes.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

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

Parâmetros

callClient: StatefulCallClient

callAgent: undefined | CallAgent

deviceManager: undefined | StatefulDeviceManager

call: undefined | Call

Devoluções

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

Crie a implementação padrão do ChatHandlers.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

O objeto retornado é memorizado para evitar rerenderizações quando usado como suporte para componentes do React.

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

Parâmetros

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Devoluções

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Cria um StatefulCallClient StatefulCallClient fazendo proxy de <xref:%40azure%2Fcommunication-calling%23CallClient> CallClient com ProxyCallClient <xref:ProxyCallClient> que, em seguida, permite o acesso ao estado de forma declarativa.

É importante usar o <xref:%40azure%2Fcommunication-calling%23DeviceManager> e <xref:%40azure%2Fcommunication-calling%23CallAgent> e <xref:%40azure%2Fcommunication-calling%23Call> (e etc.) que são obtidos do StatefulCallClient para que suas alterações de estado sejam procuradas corretamente.

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

Parâmetros

args: StatefulCallClientArgs

StatefulCallClientArgs

options: StatefulCallClientOptions

StatefulCallClientOptions

Devoluções

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Cria um StatefulChatClient StatefulChatClient por proxy de ChatClient com ProxyChatClient que permite o acesso ao estado de forma declarativa.

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

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parâmetros

id: string

Devoluções

CommunicationIdentifier

getCallingSelector<Component>(Component)

Obtenha o seletor para um componente especificado.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

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

Parâmetros

component: Component

Devoluções

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Obtenha o seletor para um componente especificado.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

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

Parâmetros

component: Component

Devoluções

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

Uma representação de cadeia de caracteres de um <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>.

Esta representação de cadeia de caracteres de CommunicationIdentifier é garantidamente estável para um usuário de comunicação exclusivo. Assim,

Ele pode ser usado para persistir a identidade de um usuário em bancos de dados externos.
ele pode ser usado como chaves em um mapa para armazenar dados para o usuário.

function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parâmetros

identifier: CommunicationIdentifier

Devoluções

string

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

Um gancho React personalizado para simplificar a criação de CallAdapter.

Semelhante a createAzureCommunicationCallAdapter, mas cuida da criação assíncrona do adaptador internamente.

Permite que os argumentos sejam indefinidos para que você possa respeitar a regra de ganchos e passar argumentos à medida que são criados. O adaptador só é criado quando todos os argumentos são definidos.

Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.

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

Parâmetros

args: Partial<AzureCommunicationCallAdapterArgs>

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

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

Devoluções

undefined | CallAdapter

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

Um gancho React personalizado para simplificar a criação de CallWithChatAdapter.

Semelhante ao createAzureCommunicationCallWithChatAdapter, mas cuida da criação assíncrona do adaptador internamente.

Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.

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

Parâmetros

args: Partial<AzureCommunicationCallWithChatAdapterArgs>

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

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

Devoluções

undefined | CallWithChatAdapter

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

Um gancho React personalizado para simplificar a criação de ChatAdapter.

Semelhante a createAzureCommunicationChatAdapter, mas cuida da criação assíncrona do adaptador internamente.

Observe que você deve memorizar os argumentos para evitar a recriação do adaptador em cada renderização. Consulte o livro de histórias para obter exemplos típicos de uso.

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>

Devoluções

undefined | ChatAdapter

useCall()

Gancho para obter <xref:%40azure%2Fcommunication-calling%23Call> do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

você deve ter usado anteriormente o CallProvider com um objeto Call para usar esse gancho

function useCall(): undefined | Call

Devoluções

undefined | Call

useCallAgent()

Gancho para obter <xref:%40azure%2Fcommunication-calling%23CallAgent> do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

function useCallAgent(): undefined | CallAgent

Devoluções

undefined | CallAgent

useCallClient()

Gancho para obter StatefulCallClient do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

function useCallClient(): StatefulCallClient

Devoluções

StatefulCallClient

useChatClient()

Gancho para obter StatefulChatClient do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

function useChatClient(): StatefulChatClient

Devoluções

StatefulChatClient

useChatThreadClient()

Gancho para obter <xref:%40azure%2Fcommunication-chat%23ChatThreadClient> do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

function useChatThreadClient(): ChatThreadClient

Devoluções

ChatThreadClient

useDeviceManager()

Gancho para obter StatefulDeviceManager do provedor.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.

function useDeviceManager(): undefined | StatefulDeviceManager

Devoluções

undefined | StatefulDeviceManager

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

Gancho principal para obter todos os ganchos necessários para um componente React desta biblioteca.

Para chamar esse gancho, o componente precisa ser encapsulado sob estes provedores:

Para componentes de chat: ChatClientProvider e ChatThreadClientProvider.
Para chamar componentes: CallClientProvider, CallAgentProvider e CallAgentProvider.

O uso mais simples de um componente se parece com:

Exemplo

    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"

Devoluções

ComponentProps<Component>

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

Gancho para obter um seletor para um componente especificado.

Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa 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"

Devoluções

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

useTheme()

Gancho de reação para acessar o tema

function useTheme(): Theme

Devoluções

Theme

Partilhar via

@azure/communication-react package

Classes

Interfaces

Aliases de Tipo

Funções

Detalhes de Função

CallAgentProvider(CallAgentProviderProps)

Parâmetros

Devoluções

CallClientProvider(CallClientProviderProps)

Parâmetros

Devoluções

CallComposite(CallCompositeProps)

Parâmetros

Devoluções

Observações

CallProvider(CallProviderProps)

Parâmetros

Devoluções

CallWithChatComposite(CallWithChatCompositeProps)

Parâmetros

Devoluções

CameraButton(CameraButtonProps)

Parâmetros

Devoluções

ChatClientProvider(ChatClientProviderProps)

Parâmetros

Devoluções

ChatComposite(ChatCompositeProps)

Parâmetros

Devoluções

Observações

ChatThreadClientProvider(ChatThreadClientProviderProps)

Parâmetros

Devoluções

ControlBar(ControlBarProps)

Parâmetros

Devoluções

ControlBarButton(ControlBarButtonProps)

Parâmetros

Devoluções

DevicesButton(DevicesButtonProps)

Parâmetros

Devoluções

EndCallButton(EndCallButtonProps)

Parâmetros

Devoluções

ErrorBar(ErrorBarProps)

Parâmetros

Devoluções

FluentThemeProvider(FluentThemeProviderProps)

Parâmetros

Devoluções

Observações

GridLayout(GridLayoutProps)

Parâmetros

Devoluções

LocalizationProvider(LocalizationProviderProps)

Parâmetros

Devoluções

Observações

MessageStatusIndicator(MessageStatusIndicatorProps)

Parâmetros

Devoluções

MessageThread(MessageThreadProps)

Parâmetros

Devoluções

MicrophoneButton(MicrophoneButtonProps)

Parâmetros

Devoluções

ParticipantItem(ParticipantItemProps)

Parâmetros

Devoluções

ParticipantList(ParticipantListProps)

Parâmetros

Devoluções

ParticipantsButton(ParticipantsButtonProps)

Parâmetros

Devoluções