ChatAdapterThreadManagement interface

Pakiet:

@azure/communication-react

Funkcje zarządzania bieżącym wątkiem czatu.

Metody

deleteMessage(string)	Usuń komunikat w wątku.
fetchInitialData()	Pobieranie stanu początkowego dla karty czatu. Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.
loadPreviousChatMessages(number)	Załaduj więcej poprzednich wiadomości w historii wątków czatu.
removeParticipant(string)	Usuń uczestnika w wątku.
sendMessage(string, SendMessageOptions)	Wyślij wiadomość w wątku.
sendReadReceipt(string)	Wyślij potwierdzenie przeczytania wiadomości.
sendTypingIndicator()	Wyślij wskaźnik wpisywania w wątku.
setTopic(string)	Ustaw temat dla wątku.
updateMessage(string, string, Record<string, string>)	Aktualizowanie zawartości wiadomości.

Szczegóły metody

deleteMessage(string)

Usuń komunikat w wątku.

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

Parametry

messageId

string

Zwraca

Promise<void>

fetchInitialData()

Pobieranie stanu początkowego dla karty czatu.

Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.

function fetchInitialData(): Promise<void>

Zwraca

Promise<void>

loadPreviousChatMessages(number)

Załaduj więcej poprzednich wiadomości w historii wątków czatu.

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

Parametry

messagesToLoad

number

Zwraca

Promise<boolean>

Uwagi

Ta metoda jest zwykle używana do kontrolowania przyrostowego pobierania/nieskończonego przewijania

removeParticipant(string)

Usuń uczestnika w wątku.

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

Parametry

userId

string

Zwraca

Promise<void>

sendMessage(string, SendMessageOptions)

Wyślij wiadomość w wątku.

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

Parametry

content

string

options

SendMessageOptions

Zwraca

Promise<void>

sendReadReceipt(string)

Wyślij potwierdzenie przeczytania wiadomości.

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

Parametry

chatMessageId

string

Zwraca

Promise<void>

sendTypingIndicator()

Wyślij wskaźnik wpisywania w wątku.

function sendTypingIndicator(): Promise<void>

Zwraca

Promise<void>

setTopic(string)

Ustaw temat dla wątku.

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

Parametry

topicName

string

Zwraca

Promise<void>

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

Aktualizowanie zawartości wiadomości.

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

Parametry

messageId

string

content

string

metadata

Record<string, string>

Zwraca

Promise<void>