@azure/communication-react package

Referência

Classes

CallError	Erro gerado de métodos de API com estado com falha.
ChatError	Erro gerado de métodos StatefulChatClient com falha.

Interfaces

ActiveErrorMessage	Mensagens de erro ativas a serem mostradas por meio de ErrorBar.
AdapterError	Erro relatado por meio de eventos de erro e armazenado no estado do adaptador.
AdapterState	Funcionalidade para interfiguração com o estado do adaptador composto.
BaseCompositeProps	Propriedades comuns a todas as composição exportadas dessa biblioteca.
BaseCustomStyles	Suportes de estilos fluentes básicos para todos os componentes exportados deste libray.
CallAdapter	Uma interface do Adaptador específica para a identidade de Comunicação do Azure que 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 de <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 proxie de estado do CallAgent é fornecer acesso ao displayName. Não nivelamos CallAgent.displayName e o colocamos em CallClientState porque seria ambiguio que displayName realmente dependa da criação/existência de CallAgent para estar disponível.
CallAndChatLocator	Argumentos para uso em createAzureCommunicationCallWithChatAdapter para ingressar em uma Chamada com um thread de Chat associado.
CallClientProviderProps	Argumentos para inicializar um CallClientProvider.
CallClientState	Contêiner para todos os dados de estado com proxie por StatefulCallClient. As chamadas, chamadasEnded, incomingCalls e estados incomingCallsEnded serão fornecidas automaticamente se um callAgent tiver sido criado. O deviceManager estará vazio inicialmente até que seja preenchido ver DeviceManagerState. O estado userId é fornecido como uma conveniência para o desenvolvedor e é completamente controlado e definido pelo desenvolvedor.
CallCompositeProps	Adereços para CallComposite.
CallCompositeStrings	Cadeias de caracteres usadas diretamente pelo CallComposite . Essas cadeias de caracteres são além daquelas usadas pelos componentes da biblioteca de componentes.
CallProviderProps	Argumentos para inicializar um CallProvider.
CallState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recuperará automaticamente o estado de Call e o adicionará ao estado exposto por StatefulCallClient.
CallWithChatAdapter	CallWithChatComposite Interface do adaptador.
CallWithChatAdapterManagement	Funcionalidade para gerenciar a chamada atual com chat.
CallWithChatAdapterState	CallWithChat State é uma combinação de clientes de chat com estado e chamadas com estado com algum estado específico apenas para a Composição CallWithChat.
CallWithChatAdapterSubscriptions	Eventos de chamada e chat que podem ser inscritos no CallWithChatAdapter.
CallWithChatAdapterUiState	Estado da interface do usuário relativo ao CallWithChatComposite.
CallWithChatClientState	Estado dos serviços de back-end que impulsionam CallWithChatComposite.
CallWithChatCompositeProps	Props necessários para o CallWithChatComposite
CallWithChatCompositeStrings	Cadeias de caracteres usadas diretamente pelo CallWithChatComposite . Essas cadeias de caracteres são além daquelas usadas pelos componentes da biblioteca de componentes.
CallWithChatControlOptions	CallWithChatComposite Chame controles 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 desse pacote é capaz de escolher manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.
CallingTheme	Palete de tema fluente personalizado usado chamando componentes relacionados nesta biblioteca.
CameraButtonContextualMenuStyles	Estilos para o menu CameraButton .
CameraButtonProps	Adereços para o componente CameraButton .
CameraButtonStrings	Cadeias de caracteres de CameraButton que podem ser substituídas.
CameraButtonStyles	Estilos para CameraButton
ChatAdapterSubscribers	Eventos compostos de chat que podem ser inscritos.
ChatAdapterThreadManagement	Funcionalidade para gerenciar o thread de chat atual.
ChatCompositeProps	Adereços para ChatComposite.
ChatCompositeStrings	Cadeias de caracteres usadas diretamente pelo ChatComposite . Essas cadeias de caracteres são além daquelas usadas pelos componentes da biblioteca de componentes.
ChatMessage	Uma mensagem de chat.
CommonCallAdapter	CallComposite Interface do adaptador.
CommonCallingHandlers	Objeto que contém todos os manipuladores necessários para chamar componentes. Chamar componentes relacionados desse pacote é capaz de escolher manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.
ComponentLocale	Informações de localidade para todos os componentes exportados dessa biblioteca.
ComponentStrings	Cadeias de caracteres usadas por todos os componentes exportados dessa biblioteca.
CompositeLocale	Informações de localidade para todos os compostos exportados dessa biblioteca.
CompositeStrings	Cadeias de caracteres usadas diretamente nas composição. Essas cadeias de caracteres são usadas diretamente pelas composição, em vez dos componentes contidos.
ContentSystemMessage	Uma mensagem do sistema com conteúdo arbitary.
ControlBarButtonProps	Adereços para ControlBarButton.
ControlBarButtonStrings	Cadeias de caracteres de ControlBarButton que podem ser substituídas.
ControlBarProps	Adereços 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 personalizado. 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	Adereços para DevicesButton.
DevicesButtonStrings	Cadeias de caracteres de DevicesButton que podem ser substituídas.
DevicesButtonStyles	Estilos para os itens de menu do botão Dispositivos.
DiagnosticsCallFeatureState	Proxy somente de estado para <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.
Disposable	Funcionalidade para descartar corretamente uma Composição.
EndCallButtonProps	Adereços para EndCallButton.
EndCallButtonStrings	Cadeias de caracteres de EndCallButton que podem ser substituídas.
ErrorBarProps	Adereços para ErrorBar. Além do seguinte, ErrorBar encaminha todos <xref:%40fluentui%2Freact%23IMessageBarProps> para o subjacente <xref:%40fluentui%2Freact%23MessageBar>.
ErrorBarStrings	Todas as cadeias de caracteres que podem ser mostradas na interface do usuário na Barra de Erros.
FluentThemeProviderProps	Adereços para FluentThemeProvider.
GridLayoutProps	Adereços para GridLayout.
GridLayoutStyles	GridLayout Estilos de componente.
HorizontalGalleryStyles	<xref:HorizontalGallery> Estilos de componente.
IncomingCallState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detectará automaticamente chamadas de entrada e adicionará seu estado ao estado exposto por StatefulCallClient.
JumpToNewMessageButtonProps	Argumentos para <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.
LocalVideoCameraCycleButtonProps
LocalVideoStreamState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.
MediaDiagnosticsState	Proxy somente de estado 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	Adereços para MicrophoneButton.
MicrophoneButtonStrings	Cadeias de caracteres de MicrophoneButton que podem ser substituídas.
MicrophoneButtonStyles	Estilos para MicrophoneButton
NetworkDiagnosticsState	Proxy somente de estado 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 à conversa de chat.
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 da conversa de chat.
ParticipantsButtonContextualMenuStyles	Estilos para o menu ParticipantsButton .
ParticipantsButtonProps	Props para ParticipantsButton.
ParticipantsButtonStrings	Cadeias de caracteres de ParticipantsButton que podem ser substituídas.
ParticipantsButtonStyles	Estilos props para participantesButton.
RecordingCallFeature	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient escutará automaticamente o estado de gravação da chamada e atualizará o estado exposto por StatefulCallClient adequadamente.
RemoteParticipantState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recuperará RemoteParticipants automaticamente e adicionará seu estado ao estado exposto por StatefulCallClient.
RemoteVideoStreamState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.
ScreenShareButtonProps	Adereços para ScreenShareButton.
ScreenShareButtonStrings	Cadeias de caracteres de ScreenShareButton que podem ser substituídas.
SendBoxProps	Adereços para SendBox.
SendBoxStrings	Cadeias de caracteres de SendBox que podem ser substituídas.
SendBoxStylesProps	Estilos fluentes para <xref:Sendbox>.
StatefulCallClient	Define os métodos que permitem que CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> seja usado com estado. A interface fornece acesso ao estado com 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 orientados por: Dados retornados de <xref:%40azure%2Fcommunication-calling%23DeviceManager> APIs. Dados retornados de <xref:%40azure%2Fcommunication-calling%23CallAgent> APIs. Ouvintes anexados automaticamente a vários objetos de chamada de comunicação do Azure: CallAgent 'incomingCall' CallAgent 'callsUpdated' DeviceManager 'videoDevicesUpdated' DeviceManager 'audioDevicesUpdated DeviceManager 'selectedMicrophoneChanged' DeviceManager 'selectedSpeakerChanged' Chamar 'stateChanged' Chamar 'idChanged' Chamar 'isMutedChanged' Chamar 'isScreenSharingOnChanged' Chamar 'remoteParticipantsUpdated' Chamar '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} sejam usados com um estado gerado centralizado. A interface fornece acesso ao estado com proxy e também permite registrar um manipulador para eventos de alteração de estado.
StatefulDeviceManager	Define os métodos adicionais adicionados pelo com estado na parte superior de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
StreamMediaProps	Adereços para StreamMedia.
SystemMessageCommon	Propriedades comuns de todas as mensagens do sistema.
TopicUpdatedSystemMessage	Uma mensagem do sistema notificando que o tópico da conversa de chat foi atualizado.
TranscriptionCallFeature	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient escutará automaticamente o estado de transcrição da chamada e atualizará o estado exposto por StatefulCallClient adequadamente.
TypingIndicatorProps	Props para TypingIndicator.
TypingIndicatorStrings	Cadeias de caracteres de TypingIndicator que podem ser substituídas.
TypingIndicatorStylesProps	Estilos fluentes para TypingIndicator.
VideoGalleryProps	Adereços para VideoGallery.
VideoGalleryRemoteParticipant	O estado de um participante remoto na VideoGallery.
VideoGalleryStream	Fluxo de vídeo de um participante no VideoGallery.
VideoGalleryStrings	Todas as cadeias de caracteres que podem ser mostradas na interface do usuário no VideoGallery.
VideoGalleryStyles	VideoGallery Estilos de componente.
VideoStreamOptions	Opções para controlar como os fluxos de vídeo são renderizados.
VideoStreamRendererViewState	Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Essa propriedade é adicionada ao estado exposto por StatefulCallClient por createView e removida por disposeView.
VideoTileProps	Adereços para VideoTile.
VideoTileStylesProps	Estilos fluentes para VideoTile.

