Partilhar via


@azure/communication-react package

Classes

CallError

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

ChatError

Erro gerado a partir de métodos StatefulChatClient com falha.

Interfaces

AcceptedTransfer

Estado do recurso de transferência

ActiveErrorMessage

Mensagens de erro ativas a serem mostradas através ErrorBar.

ActiveNotification

Notificações ativas a serem mostradas via NotificationStack.

AdapterError

Erro reportado através de eventos de erro e armazenado no estado do adaptador.

AdapterNotification

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

AdapterState

Funcionalidade para interface com o estado do adaptador composto.

AttachmentMetadata

Modelo de dados que representa um anexo de mensagem de chat onde contém um ID para identificar exclusivamente o anexo, um nome que representa o nome do ficheiro e um URL para transferir o anexo.

BaseCompositeProps

Propriedades comuns a todos os compósitos exportados desta biblioteca.

BaseCustomStyles

Adereços básicos de estilos fluentes para todos os componentes exportados a partir desta libray.

BreakoutRoomsState

Estado das salas de breakout

CallAdapter

Uma interface de adaptador específica para a identidade de Comunicação do Azure que se estende CommonCallAdapter.

CallAdapterCallManagement

Funcionalidade para gerenciar a chamada atual ou iniciar uma nova chamada

CallAdapterCallOperations

Funcionalidade para gerenciar a chamada atual.

CallAdapterDeviceManagement

Funcionalidade para gerenciar dispositivos em uma chamada.

CallAdapterSubscribers

Chame eventos compostos que podem ser assinados.

CallAgentProviderProps

Argumentos para inicializar um CallAgentProvider.

CallAgentState

A versão somente de estado do <xref:%40azure%2Fcommunication-calling%23CallAgent> exceto chamadas é movida para ser um filho diretamente de CallClientState e não está incluída aqui. O motivo para ter o estado do CallAgent por proxy é fornecer acesso a displayName. Não nivelamos o CallAgent.displayName e o colocamos em CallClientState porque seria ambíguo que displayName dependesse da criação/existência do CallAgent para estar disponível.

CallAndChatLocator

Os argumentos para uso no createAzureCommunicationCallWithChatAdapter ingressar em uma chamada com um thread de bate-papo associado.

CallClientProviderProps

Argumentos para inicializar um CallClientProvider.

CallClientState

Contêiner para todos os dados de estado por proxy por StatefulCallClient. Os estados calls, callsEnded, incomingCalls e incomingCallsEnded serão fornecidos automaticamente se um callAgent tiver sido criado. O deviceManager ficará vazio inicialmente até ser preenchido consulte DeviceManagerState. O estado userId é fornecido como uma conveniência para o desenvolvedor e é completamente controlado e definido pelo desenvolvedor.

CallCompositeLoaderProps

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

Contém duas opções de sacos:

CallCompositeProps

Props para CallComposite.

CallCompositeStrings

As cadeias de caracteres usadas pelo CallComposite diretamente.

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

CallFeatureStreamState

Indique apenas a versão 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

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23Call>. StatefulCallClient recuperará automaticamente o estado da chamada e adicioná-lo-á ao estado exposto por StatefulCallClient.

CallSurveyImprovementSuggestions

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

CallWithChatAdapter

interface do adaptador de CallWithChatComposto.

CallWithChatAdapterManagement

Funcionalidade para gerenciar a chamada atual com chat.

CallWithChatAdapterState

O Estado CallWithChat é uma combinação de clientes Stateful Chat e Stateful Calling com algum estado específico apenas para o CallWithChat Composto.

CallWithChatAdapterSubscriptions

Eventos de chamada e bate-papo que podem ser inscritos no CallWithChatAdapter.

CallWithChatAdapterUiState

Estado da interface do usuário pertencente ao CallWithChatComposite.

CallWithChatClientState

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

CallWithChatCompositeLoaderProps

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

Contém duas opções de sacos:

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 em chamadas com experiência de bate-papo.

CallingHandlers

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

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

CallingTheme

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

CameraButtonContextualMenuStyles

Estilos para o menu CameraButton.

CameraButtonProps

Props para componente CameraButton.

CameraButtonStrings

Strings de CameraButton que podem ser substituídas.

CameraButtonStyles

Estilos para CameraButton

CapabilitiesFeatureState

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

CapabilityChangedNotificationStrings

Strings para notificação de alteração de capacidade

CaptionLanguageStrings

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

CaptionsBannerProps

LegendasAdereços de componentes de banner.

CaptionsBannerStrings

strings para banner de legendas

CaptionsCallFeatureState
CaptionsInfo
CaptionsSettingsModalProps

CaptionsSettingsModal Adereços do componente.

CaptionsSettingsModalStrings

strings para legendas definindo modal

ChatAdapterSubscribers

Eventos compostos de bate-papo que podem ser inscritos.

ChatAdapterThreadManagement

Funcionalidade para gerenciar o thread de bate-papo atual.

ChatCompositeLoaderProps

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

ChatCompositeProps

Props para ChatComposite.

ChatCompositeStrings

As cadeias de caracteres usadas pelo ChatComposite diretamente.

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

ChatMessage

Uma mensagem de chat.

CommonCallAdapter

interface do adaptador de CallComposto.

CommonCallingHandlers

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

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

ComponentLocale

Informações de localidade para todos os componentes exportados desta biblioteca.

ComponentStrings

Strings usadas por todos os componentes exportados desta biblioteca.

CompositeLocale

Informações de localidade para todos os compósitos exportados desta biblioteca.

CompositeStrings

Strings usadas diretamente nos compósitos.

Essas cadeias de caracteres são usadas pelos compósitos diretamente, em vez de pelos componentes contidos.

ConferencePhoneInfo

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

ContentSystemMessage

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

ControlBarButtonProps

Props para ControlBarButton.

ControlBarButtonStrings

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

ControlBarProps

Props para ControlBar.

CreateVideoStreamViewResult

Objeto retornado após a criação de um VideoStream local ou remoto. Isso contém funções auxiliares para manipular a renderização do fluxo.

CustomCallControlButtonCallbackArgs

Argumentos para CustomCallControlButtonCallback.

CustomCallControlButtonProps

Resposta de CustomCallControlButtonCallback. Inclui os suportes de base necessários para renderizar um ControlBarButton ou <xref:DrawerMenuItem>.

CustomCallControlButtonStrings

Strings para CustomCallControlButtons

CustomMessage

Um tipo de mensagem personalizada.

As mensagens personalizadas não são renderizadas por padrão, mas os aplicativos podem fornecer renderizadores personalizados para elas.

