logo
当前页

删除消息


功能简介

ZIM SDK 支持单聊消息、群组消息、房间消息等的收发,以及查询历史消息、删除消息等功能。可广泛应用于娱乐社交、电商购物、在线教育、互动直播等多种场景下。

本文档介绍了如何使用 ZIM SDK 的接口,实现删除某个会话中指定的消息,或者删除某个会话的全部消息的功能。

注意

ZIM SDK 目前支持删除“单聊/群组”会话消息,暂不支持删除“房间”会话消息。

实现流程

ZIM SDK 支持删除某个会话中指定的消息,或者删除某个会话的全部消息。删除消息分为“删除本地消息记录”和“删除服务端消息记录”,开发者可以通过 ZIMMessageDeleteConfig 对象,设置删除消息相关的高级属性配置。

以客户端 A 删除与客户端 B 的某些消息、或全部消息为例:

删除会话的指定消息

如果客户端 A 想要删除与客户端 B 的指定消息记录:

  1. 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
  2. 客户端 A 需要获取与 B 的会话记录时:
    1. 客户端 A 首先登录 ZIM SDK。
    2. 客户端 A 调用 deleteMessages 接口,传入参数 messageList、config,删除指定的消息。
    3. 删除操作的结果,将通过 ZIMMessageDeletedResult 回调接口通知给客户端 A。

示例代码

示例代码
// 1、创建 ZIM 对象,传入 AppID
ZIMAppConfig appConfig = ZIMAppConfig();
appConfig.appID = appID;
appConfig.appSign = appSign;
ZIM.create(appConfig);

// 2、登录
try{
    ZIMLoginConfig loginConfig = ZIMLoginConfig();
    //该用户的用户昵称,不填写代表不修改用户昵称
    loginConfig.userName = 'userName';
    //若使用 token 作为登录鉴权的方式,请填写该参数,否则无需填写
    loginConfig.token = '';
    // 本次登录是否为离线登录,详情请参考离线登录相关文档
    loginConfig.isOfflineLogin = false;
    await ZIM.getInstance()?.login('zego', loginConfig);
    // 登录成功,编写登录成功的业务逻辑
} on PlatformException catch(onError){
    // 登录失败
    //登录失败的错误码,请参考接入文档的错误码表来处理
    onError.code;
    //登录失败的错误信息
    onError.message;
}


// 3、删除会话的指定消息
String conversationID = 'xxxx';
List<ZIMMessage> messageList = [];
ZIMMessageDeleteConfig config = ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = false;
await ZIM
    .getInstance()
    !.deleteMessages(
        messageList, conversationID, ZIMConversationType.peer, config)
    .then((value) => {})
    .catchError((onError) {});
1
Copied!

删除指定会话的全部消息

如果客户端 A 想要删除与客户端 B 的指定会话的全部消息记录:

  1. 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
  2. 客户端 A 需要获取与 B 的会话记录时:
    1. 客户端 A 首先登录 ZIM SDK。
    2. 客户端 A 调用 deleteAllMessage 接口,传入参数 conversationID、conversationType、config,配置删除指定会话的全部消息。
    3. 删除操作的结果,将通过 ZIMMessageDeletedResult 回调接口通知给客户端 A。

示例代码

示例代码
// 1、创建 ZIM 对象,传入 AppID
ZIMAppConfig appConfig = ZIMAppConfig();
appConfig.appID = appID;
appConfig.appSign = appSign;
ZIM.create(appConfig).catchError((onError) {});

// 2、登录
try{
    ZIMLoginConfig loginConfig = ZIMLoginConfig();
    //该用户的用户昵称,不填写代表不修改用户昵称
    loginConfig.userName = 'userName';
    //若使用 token 作为登录鉴权的方式,请填写该参数,否则无需填写
    loginConfig.token = '';
    // 本次登录是否为离线登录,详情请参考离线登录相关文档
    loginConfig.isOfflineLogin = true;
    await ZIM.getInstance()?.login('zego', loginConfig);
    // 登录成功,编写登录成功的业务逻辑
  } on PlatformException catch(onError){
    // 登录失败
    //登录失败的错误码,请参考接入文档的错误码表来处理
    onError.code;
    //登录失败的错误信息
    onError.message;
  }


// 3、删除指定会话的全部消息
String conversationID = "xxxx";

ZIMMessageDeleteConfig config = ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = false;

await ZIM
    .getInstance()
    !.deleteAllMessage(conversationID, ZIMConversationType.peer, config)
    .then((value) => {})
    .catchError((onError) {});
1
Copied!

删除所有消息

登录 ZIM SDK 后,调用 deleteAllConversationMessages 接口,传入参数 ZIMMessageDeleteConfig ,配置是否删除存放在服务端的消息,即可删除所有单聊和群聊会话的全部消息。

清空所有会话的全部消息后:

  • 如果您希望保留原有会话列表,仅更新会话列中展示的 lastMessage 为空,请重新 拉取会话列表
  • 如果您希望清空原有会话列表,请 删除全部会话
Untitled
// 删除所有会话的全部消息

// 设置是否删除存放于服务端的消息
ZIMMessageDeleteConfig config = ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = false;

await ZIM
    .getInstance()
    !.deleteAllConversationMessages(config)
    .then((value) => {})
    .catchError((onError) {});
1
Copied!

Previous

获取历史消息

Next

插入本地消息