ChatAdapterThreadManagement interface

Pakiet:

@azure/communication-react

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

Metody

deleteMessage(string)	Usuń komunikat w wątku.
downloadResourceToCache(ResourceDetails)	Pobiera zasób do pamięci podręcznej dla danej wiadomości.
fetchInitialData()	Pobierz stan początkowy 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ątku czatu.
removeParticipant(string)	Usuń uczestnika wątku.
removeResourceFromCache(ResourceDetails)	Usuwa zasób z pamięci podręcznej dla danego komunikatu.
sendMessage(string, SendMessageOptions)	Wyślij wiadomość w wątku. Należy pamiętać, że SendMessageOptions jest przestarzały, zamiast tego użyj MessageOptions.
sendReadReceipt(string)	Wyślij potwierdzenie odczytu dla 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. Należy pamiętać, że metadane są przestarzałe, zamiast tego użyj MessageOptions.metadata.

Szczegóły metody

deleteMessage(string)

Usuń komunikat w wątku.

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

Parametry

messageId

string

Zwraca

Promise<void>

downloadResourceToCache(ResourceDetails)

Pobiera zasób do pamięci podręcznej dla danej wiadomości.

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

Parametry

resourceDetails

ResourceDetails

Zwraca

Promise<void>

fetchInitialData()

Pobierz stan początkowy 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ątku 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ątku.

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

Parametry

userId

string

Zwraca

Promise<void>

removeResourceFromCache(ResourceDetails)

Usuwa zasób z pamięci podręcznej dla danego komunikatu.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametry

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Wyślij wiadomość w wątku. Należy pamiętać, że SendMessageOptions jest przestarzały, zamiast tego użyj MessageOptions.

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

Parametry

content

string

options

SendMessageOptions

Zwraca

Promise<void>

sendReadReceipt(string)

Wyślij potwierdzenie odczytu dla 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. Należy pamiętać, że metadane są przestarzałe, zamiast tego użyj MessageOptions.metadata.

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

Parametry

messageId

string

content

string

options

Record<string, string>

Zwraca

Promise<void>