CallWithChatAdapter interface

Pacote:

@azure/communication-react

interface do adaptador de CallWithChatComposto.

Extends

CallWithChatAdapterManagement,AdapterState<CallWithChatAdapterState>,Disposable,CallWithChatAdapterSubscriptions

Métodos Herdados

askDevicePermission(PermissionConstraints)	Peça permissões de dispositivos.
createStreamView(string, VideoStreamOptions)	Crie a visualização html para um fluxo.
deleteMessage(string)	Exclua uma mensagem no thread.
dispose()	Elimine o composto
disposeStreamView(string, VideoStreamOptions)	Descarte o modo de exibição html para um fluxo.
fetchInitialData()	Buscar o estado inicial para o adaptador de bate-papo. Executa a busca mínima necessária para os métodos ChatComposite e API.
getState()	Obter o estado atual
joinCall(boolean)	Participe da chamada com o microfone inicialmente ligado/desligado.
leaveCall(boolean)	Saia da chamada.
loadPreviousChatMessages(number)	Carregue mais mensagens anteriores no histórico de conversas de chat.
mute()	Silencie o usuário atual durante a chamada ou desative o microfone localmente.
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("chatError", (e: AdapterError) => void)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
offStateChange((state: CallWithChatAdapterState) => void)	Cancela a inscrição do manipulador para eventos stateChanged.
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("chatError", (e: AdapterError) => void)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
onStateChange((state: CallWithChatAdapterState) => void)	Inscreve o manipulador em eventos stateChanged.
queryCameras()	Consulta de dispositivos de câmara disponíveis.
queryMicrophones()	Consulta de dispositivos de microfone disponíveis.
querySpeakers()	Consulta de dispositivos de microfone disponíveis.
removeParticipant(string)	Remover um participante de uma Chamada.
sendMessage(string, SendMessageOptions)	Envie uma mensagem no tópico.
sendReadReceipt(string)	Envie um recibo de leitura para uma mensagem.
sendTypingIndicator()	Enviar indicador de digitação no thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Defina a câmera para usar na chamada.
setMicrophone(AudioDeviceInfo)	Defina o microfone a ser usado na chamada.
setSpeaker(AudioDeviceInfo)	Defina o alto-falante a ser usado na chamada.
startCall(string[], StartCallOptions)	Inicie a chamada.
startCamera(VideoStreamOptions)	Inicie a câmara. Esse método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa.
startScreenShare()	Comece a partilhar o ecrã durante uma chamada.
stopCamera()	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.
stopScreenShare()	Pare de compartilhar a tela.
unmute()	Desative o mudo do usuário atual durante a chamada ou ative o microfone localmente.
updateMessage(string, string, Record<string, string>)	Atualizar o conteúdo de uma mensagem.

Detalhes do Método Herdado

askDevicePermission(PermissionConstraints)

Peça permissões de dispositivos.

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

Parâmetros

constrain

PermissionConstraints

Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Devoluções

Promise<void>

Observações

A janela de permissão do navegador aparecerá se as permissões ainda não tiverem sido concedidas.

herdado de CallWithChatAdapterManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Crie a visualização html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para criar a visualização da câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void | CreateVideoStreamViewResult>

Observações

Este método é implementado para compósito.

herdado de CallWithChatAdapterManagement.createStreamView

deleteMessage(string)

Exclua uma mensagem no thread.

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

Parâmetros

messageId

string

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.deleteMessage

dispose()

Elimine o composto

function dispose()

herdado dedescartável.dispor

disposeStreamView(string, VideoStreamOptions)

Descarte o modo de exibição html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para descartar a visão da câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

Observações

Este método é implementado para compósito.

herdado de CallWithChatAdapterManagement.disposeStreamView

fetchInitialData()

Buscar o estado inicial para o adaptador de bate-papo.

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

