Compartilhar via


@azure/communication-react package

Classes

CallError

Erro gerado de métodos de API com estado com falha.

ChatError

Erro gerado de métodos StatefulChatClient com falha.

Interfaces

AcceptedTransfer

Estado do recurso de transferência

ActiveErrorMessage

Mensagens de erro ativas a serem mostradas por meio de ErrorBar.

ActiveNotification

Notificações ativas a serem mostradas via NotificationStack.

AdapterError

Erro relatado por meio de eventos de erro e armazenado no estado do adaptador.

AdapterNotification

Notificação do estado do cliente de chamada armazenada no estado do adaptador.

AdapterState

Funcionalidade para interfiguração com o estado do adaptador composto.

AttachmentMetadata

Modelo de dados que representa um anexo de mensagem de chat em que contém uma ID para identificar exclusivamente o anexo, um nome que representa o nome do arquivo e uma URL para baixar o anexo.

BaseCompositeProps

Propriedades comuns a todos os compostos exportados dessa biblioteca.

BaseCustomStyles

Estilos fluentes básicos props para todos os componentes exportados deste libray.

BreakoutRoomsState

Estado das salas de sessão de grupo

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

Versão somente de estado de <xref:%40azure%2Fcommunication-calling%23CallAgent> exceto chamadas é movida para ser um filho diretamente de CallClientState e não incluído aqui. O motivo para ter o proxy 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, callsEnded, incomingCalls e incomingCallsEnded serão fornecidas automaticamente se um callAgent tiver sido criado. O deviceManager ficará vazio inicialmente até que o DeviceManagerState. O estado userId é fornecido como uma conveniência para o desenvolvedor e é completamente controlado e definido pelo desenvolvedor.

CallCompositeLoaderProps

Props para o OutboundCallComposite que você pode usar em seu aplicativo.

Contém duas opções de bolsas:

CallCompositeProps

Adereços para CallComposite.

CallCompositeStrings

Cadeias de caracteres usadas diretamente pelo callComposite.

Essas cadeias de caracteres são adicionais às usadas pelos componentes da biblioteca de componentes.

CallFeatureStreamState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23CallFeatureStream>. Representa o estado do fluxo de recursos de chamada.

CallInfoState

Estado para rastrear os tipos <xref:CallInfo> e <xref:TeamsCallInfo>

CallNotification
CallProviderProps

Argumentos para inicializar um CallProvider.

CallState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recuperará automaticamente o estado da chamada e o adicionará ao estado exposto por statefulCallClient.

CallSurveyImprovementSuggestions

Representa a parte de sugestão de melhoria da pesquisa de chamadas

CallWithChatAdapter

interface do Adaptador CallWithChatComposite.

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 o CallWithChat Composite.

CallWithChatAdapterSubscriptions

Eventos de chamada e chat que podem ser assinados no CallWithChatAdapter.

CallWithChatAdapterUiState

Estado da interface do usuário relativo ao CallWithChatComposite.

CallWithChatClientState

Estado dos serviços de back-end que conduz CallWithChatComposite .

CallWithChatCompositeLoaderProps

Props para o CallWithChatComposite que você pode usar em seu aplicativo.

Contém duas opções de bolsas:

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

Opções de personalização para a barra de controle na experiência de chamada com chat.

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

Paleta de temas Fluent personalizada usada chamando componentes relacionados nesta biblioteca.

CameraButtonContextualMenuStyles

Estilos para o menu CameraButton.

CameraButtonProps

Adereços para componente CameraButton.

CameraButtonStrings

Cadeias de caracteres de CameraButton que podem ser substituídas.

CameraButtonStyles

Estilos para CameraButton

CapabilitiesFeatureState

Declarar apenas a versão de <xref:%40azure%2Fcommunication-calling%23CapabilitiesFeature>

CapabilityChangedNotificationStrings

Cadeias de caracteres para notificação de alteração de funcionalidade

CaptionLanguageStrings

Strings de idioma de legenda para configuração modal de legendas

CaptionsBannerProps

CaptionsBanner Props do componente.

CaptionsBannerStrings

Strings para banner de legendas

CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps

CaptionsSettingsPropriedades do componente modal.

CaptionsSettingsModalStrings

strings para legendas definindo modal

ChatAdapterSubscribers

Eventos compostos de chat que podem ser assinados.

ChatAdapterThreadManagement

Funcionalidade para gerenciar o thread de chat atual.

ChatCompositeLoaderProps

Props para o ChatComposite que você pode usar em seu aplicativo. Contém as opções para o ChatCompositeChatCompositeOptions.

ChatCompositeProps

Adereços para do ChatComposite.

ChatCompositeStrings

Cadeias de caracteres usadas diretamente pelo ChatComposite.

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 CallComposite.

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 pelos compostos, em vez dos componentes contidos.

ConferencePhoneInfo

Informações para informações de telefone de conferência

ContentSystemMessage

Uma mensagem do sistema com conteúdo arbitrário.

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.

CustomCallControlButtonCallbackArgs

Argumentos para CustomCallControlButtonCallback.

CustomCallControlButtonProps

Resposta de CustomCallControlButtonCallback. Inclui as propriedades básicas necessárias para renderizar um ControlBarButton ou <xref:DrawerMenuItem>.

CustomCallControlButtonStrings

Cadeias de caracteres para CustomCallControlButtons

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>.

DialpadProps

Adereços para o componente Dialpad .

DialpadStrings

Strings de teclado de discagem que podem ser substituídas.

DialpadStyles

Estilos para o componente Teclado de discagem .

Disposable

Funcionalidade para descartar corretamente um Composto.

DtmfDialPadOptions

Opções para determinar o comportamento de renderização do dtmfDialer no CallComposite

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

Adereços para FluentThemeProvider.

GridLayoutProps

Adereços para GridLayout .

GridLayoutStyles

estilos de componente GridLayout.

HoldButtonProps
HoldButtonStrings

Strings para os rótulos do botão de espera

HorizontalGalleryStyles

estilos de componente <xref:HorizontalGallery>.

ImageOverlayProps

Adereços para ImageOverlay.

ImageOverlayStrings

Cadeias de caracteres de ImageOverlay que podem ser substituídas.

IncomingCallNotificationProps

Propriedades do componente de notificação de chamada recebida.

IncomingCallNotificationStrings

Cadeias de caracteres para o componente de notificação de chamada recebida.

IncomingCallNotificationStyles

Estilos para o componente de notificação de chamada recebida.

IncomingCallStackCall

Representa uma chamada de entrada ativa.