DevicesButtonContextualMenuStyles

Estilos para o menu DevicesButton.

DevicesButtonProps

Props para DevicesButton.

DevicesButtonStrings

Strings de DevicesButton que podem ser substituídas.

DevicesButtonStyles

Estilos para os itens de menu do botão Dispositivos.

DiagnosticsCallFeatureState

Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23DiagnosticsCallFeature>.

DialpadProps

Adereços para o componente Dialpad .

DialpadStrings

Cadeias de caracteres do teclado de discagem que podem ser substituídas.

DialpadStyles

Estilos para o componente Dialpad .

Disposable

Funcionalidade para descartar corretamente um composto.

DtmfDialPadOptions

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

EndCallButtonProps

Props para EndCallButton.

EndCallButtonStrings

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

ErrorBarProps

Props para ErrorBar.

Além do seguinte, ErrorBar encaminha todos os <xref:%40fluentui%2Freact%23IMessageBarProps> para o <xref:%40fluentui%2Freact%23MessageBar>subjacente.

ErrorBarStrings

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

FluentThemeProviderProps

Props para FluentThemeProvider.

GridLayoutProps

Props para GridLayout.

GridLayoutStyles

GridLayout estilos de componentes.

HoldButtonProps
HoldButtonStrings

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

HorizontalGalleryStyles

<xref:HorizontalGallery> Estilos de componentes.

ImageOverlayProps

Props para ImageOverlay.

ImageOverlayStrings

Strings de ImageOverlay que podem ser substituídas.

IncomingCallNotificationProps

Propriedades para o componente de notificação de chamada de entrada.

IncomingCallNotificationStrings

Strings para o componente de notificação de chamada de entrada.

IncomingCallNotificationStyles

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

IncomingCallStackCall

Representa uma chamada de entrada ativa.

IncomingCallStackProps

Props para o componente IncomingCallManager.

IncomingCallState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23IncomingCall>. StatefulCallClient detetará automaticamente chamadas de entrada e adicionará seu estado ao estado exposto por StatefulCallClient.

InlineImage

O estado de 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 ingressar em uma chamada true = ligar o dispositivo ao ingressar na chamada false = desligar o dispositivo ao ingressar na chamada 'manter'/undefined = reter o estado de pré-chamada dos dispositivos

JumpToNewMessageButtonProps

Argumentos a favor <xref:MessageThreadProps.onRenderJumpToNewMessageButton>.

LocalVideoCameraCycleButtonProps
LocalVideoStreamState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23LocalVideoStream>.

LocalVideoStreamVideoEffectsState

Indique apenas a versão de <xref:%40azure%2Fcommunication-calling%23VideoEffectsFeature>um LocalVideoStream .

LocalVideoTileOptions

Opções para o bloco de vídeo local no composto Chamada.

MediaAccessState

Estado de acesso à mídia

MediaDiagnosticsState

Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23MediaDiagnostics>.

MeetingConferencePhoneInfoModalStrings

strings para informações do telefone modal

MessageCommon

Propriedades comuns de todos os tipos de mensagem.

MessageStatusIndicatorProps

Props para MessageStatusIndicator.

MessageStatusIndicatorStrings

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

MessageThreadStrings

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

MessageThreadStyles

Estilos fluentes para MessageThread.

MicrophoneButtonContextualMenuStyles

Estilos para o menu MicrophoneButton.

MicrophoneButtonProps

Props para MicrophoneButton.

MicrophoneButtonStrings

Strings de MicrophoneButton que podem ser substituídas.

MicrophoneButtonStyles

Estilos para MicrophoneButton

NetworkDiagnosticsState

Estado apenas proxy para <xref:%40azure%2Fcommunication-calling%23NetworkDiagnostics>.

NotificationOptions

Opções para controlar as notificações no compósito.

NotificationProps

Props 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

Indique apenas a versão 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 sacos:

PPTLiveCallFeatureState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23PPTLiveCallFeature>. StatefulCallClient escutará automaticamente o pptLive na chamada e atualizará o estado exposto por StatefulCallClient de acordo.

ParticipantAddedSystemMessage

Uma mensagem do sistema notificando que um participante foi adicionado ao tópico de bate-papo.

ParticipantItemProps

Props para ParticipantItem.

ParticipantItemStrings

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

ParticipantItemStyles

Estilos fluentes para ParticipantItem.

ParticipantListItemStyles

Estilos para o ParticipantListParticipantItem.

ParticipantListStyles

Estilos para o ParticipantList.

ParticipantRemovedSystemMessage

Uma mensagem do sistema notificando que um participante foi removido do tópico de bate-papo.

ParticipantsButtonContextualMenuStyles

Estilos para o menu ParticipantsButton.

ParticipantsButtonProps

Props para ParticipantsButton.

ParticipantsButtonStrings

Strings of ParticipantsButton que podem ser substituídas.

ParticipantsButtonStyles

Estilos Props para participantesButton.

RaiseHandButtonProps

Props para RaiseHandButton.

RaiseHandButtonStrings

Strings de RaiseHandButton que podem ser substituídas.

RaiseHandCallFeature

Indique apenas a versão 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

Props 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

Adereços do componente RealTimeTextModal.

RealTimeTextModalStrings

strings para o modal realTimeText

RealTimeTextProps

Props para uma única linha de RealTimeText.

RealTimeTextStrings

strings para rtt

RecordingCallFeature

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RecordingCallFeature>. StatefulCallClient escutará automaticamente o estado de gravação da chamada e atualizará o estado exposto por StatefulCallClient de acordo.

RemoteParticipantState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RemoteParticipant>. StatefulCallClient recuperará automaticamente RemoteParticipants e adicionará seu estado ao estado exposto por StatefulCallClient.

RemoteVideoStreamState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23RemoteVideoStream>.

RemoteVideoTileMenuOptions

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

ScreenShareButtonProps

Props para ScreenShareButton.

ScreenShareButtonStrings

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

SendBoxProps

Props para SendBox.

SendBoxStrings

Strings de SendBox que podem ser substituídas.

SendBoxStylesProps

Estilos fluentes para <xref:Sendbox>.

SpokenLanguageStrings

strings de idioma falado para configuração modal de legendas

SpotlightCallFeatureState

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

SpotlightPromptStrings

Strings usadas no prompt relacionado ao spotlight

SpotlightState

Estado do holofote com ordem

StartCaptionsAdapterOptions

Opções passadas para adapter.startCaptions

StartCaptionsButtonProps
StartCaptionsButtonStrings

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

StartRealTimeTextButtonProps

