ChatAdapterThreadManagement interface

Pacchetto:

@azure/communication-react

Funzionalità per la gestione del thread di chat corrente.

Metodi

deleteMessage(string)	Eliminare un messaggio nel thread.
downloadResourceToCache(ResourceDetails)	Scarica una risorsa nella cache per il messaggio specificato.
fetchInitialData()	Recuperare lo stato iniziale per l'adapter Chat. Esegue il recupero minimo necessario per i metodi ChatComposite e API.
loadPreviousChatMessages(number)	Caricare più messaggi precedenti nella cronologia dei thread di chat.
removeParticipant(string)	Rimuovere un partecipante nel thread.
removeResourceFromCache(ResourceDetails)	Rimuove una risorsa dalla cache per il messaggio specificato.
sendMessage(string, SendMessageOptions)	Inviare un messaggio nel thread. Si noti che SendMessageOptions è deprecato, si prega di utilizzare invece MessageOptions.
sendReadReceipt(string)	Inviare una ricevuta di lettura per un messaggio.
sendTypingIndicator()	Inviare l'indicatore di digitazione nel thread.
setTopic(string)	Impostare l'argomento per il thread.
updateMessage(string, string, Record<string, string>)	Aggiornare il contenuto di un messaggio. Si noti che i metadati sono deprecati, si prega di utilizzare invece MessageOptions.metadata.

Dettagli metodo

deleteMessage(string)

Eliminare un messaggio nel thread.

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

Parametri

messageId

string

Restituisce

Promise<void>

downloadResourceToCache(ResourceDetails)

Scarica una risorsa nella cache per il messaggio specificato.

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parametri

resourceDetails

ResourceDetails

Restituisce

Promise<void>

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>

loadPreviousChatMessages(number)

Caricare più messaggi precedenti nella cronologia dei thread di chat.

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

Parametri

messagesToLoad

number

Restituisce

Promise<boolean>

Commenti

Questo metodo viene in genere usato per controllare il recupero incrementale/scorrimento infinito

removeParticipant(string)

Rimuovere un partecipante nel thread.

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

Parametri

userId

string

Restituisce

Promise<void>

removeResourceFromCache(ResourceDetails)

Rimuove una risorsa dalla cache per il messaggio specificato.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametri

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Inviare un messaggio nel thread. Si noti che SendMessageOptions è deprecato, si prega di utilizzare invece MessageOptions.

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>

setTopic(string)

Impostare l'argomento per il thread.

function setTopic(topicName: string): Promise<void>

Parametri

topicName

string

Restituisce

Promise<void>

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

Aggiornare il contenuto di un messaggio. Si noti che i metadati sono deprecati, si prega di utilizzare invece MessageOptions.metadata.

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

Parametri

messageId

string

content

string

options

Record<string, string>

Restituisce

Promise<void>