ChatAdapterThreadManagement interface

Balíček:

@azure/communication-react

Funkce pro správu aktuálního vlákna chatu

Metody

deleteMessage(string)	Odstraňte zprávu ve vlákně.
downloadResourceToCache(ResourceDetails)	Stáhne do cache zdroj pro danou zprávu.
fetchInitialData()	Načtěte počáteční stav adaptéru chatu. Provede minimální načtení potřebné pro metody ChatComposite a rozhraní API.
loadPreviousChatMessages(number)	Načtěte další předchozí zprávy v historii vlákna chatu.
removeParticipant(string)	Odeberte účastníka ve vlákně.
removeResourceFromCache(ResourceDetails)	Odebere prostředek z mezipaměti pro danou zprávu.
sendMessage(string, SendMessageOptions)	Odešle zprávu ve vlákně. Upozorňujeme, že SendMessageOptions je zastaralý, použijte místo toho MessageOptions.
sendReadReceipt(string)	Odešle potvrzení o přečtení zprávy.
sendTypingIndicator()	Odešlete do vlákna indikátor psaní.
setTopic(string)	Nastavte téma pro vlákno.
updateMessage(string, string, Record<string, string>)	Aktualizujte obsah zprávy. Upozorňujeme, že metadata jsou zastaralá, použijte místo toho MessageOptions.metadata.

Podrobnosti metody

deleteMessage(string)

Odstraňte zprávu ve vlákně.

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

Parametry

messageId

string

Návraty

Promise<void>

downloadResourceToCache(ResourceDetails)

Stáhne do cache zdroj pro danou zprávu.

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

Parametry

resourceDetails

ResourceDetails

Návraty

Promise<void>

fetchInitialData()

Načtěte počáteční stav adaptéru chatu.

Provede minimální načtení potřebné pro metody ChatComposite a rozhraní API.

function fetchInitialData(): Promise<void>

Návraty

Promise<void>

loadPreviousChatMessages(number)

Načtěte další předchozí zprávy v historii vlákna chatu.

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

Parametry

messagesToLoad

number

Návraty

Promise<boolean>

Poznámky

Tato metoda se obvykle používá k řízení přírůstkového načítání nebo nekonečného posouvání.

removeParticipant(string)

Odeberte účastníka ve vlákně.

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

Parametry

userId

string

Návraty

Promise<void>

removeResourceFromCache(ResourceDetails)

Odebere prostředek z mezipaměti pro danou zprávu.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametry

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Odešle zprávu ve vlákně. Upozorňujeme, že SendMessageOptions je zastaralý, použijte místo toho MessageOptions.

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

Parametry

content

string

options

SendMessageOptions

Návraty

Promise<void>

sendReadReceipt(string)

Odešle potvrzení o přečtení zprávy.

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

Parametry

chatMessageId

string

Návraty

Promise<void>

sendTypingIndicator()

Odešlete do vlákna indikátor psaní.

function sendTypingIndicator(): Promise<void>

Návraty

Promise<void>

setTopic(string)

Nastavte téma pro vlákno.

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

Parametry

topicName

string

Návraty

Promise<void>

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

Aktualizujte obsah zprávy. Upozorňujeme, že metadata jsou zastaralá, použijte místo toho MessageOptions.metadata.

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

Parametry

messageId

string

content

string

options

Record<string, string>

Návraty

Promise<void>