IncomingCallStackProps

Props para o componente IncomingCallManager.

IncomingCallState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detectará automaticamente as chamadas de entrada e adicionará seu estado ao estado exposto por StatefulCallClient.

InlineImage

InlineImage, conforme refletido na interface do usuário.

InlineImageOptions

Opções para exibir a imagem embutida no cenário de imagem embutida.

JoinCallOptions

Opções para definir o estado do microfone e da câmera ao entrar em uma chamada true = ligar o dispositivo ao entrar na chamada false = desligar o dispositivo ao entrar na chamada 'manter'/undefined = reter o estado de pré-chamada dos dispositivos

JumpToNewMessageButtonProps

Argumentos para <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

LocalVideoStreamVideoEffectsState

Versão somente de estado de <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>um arquivo .

LocalVideoTileOptions

Opções para o bloco de vídeo local na composição Chamada.

MediaAccessState

Estado de acesso à mídia

MediaDiagnosticsState

Proxy somente de estado para <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.

MeetingConferencePhoneInfoModalStrings

Strings para modal de informações do telefone

MessageCommon

Propriedades comuns de todos os tipos de mensagem.

MessageStatusIndicatorProps

Adereços 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>.

NotificationOptions

Opções para controlar as notificações na composição.

NotificationProps

Adereços para notificação.

NotificationStackProps

Props para NotificationStack.

NotificationStackStrings

Todas as cadeias de caracteres que podem ser mostradas na interface do usuário no NotificationStack.

NotificationStrings

Todas as cadeias de caracteres que podem ser mostradas na interface do usuário na Notificação.

NotificationStyles

Estilos para o componente de notificação.

OptimalVideoCountFeatureState

Versão somente de estado do recurso <xref:%40azure%2Fcommunication-calling%23OptimalVideoCountCallFeature>de contagem de vídeo ideal .

OptionsDevice

Um dispositivo, por exemplo, câmera, microfone ou alto-falante, no submenu DevicesButton.

OutboundCallCompositeLoaderProps

Props para o OutboundCallComposite que você pode usar em seu aplicativo.

Contém duas opções de bolsas:

PPTLiveCallFeatureState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient escutará automaticamente o pptLive na chamada e atualizará o estado exposto pelo StatefulCallClient de acordo.

ParticipantAddedSystemMessage

Uma mensagem do sistema notificando que um participante foi adicionado ao thread de chat.

ParticipantItemProps

Adereços para ParticipantItem .

ParticipantItemStrings

Cadeias de caracteres de ParticipantItem que podem ser substituídas.

ParticipantItemStyles

Estilos fluentes para ParticipantItem .

ParticipantListItemStyles

Estilos do ParticipantItem.

ParticipantListStyles

Estilos do ParticipantList .

ParticipantRemovedSystemMessage

Uma mensagem do sistema notificando que um participante foi removido do thread de chat.

ParticipantsButtonContextualMenuStyles

Estilos para o menu ParticipantsButton.

ParticipantsButtonProps

Adereços para ParticipantsButton.

ParticipantsButtonStrings

Cadeias de caracteres de ParticipantsButton que podem ser substituídas.

ParticipantsButtonStyles

Estilos props para ParticipantsButton.

RaiseHandButtonProps

Adereços para RaiseHandButton.

RaiseHandButtonStrings

Cadeias de caracteres de RaiseHandButton que podem ser substituídas.

RaiseHandCallFeature

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23RaiseHandCallFeature>. StatefulCallClient escutará automaticamente as mãos levantadas na chamada e atualizará o estado exposto por StatefulCallClient de acordo.

ReactionButtonProps

Adereços para ReactionButton.

ReactionButtonStrings

Strings de ReactionButton que podem ser substituídas.

ReactionResources

Interface para imagem de sprite de animação e metadados relacionados

RealTimeTextCallFeatureState
RealTimeTextInfo
RealTimeTextModalProps

Propriedades do componente RealTimeTextModal.

RealTimeTextModalStrings

strings para o modal realTimeText

RealTimeTextProps

Props para uma única linha de RealTimeText.

RealTimeTextStrings

Strings para RTT

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á automaticamente RemoteParticipants e adicionará seu estado ao estado exposto por StatefulCallClient.

RemoteVideoStreamState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

RemoteVideoTileMenuOptions

Opções de menu para blocos de vídeo remotos no VideoGallery.

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>.

SpokenLanguageStrings

Cadeias de caracteres de idioma falado para configuração modal de legendas

SpotlightCallFeatureState

Declarar apenas a versão de <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>

SpotlightPromptStrings

Strings usadas no prompt relacionado ao spotlight

SpotlightState

Estado do destaque com ordem

StartCaptionsAdapterOptions

Opções passadas para adapter.startCaptions

StartCaptionsButtonProps
StartCaptionsButtonStrings

Strings para os rótulos do botão de espera

StartRealTimeTextButtonProps

Adereços para o componente StartRealTimeTextButton

StartRealTimeTextButtonStrings

Strings para os rótulos do botão de espera

StatefulCallClient

Define os métodos que permitem que o CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> seja usado com estado. A interface fornece acesso ao estado com proxie e também permite registrar um manipulador para eventos de alteração de estado. Para definição de estado, consulte CallClientState.

Os eventos de alteração de estado são orientados por:

  • Dados retornados de APIs de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.
  • Dados retornados de APIs de <xref:%40azure%2Fcommunication-calling%23CallAgent>.
  • 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'
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raiadoHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature 'reação'
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 proxie e também permite registrar um manipulador para eventos de alteração de estado.

StatefulDeviceManager

Define os métodos adicionais adicionados pelo estado em cima de <xref:%40azure%2Fcommunication-calling%23DeviceManager>.

StopCaptionsAdapterOptions

Opções passadas para adapter.stopCaptions

StreamMediaProps

Adereços para StreamMedia.

SurveyIssues

Textos correspondentes a cada edição de chamada

SurveyIssuesHeadingStrings

Textos correspondentes a cada categoria de edição de chamada

SystemMessageCommon

Propriedades comuns de todas as mensagens do sistema.

TeamsCallAdapter

Uma interface de adaptador específica para identidade do Teams que estende CommonCallAdapter.

TeamsCallingHandlers

Objeto que contém todos os manipuladores de chamadas de equipes necessários para chamar componentes.

Chamar componentes relacionados desse pacote é capaz de escolher manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.

TeamsIncomingCallState

Declarar apenas a versão de <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall>

TogetherModeCallFeatureState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Representa o estado do recurso Modo Juntos.

