ChatAdapterThreadManagement interface

Paket:

@azure/communication-react

Funktionalität zum Verwalten des aktuellen Chatthreads.

Methoden

deleteMessage(string)	Löschen sie eine Nachricht im Thread.
downloadResourceToCache(ResourceDetails)	Lädt eine Ressource für die angegebene Nachricht in den Cache herunter.
fetchInitialData()	Ruft den Anfangszustand für den Chatadapter ab. Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.
loadPreviousChatMessages(number)	Laden Sie weitere vorherige Nachrichten im Chatthreadverlauf.
removeParticipant(string)	Entfernen Sie einen Teilnehmer im Thread.
removeResourceFromCache(ResourceDetails)	Entfernt eine Ressource aus dem Cache für die angegebene Nachricht.
sendMessage(string, SendMessageOptions)	Senden Sie eine Nachricht im Thread. Bitte beachten Sie, dass SendMessageOptions veraltet ist, verwenden Sie stattdessen MessageOptions.
sendReadReceipt(string)	Senden sie eine Lesebestätigung für eine Nachricht.
sendTypingIndicator()	Senden sie die Eingabeanzeige im Thread.
setTopic(string)	Legen Sie das Thema für den Thread fest.
updateMessage(string, string, Record<string, string>)	Aktualisieren eines Nachrichteninhalts. Bitte beachten Sie, dass Metadaten veraltet sind, verwenden Sie stattdessen MessageOptions.metadata.

Details zur Methode

deleteMessage(string)

Löschen sie eine Nachricht im Thread.

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

Parameter

messageId

string

Gibt zurück

Promise<void>

downloadResourceToCache(ResourceDetails)

Lädt eine Ressource für die angegebene Nachricht in den Cache herunter.

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

Parameter

resourceDetails

ResourceDetails

Gibt zurück

Promise<void>

fetchInitialData()

Ruft den Anfangszustand für den Chatadapter ab.

Führt den minimalen Abruf aus, der für ChatComposite- und API-Methoden erforderlich ist.

function fetchInitialData(): Promise<void>

Gibt zurück

Promise<void>

loadPreviousChatMessages(number)

Laden Sie weitere vorherige Nachrichten im Chatthreadverlauf.

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

Parameter

messagesToLoad

number

Gibt zurück

Promise<boolean>

Hinweise

Diese Methode wird in der Regel zum Steuern des inkrementellen Abrufs/unendlichen Bildlaufs verwendet.

removeParticipant(string)

Entfernen Sie einen Teilnehmer im Thread.

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

Parameter

userId

string

Gibt zurück

Promise<void>

removeResourceFromCache(ResourceDetails)

Entfernt eine Ressource aus dem Cache für die angegebene Nachricht.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parameter

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Senden Sie eine Nachricht im Thread. Bitte beachten Sie, dass SendMessageOptions veraltet ist, verwenden Sie stattdessen MessageOptions.

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

Parameter

content

string

options

SendMessageOptions

Gibt zurück

Promise<void>

sendReadReceipt(string)

Senden sie eine Lesebestätigung für eine Nachricht.

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

Parameter

chatMessageId

string

Gibt zurück

Promise<void>

sendTypingIndicator()

Senden sie die Eingabeanzeige im Thread.

function sendTypingIndicator(): Promise<void>

Gibt zurück

Promise<void>

setTopic(string)

Legen Sie das Thema für den Thread fest.

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

Parameter

topicName

string

Gibt zurück

Promise<void>

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

Aktualisieren eines Nachrichteninhalts. Bitte beachten Sie, dass Metadaten veraltet sind, verwenden Sie stattdessen MessageOptions.metadata.

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

Parameter

messageId

string

content

string

options

Record<string, string>

Gibt zurück

Promise<void>