CallWithChatAdapter interface
CallWithChatComposite Interfaccia dell'adattatore.
- Extends
Metodi ereditati
Dettagli dei metodi ereditati
askDevicePermission(PermissionConstraints)
Richiedere le autorizzazioni dei dispositivi.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>
Parametri
- constrain
- PermissionConstraints
Definire vincoli per l'accesso ai dispositivi locali <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Restituisce
Promise<void>
Commenti
Verrà visualizzata la finestra delle autorizzazioni del browser se le autorizzazioni non sono ancora concesse.
Ereditato daCallWithChatAdapterManagement.askDevicePermission
createStreamView(string, VideoStreamOptions)
Creare la visualizzazione HTML per un flusso.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>
Parametri
- remoteUserId
-
string
ID del partecipante di cui eseguire il rendering, lasciarlo non definito per creare la visualizzazione della fotocamera locale
- options
- VideoStreamOptions
Opzioni per controllare il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Restituisce
Promise<void | CreateVideoStreamViewResult>
Commenti
Questo metodo viene implementato per composito.
Ereditato daCallWithChatAdapterManagement.createStreamView
deleteMessage(string)
Eliminare un messaggio nel thread.
function deleteMessage(messageId: string): Promise<void>
Parametri
- messageId
-
string
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.deleteMessage
dispose()
disposeStreamView(string, VideoStreamOptions)
Eliminare la visualizzazione HTML per un flusso.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
Parametri
- remoteUserId
-
string
ID del partecipante di cui eseguire il rendering, lasciarlo non definito per eliminare la visualizzazione della fotocamera locale
- options
- VideoStreamOptions
Opzioni per controllare il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Restituisce
Promise<void>
Commenti
Questo metodo viene implementato per composito.
Ereditato daCallWithChatAdapterManagement.disposeStreamView
fetchInitialData()
Recuperare lo stato iniziale per l'adapter Chat.
Esegue il recupero minimo necessario per i metodi ChatComposite e API.
function fetchInitialData(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.fetchInitialData
getState()
Ottenere lo stato corrente
function getState(): CallWithChatAdapterState
Restituisce
Ereditato daAdapterState.getState
joinCall(boolean)
Partecipare alla chiamata con il microfono inizialmente attivato/disattivato.
function joinCall(microphoneOn?: boolean): undefined | Call
Parametri
- microphoneOn
-
boolean
Indica se il microfono è inizialmente abilitato
Restituisce
undefined | Call
Ereditato daCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Lasciare la chiamata.
function leaveCall(forEveryone?: boolean): Promise<void>
Parametri
- forEveryone
-
boolean
Se rimuovere tutti i partecipanti all'uscita
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Caricare altri messaggi precedenti nella cronologia dei thread della chat.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parametri
- messagesToLoad
-
number
Restituisce
Promise<boolean>
Commenti
Questo metodo viene in genere usato per controllare lo scorrimento incrementale di recupero/infinito.
Ereditato daCallWithChatAdapterManagement.loadPreviousChatMessages
mute()
Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale.
function mute(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.mute
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parametri
- event
-
"callEnded"
- listener
- CallEndedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parametri
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Ereditato daCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parametri
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parametri
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parametri
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parametri
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Ereditato daCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parametri
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parametri
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parametri
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parametri
- event
-
"isLocalScreenSharingActiveChanged"
Ereditato daCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parametri
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parametri
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parametri
- event
-
"messageRead"
- listener
- MessageReadListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parametri
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parametri
- event
-
"messageSent"
- listener
- MessageReceivedListener
Ereditato daCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parametri
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Ereditato daCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parametri
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Ereditato daCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Annulla la sottoscrizione del gestore agli eventi stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Parametri
- handler
-
(state: CallWithChatAdapterState) => void
Ereditato daAdapterState.offStateChange
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parametri
- event
-
"callEnded"
- listener
- CallEndedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parametri
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Ereditato daCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parametri
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parametri
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parametri
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parametri
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Ereditato daCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parametri
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parametri
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parametri
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parametri
- event
-
"isLocalScreenSharingActiveChanged"
Ereditato daCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parametri
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parametri
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parametri
- event
-
"messageRead"
- listener
- MessageReadListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parametri
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parametri
- event
-
"messageSent"
- listener
- MessageReceivedListener
Ereditato daCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parametri
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Ereditato daCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parametri
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Ereditato daCallWithChatAdapterSubscriptions.on
onStateChange((state: CallWithChatAdapterState) => void)
Sottoscrive il gestore per gli eventi stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Parametri
- handler
-
(state: CallWithChatAdapterState) => void
Ereditato daAdapterState.onStateChange
queryCameras()
Eseguire una query per i dispositivi fotocamera disponibili.
function queryCameras(): Promise<VideoDeviceInfo[]>
Restituisce
Promise<VideoDeviceInfo[]>
Matrice di entità di informazioni sul dispositivo video <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Commenti
Questo metodo deve essere chiamato dopo askDevicePermission()
Ereditato daCallWithChatAdapterManagement.queryCameras
queryMicrophones()
Eseguire una query per i dispositivi microfoni disponibili.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Restituisce
Promise<AudioDeviceInfo[]>
Matrice di entità di informazioni sul dispositivo audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Commenti
Questo metodo deve essere chiamato dopo askDevicePermission()
Ereditato daCallWithChatAdapterManagement.queryMicrophones
querySpeakers()
Eseguire una query per i dispositivi microfoni disponibili.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Restituisce
Promise<AudioDeviceInfo[]>
Matrice di entità di informazioni sul dispositivo audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Commenti
Questo metodo deve essere chiamato dopo askDevicePermission()
Ereditato daCallWithChatAdapterManagement.querySpeakers
removeParticipant(string)
Rimuovere un partecipante da una chiamata.
function removeParticipant(userId: string): Promise<void>
Parametri
- userId
-
string
UserId del partecipante da rimuovere.
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.removeParticipant
sendMessage(string, SendMessageOptions)
Inviare un messaggio nel thread.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parametri
- content
-
string
- options
- SendMessageOptions
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Inviare una ricevuta di lettura per un messaggio.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parametri
- chatMessageId
-
string
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.sendReadReceipt
sendTypingIndicator()
Inviare l'indicatore di digitazione nel thread.
function sendTypingIndicator(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.sendTypingIndicator
setCamera(VideoDeviceInfo, VideoStreamOptions)
Impostare la fotocamera da usare nella chiamata.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parametri
- sourceInfo
- VideoDeviceInfo
Dispositivo fotocamera da scegliere, selezionarne uno restituito da queryCameras
- options
- VideoStreamOptions
Opzioni per controllare il rendering del flusso della fotocamera <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.setCamera
setMicrophone(AudioDeviceInfo)
Impostare il microfono da usare nella chiamata.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parametri
- sourceInfo
- AudioDeviceInfo
Dispositivo microfono da scegliere, selezionarne uno restituito dalla queryMicrophones
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.setMicrophone
setSpeaker(AudioDeviceInfo)
Impostare l'altoparlante da usare nella chiamata.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parametri
- sourceInfo
- AudioDeviceInfo
Dispositivo altoparlante da scegliere, selezionarne uno restituito da querySpeakers
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.setSpeaker
startCall(string[], StartCallOptions)
Avviare la chiamata.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parametri
- participants
-
string[]
Matrice di ID partecipante da aggiungere
- options
- StartCallOptions
Restituisce
undefined | Call
Ereditato daCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Avviare la fotocamera.
Questo metodo avvierà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.
function startCamera(options?: VideoStreamOptions): Promise<void>
Parametri
- options
- VideoStreamOptions
Opzioni per controllare il rendering dei flussi video <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.startCamera
startScreenShare()
Iniziare a condividere la schermata durante una chiamata.
function startScreenShare(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.startScreenShare
stopCamera()
Arrestare la fotocamera.
Questo metodo interromperà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva.
function stopCamera(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.stopCamera
stopScreenShare()
Interrompere la condivisione dello schermo.
function stopScreenShare(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.stopScreenShare
unmute()
Deselezionare l'utente corrente durante la chiamata o abilitare il microfono in locale.
function unmute(): Promise<void>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Aggiornare il contenuto di un messaggio.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>
Parametri
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Restituisce
Promise<void>
Ereditato daCallWithChatAdapterManagement.updateMessage