TogetherModeSeatingPositionState

Versão somente de estado do <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>.

Representa a posição sentada de um participante no Modo Juntos.

TogetherModeStreamOptions

Interface que representa o resultado de uma visualização de fluxo do Modo Juntos.

TogetherModeStreamViewResult

Interface que representa o resultado de uma visualização de fluxo do Modo Juntos.

TogetherModeStreamsState

Representa os fluxos no Modo Juntos.

TopicUpdatedSystemMessage

Uma mensagem do sistema notificando que o tópico do thread 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.

TransferFeature

Estado do recurso de transferência

TypingIndicatorProps

Adereços para TypingIndicator.

TypingIndicatorStrings

Cadeias de caracteres de typingIndicator que podem ser substituídas.

TypingIndicatorStylesProps

Estilos fluentes para TypingIndicator.

VerticalGalleryControlBarStyles

Estilos para a barra de controle dentro do componente VerticalGallery

VerticalGalleryStrings

Strings para localização da galeria vertical.

VerticalGalleryStyles

Estilos para o componente VerticalGallery

VideoBackgroundBlurEffect

Contém os atributos do efeito de fundo de vídeo desfocado

VideoBackgroundImage

Contém os atributos de uma imagem de fundo como url, nome etc.

VideoBackgroundNoEffect

Contém os atributos para remover o efeito de fundo do vídeo

VideoBackgroundReplacementEffect

Contém os atributos de um efeito de plano de fundo de vídeo de substituição selecionado

VideoGalleryLocalParticipant

O estado do participante local do VideoGallery.

VideoGalleryProps

Adereços para VideoGallery.

VideoGalleryRemoteParticipant

O estado de um participante remoto no VideoGallery.

VideoGalleryStream

Fluxo de vídeo de um participante do VideoGallery.

VideoGalleryStrings

Todas as cadeias de caracteres que podem ser mostradas na interface do usuário no VideoGallery.

VideoGalleryStyles

estilos de componente VideoGallery.

VideoGalleryTogetherModeSeatingInfo

Interface que representa as informações de assentos no modo Together.

VideoGalleryTogetherModeStreams

Interface que representa os fluxos no modo Together.

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 createView e removida por disposeView.

VideoTileContextualMenuProps

Propriedades para mostrar o menu contextual para componentes remotos do VideoTile no VideoGallery.

VideoTileDrawerMenuProps

Propriedades para mostrar o menu da gaveta no VideoTile remoto toque longo no VideoGallery.

VideoTileProps

Adereços para VideoTile .

VideoTileStrings

Cadeias de caracteres de VideoTile que podem ser substituídas.

VideoTileStylesProps

Estilos fluentes para videotile.

VideoTilesOptions

Opções que se aplicam a todos os blocos de vídeo na VideoGallery

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.

AdapterNotifications

Os adaptadores armazenam a notificação mais recente para cada destino.

AreEqual

Comparar se 2 componentes react são iguais exatos, o tipo de resultado será true/false

AreParamEqual

Comparar se os adereços de 2 componentes react são iguais, o tipo de resultado será true/false

AreTypeEqual

Comparar se dois tipos são iguais, o tipo de resultado será true/false

AvatarPersonaData

Atributos de dados personalizados para exibir o avatar de 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 dos Serviços de Comunicação do Azure de CallAdapter.

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

AzureCommunicationCallAdapterOptions

Parâmetros opcionais para criar useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>)

AzureCommunicationCallWithChatAdapterArgs

Argumentos para createAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Argumentos para <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

Argumentos para criar a implementação dos Serviços de Comunicação do Azure de chatAdapter.

AzureCommunicationOutboundCallAdapterArgs

Argumentos para criar a implementação dos Serviços de Comunicação do Azure de CallAdapter.

Esses argumentos são usados para criar cenários de chamada de saída.

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

CallAdapterCallEndedEvent

Conteúdo para CallEndedListener contendo detalhes sobre a chamada final.

CallAdapterClientState

commonCallAdapter estado inferido do back-end dos Serviços de Comunicação do Azure.

CallAdapterLocator

Localizador usado por createAzureCommunicationCallAdapter para localizar a chamada para ingressar

CallAdapterState

estado CommonCallAdapter.

CallAdapterUiState

commonCallAdapter estado para fins de interface do usuário puros.

CallCompositeIcons

Ícones que podem ser substituídos para CallComposite.

CallCompositeOptions

Recursos opcionais do CallComposite.

CallCompositePage

Telas principais 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 gerados de chamadas de API para o SDK de Chamada.

Cada propriedade no objeto armazena o erro mais recente para um método de API do SDK específico.

Erros desse objeto podem ser limpos usando o <xref:newClearCallErrorsModifier>. Além disso, os erros são limpos automaticamente quando:

  • O estado está limpo.
  • As chamadas subsequentes aos métodos de API relacionados são bem-sucedidas. Consulte a documentação de métodos de cliente com estado individuais para obter detalhes sobre quando os erros podem ser limpos automaticamente.
CallFeatureStreamName

Representa o nome do fluxo de recursos de chamada

CallIdChangedListener

Retorno de chamada para callAdapterSubscribers evento 'callIdChanged'.

CallNotifications
CallParticipantListParticipant

Chamando o estado do participante, conforme refletido nos componentes da interface do usuário.

CallWithChatCompositeIcons

Ícones que podem ser substituídos para CallWithChatComposite .

CallWithChatCompositeOptions

Recursos opcionais do CallWithChatComposite.

CallWithChatEvent

Eventos disparados pelo CallWithChatAdapter.

CallingBaseSelectorProps

Adereços comuns usados para fazer referência à chamada de estado declarativo do cliente.

CallingHandlersOptions

Opções de configuração para incluir dependência de plano de fundo de efeito de vídeo.

CallingReturnProps

Tipo auxiliar para usePropsFor.

CallingSounds

Digite para representar um conjunto de sons a serem usados para diferentes eventos de chamada

CameraButtonSelector

Tipo de seletor para componente CameraButton.

CancelEditCallback

A função de retorno de chamada é executada quando uma edição de mensagem é cancelada.

CapabilitiesChangedListener

Retorno de chamada para o evento 'capabilitiesChanged' CallAdapterSubscribers .

CaptionSettingsSelector

Tipo de seletor para componentes para Alterar o idioma da legenda e o idioma falado

CaptionsBannerSelector

Tipo de seletor para o componente CaptionsBanner .

CaptionsInformation

informações necessárias para cada linha de legenda

CaptionsOptions

