删除指定会话
删除指定会话
API 参考:removeConversation
参数说明
参数 | 类型 | 必填 | 说明 | 最低版本 |
---|---|---|---|---|
conversationType | Number | 是 | 会话类型,群组会话传入 GROUP | 2.2.0 |
targetId | String | 是 | 群组 ID | 2.2.0 |
callback | Object | 是 | 回调对象 | 2.2.0 |
callback.onSuccess | Function | 是 | 成功回调 | 2.2.0 |
callback.onError | Function | 是 | 失败回调 | 2.2.0 |
代码示例
var conversationType = GROUP;
var targetId = '群组 ID';
var callback = {
onSuccess: function() {
console.log('删除指定会话成功');
},
onError: function(error) {
console.log('删除指定会话失败', error);
}
};
RongIMClient.getInstance().removeConversation(conversationType, targetId, callback);
按会话类型删除
提示
conversationTypes 为 Array 类型。可以按类型进行删除,可传递多个,不填则清除所有会话。
API 参考:clearConversations
参数说明
参数 | 类型 | 必填 | 说明 | 最低版本 |
---|---|---|---|---|
callback | Object | 是 | 回调对象 | 2.3.2 |
callback.onSuccess | Function | 是 | 成功回调 | 2.2.0 |
callback.onError | Function | 是 | 失败回调 | 2.2.0 |
conversationTypes | Array | 否 | 清除的会话类型, 不填则清除所有会话 | 2.3.2 |
conversationTypes
枚举值说明
会话类型 | 说明 | 枚举值 |
---|---|---|
RongIMLib.ConversationType.PRIVATE | 单聊 | 1 |
RongIMLib.ConversationType.GROUP | 群聊 | 3 |
RongIMLib.ConversationType.CHATROOM | 聊天室 | 4 |
RongIMLib.ConversationType.SYSTEM | 系统 | 6 |
代码示例
var conversationTypes = [RongIMLib.ConversationType.PRIVATE, RongIMLib.ConversationType.GROUP];
RongIMClient.getInstance().clearConversations({
onSuccess: function(bool) {
console.log('清除会话成功',bool);
},
onError: function(error) {
console.log('清除会话失败', error);
}
}, conversationTypes);