ChatAdapterThreadManagement interface

Пакет:

@azure/communication-react

Функции управления текущим потоком чата.

Методы

deleteMessage(string)	Удаление сообщения в потоке.
downloadResourceToCache(ResourceDetails)	Загружает ресурс в кэш для данного сообщения.
fetchInitialData()	Получение начального состояния адаптера чата. Выполняет минимальное получение, необходимое для методов ChatComposite и API.
loadPreviousChatMessages(number)	Загрузите дополнительные предыдущие сообщения в журнале потоков чата.
removeParticipant(string)	Удалите участника в потоке.
removeResourceFromCache(ResourceDetails)	Удаляет ресурс из кэша для данного сообщения.
sendMessage(string, SendMessageOptions)	Отправьте сообщение в потоке. Обратите внимание, что SendMessageOptions является устаревшим, используйте вместо него MessageOptions.
sendReadReceipt(string)	Отправьте квитанцию о чтении сообщения.
sendTypingIndicator()	Отправка индикатора ввода текста в потоке.
setTopic(string)	Задайте раздел для потока.
updateMessage(string, string, Record<string, string>)	Обновление содержимого сообщения. Обратите внимание, что метаданные устарели, используйте вместо них MessageOptions.metadata.

Сведения о методе

deleteMessage(string)

Удаление сообщения в потоке.

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

Параметры

messageId

string

Возвращаемое значение

Promise<void>

downloadResourceToCache(ResourceDetails)

Загружает ресурс в кэш для данного сообщения.

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

Параметры

resourceDetails

ResourceDetails

Возвращаемое значение

Promise<void>

fetchInitialData()

Получение начального состояния адаптера чата.

Выполняет минимальное получение, необходимое для методов ChatComposite и API.

function fetchInitialData(): Promise<void>

Возвращаемое значение

Promise<void>

loadPreviousChatMessages(number)

Загрузите дополнительные предыдущие сообщения в журнале потоков чата.

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

Параметры

messagesToLoad

number

Возвращаемое значение

Promise<boolean>

Комментарии

Этот метод обычно используется для управления добавочным получением или бесконечным прокруткой

removeParticipant(string)

Удалите участника в потоке.

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

Параметры

userId

string

Возвращаемое значение

Promise<void>

removeResourceFromCache(ResourceDetails)

Удаляет ресурс из кэша для данного сообщения.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Параметры

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Отправьте сообщение в потоке. Обратите внимание, что SendMessageOptions является устаревшим, используйте вместо него MessageOptions.

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

Параметры

content

string

options

SendMessageOptions

Возвращаемое значение

Promise<void>

sendReadReceipt(string)

Отправьте квитанцию о чтении сообщения.

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

Параметры

chatMessageId

string

Возвращаемое значение

Promise<void>

sendTypingIndicator()

Отправка индикатора ввода текста в потоке.

function sendTypingIndicator(): Promise<void>

Возвращаемое значение

Promise<void>

setTopic(string)

Задайте раздел для потока.

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

Параметры

topicName

string

Возвращаемое значение

Promise<void>

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

Обновление содержимого сообщения. Обратите внимание, что метаданные устарели, используйте вместо них MessageOptions.metadata.

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

Параметры

messageId

string

content

string

options

Record<string, string>

Возвращаемое значение

Promise<void>