Bolsa de opções para iniciar legendas

CaptionsReceivedListener

Retorno de chamada para o evento 'captionsReceived' CallAdapterSubscribers .

ChatAdapter

interface do Adaptador de do ChatComposite.

ChatAdapterOptions

Opções para configurar o ChatAdapter.

ChatAdapterState

estado do ChatAdapter.

ChatAdapterUiState

chatAdapter estado para fins de interface do usuário puros.

ChatAttachmentType

Representa o tipo de anexo

ChatBaseSelectorProps

Adereços 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 para 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 em ChatErrors.

ChatErrors

Erros gerados de chamadas de API para o SDK de Chat.

Cada propriedade no objeto armazena o erro mais recente para um método de API do SDK específico.

ChatHandlers

Objeto que contém todos os manipuladores necessários para componentes de chat.

Os componentes relacionados ao chat desse pacote são capazes de escolher manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.

ChatInitializedListener

Retorno de chamada para <xref:CallWithChatAdapterSubscribers> o evento 'chatInitialized'.

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.

ChatProfile

O perfil de um usuário ou bot.

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>.

Veja também: CallClientState, ChatClientState.

Common

Tipo de interseção de retorno de 2 tipos

CommonCallAdapterOptions

Parâmetros opcionais comuns para criar useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (adapter: CallAdapter) => Promise<CallAdapter>, (adapter: CallAdapter) => Promise<void>) ou TeamsCallAdapter

CommonCallControlOptions

Opções de personalização para a barra de controle na experiência de chamada.

CommonProperties

Retornar propriedades de interseção de dois tipos

CommunicationParticipant

O estado de um participante de chat ou de chamada, conforme refletido na interface do usuário.

ComponentIcons

Ícones usados pelos componentes do React exportados dessa biblioteca.

ComponentProps

Tipo auxiliar para usePropsFor.

ComponentSlotStyle

ComponentSlotStyle é um @fluentui/react-northstar tipo. À medida que nos afastamos desse pacote, usamos o tipo IRawStyle mais genérico do fluent para interoperabilidade.

CompositeIcons

Ícones que podem ser substituídos em uma das composição exportadas por essa biblioteca.

Consulte ChatCompositeIcons, CallCompositeIcons e CallWithChatCompositeIcons para obter tipos mais direcionados.

ControlBarButtonStyles

Estilos para todas as implementações de ControlBarButton.

ControlBarLayout

Apresentar layouts para o doControlBar.

CreateDefaultCallingHandlers

Tipo de createDefaultCallingHandlers.

CreateViewResult

Retornar resultado de createView.

CustomAvatarOptions

Opções que podem ser injetadas na função onRender para personalizar um componente Avatar (Persona).

CustomCallControlButtonCallback

Um retorno de chamada que retorna as props para renderizar um ControlBarButton personalizado e <xref:DrawerMenuItem>um arquivo .

A resposta indica onde o botão personalizado deve ser colocado.

Dica de desempenho: esse retorno de chamada só é chamado quando o retorno de chamada ou seus argumentos são alterados.

CustomCallControlButtonPlacement

Posicionamento de um botão personalizado injetado <xref:CommonCallControlBar>no .

'primary': coloque o(s) botão(ões) na extremidade direita da barra de controle central, mas antes do EndCallButton (extremidade esquerda no modo rtl). 'overflow': Coloque o(s) botão(ões) no final do menu flutuante. 'secundário': Coloque o(s) botão(ões) na extremidade esquerda da barra de controle lateral (direita no modo rtl).

Vários botões atribuídos ao mesmo posicionamento são anexados em ordem. Por exemplo, se dois botões forem colocados em 'secundário', ambos aparecerão na extremidade esquerda (extremidade direita no modo rtl) na ordem fornecida.

Somente o posicionamento 'primário' funciona quando o controle de chamadas herdado está habilitado no composto de chamadas

DeclarativeCallAgent

DeclarativeCallAgent estende e faz proxy do <xref:%40azure%2Fcommunication-calling%23CallAgent>

DeclarativeTeamsCallAgent

DeclarativeTeamsCallAgent estende e faz proxy do <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>

DeepNoiseSuppressionEffectDependency

Tipo de dependência a ser injetado para supressão de ruído profundo

DeviceManagerState

Esse tipo destina-se a encapsular todo o estado dentro de <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 vazias até <xref:%40azure%2Fcommunication-calling%23DeviceManager>que as APIs getCameras, getMicrophones, getSpeakers e askDevicePermission correspondentes sejam chamadas e concluídas.

DevicesButtonSelector

Tipo de seletor para componente DevicesButton.

DiagnosticChangedEventListner

Retorno de chamada para callAdapterSubscribers evento 'diagnosticChanged'.

DialpadMode

Modos do componente do teclado de discagem.

DisplayNameChangedListener

Retorno de chamada para CallAdapterSubscribers evento 'displayNameChanged'.

DtmfTone

Tom DTMF para chamadas PSTN.

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 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.

HoldButtonSelector

Tipo de seletor para o componente HoldButton .

IncomingCallManagement

Isso contém uma matriz somente leitura que retorna todos os arquivos .incomingCalls Uma chamada de entrada ativa é uma chamada que não foi atendida, recusada ou desconectada.

IncomingCallStackSelector

Seletor para obter as chamadas de entrada ativas e removidas.

IsCaptionLanguageChangedListener

Retorno de chamada para o evento 'isCaptionLanguageChanged' de CallAdapterSubscribers .

IsCaptionsActiveChangedListener

Retorno de chamada para o evento 'isCaptionsActiveChanged' de CallAdapterSubscribers .

IsLocalScreenSharingActiveChangedListener

Retorno de chamada para CallAdapterSubscribers evento 'isLocalScreenSharingActiveChanged'.

IsMutedChangedListener

Retorno de chamada para callAdapterSubscribers evento 'isMuted'.

IsSpeakingChangedListener

Retorno de chamada para callAdapterSubscribers evento 'isSpeakingChanged'.

IsSpokenLanguageChangedListener

Retorno de chamada para o evento 'isSpokenLanguageChanged' de CallAdapterSubscribers .

LoadingState

Se o fluxo está carregando ou não.

LocalScreenShareView
LocalVideoTileSize

Diferentes modos do bloco de vídeo local

LocalizationProviderProps

Adereços para LocalizationProvider.

LongPressTrigger

Modos de como os manipuladores de longpress podem ser tiggerados.

MediaAccess

Estado de acesso à mídia de áudio/vídeo

MediaDiagnosticChangedEvent

