删除会话
功能简介
ZIM 支持用户删除会话列表中的某个会话和全部会话。
删除单个会话
用户登录后,可以删除自己的会话列表中的某个会话。开发者通过调用 deleteConversation 接口,传入 conversationID 指定会话,删除某个会话。
随后,开发者可通过 ZIMConversationDeletedResult 获取删除操作结果。
说明
- 删除某个会话时:
- 会话内的所有消息并不会自动删除。开发者如果需要同时删除会话和会话内的所有消息,请先调用 deleteAllMessage 接口(详情请参考 删除消息)删除所有消息,再调用 deleteConversation 接口删除该会话。
- 如果这个会话存在未读消息,将会通过 conversationTotalUnreadMessageCountUpdated 回调接口,减少消息未读总数,详情请参考 4 获取消息未读总数。
- 当用户多端登录时,仅发起删除操作的那一端会收到 ZIMConversationDeletedResult,如需了解该用户其他在线客户端如何获取删除事件,请参考 多端登录 - 删除单个服务端会话。
示例代码
// 删除某个会话,以下为 删除单聊会话
var conversationID = '';
var conversationType = 0;
var config = { isAlsoDeleteServerConversation: true };
zim.deleteConversation(conversationID, conversationType, config)
.then(function(res){
// 操作成功
})
.catch(function(err){
// 操作失败
})
1
删除全部会话
用户登录后,可以删除会话列表中的所有会话。开发者通过调用 deleteAllConversations 接口删除全部会话。
说明
当用户多端登录时,发起删除的客户端只需关注操作是否成功(或捕获异常)。其他在线客户端如需同步删除事件,请参考 多端登录 - 删除全部服务端会话。
示例代码
// 删除全部会话
var config = { isAlsoDeleteServerConversation: true };
zim.deleteAllConversations(config)
.then(function(){
// 操作成功
})
.catch(function(err){
// 操作失败
})
1