Web&小程序&uni-app

最近更新时间:2024-10-09 10:53:01

我的收藏

功能描述

在删除好友或退出群组后,如果不需要查看好友或群会话的历史消息,可以选择删除会话。

删除会话

注意
1. 删除会话默认不会多端同步,如果需要多端同步,请在 即时通信 IM 控制台 > 应用配置 > 功能配置 > 登录与消息 > 多端同步设置开启删除会话后多端同步
2. 支持批量删除会话(每次最多支持删除100个会话),同时可选择是否清空会话历史消息。
3. 支持批量删除会话(每次最多支持删除100个会话)。
4. 成员退群、群主解散群、成员被移出群等场景下,若用户登录态未失效,则对应的群会话仍会保留在本地会话列表,此时用户可以查看已缓存的历史消息,但不能发送消息。
接口
chat.deleteConversation(conversationID);
参数
Name
Type
Description
options
String | Object
当类型为 String 时, 表示为: 会话 ID。会话 ID 组成方式:
C2C${userID}(单聊)
GROUP{groupID}(群聊)
@TIM#SYSTEM(系统通知会话)
当类型为 Object 时,包含以下属性:
conversationIDList,会话ID列表
clearHistoryMessage,默认值为 true,清空会话历史消息;设置为 false 则只删除会话,不删除历史消息
返回值
Promise
示例
// 删除单一会话, 并清空会话历史消息
let promise = chat.deleteConversation('C2CExample');
promise.then(function(imResponse) {
// 删除会话成功
const { conversationID } = imResponse.data; // 被删除的会话 ID
}).catch(function(imError) {
console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
});
// 删除单一会话, 不清空会话历史消息
let promise = chat.deleteConversation({conversationIDList: ['C2CExample'], clearHistoryMessage: false});
promise.then(function(imResponse) {
// 删除会话成功
const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
}).catch(function(imError) {
console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
});
// 删除多个会话, 并清空会话历史消息
let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample']});
promise.then(function(imResponse) {
// 删除会话成功
const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
}).catch(function(imError) {
console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
});
// 删除多个会话, 不清空会话历史消息
let promise = chat.deleteConversation({conversationIDList: ['C2CExample', 'GROUPExample'], clearHistoryMessage: false});
promise.then(function(imResponse) {
// 删除会话成功
const { conversationIDList } = imResponse.data; // 被删除的会话 ID 列表
}).catch(function(imError) {
console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
});