Conteúdo para DiagnosticChangedEventListner em que 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. Se true, a mensagem aparecerá agrupada com a mensagem antes dela. 'top' e 'bottom' são usados para indicar que a mensagem é o início ou o fim de um grupo.

MessageContentType

Tipos com suporte de conteúdo de mensagens de chat.

MessageDeletedListener

Retorno de chamada para o evento 'messageDeleted' ChatAdapterSubscribers .

MessageEditedListener

Retorno de chamada para o evento 'messageEdited' ChatAdapterSubscribers .

MessageProps

Adereços 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 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 componente MicrophoneButton.

NetworkDiagnosticChangedEvent

Conteúdo para DiagnosticChangedEventListner em que há uma alteração em um diagnóstico de rede.

NotificationStackSelector

Tipo de seletor para o componente Notificação .

NotificationTarget
NotificationType

Todas as notificações que podem ser mostradas no NotificationStack.

OnFetchChatProfileCallback

Função de retorno de chamada usada para fornecer dados personalizados para criar o perfil de um usuário ou bot.

OnFetchProfileCallback

Função de retorno de chamada usada para fornecer dados personalizados para criar o perfil de um usuário ou bot.

OnRenderAvatarCallback

Um retorno de chamada renderizado personalizado que permite aos usuários personalizar a renderização de um componente persona.

OverflowGalleryPosition

Diferentes modos e posições da galeria de estouro na VideoGallery

ParticipantListParticipant

Participantes exibidos em uma lista de participantes .

ParticipantListProps

Adereços para ParticipantList .

ParticipantListSelector

Tipo de seletor para componente ParticipantList.

ParticipantMenuItemsCallback

Um retorno de chamada para fornecer itens de menu personalizados para cada participante do 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 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'.

Profile

O perfil de um usuário ou bot.

RaiseHandButtonSelector

Tipo de seletor para o componente RaiseHandButton .

RaisedHand

Estado levantado da mão com ordem

RaisedHandState

Estado levantado da mão com ordem

Reaction

Estado de reação com tipo de reação a ser renderizado

ReactionButtonReaction

Tipos de reações para o botão Reação

ReactionSprite

Tipo para imagem de sprite de animação e metadados relacionados

ReactionState

Declare apenas a versão de com as props auxiliares da interface do <xref:%40azure%2Fcommunication-calling%23Call.ReactionMessage> usuário receivedOn. Estado de reação com um carimbo de data/hora que ajuda a interface do usuário a decidir renderizar a reação de acordo.

ReadReceiptsBySenderId

Uma matriz de pares de valor de chave que armazena o nome de exibição de cada remetente e a última mensagem de leitura

RealTimeTextInformation

Informações necessárias para cada linha de texto em tempo real

RealTimeTextReceivedListener

Retorno de chamada para o evento 'realTimeTextReceived' CallAdapterSubscribers .

ResourceDetails

Detalhes necessários para baixar um recurso para armazenar em cache.

ResourceFetchResult

Resultado do recurso baixado do cliente com estado

ScreenShareButtonSelector

Tipo de seletor para componente ScreenShareButton.

Selector

Um seletor otimizado que refina ClientState atualizações em adereços para componentes react nesta biblioteca.

SendBoxSelector

Tipo de seletor para componente SendBox.

SoundEffect

Digite para representar um som personalizado a ser usado para um evento de chamada

Spotlight

Estado do destaque com ordem

SpotlightChangedListener

Retorno de chamada para o evento 'spotlightChanged' CallAdapterSubscribers .

StartCallIdentifier

Tipos de identificador para iniciar uma chamada usando o CallAdapter

StartCaptionsButtonSelector

Tipo de seletor para o componente StartCaptionsButton .

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.

SupportedCaptionLanguage
SupportedSpokenLanguage
SystemMessage

União discriminada de todas as mensagens do sistema.

O campo systemMessageType é especializado em variantes de união.

TeamsAdapterOptions

Parâmetros opcionais para criar TeamsCallAdapter

TeamsCallAdapterArgs

Argumentos para criar a implementação dos Serviços de Comunicação do Azure do TeamsCallAdapter.

TeamsCallAdapterArgsCommon

Parte comum de args para criar a implementação dos Serviços de Comunicação do Azure do TeamsCallAdapter.

TeamsIncomingCallManagement

Faz proxy da <xref:%40azure%2Fcommunication-calling%23TeamsIncomingCall> interface.

TogetherModeParticipantSeatingState

Representa as posições sentadas dos participantes no Modo Juntos.

TopicChangedListener

Retorno de chamada para chatAdapterSubscribers evento 'topicChanged'.

TransferAcceptedListener

Retorno de chamada para o evento 'transferRequested' CallAdapterSubscribers .

TypingIndicatorSelector

Tipo de seletor para componente TypingIndicator.

UpdateMessageCallback

A função de retorno de chamada é executada quando uma mensagem é atualizada.

VideoBackgroundEffect

Contém os atributos de um efeito de plano de fundo de vídeo selecionado

VideoBackgroundEffectsDependency

Tipo de dependência a ser injetado para efeitos de plano de fundo de vídeo

VideoGalleryLayout
VideoGalleryParticipant

O estado de um participante do VideoGallery.

VideoGallerySelector

Tipo de seletor para componente VideoGallery.

VideoGalleryTogetherModeParticipantPosition

Interface que representa a posição de um participante no Modo Juntos.

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)

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

CameraButton(CameraButtonProps)

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

Pode ser usado com ControlBar.

CaptionsBanner(CaptionsBannerProps)

Um componente para exibir um CaptionsBanner com o ícone do usuário, displayName e texto de legendas.

CaptionsSettingsModal(CaptionsSettingsModalProps)

um componente para definir idiomas falados

ChatClientProvider(ChatClientProviderProps)

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

Os componentes de chat desse 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 desse 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 o ControlBar do.

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.

Dialpad(DialpadProps)

Um componente para permitir que os usuários insiram o número de telefone clicando no teclado de discagem / usando o teclado Ele retornará um componente vazio para compilações estáveis

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 descartado.
  • Erros que não têm um carimbo de data/hora: o erro é descartado até que ele desapareça dos adereços. Se o erro ocorrer novamente, ele será mostrado na interface do usuário.

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

FluentThemeProvider(FluentThemeProviderProps)

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

GridLayout(GridLayoutProps)

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

HoldButton(HoldButtonProps)

um botão para segurar ou retomar uma chamada em andamento.

Pode ser usado com o ControlBar

