你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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>