Props 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 monitoração de estado. A interface fornece acesso ao estado proxy e também permite registrar um manipulador para eventos de alteração de estado. Para obter a definição de estado, consulte CallClientState.

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

  • Dados retornados de <xref:%40azure%2Fcommunication-calling%23DeviceManager> APIs.
  • Dados retornados de <xref:%40azure%2Fcommunication-calling%23CallAgent> APIs.
  • Ouvintes automaticamente anexados a vários objetos de chamada de comunicação do Azure:
    • CallAgent 'incomingCall'
    • CallAgent 'chamadasAtualizado'
    • DeviceManager 'videoDevicesUpdated'
    • DeviceManager 'audioDevicesUpdated
    • DeviceManager 'selectedMicrophoneChanged'
    • DeviceManager 'selectedSpeakerChanged'
    • Chamar 'stateChanged'
    • Chamada 'idChanged'
    • Chamada 'isMutedChanged'
    • Chamada 'isScreenSharingOnChanged'
    • Ligue para 'remoteParticipantsUpdated'
    • Ligue para 'localVideoStreamsUpdated'
    • IncomingCall 'callEnded'
    • RemoteParticipant 'stateChanged'
    • RemoteParticipant 'isMutedChanged'
    • RemoteParticipant 'displayNameChanged'
    • RemoteParticipant 'isSpeakingChanged'
    • RemoteParticipant 'videoStreamsUpdated'
    • RemoteVideoStream 'isAvailableChanged'
    • TranscriptionCallFeature 'isTranscriptionActiveChanged'
    • RecordingCallFeature 'isRecordingActiveChanged'
    • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
    • RaiseHandCallFeature 'raisedHandEvent'
    • RaiseHandCallFeature 'loweredHandEvent'
    • PPTLiveCallFeature 'isAciveChanged'
    • ReactionCallFeature 'reação'
StatefulChatClient