ImageOverlay(ImageOverlayProps)

Componente para renderizar um modal de tela cheia para uma imagem selecionada.

IncomingCallNotification(IncomingCallNotificationProps)

Um componente de notificação que deve ser usado para representar chamadas de entrada para o usuário final. Permite que o usuário aceite ou rejeite a chamada recebida.

IncomingCallStack(IncomingCallStackProps)

Wrapper para gerenciar várias chamadas recebidas

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 correspondente ao status da mensagem.

MessageThread(MessageThreadProps)

MessageThread permite criar 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.

Notification(NotificationProps)

Um componente para mostrar mensagens de notificação na interface do usuário.

NotificationStack(NotificationStackProps)

Um componente para mostrar notificações 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. As notificações ativas são selecionadas por activeNotifications.

Esse componente controla internamente o descarte pelo usuário.

  • Notificações que têm um carimbo de data/hora associado: a notificação será mostrada na interface do usuário novamente se ocorrer após ser descartada.
  • Notificações que não têm um carimbo de data/hora: a notificação é descartada até que desapareça das props. Se a notificação for recorrente, ela será mostrada na interface do usuário.
ParticipantItem(ParticipantItemProps)

Componente para renderizar um participante de chamada ou chat.

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

ParticipantList(ParticipantListProps)

Componente para renderizar todas as chamadas ou participantes de 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. Esse menuProps pode ser totalmente redefinido e sua propriedade é do tipo IContextualMenuProps.

RaiseHandButton(RaiseHandButtonProps)

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

Pode ser usado com ControlBar.

ReactionButton(ReactionButtonProps)

Um botão para enviar reações.

Pode ser usado com ControlBar.

RealTimeText(RealTimeTextProps)

Um componente para exibir uma única linha de RealTimeText

RealTimeTextModal(RealTimeTextModalProps)

um componente para o modal realTimeText

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.

StartCaptionsButton(StartCaptionsButtonProps)

um botão para iniciar ou parar legendas

Pode ser usado com o ControlBar

StartRealTimeTextButton(StartRealTimeTextButtonProps)

um botão para iniciar o RealTimeText com base no requisito de acessibilidade, o texto em tempo real não pode ser desativado depois de ativado

Pode ser usado com o ControlBar

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 único participante de chamada.

Use com GridLayout em uma videogallery.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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

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

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

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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

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

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

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)

Crie um CallAdapter usando o StatefulCallClientfornecido.

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

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Crie um CallAdapter usando o StatefulCallClientfornecido.

Ú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 fornecido e statefulCallClient.

Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Observe que chatThreadClient deve ser criado por StatefulChatClient por meio da API chatClient.getChatThreadClient(chatThreadId). Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

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

Essa é a implementação padrão de do ChatAdapter fornecidos por essa biblioteca.

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Crie um ChatAdapter usando o StatefulChatClientfornecido.

Ú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, CallingHandlersOptions)

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 de ChatHandlers.

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

O objeto retornado é memorandodo para evitar remetentes quando usado como adereços para componentes react.

createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })

Crie a implementação padrão de TeamsCallingHandlers para chamada de equipes.

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

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Cria uma StatefulCallClient StatefulCallClient por 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.) obtidos do StatefulCallClient para que as alterações de estado sejam criadas corretamente.

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

createTeamsCallAdapter(TeamsCallAdapterArgs)
createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Crie um TeamsCallAdapter usando o StatefulCallClient fornecido.

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

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.

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Loader para o CallComposite que você pode usar em seu aplicativo. Essa função carregará o CallComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Props para o CallWithChatComposite que você pode usar em seu aplicativo. Essa função carregará o CallWithChatComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Loader para o ChatComposite que você pode usar em seu aplicativo. Essa função carregará o ChatComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Loader para o OutboundCallComposite que você pode usar em seu aplicativo. Essa função carregará o CallComposite no elemento HTML fornecido para fazer chamadas de saída. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

onResolveDeepNoiseSuppressionDependency()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

onResolveDeepNoiseSuppressionDependencyLazy()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

onResolveVideoEffectDependency()

Resolução de dependência para efeitos de plano de fundo de vídeo.

onResolveVideoEffectDependencyLazy()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

toFlatCommunicationIdentifier(CommunicationIdentifier)

Uma representação de cadeia de caracteres de um <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 | AzureCommunicationOutboundCallAdapterArgs>, (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 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. Consulte o storybook para obter exemplos de uso típicos.

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

Um gancho 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 à medida que 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. Consulte o storybook para obter exemplos de uso típicos.

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

Um gancho react personalizado para simplificar a criação de 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 à medida que 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. Consulte 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 este 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 React desta biblioteca.

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

  1. Para componentes de chat: chatClientProvider e ChatThreadClientProvider.

  2. Para componentes de chamada: 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.

useTeamsCall()

Gancho para obter <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall para usar esse gancho

useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)

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

Semelhante ao <xref:createTeamsAzureCommunicationCallAdapter>, 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 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. Consulte o storybook para obter exemplos de uso típicos.

useTeamsCallAgent()

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

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

useTheme()

Gancho do React 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

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

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

Retornos

Element

Comentários

Chamar a largura/altura mínima da composição 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

Retornos

Element

CallWithChatComposite(CallWithChatCompositeProps)

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

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parâmetros

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

Retornos

Element

CaptionsBanner(CaptionsBannerProps)

Um componente para exibir um CaptionsBanner com o ícone do usuário, displayName e texto de legendas.

function CaptionsBanner(props: CaptionsBannerProps): Element

Parâmetros

Retornos

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

um componente para definir idiomas falados

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

Parâmetros

Retornos

Element

ChatClientProvider(ChatClientProviderProps)

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

Os componentes de chat desse pacote devem ser encapsulados com um chatClientProvider.

function ChatClientProvider(props: ChatClientProviderProps): Element

Parâmetros

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

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 desse pacote devem ser encapsulados com um ChatThreadClientProvider.

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parâmetros

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

Retornos

Element

ControlBarButton(ControlBarButtonProps)

Botão padrão estilizado para o ControlBar do.

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

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

Retornos

Element

Dialpad(DialpadProps)

Um componente para permitir que os usuários insiram o número de telefone clicando no teclado de discagem / usando o teclado Ele retornará um componente vazio para compilações estáveis

function Dialpad(props: DialpadProps): Element

Parâmetros

props
DialpadProps

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

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 descartado.
  • Erros que não têm um carimbo de data/hora: o erro é descartado até que ele desapareça dos adereços. Se o erro ocorrer novamente, ele será mostrado na interface do usuário.

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