Aliases de tipo

AdapterErrors	Os adaptadores armazenam 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á true/false
AreParamEqual	Compare se os adereços de 2 componentes react são iguais, o tipo de resultado será true/false
AreTypeEqual	Comparar se dois tipos forem iguais, o tipo de resultado será true/false
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 criar um avatar para um usuário.
AzureCommunicationCallAdapterArgs	Argumentos para criar a implementação Serviços de Comunicação do Azure de CallAdapter. Observação: `displayName` pode ter no máximo 256 caracteres.
AzureCommunicationCallWithChatAdapterArgs	Argumentos para createAzureCommunicationCallWithChatAdapter
AzureCommunicationCallWithChatAdapterFromClientArgs	Argumentos para <xref:createAzureCommunicationCallWithChatAdapterFromClient>
AzureCommunicationChatAdapterArgs	Argumentos para criar a implementação Serviços de Comunicação do Azure de ChatAdapter.
CallAdapterCallEndedEvent	Payload para CallEndedListener contendo detalhes sobre a chamada final.
CallAdapterClientState	Estado CommonCallAdapter inferido de Serviços de Comunicação do Azure back-end.
CallAdapterLocator	Localizador usado por createAzureCommunicationCallAdapter para localizar a chamada para ingressar
CallAdapterState	Estado CommonCallAdapter .
CallAdapterUiState	Estado CommonCallAdapter para fins de interface do usuário pura.
CallCompositeIcons	Ícones que podem ser substituídos por CallComposite.
CallCompositeOptions	Recursos opcionais do CallComposite.
CallCompositePage	Principais telas de 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 o evento CallAdapterSubscribers 'callEnded'.
CallErrorBarSelector	Tipo de seletor para o componente ErrorBar .
CallErrorTarget	Tipo literal de cadeia de caracteres para todas as chaves permitidas em {@Link CallErrors}.
CallErrors	Erros gerados de chamadas à API para o SDK de Chamada. Cada propriedade no objeto armazena o erro mais recente para um método específico de API do SDK. Erros desse objeto podem ser limpos usando o <xref:newClearCallErrorsModifier>. Além disso, os erros são limpos automaticamente quando: O estado está limpo. Chamadas subsequentes para métodos de API relacionados têm êxito. Consulte a documentação de métodos de cliente com estado individuais para obter detalhes sobre quando os erros podem ser limpos automaticamente.
CallIdChangedListener	Retorno de chamada para o evento CallAdapterSubscribers '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	Adereços comuns usados para fazer referência ao estado declarativo do cliente de chamada.
CallingReturnProps	Tipo auxiliar para usePropsFor.
CameraButtonSelector	Tipo de seletor para o componente CameraButton .
ChatAdapter	ChatComposite Interface do adaptador.
ChatAdapterState	Estado de ChatAdapter .
ChatAdapterUiState	Estado chatAdapter para fins de interface do usuário puras.
ChatBaseSelectorProps	Adereços comuns para seletores para ChatClientState.
ChatClientProviderProps	Argumentos para inicializar um ChatClientProvider.
ChatClientState	Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatClient>.
ChatCompositeClientState	Estado chatAdapter inferido de Serviços de Comunicação do Azure back-end.
ChatCompositeIcons	Ícones que podem ser substituídos para ChatComposite.
ChatCompositeOptions	Recursos opcionais do ChatComposite.
ChatErrorBarSelector	Tipo de seletor para o componente ErrorBar .
ChatErrorTarget	Tipo literal de cadeia de caracteres para todas as chaves permitidas em ChatErrors.
ChatErrors	Erros de chamadas à API para o SDK de Chat. Cada propriedade no objeto armazena o erro mais recente para um método específico de API do SDK.
ChatHandlers	Objeto que contém todos os manipuladores necessários para componentes de chat. Os componentes relacionados ao chat deste pacote são capazes de escolher manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.
ChatMessageWithStatus	Uma extensão para <xref:%40azure%2Fcommunication-chat%23ChatMessage> que armazena apenas metadados do lado do cliente para mensagens de chat. TODO: o nome foi atribuído. Renomeie-me.
ChatParticipantListSelector	Tipo de seletor para componente ParticipantList .
ChatReturnProps	Tipo 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 dois tipos
CommonProperties	Retornar propriedades de interseção de dois tipos
CommunicationParticipant	O estado de um participante de Chat ou Chamada, conforme refletido na interface do usuário.
ComponentIcons	Ícones usados pelos componentes React exportados dessa biblioteca.
ComponentProps	Tipo auxiliar para usePropsFor.
CompositeIcons	Ícones que podem ser substituídos em uma das composição exportadas por essa biblioteca. Consulte ChatCompositeIcons, CallCompositeIcons e CallWithChatCompositeIcons para obter mais tipos direcionados.
ControlBarButtonStyles	Estilos para todas as implementações de ControlBarButton .
ControlBarLayout	Apresente layouts para a Barra de Controle.
CreateViewResult	Retornar o resultado de createView.
CustomAvatarOptions	Opções que podem ser injetadas na `onRender` função para personalizar um componente Avatar (`Persona`).
DeviceManagerState	Esse tipo destina-se a encapsular todo o estado dentro <xref:%40azure%2Fcommunication-calling%23DeviceManager>de . 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 <xref:%40azure%2Fcommunication-calling%23DeviceManager>sejam chamadas e concluídas.
DevicesButtonSelector	Tipo de seletor para o componente DevicesButton .
DiagnosticChangedEventListner	Retorno de chamada para o evento 'diagnosticChanged' callAdapterSubscribers .
DisplayNameChangedListener	Retorno de chamada para o evento 'displayNameChanged' de CallAdapterSubscribers .
EmptySelector	Um tipo para seletores triviais que não retornam dados. Usado como um valor retornado padrão se usePropsFor for chamado para um componente que não requer dados.
ErrorType	Todos os erros que podem ser mostrados na Barra de Erros.
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 o evento CallAdapterSubscribers 'isLocalScreenSharingActiveChanged'.
IsMutedChangedListener	Retorno de chamada para o evento 'isMuted' de CallAdapterSubscribers .
IsSpeakingChangedListener	Retorno de chamada para o evento 'isSpeakingChanged' de CallAdapterSubscribers .
LoadingState	Se o fluxo está carregando ou não.
LocalizationProviderProps	Props para LocalizationProvider.
MediaDiagnosticChangedEvent	Payload para DiagnosticChangedEventListner em que há uma alteração em um diagnóstico de mídia.
Message	União discriminada de todas as mensagens. O `messageType` campo é 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 uma única bolha de mensagem.
MessageContentType	Tipos com suporte de conteúdo de mensagem de chat.
MessageProps	Adereços para renderizar uma única mensagem. Consulte MessageRenderer.
MessageReadListener	Retorno de chamada para o evento 'messageRead' de Assinantes do ChatAdapter .
MessageReceivedListener	Retorno de chamada para o evento 'messageReceived' dos Assinantes do ChatAdapter .
MessageRenderer	Um componente para renderizar uma única mensagem.
MessageSentListener	Retorno de chamada para o evento 'messageSent' de Assinantes do ChatAdapter .
MessageStatus	Estado do lado do cliente de uma mensagem enviada. Inclui estados de transição que ocorrem antes da confirmação da entrega de mensagens do back-end.
MessageThreadProps	Adereços para MessageThread.
MessageThreadSelector	Tipo de seletor para componente MessageThread .
MicrophoneButtonSelector	Tipo de seletor para o componente MicrophoneButton .
NetworkDiagnosticChangedEvent	Payload para DiagnosticChangedEventListner em que 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	Participantes exibidos em um ParticipantList.
ParticipantListProps	Props para ParticipantList.
ParticipantListSelector	Tipo de seletor para o componente ParticipantList .
ParticipantMenuItemsCallback	Um retorno de chamada para fornecer itens de menu personalizados para cada participante em ParticipantList.
ParticipantState	O estado de conexão de um participante da chamada.
ParticipantsAddedListener	Retorno de chamada para chatAdapterSubscribers evento 'participantsAdded'.
ParticipantsButtonSelector	Tipo de seletor para o componente ParticipantsButton .
ParticipantsJoinedListener	Retorno de chamada para o evento "participantsJoined" de CallAdapterSubscribers .
ParticipantsLeftListener	Retorno de chamada para o evento 'participantsLeft' de CallAdapterSubscribers .
ParticipantsRemovedListener	Retorno de chamada para o evento 'participantsRemoved' dos Assinantes do ChatAdapter .
ReadReceiptsBySenderId	Uma matriz de pares chave-valor que armazena o nome de exibição de cada remetente e a última mensagem de leitura
ScreenShareButtonSelector	Tipo de seletor para o componente ScreenShareButton .
Selector	Um seletor otimizado que refina as atualizações de ClientState em adereços para componentes React nesta biblioteca.
SendBoxSelector	Tipo de seletor para o 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 `systemMessageType` campo é especializado em variantes de união.
TopicChangedListener	Retorno de chamada para o evento 'topicChanged' de ChatAdapterSubscribers .
TypingIndicatorSelector	Tipo de seletor para o 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 o 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>. Os componentes de chamada desse pacote devem ser encapsulados com um CallAgentProvider.
CallClientProvider(CallClientProviderProps)	Um <xref:React.Context> que armazena um StatefulCallClient. Os componentes de chamada desse pacote devem ser encapsulados com um CallClientProvider.
CallComposite(CallCompositeProps)	Uma composição 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 desse pacote devem ser encapsulados com um CallProvider.
CallWithChatComposite(CallWithChatCompositeProps)	CallWithChatComposite reúne os principais componentes para fornecer uma chamada completa com experiência de chat pronta para uso.
CameraButton(CameraButtonProps)	Um botão para ativar/desativar a câmera. Pode ser usado com ControlBar.
ChatClientProvider(ChatClientProviderProps)	Um <xref:React.Context> que armazena um StatefulChatClient. Os componentes de chat deste pacote devem ser encapsulados com um ChatClientProvider.
ChatComposite(ChatCompositeProps)	Uma composição de interface do usuário personalizável para a experiência de chat.
ChatThreadClientProvider(ChatThreadClientProviderProps)	Um <xref:React.Context> que armazena um <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>. Os componentes de chat deste pacote devem ser encapsulados 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, CameraButton ou suas próprias instâncias de ControlBarButton diretamente.
ControlBarButton(ControlBarButtonProps)	Botão padrão estilizado para a Barra de Controle. Use esse componente para criar botões personalizados que são estilizados da mesma forma que outros botões fornecidos pela Biblioteca de 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 cadeias de caracteres para que possam ser localizadas. Os erros ativos são selecionados por activeErrorMessages. Esse componente controla internamente o descarte pelo usuário. Erros que têm um carimbo de data/hora associado: o erro será mostrado na interface do usuário novamente se ocorrer após ser ignorado. Erros que não têm um carimbo de data/hora: o erro é ignorado até desaparecer dos adereços. Se o erro ocorrer novamente, ele será mostrado na interface do usuário. Usa o elemento de interface do <xref:%40fluentui%2Freact%23MessageBar> usuário.
FluentThemeProvider(FluentThemeProviderProps)	Provedor para aplicar um tema fluente nos componentes react desta biblioteca.
GridLayout(GridLayoutProps)	Um componente para definir blocos de participantes de áudio/vídeo em uma chamada.
LocalizationProvider(LocalizationProviderProps)	Provedor para fornecer cadeias de caracteres localizadas para os componentes react dessa biblioteca.
MessageStatusIndicator(MessageStatusIndicatorProps)	Componente para exibir o status de uma mensagem enviada. Adiciona um ícone e uma dica de ferramenta correspondentes à mensagem status.
MessageThread(MessageThreadProps)	`MessageThread` permite que você crie facilmente um componente para renderizar mensagens de chat, lidar com o comportamento de rolagem de mensagens novas/antigas e personalizar ícones & controles dentro do thread de chat.
MicrophoneButton(MicrophoneButtonProps)	Um botão para ativar/desativar o microfone. Pode ser usado com ControlBar.
ParticipantItem(ParticipantItemProps)	Componente para renderizar um participante de chamada ou chat. Exibe o avatar do participante, displayName e status, bem como ícones opcionais e menu de contexto.
ParticipantList(ParticipantListProps)	Componente para renderizar todos os participantes de chamada ou chat. Por padrão, cada participante é renderizado com ParticipantItem. Consulte <xref:ParticipantListProps.onRenderParticipant> para substituir.
ParticipantsButton(ParticipantsButtonProps)	Um botão para mostrar um menu com participantes de chamada ou chat. 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 sub-menu e uma opção para ativar o mudo de todos os participantes, bem como um botão copiar para área de transferência para copiar a URL de convite de chamada. Isso `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 digitar e enviar mensagens. Dá suporte ao envio de notificação de digitação quando o usuário começa a inserir texto. Dá suporte a 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 chat estiverem 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 ingressou na chamada.
VideoTile(VideoTileProps)	Um componente para renderizar o fluxo de vídeo para um participante de chamada única. Use com GridLayout em um VideoGallery.
createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)	Crie um CallAdapter com o Serviços de Comunicação do Azure. Essa é a implementação padrão de CallAdapter fornecida por essa biblioteca. Observação: `displayName` pode ter no máximo 256 caracteres.
createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)	Crie um CallAdapter usando o StatefulCallClient fornecido. Útil se você quiser manter uma referência a StatefulCallClient. Considere usar createAzureCommunicationCallAdapter para uma API mais simples.
createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)	Crie um CallWithChatAdapter com o apoio dos serviços de Comunicação do Azure para conectar-se ao CallWithChatComposite.
createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)	Crie um CallWithChatAdapter usando o StatefulChatClient e StatefulCallClient fornecidos. Ú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 com o apoio de Serviços de Comunicação do Azure. Essa é a implementação padrão de ChatAdapter fornecida 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 ChamadasHandlers 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 de ChatHandlers. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca. O objeto retornado é memorizado para evitar remetentes quando usado como adereços para componentes React.
createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)	Cria um StatefulCallClient StatefulCallClient por proxy CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> com ProxyCallClient <xref:ProxyCallClient> que, em seguida, permite o acesso ao estado de forma declarativa. É importante usar o <xref:%40azure%2Fcommunication-calling%23DeviceManager> e e <xref:%40azure%2Fcommunication-calling%23CallAgent><xref:%40azure%2Fcommunication-calling%23Call> (e etc.) obtidos do StatefulCallClient para que suas alterações de estado sejam criadas corretamente.
createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)	Cria um ChatClient StatefulChatClient com estado por proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> com ProxyChatClient <xref:ProxyChatClient> , que permite o acesso ao estado de maneira declarativa.
fromFlatCommunicationIdentifier(string)	Operação inversa de toFlatCommunicationIdentifier.
getCallingSelector<Component>(Component)	Obtenha o seletor de um componente especificado. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
getChatSelector<Component>(Component)	Obtenha o seletor de um componente especificado. Útil ao implementar um componente personalizado que utiliza os provedores exportados dessa biblioteca.
toFlatCommunicationIdentifier(CommunicationIdentifier)	Uma representação da cadeia de caracteres de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier>. Essa representação de cadeia de caracteres de CommunicationIdentifier tem a garantia de ser 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 de 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 conforme eles são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos de uso típicos.
useAzureCommunicationCallWithChatAdapter(Partial<AzureCommunicationCallWithChatAdapterArgs>, (adapter: CallWithChatAdapter) => Promise<CallWithChatAdapter>, (adapter: CallWithChatAdapter) => Promise<void>)	Um gancho de React personalizado para simplificar a criação de CallWithChatAdapter. Semelhante a 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 conforme eles são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos de uso típicos.
useAzureCommunicationChatAdapter(Partial<AzureCommunicationChatAdapterArgs>, (adapter: ChatAdapter) => Promise<ChatAdapter>, (adapter: ChatAdapter) => Promise<void>)	Um gancho de React personalizado para simplificar a criação do 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 conforme eles são criados. O adaptador só é criado quando todos os argumentos são definidos. Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos de uso típicos.
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 primário para obter todos os ganchos necessários para um componente de React dessa biblioteca. Para chamar esse gancho, o componente precisa ser encapsulado nesses provedores: Para componentes de chat: ChatClientProvider e ChatThreadClientProvider. Para chamar componentes: CallClientProvider, CallAgentProvider e CallAgentProvider. O uso mais simples de um componente é semelhante a: 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()	React gancho para acessar o tema

Detalhes da função

CallAgentProvider(CallAgentProviderProps)

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

Os componentes de chamada desse pacote devem ser encapsulados com um CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parâmetros

props: CallAgentProviderProps

Retornos

Element

CallClientProvider(CallClientProviderProps)

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

Os componentes de chamada desse pacote devem ser encapsulados com um CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parâmetros

props: CallClientProviderProps

Retornos

Element

CallComposite(CallCompositeProps)

Uma composição de interface do usuário personalizável para a experiência de chamada.

function CallComposite(props: CallCompositeProps): Element

Parâmetros

props: CallCompositeProps

Retornos

Element

Comentários

Chame a composição de largura/altura mínima são as seguintes:

mobile: 17.5rem x 21rem (280px x 336px, com rem padrão em 16px)
desktop: 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 desse pacote devem ser encapsulados com um CallProvider.

function CallProvider(props: CallProviderProps): Element

Parâmetros

props: CallProviderProps

Retornos

Element

CallWithChatComposite(CallWithChatCompositeProps)

CallWithChatComposite reúne os principais componentes para fornecer uma chamada completa com experiência de chat pronta para uso.

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parâmetros

props: CallWithChatCompositeProps

Retornos

Element

CameraButton(CameraButtonProps)

Um botão para ativar/desativar a câmera.

Pode ser usado com ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parâmetros

props: CameraButtonProps

Retornos

Element

ChatClientProvider(ChatClientProviderProps)

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

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

function ChatClientProvider(props: ChatClientProviderProps): Element

Parâmetros

props: ChatClientProviderProps

Retornos

Element

ChatComposite(ChatCompositeProps)

Uma composição de interface do usuário personalizável para a experiência de chat.

function ChatComposite(props: ChatCompositeProps): Element

Parâmetros

props: ChatCompositeProps

Retornos

Element

Comentários

A largura mínima e a altura da composição de 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 encapsulados com um ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parâmetros

props: ChatThreadClientProviderProps

Retornos

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, CameraButton ou suas próprias instâncias de ControlBarButton diretamente.

function ControlBar(props: ControlBarProps): Element

Parâmetros

props: ControlBarProps

Retornos

Element

ControlBarButton(ControlBarButtonProps)

Botão padrão estilizado para a Barra de Controle.

Use esse componente para criar botões personalizados que são estilizados da mesma forma que outros botões fornecidos pela Biblioteca de Interface do Usuário.

function ControlBarButton(props: ControlBarButtonProps): Element

Parâmetros

props: ControlBarButtonProps

Retornos

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

Retornos

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

Retornos

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 cadeias de caracteres para que possam ser localizadas. Os erros ativos são selecionados por activeErrorMessages.

Esse componente controla internamente o descarte pelo usuário.

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

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

function ErrorBar(props: ErrorBarProps): Element

Parâmetros

props: ErrorBarProps

Retornos

Element

FluentThemeProvider(FluentThemeProviderProps)

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

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parâmetros

props: FluentThemeProviderProps

Retornos

Element

Comentários

Os componentes nesta biblioteca são compostos principalmente pela interface do usuário fluente, controles e também por controles Fluent React Northstar. Esse provedor lida com a aplicação de qualquer tema fornecido aos controles de interface do usuário fluentes subjacentes, bem como aos controles Fluent React Northstar.

GridLayout(GridLayoutProps)

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

function GridLayout(props: GridLayoutProps): Element

Parâmetros

props: GridLayoutProps

Retornos

Element

LocalizationProvider(LocalizationProviderProps)

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

function LocalizationProvider(props: LocalizationProviderProps): Element

Parâmetros

props: LocalizationProviderProps

Retornos

Element

Comentários

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 à mensagem status.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parâmetros

props: MessageStatusIndicatorProps

Retornos

Element

MessageThread(MessageThreadProps)

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

function MessageThread(props: MessageThreadProps): Element

Parâmetros

props: MessageThreadProps

do tipo MessageThreadProps

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

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

Retornos

Element

MicrophoneButton(MicrophoneButtonProps)

Um botão para ativar/desativar o microfone.

Pode ser usado com ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parâmetros

props: MicrophoneButtonProps

Retornos

Element

ParticipantItem(ParticipantItemProps)

Componente para renderizar um participante de chamada ou chat.

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

function ParticipantItem(props: ParticipantItemProps): Element

Parâmetros

props: ParticipantItemProps

Retornos

Element

ParticipantList(ParticipantListProps)

Componente para renderizar todos os participantes de chamada ou chat.

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

function ParticipantList(props: ParticipantListProps): Element

Parâmetros

props: ParticipantListProps

Retornos

Element

ParticipantsButton(ParticipantsButtonProps)

Um botão para mostrar um menu com participantes de chamada ou chat.

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 sub-menu e uma opção para ativar o mudo de todos os participantes, bem como um botão copiar para área de transferência para copiar a URL de convite de chamada. Isso menuProps pode ser totalmente redefinido e sua propriedade é do tipo IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parâmetros

props: ParticipantsButtonProps

Retornos

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

Retornos

Element

SendBox(SendBoxProps)

Componente para digitar e enviar mensagens.

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

function SendBox(props: SendBoxProps): Element

Parâmetros

props: SendBoxProps

Retornos

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

Retornos

Element

TypingIndicator(TypingIndicatorProps)

Componente para notificar o usuário local quando um ou mais participantes no thread de chat estiverem digitando.

function TypingIndicator(props: TypingIndicatorProps): Element

Parâmetros

props: TypingIndicatorProps

Retornos

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 ingressou na chamada.

function VideoGallery(props: VideoGalleryProps): Element

Parâmetros

props: VideoGalleryProps

Retornos

Element

VideoTile(VideoTileProps)

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

Use com GridLayout em um VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parâmetros

props: VideoTileProps

Retornos

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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

Essa é a implementação padrão de CallAdapter fornecida por essa biblioteca.

Observação: displayName pode ter no máximo 256 caracteres.

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

Parâmetros

__namedParameters: AzureCommunicationCallAdapterArgs

Retornos

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator)

Crie um CallAdapter usando o StatefulCallClient fornecido.

Ú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

Retornos

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

Crie um CallWithChatAdapter com o apoio dos serviços de Comunicação do Azure para conectar-se ao CallWithChatComposite.

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

Parâmetros

__namedParameters: AzureCommunicationCallWithChatAdapterArgs

Retornos

Promise<CallWithChatAdapter>

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Crie um CallWithChatAdapter usando o StatefulChatClient e StatefulCallClient fornecidos.

Ú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

Retornos

Promise<CallWithChatAdapter>

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

Crie um ChatAdapter com o apoio de Serviços de Comunicação do Azure.

Essa é a implementação padrão de ChatAdapter fornecida por esta biblioteca.

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

Parâmetros

__namedParameters: AzureCommunicationChatAdapterArgs

Retornos

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

Retornos

Promise<ChatAdapter>

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

Crie a implementação padrão de ChamadasHandlers 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

Retornos

CallingHandlers

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

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

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

O objeto retornado é memorizado para evitar remetentes quando usado como adereços para componentes React.

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

Parâmetros

chatClient: StatefulChatClient

chatThreadClient: ChatThreadClient

Retornos

ChatHandlers

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

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

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

Parâmetros

args: StatefulCallClientArgs

StatefulCallClientArgs

options: StatefulCallClientOptions

StatefulCallClientOptions

Retornos

StatefulCallClient

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Cria um ChatClient StatefulChatClient com estado por proxy ChatClient <xref:%40azure%2Fcommunication-chat%23ChatClient> com ProxyChatClient <xref:ProxyChatClient> , que permite o acesso ao estado de maneira declarativa.

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

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parâmetros

id: string

Retornos

CommunicationIdentifier

getCallingSelector<Component>(Component)

Obtenha o seletor de 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

Retornos

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Obtenha o seletor de 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

Retornos

GetChatSelector<Component>

toFlatCommunicationIdentifier(CommunicationIdentifier)

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

Essa representação de cadeia de caracteres de CommunicationIdentifier tem a garantia de ser 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

Retornos

string

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

Um gancho de 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 conforme eles são criados. O adaptador só é criado quando todos os argumentos são definidos.

Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos de uso típicos.

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

Parâmetros

args: Partial<AzureCommunicationCallAdapterArgs>

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

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

Retornos

undefined | CallAdapter

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

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

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

Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos de uso típicos.

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

Parâmetros

args: Partial<AzureCommunicationCallWithChatAdapterArgs>

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

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

Retornos

undefined | CallWithChatAdapter

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

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

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

Observe que você deve memorizar os argumentos para evitar recriar o adaptador em cada renderização. Confira o storybook para obter exemplos 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>

Retornos

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

Retornos

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

Retornos

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

Retornos

StatefulCallClient

useChatClient()

Gancho para obter StatefulChatClient do provedor.

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

function useChatClient(): StatefulChatClient

Retornos

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

Retornos

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

Retornos

undefined | StatefulDeviceManager

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

Gancho primário para obter todos os ganchos necessários para um componente de React dessa biblioteca.

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

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

O uso mais simples de um componente é semelhante a:

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"

Retornos

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"

Retornos

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

useTheme()

React gancho para acessar o tema

function useTheme(): Theme

Retornos

Theme

Compartilhar via

@azure/communication-react package

Classes

Interfaces

Aliases de tipo

Funções

Detalhes da função

CallAgentProvider(CallAgentProviderProps)

Parâmetros

Retornos

CallClientProvider(CallClientProviderProps)

Parâmetros

Retornos

CallComposite(CallCompositeProps)

Parâmetros

Retornos

Comentários

CallProvider(CallProviderProps)

Parâmetros

Retornos

CallWithChatComposite(CallWithChatCompositeProps)

Parâmetros

Retornos

CameraButton(CameraButtonProps)

Parâmetros

Retornos

ChatClientProvider(ChatClientProviderProps)

Parâmetros

Retornos

ChatComposite(ChatCompositeProps)

Parâmetros

Retornos

Comentários

ChatThreadClientProvider(ChatThreadClientProviderProps)

Parâmetros

Retornos

ControlBar(ControlBarProps)

Parâmetros

Retornos

ControlBarButton(ControlBarButtonProps)

Parâmetros

Retornos

DevicesButton(DevicesButtonProps)

Parâmetros

Retornos

EndCallButton(EndCallButtonProps)

Parâmetros

Retornos

ErrorBar(ErrorBarProps)

Parâmetros

Retornos

FluentThemeProvider(FluentThemeProviderProps)

Parâmetros

Retornos

Comentários

GridLayout(GridLayoutProps)

Parâmetros

Retornos

LocalizationProvider(LocalizationProviderProps)

Parâmetros

Retornos

Comentários

MessageStatusIndicator(MessageStatusIndicatorProps)

Parâmetros

Retornos

MessageThread(MessageThreadProps)

Parâmetros

Retornos

MicrophoneButton(MicrophoneButtonProps)

Parâmetros

Retornos

ParticipantItem(ParticipantItemProps)

Parâmetros

Retornos

ParticipantList(ParticipantListProps)

Parâmetros

Retornos

ParticipantsButton(ParticipantsButtonProps)

Parâmetros

Retornos