function fetchInitialData(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.fetchInitialData

getState()

Obter o estado atual

function getState(): CallWithChatAdapterState

Devoluções

CallWithChatAdapterState

herdado de AdapterState.getState

joinCall(boolean)

Participe da chamada com o microfone inicialmente ligado/desligado.

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

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente ativado

Devoluções

undefined | Call

herdado deCallWithChatAdapterManagement.joinCall

leaveCall(boolean)

Saia da chamada.

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

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos ao sair

Devoluções

Promise<void>

herdado deCallWithChatAdapterManagement.leaveCall

loadPreviousChatMessages(number)

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

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

Parâmetros

messagesToLoad

number

Devoluções

Promise<boolean>

Observações

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

herdado deCallWithChatAdapterManagement.loadPreviousChatMessages

mute()

Silencie o usuário atual durante a chamada ou desative o microfone localmente.

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.mute

off("callEnded", CallEndedListener)

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

Parâmetros

event

"callEnded"

listener

CallEndedListener

herdado deCallWithChatAdapterSubscriptions.off

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

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

Parâmetros

event

"callError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

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

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

herdado deCallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

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

Parâmetros

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

herdado deCallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

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

Parâmetros

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

herdado deCallWithChatAdapterSubscriptions.off

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

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

Parâmetros

event

"chatError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

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

Parâmetros

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

herdado deCallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

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

Parâmetros

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

herdado deCallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

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

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

herdado deCallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

herdado deCallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

herdado deCallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

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

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

herdado deCallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

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

Parâmetros

event

"messageRead"

listener

MessageReadListener

herdado deCallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

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

Parâmetros

event

"messageReceived"

listener

MessageReceivedListener

herdado deCallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

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

Parâmetros

event

"messageSent"

listener

MessageReceivedListener

herdado deCallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

herdado deCallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

herdado deCallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

Cancela a inscrição do manipulador para eventos stateChanged.

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

Parâmetros

handler

(state: CallWithChatAdapterState) => void

herdado de AdapterState.offStateChange

on("callEnded", CallEndedListener)

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

Parâmetros

event

"callEnded"

listener

CallEndedListener

herdado deCallWithChatAdapterSubscriptions.on

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

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

Parâmetros

event

"callError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

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

Parâmetros

event

"callIdChanged"

listener

CallIdChangedListener

herdado deCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

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

Parâmetros

event

"callParticipantsJoined"

listener

ParticipantsJoinedListener

herdado deCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

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

Parâmetros

event

"callParticipantsLeft"

listener

ParticipantsLeftListener

herdado deCallWithChatAdapterSubscriptions.on

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

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

Parâmetros

event

"chatError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

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

Parâmetros

event

"chatParticipantsAdded"

listener

ParticipantsAddedListener

herdado deCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

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

Parâmetros

event

"chatParticipantsRemoved"

listener

ParticipantsRemovedListener

herdado deCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

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

Parâmetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

herdado deCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

herdado deCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

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

Parâmetros

event

"isMutedChanged"

listener

IsMutedChangedListener

herdado deCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

Parâmetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

herdado deCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

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

Parâmetros

event

"messageRead"

listener

MessageReadListener

herdado deCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

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

Parâmetros

event

"messageReceived"

listener

MessageReceivedListener

herdado deCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

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

Parâmetros

event

"messageSent"

listener

MessageReceivedListener

herdado deCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

herdado deCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

herdado deCallWithChatAdapterSubscriptions.on

onStateChange((state: CallWithChatAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

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

Parâmetros

handler

(state: CallWithChatAdapterState) => void

herdado de AdapterState.onStateChange

queryCameras()

Consulta de dispositivos de câmara disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluções

Promise<VideoDeviceInfo[]>

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

Observações

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

herdado deCallWithChatAdapterManagement.queryCameras

queryMicrophones()

Consulta de dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado de CallWithChatAdapterManagement.queryMicrophones

querySpeakers()

Consulta de dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado doCallWithChatAdapterManagement.querySpeakers

removeParticipant(string)

Remover um participante de uma Chamada.

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

Parâmetros

userId

string

UserId do participante a remover.

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.removeParticipant

sendMessage(string, SendMessageOptions)

Envie uma mensagem no tópico.

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

Parâmetros

content

string

options

SendMessageOptions

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

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

Parâmetros

chatMessageId

string

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendTypingIndicator

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera para usar na chamada.

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

Parâmetros

sourceInfo

VideoDeviceInfo

Dispositivo de câmera para escolher, escolha um retornado por queryCameras

options

VideoStreamOptions

Opções para controlar como o fluxo da câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.setCamera

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

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

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de microfone para escolher, escolha um retornado por queryMicrophones

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

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

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de alto-falante para escolher, escolha um retornado por querySpeakers

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.setSpeaker

startCall(string[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

string[]

Uma matriz de ids de participante para participar

options

StartCallOptions

Devoluções

undefined | Call

herdado doCallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Inicie a câmara.

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

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.startCamera

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.startScreenShare

stopCamera()

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>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.stopCamera

stopScreenShare()

Pare de compartilhar a tela.

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.stopScreenShare

unmute()

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

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.unmute

updateMessage(string, string, Record<string, string>)

Atualizar o conteúdo de uma mensagem.

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

Parâmetros

messageId

string

content

string

metadata

Record<string, string>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.updateMessage