ChatAdapterThreadManagement interface

Пакет:

@azure/communication-react

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

Методы

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

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

deleteMessage(string)

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

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

Параметры

messageId

string

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

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>

sendMessage(string, SendMessageOptions)

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

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>)

Обновление содержимого сообщения.

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

Параметры

messageId

string

content

string

metadata

Record<string, string>

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

Promise<void>