CallWithChatAdapter interface

Solicitar permissões de dispositivos.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parâmetros

Retornos

Comentários

A janela de permissão do navegador será exibida se as permissões ainda não forem concedidas.

Herdado deCallWithChatAdapterManagement.askDevicePermission

Crie a exibição html para um fluxo.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parâmetros

Retornos

Comentários

Esse método é implementado para composição.

Herdado deCallWithChatAdapterManagement.createStreamView

Exclua uma mensagem no thread.

function deleteMessage(messageId: string): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.deleteMessage

Descartar a composição

function dispose()

Herdado deDescartável.dispose

Descarte a exibição html para um fluxo.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parâmetros

Retornos

Comentários

Esse método é implementado para composição.

Herdado deCallWithChatAdapterManagement.disposeStreamView

Busque o estado inicial do adaptador de chat.

Executa a busca mínima necessária para os métodos chatComposite e API.

function fetchInitialData(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.fetchInitialData

Obter o estado atual

function getState(): CallWithChatAdapterState

Retornos

Herdado deAdapterState.getState

Ingresse a chamada com o microfone ativado/desativado inicialmente.

function joinCall(microphoneOn?: boolean): undefined | Call

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.joinCall

Deixe a chamada.

function leaveCall(forEveryone?: boolean): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.leaveCall

Carregue mais mensagens anteriores no histórico de threads de chat.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parâmetros

Retornos

Comentários

Esse método geralmente é usado para controlar a busca incremental/rolagem infinita.

Herdado deCallWithChatAdapterManagement.loadPreviousChatMessages

Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente.

function mute(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.mute

function off(event: "callEnded", listener: CallEndedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "callError", listener: (e: AdapterError) => void)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "chatError", listener: (e: AdapterError) => void)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "messageRead", listener: MessageReadListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "messageReceived", listener: MessageReceivedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "messageSent", listener: MessageReceivedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.off

Cancela a assinatura do manipulador para eventos stateChanged.

function offStateChange(handler: (state: CallWithChatAdapterState) => void)

Parâmetros

Herdado deAdapterState.offStateChange

function on(event: "callEnded", listener: CallEndedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "callError", listener: (e: AdapterError) => void)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "chatError", listener: (e: AdapterError) => void)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "messageRead", listener: MessageReadListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "messageReceived", listener: MessageReceivedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "messageSent", listener: MessageReceivedListener)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parâmetros

Herdado deCallWithChatAdapterSubscriptions.on

Assina o manipulador para eventos stateChanged.

function onStateChange(handler: (state: CallWithChatAdapterState) => void)

Parâmetros

Herdado deAdapterState.onStateChange

Consultar dispositivos de câmera disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retornos

Uma matriz de entidades de informações do dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallWithChatAdapterManagement.queryCameras

Consultar dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retornos

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallWithChatAdapterManagement.queryMicrophones

Consultar dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retornos

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallWithChatAdapterManagement.querySpeakers

Remova um participante de uma Chamada.

function removeParticipant(userId: string): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.removeParticipant

Envie uma mensagem no thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.sendMessage

Envie um recibo de leitura para uma mensagem.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.sendReadReceipt

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.sendTypingIndicator

Defina a câmera a ser usada na chamada.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.setCamera

Defina o microfone a ser usado na chamada.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.setMicrophone

Defina o alto-falante a ser usado na chamada.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.setSpeaker

Inicie a chamada.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.startCall

Inicie a câmera.

Esse método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa.

function startCamera(options?: VideoStreamOptions): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.startCamera

Comece a compartilhar a tela durante uma chamada.

function startScreenShare(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.startScreenShare

Pare a câmera.

Esse método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa.

function stopCamera(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.stopCamera

Pare de compartilhar a tela.

function stopScreenShare(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.stopScreenShare

Desative o mudo do usuário atual durante a chamada ou habilite o microfone localmente.

function unmute(): Promise<void>

Retornos

Herdado deCallWithChatAdapterManagement.unmute

Atualizar um conteúdo de mensagem.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Parâmetros

Retornos

Herdado deCallWithChatAdapterManagement.updateMessage