CallWithChatAdapter interface
interface do Adaptador CallWithChatComposite.
- Extends
Propriedades herdadas
| forbid |
Proíbe áudio para os IDs de usuário especificados. |
| forbid |
proíbe áudio para participantes de reuniões do Teams, exceto o usuário local. |
| forbid |
proíbe o vídeo para participantes da reunião do Teams, exceto o usuário local. |
| forbid |
Proíbe vídeo para os IDs de usuário especificados. |
| permit |
Permite áudio para os IDs de usuário especificados. |
| permit |
permite áudio para participantes da reunião do Teams, exceto o usuário local. |
| permit |
permite vídeo para participantes da reunião do Teams, exceto o usuário local. |
| permit |
Permite vídeo para os IDs de usuário especificados. |
| send |
Enviar tom DTMF para outro participante da chamada em chamadas 1:1 |
| send |
Enviar texto em tempo real |
Métodos herdados
Detalhes das propriedades herdadas
forbidAudio
Proíbe áudio para os IDs de usuário especificados.
forbidAudio: (userIds: string[]) => Promise<void>Valor da propriedade
(userIds: string[]) => Promise<void>
forbidOthersAudio
proíbe áudio para participantes de reuniões do Teams, exceto o usuário local.
forbidOthersAudio: () => Promise<void>Valor da propriedade
() => Promise<void>
forbidOthersVideo
proíbe o vídeo para participantes da reunião do Teams, exceto o usuário local.
forbidOthersVideo: () => Promise<void>Valor da propriedade
() => Promise<void>
forbidVideo
Proíbe vídeo para os IDs de usuário especificados.
forbidVideo: (userIds: string[]) => Promise<void>Valor da propriedade
(userIds: string[]) => Promise<void>
permitAudio
Permite áudio para os IDs de usuário especificados.
permitAudio: (userIds: string[]) => Promise<void>Valor da propriedade
(userIds: string[]) => Promise<void>
permitOthersAudio
permite áudio para participantes da reunião do Teams, exceto o usuário local.
permitOthersAudio: () => Promise<void>Valor da propriedade
() => Promise<void>
permitOthersVideo
permite vídeo para participantes da reunião do Teams, exceto o usuário local.
permitOthersVideo: () => Promise<void>Valor da propriedade
() => Promise<void>
permitVideo
Permite vídeo para os IDs de usuário especificados.
permitVideo: (userIds: string[]) => Promise<void>Valor da propriedade
(userIds: string[]) => Promise<void>
sendDtmfTone
Enviar tom DTMF para outro participante da chamada em chamadas 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>Valor da propriedade
(dtmfTone: DtmfTone) => Promise<void>
sendRealTimeText
Enviar texto em tempo real
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>Valor da propriedade
(text: string, isFinalized: boolean) => Promise<void>
Detalhes do método herdado
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>Parâmetros
- participant
- CommunicationUserIdentifier
Retornos
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Adiciona um novo Participante à chamada.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>Parâmetros
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Retornos
Promise<void>
askDevicePermission(PermissionConstraints)
Peça permissões de dispositivos.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>Parâmetros
- constrain
- PermissionConstraints
Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Retornos
Promise<DeviceAccess>
Comentários
A janela de permissão do navegador será exibida se as permissões ainda não forem concedidas.
createStreamView(string, VideoStreamOptions)
Crie o modo de exibição html para um fluxo.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Parâmetros
- remoteUserId
-
string
ID do participante a ser renderizado, deixe-a indefinida para criar o modo de exibiçã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>
Retornos
Promise<void | CreateVideoStreamViewResult>
Comentários
Esse método é implementado para composição.
createTogetherModeStreamView(TogetherModeStreamOptions)
Crie a visualização html para um fluxo togethermode.
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>Parâmetros
- options
- TogetherModeStreamOptions
Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Retornos
Promise<void | TogetherModeStreamViewResult>
Comentários
Esse método é implementado para composição
Herdado deCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
Exclua uma mensagem no thread.
function deleteMessage(messageId: string): Promise<void>Parâmetros
- messageId
-
string
Retornos
Promise<void>
dispose()
disposeLocalVideoStreamView()
Descartar a visualização html para um fluxo de vídeo local
function disposeLocalVideoStreamView(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
Descartar a visualização html para um fluxo de vídeo remoto
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>Parâmetros
- remoteUserId
-
string
ID do participante a ser descartado
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
Descartar a visualização html para um fluxo de compartilhamento de tela
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>Parâmetros
- remoteUserId
-
string
ID do participante para o qual descartar a exibição de fluxo de compartilhamento de tela.
Retornos
Promise<void>
Comentários
Este método é implementado para compostos
Herdado deCallWithChatAdapterManagement.disposeScreenShareStreamView
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 ser renderizado, deixe-o indefinido para descartar a exibiçã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>
Retornos
Promise<void>
Comentários
Esse método é implementado para composição.
disposeTogetherModeStreamView()
Descarte a visualização html para um fluxo togethermode.
function disposeTogetherModeStreamView(): Promise<void>Retornos
Promise<void>
Comentários
Esse método é implementado para composição
Herdado deCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>Parâmetros
- resourceDetails
- ResourceDetails
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
Buscar o estado inicial para o adaptador de Chat.
Executa a busca mínima necessária para métodos de ChatComposite e API.
function fetchInitialData(): Promise<void>Retornos
Promise<void>
getState()
Obter o estado atual
function getState(): CallWithChatAdapterStateRetornos
Herdado deAdapterState.getState
holdCall()
Coloca a chamada em um localhold.
function holdCall(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.holdCall
joinCall(boolean)
Aviso
Essa API foi preterida.
Use joinCall(options?:JoinCallOptions) instead.
Ingresse a chamada com o microfone inicialmente ativado/desativado.
function joinCall(microphoneOn?: boolean): undefined | CallParâmetros
- microphoneOn
-
boolean
Se o microfone está habilitado inicialmente
Retornos
undefined | Call
Herdado deCallWithChatAdapterManagement.joinCall
joinCall(JoinCallOptions)
Participe da chamada com o saco de opções para definir o estado inicial do microfone/câmera ao entrar na chamada true = liga o dispositivo ao entrar na chamada false = desliga o dispositivo ao entrar na chamada 'keep'/undefined = reter o estado de pré-chamada dos dispositivos
function joinCall(options?: JoinCallOptions): undefined | CallParâmetros
- options
- JoinCallOptions
parâmetro para ativar / desativar / usar o microfone / câmera inicialmente.
Retornos
undefined | Call
Herdado deCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Deixe a chamada.
function leaveCall(forEveryone?: boolean): Promise<void>Parâmetros
- forEveryone
-
boolean
Se todos os participantes devem ser removidos
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Carregue mais mensagens anteriores no histórico de threads de chat.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>Parâmetros
- messagesToLoad
-
number
Retornos
Promise<boolean>
Comentários
Esse método geralmente é usado para controlar a busca incremental/rolagem infinita.
Herdado deCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Mão inferior para usuário local.
function lowerHand(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.lowerHand
mute()
Silencie o usuário atual durante a chamada ou desabilite o microfone localmente.
function mute(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.mute
muteAllRemoteParticipants()
Silenciar um participante
function muteAllRemoteParticipants(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Silenciar um participante
function muteParticipant(userId: string): Promise<void>Parâmetros
- userId
-
string
Retornos
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
Herdado deCallWithChatAdapterSubscriptions.off
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("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
Herdado deCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
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("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)Parâmetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
Herdado deCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
Herdado deCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
Herdado deCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)Parâmetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
Herdado deCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)Parâmetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
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("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
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
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
Herdado deCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Cancela a assinatura do manipulador para eventos stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)Parâmetros
- handler
-
(state: CallWithChatAdapterState) => void
Herdado deAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
Herdado deCallWithChatAdapterSubscriptions.on
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("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
Herdado deCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
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("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)Parâmetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
Herdado deCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
Herdado deCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
Herdado deCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)Parâmetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
Herdado deCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)Parâmetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
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("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
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
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
Herdado deCallWithChatAdapterSubscriptions.on
onReactionClick(Reaction)
Envie a reação à reunião em andamento.
function onReactionClick(reaction: Reaction): Promise<void>Parâmetros
- reaction
- Reaction
Um valor do tipo <xref:%40azure%2Fcommunication-calling%23Reaction>
Retornos
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
Assina o manipulador para eventos stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)Parâmetros
- handler
-
(state: CallWithChatAdapterState) => void
Herdado deAdapterState.onStateChange
queryCameras()
Consultar dispositivos de câmera disponíveis.
function queryCameras(): Promise<VideoDeviceInfo[]>Retornos
Promise<VideoDeviceInfo[]>
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()
queryMicrophones()
Consultar dispositivos de microfone disponíveis.
function queryMicrophones(): Promise<AudioDeviceInfo[]>Retornos
Promise<AudioDeviceInfo[]>
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()
querySpeakers()
Consultar dispositivos de microfone disponíveis.
function querySpeakers(): Promise<AudioDeviceInfo[]>Retornos
Promise<AudioDeviceInfo[]>
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()
raiseHand()
Levante a mão para o usuário local.
function raiseHand(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.raiseHand
removeParticipant(CommunicationIdentifier)
Remova um participante da chamada.
function removeParticipant(participant: CommunicationIdentifier): Promise<void>Parâmetros
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> do participante a ser removido
Retornos
Promise<void>
removeParticipant(string)
Remova um participante de uma chamada.
function removeParticipant(userId: string): Promise<void>Parâmetros
- userId
-
string
UserId do participante a ser removido.
Retornos
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)Parâmetros
- resourceDetails
- ResourceDetails
Herdado deCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Retoma a chamada de um estado LocalHold.
function resumeCall(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.resumeCall
returnFromBreakoutRoom()
Retorno à chamada de origem da sala de descanso
function returnFromBreakoutRoom(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.returnFromBreakoutRoom
sendMessage(string, SendMessageOptions)
Envie uma mensagem no thread.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>Parâmetros
- content
-
string
- options
- SendMessageOptions
Retornos
Promise<void>
sendReadReceipt(string)
Envie um recibo de leitura para uma mensagem.
function sendReadReceipt(chatMessageId: string): Promise<void>Parâmetros
- chatMessageId
-
string
Retornos
Promise<void>
sendTypingIndicator()
Enviar indicador de digitação no thread.
function sendTypingIndicator(): Promise<void>Retornos
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Defina a câmera a ser usada 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 de câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.setCamera
setCaptionLanguage(string)
Função para definir o idioma da legenda
function setCaptionLanguage(language: string): Promise<void>Parâmetros
- language
-
string
Idioma definido para legenda
Retornos
Promise<void>
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
Retornos
Promise<void>
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
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.setSpeaker
setSpokenLanguage(string)
Função para definir o idioma falado
function setSpokenLanguage(language: string): Promise<void>Parâmetros
- language
-
string
Linguagem falada
Retornos
Promise<void>
setTogetherModeSceneSize(number, number)
Recalcule as posições dos bancos para o modo juntos.
function setTogetherModeSceneSize(width: number, height: number)Parâmetros
- width
-
number
Largura do contêiner
- height
-
number
Altura do recipiente
Comentários
Esse método é implementado para composição
Herdado deCallWithChatAdapterManagement.setTogetherModeSceneSize
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Inicie a chamada.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | CallParâmetros
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Um array de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser chamado
- options
- StartCallOptions
Retornos
undefined | Call
Herdado deCallWithChatAdapterManagement.startCall
startCall(string[], StartCallOptions)
Inicie a chamada.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallParâmetros
- participants
-
string[]
Uma matriz de IDs de participante para ingressar
- options
- StartCallOptions
Retornos
undefined | Call
Herdado deCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
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
- options
- VideoStreamOptions
Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Retornos
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
Função para iniciar legendas
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>Parâmetros
- options
- StartCaptionsAdapterOptions
Opções para legendas iniciais
Retornos
Promise<void>
startNoiseSuppressionEffect()
Inicie o efeito de supressão de ruído.
function startNoiseSuppressionEffect(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
Comece a compartilhar a tela durante uma chamada.
function startScreenShare(): Promise<void>Retornos
Promise<void>
startSpotlight(string[])
Iniciar destaque
function startSpotlight(userIds?: string[]): Promise<void>Parâmetros
- userIds
-
string[]
Retornos
Promise<void>
startTogetherMode()
Modo de início em conjunto.
function startTogetherMode(): Promise<void>Retornos
Promise<void>
Comentários
Esse método é implementado para composição
startVideoBackgroundEffect(VideoBackgroundEffect)
Inicie o efeito de fundo do vídeo.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>Parâmetros
- videoBackgroundEffect
- VideoBackgroundEffect
Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.startVideoBackgroundEffect
stopAllSpotlight()
Pare todos os holofotes
function stopAllSpotlight(): Promise<void>Retornos
Promise<void>
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>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Função para parar legendas
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>Parâmetros
- options
- StopCaptionsAdapterOptions
Retornos
Promise<void>
stopNoiseSuppressionEffect()
Inicie o efeito de supressão de ruído.
function stopNoiseSuppressionEffect(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.stopNoiseSuppressionEffect
stopScreenShare()
Pare de compartilhar a tela.
function stopScreenShare(): Promise<void>Retornos
Promise<void>
stopSpotlight(string[])
Pare de holofotes
function stopSpotlight(userIds?: string[]): Promise<void>Parâmetros
- userIds
-
string[]
Retornos
Promise<void>
stopVideoBackgroundEffects()
Pare o efeito de fundo do vídeo.
function stopVideoBackgroundEffects(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.stopVideoBackgroundEffects
submitSurvey(CallSurvey)
Enviar o resultado da pesquisa de fim de chamada
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>Parâmetros
- survey
- CallSurvey
Retornos
Promise<undefined | CallSurveyResponse>
unmute()
Desative o usuário atual durante a chamada ou habilite o microfone localmente.
function unmute(): Promise<void>Retornos
Promise<void>
Herdado deCallWithChatAdapterManagement.unmute
updateBackgroundPickerImages(VideoBackgroundImage[])
Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])Parâmetros
- backgroundImages
Matriz de imagens de fundo personalizadas.
Herdado deCallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
Atualize um conteúdo de mensagem.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>Parâmetros
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Retornos
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Atualizar o efeito de plano de fundo do vídeo selecionado
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)Parâmetros
- selectedVideoBackground
- VideoBackgroundEffect
Herdado deCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect