Web&小程序&uni-app

最近更新时间:2024-05-08 17:03:11

我的收藏

功能描述

在发送消息时,可能会遇到消息尚未编辑完,就要切换至其它聊天窗口的情况。这些未编辑完的消息可通过 setConversationDraft 接口保存,以便于下次回到这个聊天界面时,通过 conversation 对象的 draftText 字段,获取到尚未编辑完的内容,继续编辑。
注意:
v3.1.1 及以上版本支持。
会话草稿仅支持文本内容。
草稿只在 SDK 运行期间保存,不会存储 Server,不能多端同步。

设置会话草稿

您可以调用 setConversationDraft接口,设置会话草稿。如果传递的 draftText 参数为 '',表示清除草稿。
接口
chat.setConversationDraft();
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
conversationID
String
会话 ID。
会话 ID 组成方式:
C2C${userID}(单聊)
GROUP${groupID}(群聊)
draftText
String
草稿内容,传 '' 时,表示清除草稿。
返回值
Promise
示例
// 设置会话草稿
let promise = chat.setConversationDraft({
conversationID: 'GROUPpublic1',
draftText: '123'
});
promise.then(function(imResponse) {
// 设置会话草稿成功
}).catch(function(imError) {
console.warn('setConversationDraft error:', imError); // 设置会话草稿失败
});

清除草稿

示例
// 清除草稿
let promise = chat.setConversationDraft({
conversationID: 'GROUPpublic1',
draftText: ''
});
promise.then(function(imResponse) {
// 清除 GROUPpublic1 会话草稿成功
}).catch(function(imError) {
console.warn('setConversationDraft error:', imError); // 清除草稿失败
});