CallWithChatAdapterManagement interface
Funzionalità per la gestione della chiamata corrente con chat.
Metodi
ask |
Richiedere le autorizzazioni dei dispositivi. |
create |
Creare la visualizzazione HTML per un flusso. |
delete |
Eliminare un messaggio nel thread. |
dispose |
Eliminare la visualizzazione HTML per un flusso. |
fetch |
Recuperare lo stato iniziale per l'adapter Chat. Esegue il recupero minimo necessario per i metodi ChatComposite e API. |
join |
Partecipare alla chiamata con il microfono inizialmente attivato/disattivato. |
leave |
Lasciare la chiamata. |
load |
Caricare altri messaggi precedenti nella cronologia dei thread della chat. |
mute() | Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale. |
query |
Eseguire una query per i dispositivi fotocamera disponibili. |
query |
Eseguire una query per i dispositivi microfoni disponibili. |
query |
Eseguire una query per i dispositivi microfoni disponibili. |
remove |
Rimuovere un partecipante da una chiamata. |
send |
Inviare un messaggio nel thread. |
send |
Inviare una ricevuta di lettura per un messaggio. |
send |
Inviare l'indicatore di digitazione nel thread. |
set |
Impostare la fotocamera da usare nella chiamata. |
set |
Impostare il microfono da usare nella chiamata. |
set |
Impostare l'altoparlante da usare nella chiamata. |
start |
Avviare la chiamata. |
start |
Avviare la fotocamera. Questo metodo inizierà a eseguire il rendering di una visualizzazione fotocamera locale quando la chiamata non è attiva. |
start |
Avviare la condivisione della schermata durante una chiamata. |
stop |
Arrestare la fotocamera. Questo metodo interromperà il rendering di una visualizzazione della fotocamera locale quando la chiamata non è attiva. |
stop |
Arrestare la condivisione dello schermo. |
unmute() | Annullare l'modifica dell'utente corrente durante la chiamata o abilitare il microfono in locale. |
update |
Aggiornare un contenuto del messaggio. |
Dettagli metodo
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.
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.
deleteMessage(string)
Eliminare un messaggio nel thread.
function deleteMessage(messageId: string): Promise<void>
Parametri
- messageId
-
string
Restituisce
Promise<void>
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.
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>
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
leaveCall(boolean)
Lasciare la chiamata.
function leaveCall(forEveryone?: boolean): Promise<void>
Parametri
- forEveryone
-
boolean
Se rimuovere tutti i partecipanti all'uscita
Restituisce
Promise<void>
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.
mute()
Disattivare l'utente corrente durante la chiamata o disabilitare il microfono in locale.
function mute(): Promise<void>
Restituisce
Promise<void>
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()
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()
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()
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>
sendMessage(string, SendMessageOptions)
Inviare un messaggio nel thread.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parametri
- content
-
string
- options
- SendMessageOptions
Restituisce
Promise<void>
sendReadReceipt(string)
Inviare una ricevuta di lettura per un messaggio.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parametri
- chatMessageId
-
string
Restituisce
Promise<void>
sendTypingIndicator()
Inviare l'indicatore di digitazione nel thread.
function sendTypingIndicator(): Promise<void>
Restituisce
Promise<void>
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>
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>
setSpeaker(AudioDeviceInfo)
Impostare l'altoparlante da usare nella chiamata.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parametri
- sourceInfo
- AudioDeviceInfo
Dispositivo altoparlante da scegliere, selezionare uno restituito da querySpeakers
Restituisce
Promise<void>
startCall(string[], StartCallOptions)
Avviare la chiamata.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parametri
- participants
-
string[]
Matrice di ID partecipanti da aggiungere
- options
- StartCallOptions
Restituisce
undefined | Call
startCamera(VideoStreamOptions)
Avviare la fotocamera.
Questo metodo inizierà a eseguire il rendering di una visualizzazione 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>
startScreenShare()
Avviare la condivisione della schermata durante una chiamata.
function startScreenShare(): Promise<void>
Restituisce
Promise<void>
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>
stopScreenShare()
Arrestare la condivisione dello schermo.
function stopScreenShare(): Promise<void>
Restituisce
Promise<void>
unmute()
Annullare l'modifica dell'utente corrente durante la chiamata o abilitare il microfono in locale.
function unmute(): Promise<void>
Restituisce
Promise<void>
updateMessage(string, string, Record<string, string>)
Aggiornare un contenuto del 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>