function ErrorBar(props: ErrorBarProps): Element

Parâmetros

Retornos

Element

FluentThemeProvider(FluentThemeProviderProps)

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

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parâmetros

Retornos

Element

Comentários

Os componentes nesta biblioteca são compostos principalmente de controles Fluent UI, misturando controles v8 e v9. Esse provedor lida com a aplicação de qualquer tema fornecido aos controles de interface do usuário fluentes subjacentes. *

GridLayout(GridLayoutProps)

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

function GridLayout(props: GridLayoutProps): Element

Parâmetros

Retornos

Element

HoldButton(HoldButtonProps)

um botão para segurar ou retomar uma chamada em andamento.

Pode ser usado com o ControlBar

function HoldButton(props: HoldButtonProps): Element

Parâmetros

props
HoldButtonProps

do botão de espera.

Retornos

Element

ImageOverlay(ImageOverlayProps)

Componente para renderizar um modal de tela cheia para uma imagem selecionada.

function ImageOverlay(props: ImageOverlayProps): Element

Parâmetros

Retornos

Element

IncomingCallNotification(IncomingCallNotificationProps)

Um componente de notificação que deve ser usado para representar chamadas de entrada para o usuário final. Permite que o usuário aceite ou rejeite a chamada recebida.

function IncomingCallNotification(props: IncomingCallNotificationProps): Element

Parâmetros

Retornos

Element

IncomingCallStack(IncomingCallStackProps)

Wrapper para gerenciar várias chamadas recebidas

function IncomingCallStack(props: IncomingCallStackProps): Element

Parâmetros

props
IncomingCallStackProps

<xref:IncomingCallManagerProps>

Retornos

Element

LocalizationProvider(LocalizationProviderProps)

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

function LocalizationProvider(props: LocalizationProviderProps): Element

Parâmetros

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 correspondente ao status da mensagem.

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parâmetros

Retornos

Element

MessageThread(MessageThreadProps)

MessageThread permite criar 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 componente MessageThread. Os usuários também podem personalizar MessageThread passando seu próprio Avatar, MessageStatusIndicator ícone, JumpToNewMessageButton, LoadPreviousMessagesButton e o comportamento desses controles.

MessageThread usa internamente o Chat componente de @fluentui-contrib/chat. Você pode conferir os detalhes sobre esses componentes aqui.

Retornos

Element

MicrophoneButton(MicrophoneButtonProps)

Um botão para ativar/desativar o microfone.

Pode ser usado com ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parâmetros

Retornos

Element

Notification(NotificationProps)

Um componente para mostrar mensagens de notificação na interface do usuário.

function Notification(props: NotificationProps): Element

Parâmetros

Retornos

Element

NotificationStack(NotificationStackProps)

Um componente para mostrar notificações 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. As notificações ativas são selecionadas por activeNotifications.

Esse componente controla internamente o descarte pelo usuário.

  • Notificações que têm um carimbo de data/hora associado: a notificação será mostrada na interface do usuário novamente se ocorrer após ser descartada.
  • Notificações que não têm um carimbo de data/hora: a notificação é descartada até que desapareça das props. Se a notificação for recorrente, ela será mostrada na interface do usuário.
function NotificationStack(props: NotificationStackProps): Element

Parâmetros

Retornos

Element

ParticipantItem(ParticipantItemProps)

Componente para renderizar um participante de chamada ou chat.

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

function ParticipantItem(props: ParticipantItemProps): Element

Parâmetros

Retornos

Element

ParticipantList(ParticipantListProps)

Componente para renderizar todas as chamadas ou participantes de chat.

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

function ParticipantList(props: ParticipantListProps): Element

Parâmetros

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. Esse menuProps pode ser totalmente redefinido e sua propriedade é do tipo IContextualMenuProps.

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parâmetros

Retornos

Element

RaiseHandButton(RaiseHandButtonProps)

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

Pode ser usado com ControlBar.

function RaiseHandButton(props: RaiseHandButtonProps): Element

Parâmetros

Retornos

Element

ReactionButton(ReactionButtonProps)

Um botão para enviar reações.

Pode ser usado com ControlBar.

function ReactionButton(props: ReactionButtonProps): Element

Parâmetros

Retornos

Element

RealTimeText(RealTimeTextProps)

Um componente para exibir uma única linha de RealTimeText

function RealTimeText(props: RealTimeTextProps): Element

Parâmetros

Retornos

Element

RealTimeTextModal(RealTimeTextModalProps)

um componente para o modal realTimeText

function RealTimeTextModal(props: RealTimeTextModalProps): Element

Parâmetros

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

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

StartCaptionsButton(StartCaptionsButtonProps)

um botão para iniciar ou parar legendas

Pode ser usado com o ControlBar

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

Parâmetros

props
StartCaptionsButtonProps

do botão Legendas Iniciais.

Retornos

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

um botão para iniciar o RealTimeText com base no requisito de acessibilidade, o texto em tempo real não pode ser desativado depois de ativado

Pode ser usado com o ControlBar

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

Parâmetros

props
StartRealTimeTextButtonProps

propriedades para o botão iniciar RealTimeText.

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

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

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

Retornos

Element

VideoTile(VideoTileProps)

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

Use com GridLayout em uma videogallery.

function VideoTile(props: VideoTileProps): Element

Parâmetros

Retornos

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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

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

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

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

Parâmetros

Retornos

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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

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

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

function createAzureCommunicationCallAdapter(args: AzureCommunicationOutboundCallAdapterArgs): Promise<CallAdapter>

Parâmetros

Retornos

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CommunicationIdentifier[], CommonCallAdapterOptions)

Crie um CallAdapter usando o StatefulCallClientfornecido.

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

function createAzureCommunicationCallAdapterFromClient(callClient: StatefulCallClient, callAgent: CallAgent, targetCallees: CommunicationIdentifier[], options?: CommonCallAdapterOptions): Promise<CallAdapter>

Parâmetros

callClient
StatefulCallClient
callAgent
CallAgent
targetCallees

CommunicationIdentifier[]

Retornos

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Crie um CallAdapter usando o StatefulCallClientfornecido.

Ú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, options?: CommonCallAdapterOptions): Promise<CallAdapter>

Parâmetros

callClient
StatefulCallClient
callAgent
CallAgent

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

Retornos

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Crie um CallWithChatAdapter usando o StatefulChatClient fornecido e statefulCallClient.

Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Observe que chatThreadClient deve ser criado por StatefulChatClient por meio da API chatClient.getChatThreadClient(chatThreadId). Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.

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

