ChatAdapterThreadManagement interface

Csomag:

@azure/communication-react

Az aktuális csevegési szál kezelésére szolgáló funkciók.

Metódusok

deleteMessage(string)	Üzenet törlése a szálból.
downloadResourceToCache(ResourceDetails)	Letölt egy erőforrást az adott üzenet gyorsítótárába.
fetchInitialData()	A csevegőadapter kezdeti állapotának lekérése. Végrehajtja a ChatComposite és AZ API metódusokhoz szükséges minimális lekérést.
loadPreviousChatMessages(number)	További korábbi üzenetek betöltése a csevegési szál előzményeibe.
removeParticipant(string)	Távolítsa el a résztvevőt a szálból.
removeResourceFromCache(ResourceDetails)	Eltávolít egy erőforrást az adott üzenet gyorsítótárából.
sendMessage(string, SendMessageOptions)	Üzenet küldése a szálban. Vegye figyelembe, hogy a SendMessageOptions elavult, használja helyette a MessageOptions értéket.
sendReadReceipt(string)	Üzenet olvasási visszaigazolásának küldése.
sendTypingIndicator()	Gépelési jelző küldése a szálon.
setTopic(string)	Adja meg a téma témáját.
updateMessage(string, string, Record<string, string>)	Üzenettartalom frissítése. Vegye figyelembe, hogy a metaadatok elavultak, használja helyette a MessageOptions.metadata fájlt.

Metódus adatai

deleteMessage(string)

Üzenet törlése a szálból.

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

Paraméterek

messageId

string

Válaszok

Promise<void>

downloadResourceToCache(ResourceDetails)

Letölt egy erőforrást az adott üzenet gyorsítótárába.

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

Paraméterek

resourceDetails

ResourceDetails

Válaszok

Promise<void>

fetchInitialData()

A csevegőadapter kezdeti állapotának lekérése.

Végrehajtja a ChatComposite és AZ API metódusokhoz szükséges minimális lekérést.

function fetchInitialData(): Promise<void>

Válaszok

Promise<void>

loadPreviousChatMessages(number)

További korábbi üzenetek betöltése a csevegési szál előzményeibe.

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

Paraméterek

messagesToLoad

number

Válaszok

Promise<boolean>

Megjegyzések

Ezt a módszert általában a növekményes beolvasás/végtelen görgetés szabályozására használják

removeParticipant(string)

Távolítsa el a résztvevőt a szálból.

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

Paraméterek

userId

string

Válaszok

Promise<void>

removeResourceFromCache(ResourceDetails)

Eltávolít egy erőforrást az adott üzenet gyorsítótárából.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Paraméterek

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Üzenet küldése a szálban. Vegye figyelembe, hogy a SendMessageOptions elavult, használja helyette a MessageOptions értéket.

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

Paraméterek

content

string

options

SendMessageOptions

Válaszok

Promise<void>

sendReadReceipt(string)

Üzenet olvasási visszaigazolásának küldése.

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

Paraméterek

chatMessageId

string

Válaszok

Promise<void>

sendTypingIndicator()

Gépelési jelző küldése a szálon.

function sendTypingIndicator(): Promise<void>

Válaszok

Promise<void>

setTopic(string)

Adja meg a téma témáját.

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

Paraméterek

topicName

string

Válaszok

Promise<void>

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

Üzenettartalom frissítése. Vegye figyelembe, hogy a metaadatok elavultak, használja helyette a MessageOptions.metadata fájlt.

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

Paraméterek

messageId

string

content

string

options

Record<string, string>

Válaszok

Promise<void>