Define os métodos que permitem que {@Link @azure/communication-chat#ChatClient} seja usado com um estado gerado centralizado.

A interface fornece acesso ao estado proxy e também permite registrar um manipulador para eventos de alteração de estado.

StatefulDeviceManager

Define os métodos adicionais adicionados pelo stateful sobre <xref:%40azure%2Fcommunication-calling%23DeviceManager>.

StopCaptionsAdapterOptions

Opções passadas para adapter.stopCaptions

StreamMediaProps

Props para StreamMedia.

SurveyIssues

Textos correspondentes a cada questão do convite à apresentação de propostas

SurveyIssuesHeadingStrings

Textos correspondentes a cada categoria de emissão do convite à apresentação de propostas

SystemMessageCommon

Propriedades comuns de todas as mensagens do sistema.

TeamsCallAdapter

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

TeamsCallingHandlers

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

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

TeamsIncomingCallState

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

TogetherModeCallFeatureState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23TogetherModeCallFeature>. StatefulCallClient. Representa o estado do recurso Modo Conjunto.

TogetherModeSeatingPositionState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23TogetherModeSeatingMap>.

Representa a posição de assento 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 bate-papo foi atualizado.

TranscriptionCallFeature

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23TranscriptionCallFeature>. StatefulCallClient escutará automaticamente o estado de transcrição da chamada e atualizará o estado exposto por StatefulCallClient de acordo.

TransferFeature

Estado do recurso de transferência

TypingIndicatorProps

Props para TypingIndicator.

TypingIndicatorStrings

Strings 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 trajes do efeito de fundo de vídeo de desfoque

VideoBackgroundImage

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

VideoBackgroundNoEffect

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

VideoBackgroundReplacementEffect

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

VideoGalleryLocalParticipant

O estado do participante local na VideoGallery.

VideoGalleryProps

Props para VideoGallery.

VideoGalleryRemoteParticipant

O estado de um participante remoto na VideoGallery.

VideoGalleryStream

Fluxo de vídeo de um participante VideoGallery.

VideoGalleryStrings

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

VideoGalleryStyles

VideoGallery estilos de componentes.

VideoGalleryTogetherModeSeatingInfo

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

VideoGalleryTogetherModeStreams

Interface que representa os fluxos no modo Juntos.

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados.

VideoStreamRendererViewState

Indique apenas a versão do <xref:%40azure%2Fcommunication-calling%23VideoStreamRendererView>. Essa propriedade é adicionada ao estado exposto por StatefulCallClient pelo createView e removida por disposeView.

VideoTileContextualMenuProps

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

VideoTileDrawerMenuProps

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

VideoTileProps

Props para VideoTile.

VideoTileStrings

Strings 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

Adaptadores armazena o erro mais recente para cada operação no estado.

target é uma cadeia de caracteres definida pelo adaptador para cada operação exclusiva executada pelo adaptador.

AdapterNotifications

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

AreEqual

Compare se 2 componentes react são exatamente iguais, o tipo de resultado será verdadeiro/falso

AreParamEqual

Compare se os suportes de 2 componentes react são iguais, o tipo de resultado será verdadeiro/falso

AreTypeEqual

Compare se dois tipos são iguais, o tipo de resultado será verdadeiro/falso

AvatarPersonaData

Atributos de dados personalizados para exibir avatar para um usuário.

AvatarPersonaDataCallback

Função de retorno de chamada usada para fornecer dados personalizados para construir um avatar para um usuário.

AzureCommunicationCallAdapterArgs

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

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

AzureCommunicationCallAdapterOptions

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

AzureCommunicationCallWithChatAdapterArgs

Argumentos para createAzureCommunicationCallWithChatAdapter

AzureCommunicationCallWithChatAdapterFromClientArgs

Argumentos a favor <xref:createAzureCommunicationCallWithChatAdapterFromClient>

AzureCommunicationChatAdapterArgs

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

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.

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

CallAdapterCallEndedEvent

Payload para CallEndedListener contendo detalhes sobre a chamada finalizada.

CallAdapterClientState

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

CallAdapterLocator

Localizador usado por createAzureCommunicationCallAdapter para localizar a chamada para ingressar

CallAdapterState

CommonCallAdapter estado.

CallAdapterUiState

CommonCallAdapter estado para fins puros da interface do usuário.

CallCompositeIcons

Ícones que podem ser substituídos por CallComposite.

CallCompositeOptions

Recursos opcionais do CallComposite.

CallCompositePage

Principais telas da interface do usuário mostradas no CallComposite.

CallControlDisplayType

Tipo de exibição da barra de controle para CallComposite.

CallControlOptions

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

CallEndedListener

Retorno de chamada para CallAdapterSubscribers evento 'callEnded'.

CallErrorBarSelector

Tipo de seletor para componente ErrorBar.

CallErrorTarget

Tipo literal de cadeia de caracteres para todas as chaves permitidas em {@Link CallErrors}.

CallErrors

Erros relacionados a chamadas de API para o SDK de chamada.

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

Os erros deste objeto podem ser eliminados usando o <xref:newClearCallErrorsModifier>. Além disso, os erros são automaticamente eliminados quando:

  • O Estado está liberado.
  • As chamadas subsequentes para métodos de API relacionados são bem-sucedidas. Consulte a documentação de métodos de cliente com monitoração de estado individuais para obter detalhes sobre quando os erros podem ser apagados automaticamente.
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 por CallWithChatComposite.

CallWithChatCompositeOptions

Recursos opcionais do CallWithChatComposite.

CallWithChatEvent

Eventos disparados pelo CallWithChatAdapter.

CallingBaseSelectorProps

Props comuns usados para fazer referência ao estado declarativo do cliente de chamada.

CallingHandlersOptions

Opções de configuração para incluir a dependência em segundo plano do efeito de vídeo.

CallingReturnProps

Tipo de auxiliar para usePropsFor.

CallingSounds

Tipo 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' de 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

opções saco para iniciar legendas

CaptionsReceivedListener

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

ChatAdapter

interface do adaptador de ChatComposto.

ChatAdapterOptions

Opções para configurar o ChatAdapter.

ChatAdapterState

ChatAdapter estado.

ChatAdapterUiState

ChatAdapter estado para fins de interface do usuário pura.

ChatAttachmentType

Representa o tipo de anexo

ChatBaseSelectorProps

Props comuns para seletores para ChatClientState.

ChatClientProviderProps

Argumentos para inicializar um ChatClientProvider.

ChatClientState

Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatClient>.

ChatCompositeClientState

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

ChatCompositeIcons

Ícones que podem ser substituídos por ChatComposite.

ChatCompositeOptions

Recursos opcionais do ChatComposite.

ChatErrorBarSelector

Tipo de seletor para componente ErrorBar.

ChatErrorTarget

Tipo literal de cadeia de caracteres para todas as chaves permitidas no ChatErrors.

ChatErrors

Erros relacionados a chamadas de API para o SDK de bate-papo.

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

ChatHandlers

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

Os componentes relacionados ao bate-papo deste pacote são capazes de selecionar manipuladores relevantes desse objeto. Consulte <xref:useHandlers> e usePropsFor.

ChatInitializedListener

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

ChatMessageWithStatus

Uma extensão para <xref:%40azure%2Fcommunication-chat%23ChatMessage> que armazena metadados apenas do lado do cliente para mensagens de chat.

TODO: O nome atrapalhou. Renomeie-me.

ChatParticipantListSelector

Tipo de seletor para componente ParticipantList.

ChatProfile

O perfil de um usuário ou bot.

ChatReturnProps

Tipo de auxiliar para usePropsFor.

ChatThreadClientProviderProps

Argumentos para inicializar um ChatThreadClientProvider.

ChatThreadClientState

Estado centralizado para <xref:%40azure%2Fcommunication-chat%23ChatThreadClient>.

ChatThreadProperties

Propriedades de um thread de chat.

Definimos um mínimo que nos ajuda a ocultar os diferentes tipos usados pela API subjacente.

ClientState

Estado centralizado para <xref:%40azure%2Fcommunication-calling%23CallClient> ou <xref:%40azure%2Fcommunication-chat%23ChatClient>.

Consulte também: CallClientState ChatClientState.

Common

Tipo de interseção de retorno de 2 tipos

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

CommunicationParticipant

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

ComponentIcons

Ícones usados pelos componentes do React exportados desta biblioteca.

ComponentProps

Tipo de auxiliar para usePropsFor.

ComponentSlotStyle

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

CompositeIcons

Ícones que podem ser substituídos em um dos compósitos exportados por esta biblioteca.

Consulte ChatCompositeIcons CallCompositeIcons e CallWithChatCompositeIcons para obter tipos mais direcionados.

ControlBarButtonStyles

Estilos para todas as implementações ControlBarButton.

ControlBarLayout

Apresentar layouts para o ControlBar.

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 os props para renderizar um ControlBarButton personalizado e <xref:DrawerMenuItem>.

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

CustomCallControlButtonPlacement

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

'primário': Coloque o(s) botão(ões) na extremidade direita da barra de controlo central, mas antes do EndCallButton (extremidade esquerda no modo rtl). 'overflow': Coloque o(s) botão(ões) no final do menu de estouro. «Secundário»: Coloque o(s) botão(ões) na extremidade esquerda da barra de controlo lateral (à direita no modo RTL).

Vários botões atribuídos ao mesmo posicionamento são acrescentados 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 "principal" funciona quando o controle de chamada herdado está habilitado no composto de chamadas

DeclarativeCallAgent

DeclarativeCallAgent estende e proxies o <xref:%40azure%2Fcommunication-calling%23CallAgent>

DeclarativeTeamsCallAgent

DeclarativeTeamsCallAgent estende e proxies o <xref:%40azure%2Fcommunication-calling%23TeamsCallAgent>

DeepNoiseSuppressionEffectDependency

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

DeviceManagerState

Este tipo destina-se a encapsular todo o estado dentro <xref:%40azure%2Fcommunication-calling%23DeviceManager>. Para parâmetros opcionais, eles podem não estar disponíveis até que a permissão seja concedida pelo usuário. As câmeras, microfones, alto-falantes e estados deviceAccess ficarão vazios até que as APIs getCameras, getMicrophones, getSpeakers e askDevicePermission correspondentes do <xref:%40azure%2Fcommunication-calling%23DeviceManager>sejam chamadas e concluídas.

DevicesButtonSelector

Tipo de seletor para componente DevicesButton.

DiagnosticChangedEventListner

Retorno de chamada para CallAdapterSubscribers evento 'diagnosticChanged'.

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 de retorno padrão se usePropsFor for chamado para um componente que não requer dados.

ErrorType

Todos os erros que podem ser mostrados no ErrorBar.

GetCallingSelector

Tipo específico do seletor aplicável a um determinado componente.

GetChatSelector

Tipo específico do seletor aplicável a um determinado componente.

HoldButtonSelector

Tipo de seletor para o componente HoldButton .

IncomingCallManagement

Isso contém uma matriz somente leitura que retorna todo o arquivo 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

Props para LocalizationProvider.

LongPressTrigger

Modos de como os manipuladores de pressão longa podem ser tiggered.

MediaAccess

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

MediaDiagnosticChangedEvent

Carga útil para DiagnosticChangedEventListner onde há uma alteração em um diagnóstico de mídia.

Message

União discriminada de todas as mensagens.

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

MessageAttachedStatus

Indique se uma mensagem de chat deve ser exibida mesclada com a mensagem antes / depois dela. Se true, a mensagem aparecerá agrupada com a mensagem antes dela. «Superior» e «inferior» são utilizados para indicar que a mensagem é o início ou o fim de um grupo.

MessageContentType

Tipos suportados de conteúdo de mensagens de chat.

MessageDeletedListener

Retorno de chamada para o evento 'messageDeleted' de ChatAdapterSubscribers .

MessageEditedListener

Retorno de chamada para o evento 'messageEdited' de ChatAdapterSubscribers .

MessageProps

Props para renderizar uma única mensagem.

Consulte MessageRenderer.

MessageReadListener

Retorno de chamada para ChatAdapterSubscribers evento 'messageRead'.

MessageReceivedListener

Retorno de chamada para ChatAdapterSubscribers evento 'messageReceived'.

MessageRenderer

Um componente para renderizar uma única mensagem.

MessageSentListener

Retorno de chamada para ChatAdapterSubscribers evento 'messageSent'.

MessageStatus

Estado do lado do cliente de uma mensagem enviada.

Inclui estados de transição que ocorrem antes da entrega de mensagens ser confirmada a partir do back-end.

MessageThreadProps

Props para MessageThread.

MessageThreadSelector

Tipo de seletor para componente MessageThread.

MicrophoneButtonSelector

Tipo de seletor para componente MicrophoneButton.

NetworkDiagnosticChangedEvent

Carga útil para DiagnosticChangedEventListner onde há uma alteração em um diagnóstico de rede.

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 perfil para um usuário ou bot.

OnFetchProfileCallback

Função de retorno de chamada usada para fornecer dados personalizados para criar perfil para 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

Os participantes exibidos em uma Lista de Participantes.

ParticipantListProps

Props para ParticipantList.

ParticipantListSelector

Tipo de seletor para componente ParticipantList.

ParticipantMenuItemsCallback

Um retorno de chamada para fornecer itens de menu personalizados para cada participante em Lista de Participantes.

ParticipantState

O estado de conexão de um participante da chamada.

ParticipantsAddedListener

Retorno de chamada para ChatAdapterSubscribers evento 'participantsAdded'.

ParticipantsButtonSelector

Tipo de seletor para componente ParticipantsButton.

ParticipantsJoinedListener

Retorno de chamada para CallAdapterSubscribers evento 'participantsJoined'.

ParticipantsLeftListener

Retorno de chamada para CallAdapterSubscribers evento 'participantsLeft'.

ParticipantsRemovedListener

Retorno de chamada para ChatAdapterSubscribers evento 'participantsRemoved'.

Profile

O perfil de um usuário ou bot.

RaiseHandButtonSelector

Tipo de seletor para o componente RaiseHandButton .

RaisedHand

Estado da mão levantada com ordem

RaisedHandState

Estado da mão levantada com ordem

Reaction

Estado de reação com tipo de reação para renderizar

ReactionButtonReaction

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

ReactionSprite

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

ReactionState

Indique apenas a versão de com os suportes 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 valores de chave que armazena o nome de exibição e a última mensagem lida de cada remetente

RealTimeTextInformation

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

RealTimeTextReceivedListener

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

ResourceDetails

Detalhes necessários para baixar um recurso para cache.

ResourceFetchResult

Resultado do recurso baixado do cliente stateful

ScreenShareButtonSelector

Tipo de seletor para componente ScreenShareButton.

Selector

Um seletor otimizado que refina ClientState atualizações em props para componentes React nesta biblioteca.

SendBoxSelector

Tipo de seletor para componente SendBox.

SoundEffect

Tipo para representar um som personalizado a ser usado em um evento de chamada

Spotlight

Estado do holofote com ordem

SpotlightChangedListener

Retorno de chamada para o evento 'spotlightChanged' de 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 de TeamsCallAdapter.

TeamsCallAdapterArgsCommon

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

TeamsIncomingCallManagement

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

TogetherModeParticipantSeatingState

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

TopicChangedListener

O retorno de chamada para ChatAdapterSubscribers evento 'topicChanged'.

TransferAcceptedListener

Retorno de chamada para o evento 'transferRequested' de 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 trajes de um efeito de fundo de vídeo selecionado

VideoBackgroundEffectsDependency

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

VideoGalleryLayout
VideoGalleryParticipant

O estado de um participante na 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>.

Chamar componentes deste pacote deve ser encapsulado com um CallAgentProvider.

CallClientProvider(CallClientProviderProps)

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

Chamar componentes deste pacote deve ser encapsulado com um CallClientProvider.

CallComposite(CallCompositeProps)

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

CallProvider(CallProviderProps)

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

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

CallWithChatComposite(CallWithChatCompositeProps)

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

CameraButton(CameraButtonProps)

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

Pode ser usado com ControlBar.

CaptionsBanner(CaptionsBannerProps)

Um componente para exibir um CaptionsBanner com ícone de 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 deste pacote devem ser empacotados com um ChatClientProvider.

ChatComposite(ChatCompositeProps)

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

ChatThreadClientProvider(ChatThreadClientProviderProps)

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

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

ControlBar(ControlBarProps)

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

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

ControlBarButton(ControlBarButtonProps)

Botão padrão estilizado para o ControlBar.

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

DevicesButton(DevicesButtonProps)

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

Pode ser usado com ControlBar.

Dialpad(DialpadProps)

Um componente para permitir que os usuários insiram o número de telefone clicando no teclado / usando o teclado Ele retornará o 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 as strings para que possam ser localizadas. Os erros ativos são selecionados por activeErrorMessages.

Este componente rastreia internamente descartado pelo usuário.

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

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

FluentThemeProvider(FluentThemeProviderProps)

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

GridLayout(GridLayoutProps)

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

HoldButton(HoldButtonProps)

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

Pode ser usado com 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 desta biblioteca.

MessageStatusIndicator(MessageStatusIndicatorProps)

Componente para exibir o status de uma mensagem enviada.

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

MessageThread(MessageThreadProps)

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

MicrophoneButton(MicrophoneButtonProps)

Um botão para ligar / desligar o microfone.

Pode ser usado com ControlBar.

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 as strings para que possam ser localizadas. As notificações ativas são selecionadas por activeNotifications.

Este componente rastreia internamente descartado pelo usuário.

  • Notificações que têm um carimbo de data/hora associado: a notificação é 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é desaparecer dos adereços. Se a notificação for recorrente, ela será mostrada na interface do usuário.
ParticipantItem(ParticipantItemProps)

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

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

ParticipantList(ParticipantListProps)

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

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

ParticipantsButton(ParticipantsButtonProps)

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

Pode ser usado com ControlBar.

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

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 digitação e envio de mensagens.

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

StartCaptionsButton(StartCaptionsButtonProps)

um botão para iniciar ou parar legendas

Pode ser usado com ControlBar

StartRealTimeTextButton(StartRealTimeTextButtonProps)

um botão para iniciar RealTimeText com base no requisito de acessibilidade, texto em tempo real não pode ser desligado uma vez que está ligado

Pode ser usado com 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 bate-papo estão digitando.

VideoGallery(VideoGalleryProps)

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

VideoTile(VideoTileProps)

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

Use com GridLayout em um VideoGallery.

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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

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

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

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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

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

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

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

Crie um CallAdapter usando o StatefulCallClient fornecido peloStatefulCall.

Ú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 StatefulCallClient fornecido peloStatefulCall.

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

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

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

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Crie um CallWithChatAdapter usando o StatefulChatClient fornecido e StatefulCallClient.

Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Por favor, note que chatThreadClient tem que ser criado por StatefulChatClient via chatClient.getChatThreadClient(chatThreadId) API. Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

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

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

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Crie um ChatAdapter usando o StatefulChatClient fornecido.

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

createDefaultCallingHandlers(StatefulCallClient, undefined | CallAgent, undefined | StatefulDeviceManager, undefined | Call, 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 do ChatHandlers.

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

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

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

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

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

Cria um StatefulChatClient StatefulChatClient por proxy de <xref:%40azure%2Fcommunication-chat%23ChatClient> ChatClient com ProxyChatClient <xref:ProxyChatClient> que 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 para um componente especificado.

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

getChatSelector<Component>(Component)

Obtenha o seletor para um componente especificado.

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

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Função de carregador para o CallComposite que você pode usar em seu aplicativo. Esta função carregará o CallComposite no elemento HTML fornecido. O melhor caso de uso para isso está em uma estrutura UI do Node que não é baseada no React.

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

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

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

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

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

Função de carregador para o OutboundCallComposite que você pode usar em seu aplicativo. Esta função carregará o CallComposite no elemento HTML fornecido para fazer chamadas de saída. O melhor caso de uso para isso está em uma estrutura de interface do usuário do nó que não é baseada no 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 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>.

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

  • Ele pode ser usado para persistir a identidade de um usuário em bancos de dados externos.
  • ele pode ser usado como chaves em um mapa para armazenar dados para o usuário.
useAzureCommunicationCallAdapter(Partial<AzureCommunicationCallAdapterArgs | 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 são criados. O adaptador só é criado quando todos os argumentos são definidos.

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

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

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

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

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

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

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

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

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

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

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

useCall()

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

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

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

useCallAgent()

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

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

useCallClient()

Gancho para obter StatefulCallClient do provedor.

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

useChatClient()

Gancho para obter StatefulChatClient do provedor.

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

useChatThreadClient()

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

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

useDeviceManager()

Gancho para obter StatefulDeviceManager do provedor.

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

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

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

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

  1. Para componentes de chat: ChatClientProvider e ChatThreadClientProvider.

  2. Para chamar componentes: CallClientProvider, CallAgentProvider e CallAgentProvider.

O uso mais simples de um componente se parece com:

Exemplo

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }
useSelector<ParamT>(ParamT, (ParamT extends Selector ? Parameters<ParamT>[1] : undefined), "chat" | "calling")

Gancho para obter um seletor para um componente especificado.

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

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

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

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 de reação para acessar o tema

Detalhes de Função

CallAgentProvider(CallAgentProviderProps)

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

Chamar componentes deste pacote deve ser encapsulado com um CallAgentProvider.

function CallAgentProvider(props: CallAgentProviderProps): Element

Parâmetros

Devoluções

Element

CallClientProvider(CallClientProviderProps)

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

Chamar componentes deste pacote deve ser encapsulado com um CallClientProvider.

function CallClientProvider(props: CallClientProviderProps): Element

Parâmetros

Devoluções

Element

CallComposite(CallCompositeProps)

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

function CallComposite(props: CallCompositeProps): Element

Parâmetros

Devoluções

Element

Observações

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

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

CallProvider(CallProviderProps)

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

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

function CallProvider(props: CallProviderProps): Element

Parâmetros

Devoluções

Element

CallWithChatComposite(CallWithChatCompositeProps)

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

function CallWithChatComposite(props: CallWithChatCompositeProps): Element

Parâmetros

Devoluções

Element

CameraButton(CameraButtonProps)

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

Pode ser usado com ControlBar.

function CameraButton(props: CameraButtonProps): Element

Parâmetros

Devoluções

Element

CaptionsBanner(CaptionsBannerProps)

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

function CaptionsBanner(props: CaptionsBannerProps): Element

Parâmetros

Devoluções

Element

CaptionsSettingsModal(CaptionsSettingsModalProps)

um componente para definir idiomas falados

function CaptionsSettingsModal(props: CaptionsSettingsModalProps): Element

Parâmetros

Devoluções

Element

ChatClientProvider(ChatClientProviderProps)

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

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

function ChatClientProvider(props: ChatClientProviderProps): Element

Parâmetros

Devoluções

Element

ChatComposite(ChatCompositeProps)

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

function ChatComposite(props: ChatCompositeProps): Element

Parâmetros

Devoluções

Element

Observações

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

ChatThreadClientProvider(ChatThreadClientProviderProps)

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

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

function ChatThreadClientProvider(props: ChatThreadClientProviderProps): Element

Parâmetros

Devoluções

Element

ControlBar(ControlBarProps)

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

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

function ControlBar(props: ControlBarProps): Element

Parâmetros

Devoluções

Element

ControlBarButton(ControlBarButtonProps)

Botão padrão estilizado para o ControlBar.

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

function ControlBarButton(props: ControlBarButtonProps): Element

Parâmetros

Devoluções

Element

DevicesButton(DevicesButtonProps)

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

Pode ser usado com ControlBar.

function DevicesButton(props: DevicesButtonProps): Element

Parâmetros

Devoluções

Element

Dialpad(DialpadProps)

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

function Dialpad(props: DialpadProps): Element

Parâmetros

props
DialpadProps

Devoluções

Element

EndCallButton(EndCallButtonProps)

Um botão para encerrar uma chamada em andamento.

Pode ser usado com ControlBar.

function EndCallButton(props: EndCallButtonProps): Element

Parâmetros

Devoluções

Element

ErrorBar(ErrorBarProps)

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

Este componente rastreia internamente descartado pelo usuário.

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

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

function ErrorBar(props: ErrorBarProps): Element

Parâmetros

Devoluções

Element

FluentThemeProvider(FluentThemeProviderProps)

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

function FluentThemeProvider(props: FluentThemeProviderProps): Element

Parâmetros

Devoluções

Element

Observações

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

GridLayout(GridLayoutProps)

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

function GridLayout(props: GridLayoutProps): Element

Parâmetros

Devoluções

Element

HoldButton(HoldButtonProps)

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

Pode ser usado com ControlBar

function HoldButton(props: HoldButtonProps): Element

Parâmetros

props
HoldButtonProps

propriedades do botão de espera.

Devoluções

Element

ImageOverlay(ImageOverlayProps)

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

function ImageOverlay(props: ImageOverlayProps): Element

Parâmetros

Devoluções

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

Devoluções

Element

IncomingCallStack(IncomingCallStackProps)

Wrapper para gerenciar várias chamadas recebidas

function IncomingCallStack(props: IncomingCallStackProps): Element

Parâmetros

props
IncomingCallStackProps

<xref:IncomingCallManagerProps>

Devoluções

Element

LocalizationProvider(LocalizationProviderProps)

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

function LocalizationProvider(props: LocalizationProviderProps): Element

Parâmetros

Devoluções

Element

Observações

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

MessageStatusIndicator(MessageStatusIndicatorProps)

Componente para exibir o status de uma mensagem enviada.

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

function MessageStatusIndicator(props: MessageStatusIndicatorProps): Element

Parâmetros

Devoluções

Element

MessageThread(MessageThreadProps)

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

function MessageThread(props: MessageThreadProps): Element

Parâmetros

props
MessageThreadProps

do tipo MessageThreadProps

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

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

Devoluções

Element

MicrophoneButton(MicrophoneButtonProps)

Um botão para ligar / desligar o microfone.

Pode ser usado com ControlBar.

function MicrophoneButton(props: MicrophoneButtonProps): Element

Parâmetros

Devoluções

Element

Notification(NotificationProps)

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

function Notification(props: NotificationProps): Element

Parâmetros

Devoluções

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 as strings para que possam ser localizadas. As notificações ativas são selecionadas por activeNotifications.

Este componente rastreia internamente descartado pelo usuário.

  • Notificações que têm um carimbo de data/hora associado: a notificação é 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é desaparecer dos adereços. Se a notificação for recorrente, ela será mostrada na interface do usuário.
function NotificationStack(props: NotificationStackProps): Element

Parâmetros

Devoluções

Element

ParticipantItem(ParticipantItemProps)

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

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

function ParticipantItem(props: ParticipantItemProps): Element

Parâmetros

Devoluções

Element

ParticipantList(ParticipantListProps)

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

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

function ParticipantList(props: ParticipantListProps): Element

Parâmetros

Devoluções

Element

ParticipantsButton(ParticipantsButtonProps)

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

Pode ser usado com ControlBar.

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

function ParticipantsButton(props: ParticipantsButtonProps): Element

Parâmetros

Devoluções

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

Devoluções

Element

ReactionButton(ReactionButtonProps)

Um botão para enviar reações.

Pode ser usado com ControlBar.

function ReactionButton(props: ReactionButtonProps): Element

Parâmetros

Devoluções

Element

RealTimeText(RealTimeTextProps)

Um componente para exibir uma única linha de RealTimeText

function RealTimeText(props: RealTimeTextProps): Element

Parâmetros

Devoluções

Element

RealTimeTextModal(RealTimeTextModalProps)

um componente para o modal realTimeText

function RealTimeTextModal(props: RealTimeTextModalProps): Element

Parâmetros

Devoluções

Element

ScreenShareButton(ScreenShareButtonProps)

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

Pode ser usado com ControlBar.

function ScreenShareButton(props: ScreenShareButtonProps): Element

Parâmetros

Devoluções

Element

SendBox(SendBoxProps)

Componente para digitação e envio de mensagens.

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

function SendBox(props: SendBoxProps): Element

Parâmetros

props
SendBoxProps

Devoluções

Element

StartCaptionsButton(StartCaptionsButtonProps)

um botão para iniciar ou parar legendas

Pode ser usado com ControlBar

function StartCaptionsButton(props: StartCaptionsButtonProps): Element

Parâmetros

props
StartCaptionsButtonProps

propriedades do botão Iniciar legendas.

Devoluções

Element

StartRealTimeTextButton(StartRealTimeTextButtonProps)

um botão para iniciar RealTimeText com base no requisito de acessibilidade, texto em tempo real não pode ser desligado uma vez que está ligado

Pode ser usado com ControlBar

function StartRealTimeTextButton(props: StartRealTimeTextButtonProps): Element

Parâmetros

props
StartRealTimeTextButtonProps

propriedades para o botão iniciar RealTimeText.

Devoluções

Element

StreamMedia(StreamMediaProps)

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

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

function StreamMedia(props: StreamMediaProps): Element

Parâmetros

Devoluções

Element

TypingIndicator(TypingIndicatorProps)

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

function TypingIndicator(props: TypingIndicatorProps): Element

Parâmetros

Devoluções

Element

VideoGallery(VideoGalleryProps)

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

function VideoGallery(props: VideoGalleryProps): Element

Parâmetros

Devoluções

Element

VideoTile(VideoTileProps)

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

Use com GridLayout em um VideoGallery.

function VideoTile(props: VideoTileProps): Element

Parâmetros

Devoluções

Element

createAzureCommunicationCallAdapter(AzureCommunicationCallAdapterArgs)

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

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

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

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

Parâmetros

Devoluções

Promise<CallAdapter>

createAzureCommunicationCallAdapter(AzureCommunicationOutboundCallAdapterArgs)

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

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

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

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

Parâmetros

Devoluções

Promise<CallAdapter>

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

Crie um CallAdapter usando o StatefulCallClient fornecido peloStatefulCall.

Ú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[]

Devoluções

Promise<CallAdapter>

createAzureCommunicationCallAdapterFromClient(StatefulCallClient, CallAgent, CallAdapterLocator, CommonCallAdapterOptions)

Crie um CallAdapter usando o StatefulCallClient fornecido peloStatefulCall.

Ú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

Devoluções

Promise<CallAdapter>

createAzureCommunicationCallWithChatAdapter(AzureCommunicationCallWithChatAdapterArgs)

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

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

Parâmetros

Devoluções

createAzureCommunicationCallWithChatAdapterFromClients(AzureCommunicationCallWithChatAdapterFromClientArgs)

Crie um CallWithChatAdapter usando o StatefulChatClient fornecido e StatefulCallClient.

Útil se você quiser manter uma referência a StatefulChatClient e StatefulCallClient. Por favor, note que chatThreadClient tem que ser criado por StatefulChatClient via chatClient.getChatThreadClient(chatThreadId) API. Considere usar createAzureCommunicationCallWithChatAdapter para uma API mais simples.

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

Parâmetros

Devoluções

createAzureCommunicationChatAdapter(AzureCommunicationChatAdapterArgs)

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

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

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

Parâmetros

Devoluções

Promise<ChatAdapter>

createAzureCommunicationChatAdapterFromClient(StatefulChatClient, ChatThreadClient, ChatAdapterOptions)

Crie um ChatAdapter usando o StatefulChatClient fornecido.

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

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

Parâmetros

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient
chatAdapterOptions
ChatAdapterOptions

Devoluções

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

Devoluções

createDefaultChatHandlers(StatefulChatClient, ChatThreadClient)

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

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

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

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

Parâmetros

chatClient
StatefulChatClient
chatThreadClient
ChatThreadClient

Devoluções

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

Devoluções

createStatefulCallClient(StatefulCallClientArgs, StatefulCallClientOptions)

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

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

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

Parâmetros

Devoluções

createStatefulChatClient(StatefulChatClientArgs, StatefulChatClientOptions)

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

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

Parâmetros

Devoluções

createTeamsCallAdapter(TeamsCallAdapterArgs)

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

Parâmetros

Devoluções

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

Devoluções

Promise<TeamsCallAdapter>

fromFlatCommunicationIdentifier(string)

Operação inversa de toFlatCommunicationIdentifier.

function fromFlatCommunicationIdentifier(id: string): CommunicationIdentifier

Parâmetros

id

string

Devoluções

getCallingSelector<Component>(Component)

Obtenha o seletor para um componente especificado.

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

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

Parâmetros

component

Component

Devoluções

GetCallingSelector<Component>

getChatSelector<Component>(Component)

Obtenha o seletor para um componente especificado.

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

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

Parâmetros

component

Component

Devoluções

GetChatSelector<Component>

loadCallComposite(CallCompositeLoaderProps, HTMLElement)

Função de carregador para o CallComposite que você pode usar em seu aplicativo. Esta função carregará o CallComposite no elemento HTML fornecido. O melhor caso de uso para isso está em uma estrutura UI do Node que não é baseada no React.

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

Parâmetros

htmlElement

HTMLElement

Devoluções

Promise<undefined | CallAdapter>

loadCallWithChatComposite(CallWithChatCompositeLoaderProps, HTMLElement)

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

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

Parâmetros

htmlElement

HTMLElement

Devoluções

Promise<undefined | CallWithChatAdapter>

loadChatComposite(ChatCompositeLoaderProps, HTMLElement)

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

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

Parâmetros

htmlElement

HTMLElement

Devoluções

Promise<undefined | ChatAdapter>

loadOutboundCallComposite(OutboundCallCompositeLoaderProps, HTMLElement)

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

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

Parâmetros

htmlElement

HTMLElement

Devoluções

Promise<undefined | CallAdapter>

onResolveDeepNoiseSuppressionDependency()

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

function onResolveDeepNoiseSuppressionDependency(): Promise<DeepNoiseSuppressionEffectDependency>

Devoluções

onResolveDeepNoiseSuppressionDependencyLazy()

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

function onResolveDeepNoiseSuppressionDependencyLazy(): Promise<DeepNoiseSuppressionEffectDependency>

Devoluções

onResolveVideoEffectDependency()

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

function onResolveVideoEffectDependency(): Promise<VideoBackgroundEffectsDependency>

Devoluções

onResolveVideoEffectDependencyLazy()

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

function onResolveVideoEffectDependencyLazy(): Promise<VideoBackgroundEffectsDependency>

Devoluções

toFlatCommunicationIdentifier(CommunicationIdentifier)

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

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

  • Ele pode ser usado para persistir a identidade de um usuário em bancos de dados externos.
  • ele pode ser usado como chaves em um mapa para armazenar dados para o usuário.
function toFlatCommunicationIdentifier(identifier: CommunicationIdentifier): string

Parâmetros

Devoluções

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

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

function useAzureCommunicationCallAdapter(args: Partial<AzureCommunicationCallAdapterArgs | 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>

Devoluções

undefined | CallAdapter

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

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

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

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

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

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

Devoluções

undefined | CallWithChatAdapter

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

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

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

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

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

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

Devoluções

undefined | ChatAdapter

useCall()

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

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

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

function useCall(): undefined | Call

Devoluções

undefined | Call

useCallAgent()

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

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

function useCallAgent(): undefined | CallAgent

Devoluções

undefined | CallAgent

useCallClient()

Gancho para obter StatefulCallClient do provedor.

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

function useCallClient(): StatefulCallClient

Devoluções

useChatClient()

Gancho para obter StatefulChatClient do provedor.

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

function useChatClient(): StatefulChatClient

Devoluções

useChatThreadClient()

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

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

function useChatThreadClient(): ChatThreadClient

Devoluções

useDeviceManager()

Gancho para obter StatefulDeviceManager do provedor.

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

function useDeviceManager(): undefined | StatefulDeviceManager

Devoluções

undefined | StatefulDeviceManager

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

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

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

  1. Para componentes de chat: ChatClientProvider e ChatThreadClientProvider.

  2. Para chamar componentes: CallClientProvider, CallAgentProvider e CallAgentProvider.

O uso mais simples de um componente se parece com:

Exemplo

    import { ParticipantList, usePropsFor } from '@azure/communication-react';

    const App = (): JSX.Element => {
        // ... code to setup Providers ...

        return <ParticipantList {...usePropsFor(ParticipantList)}/>
    }
function usePropsFor<Component>(component: Component, type?: "chat" | "calling"): ComponentProps<Component>

Parâmetros

component

Component

type

"chat" | "calling"

Devoluções

ComponentProps<Component>

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

Gancho para obter um seletor para um componente especificado.

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

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

Parâmetros

selector

ParamT

selectorProps

(ParamT extends Selector ? Parameters<ParamT>[1] : undefined)

type

"chat" | "calling"

Devoluções

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

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

Devoluções

undefined | TeamsCall

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

Um gancho React personalizado para simplificar a criação de 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 são criados. O adaptador só é criado quando todos os argumentos são definidos.

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

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

Devoluções

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

Devoluções

undefined | TeamsCallAgent

useTheme()

Gancho de reação para acessar o tema

function useTheme(): Theme

Devoluções

Theme