Parâmetros

Retornos

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

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

Essa é a implementação padrão de do ChatAdapter fornecidos por essa biblioteca.

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

Parâmetros

Retornos

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Crie um ChatAdapter usando o StatefulChatClientfornecido.

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

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

Parâmetros

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient
chatAdapterOptions
ChatAdapterOptions

Retornos

Promise<ChatAdapter>

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

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, options?: CallingHandlersOptions): CallingHandlers

Parâmetros

callClient
StatefulCallClient
callAgent

undefined | CallAgent

deviceManager

undefined | StatefulDeviceManager

call

undefined | Call

Retornos

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 é memorandodo 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

createDefaultTeamsCallingHandlers(StatefulCallClient, TeamsCallAgent, StatefulDeviceManager, TeamsCall, { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> })

Crie a implementação padrão de TeamsCallingHandlers para chamada de equipes.

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

function createDefaultTeamsCallingHandlers(callClient: StatefulCallClient, callAgent?: TeamsCallAgent, deviceManager?: StatefulDeviceManager, call?: TeamsCall, options?: { onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }): TeamsCallingHandlers

Parâmetros

callClient
StatefulCallClient
callAgent
TeamsCallAgent
deviceManager
StatefulDeviceManager
call
TeamsCall
options

{ onResolveDeepNoiseSuppressionDependency?: () => Promise<DeepNoiseSuppressionEffectDependency>, onResolveVideoBackgroundEffectsDependency?: () => Promise<VideoBackgroundEffectsDependency> }

Retornos

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

Cria uma StatefulCallClient StatefulCallClient por 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.) obtidos do StatefulCallClient para que as alterações de estado sejam criadas corretamente.

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

Parâmetros

Retornos

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

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

Parâmetros

Retornos

createTeamsCallAdapter(TeamsCallAdapterArgs)

function createTeamsCallAdapter(args: TeamsCallAdapterArgs): Promise<TeamsCallAdapter>

Parâmetros

Retornos

Promise<TeamsCallAdapter>

createTeamsCallAdapterFromClient(StatefulCallClient, TeamsCallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Crie um TeamsCallAdapter usando o StatefulCallClient fornecido.

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

function createTeamsCallAdapterFromClient(callClient: StatefulCallClient, callAgent: TeamsCallAgent, locator: CallAdapterLocator, options?: CommonCallAdapterOptions): Promise<TeamsCallAdapter>

Parâmetros

callClient
StatefulCallClient
callAgent
TeamsCallAgent

Retornos

Promise<TeamsCallAdapter>

fromFlatCommunicationIdentifier(string)

Operação inversa de toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parâmetros

id

string

Retornos

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>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Loader para o CallComposite que você pode usar em seu aplicativo. Essa função carregará o CallComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

function loadCallComposite(loaderArgs: CallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

Parâmetros

htmlElement

HTMLElement

Retornos

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

Props para o CallWithChatComposite que você pode usar em seu aplicativo. Essa função carregará o CallWithChatComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

function loadCallWithChatComposite(loaderArgs: CallWithChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallWithChatAdapter>

Parâmetros

htmlElement

HTMLElement

Retornos

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

Loader para o ChatComposite que você pode usar em seu aplicativo. Essa função carregará o ChatComposite no elemento HTML fornecido. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

function loadChatComposite(loaderArgs: ChatCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | ChatAdapter>

Parâmetros

htmlElement

HTMLElement

Retornos

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Loader para o OutboundCallComposite que você pode usar em seu aplicativo. Essa função carregará o CallComposite no elemento HTML fornecido para fazer chamadas de saída. O melhor caso de uso para isso é em uma estrutura de interface do usuário do Node que não é baseada em React.

function loadOutboundCallComposite(loaderArgs: OutboundCallCompositeLoaderProps, htmlElement: HTMLElement): Promise<undefined | CallAdapter>

Parâmetros

htmlElement

HTMLElement

Retornos

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

Retornos

onResolveDeepNoiseSuppressionDependencyLazy()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

Retornos

onResolveVideoEffectDependency()

Resolução de dependência para efeitos de plano de fundo de vídeo.

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

Retornos

onResolveVideoEffectDependencyLazy()

Resolução de dependência para efeitos de fundo de vídeo usando carregamento lento.

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

Retornos

toFlatCommunicationIdentifier(CommunicationIdentifier)

Uma representação de cadeia de caracteres de um <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

Retornos

string

useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | AzureCommunicationOutboundCallAdapterArgs>, (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 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. Consulte o storybook para obter exemplos de uso típicos.

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

Parâmetros

afterCreate

(adapter: CallAdapter) => Promise<CallAdapter>

beforeDispose

(adapter: CallAdapter) => Promise<void>

Retornos

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 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 à medida que 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. Consulte 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

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 react personalizado para simplificar a criação de 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 à medida que 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. Consulte 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

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 este 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

useChatClient()

Gancho para obter StatefulChatClient do provedor.

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

function useChatClient(): StatefulChatClient

Retornos

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

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 React desta biblioteca.

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

  1. Para componentes de chat: chatClientProvider e ChatThreadClientProvider.

  2. Para componentes de chamada: 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)

useTeamsCall()

Gancho para obter <xref:%40azure%2Fcommunication-calling%23TeamsCall> 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 TeamsCall para usar esse gancho

function useTeamsCall(): undefined | TeamsCall

Retornos

undefined | TeamsCall

useTeamsCallAdapter(Partial<TeamsCallAdapterArgs>, (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, (adapter: TeamsCallAdapter) => Promise<void>)

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

Semelhante ao <xref:createTeamsAzureCommunicationCallAdapter>, 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 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. Consulte o storybook para obter exemplos de uso típicos.

function useTeamsCallAdapter(args: Partial<TeamsCallAdapterArgs>, afterCreate?: (adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>, beforeDispose?: (adapter: TeamsCallAdapter) => Promise<void>): undefined | TeamsCallAdapter

Parâmetros

args

Partial<TeamsCallAdapterArgs>

afterCreate

(adapter: TeamsCallAdapter) => Promise<TeamsCallAdapter>

beforeDispose

(adapter: TeamsCallAdapter) => Promise<void>

Retornos

undefined | TeamsCallAdapter

useTeamsCallAgent()

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

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

function useTeamsCallAgent(): undefined | TeamsCallAgent

Retornos

undefined | TeamsCallAgent

useTheme()

Gancho do React para acessar o tema

function useTheme(): Theme

Retornos

Theme