删除消息

---

功能简介

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

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

前提条件

在实现“删除消息”功能之前，请确保：

• 已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
• 已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 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. 删除操作的结果，将通过 ZIMMessageDeletedCallback 回调接口通知给客户端 A。

调用接口示例

//存放待删除消息的数组
std::vector<std::shared_ptr<ZIMMessage>> messageList;
zim::ZIMMessageDeleteConfig config;
//用于确定是否删除服务器消息
config.isAlsoDeleteServerMessage = true;

zim_->deleteMessages(messageList,"conversationID",zim::ZIMConversationTypePeer,config,callback);

参数说明

参数 config，需要通过 ZIMMessageDeleteConfig 类的以下参数进行配置：

示例代码

// 1、创建 ZIM 对象，传入 appID、appSign，目前仅建议一个客户端创建一个zim实例
zim::ZIMAppConfig app_config;
app_config.appID = 12345;     //替换为您申请到的 AppID
app_config.appSign = "appSign";   //替换为您申请到的 AppSign
zim_ = zim::ZIM::create(app_config);

// 2、设置 setEventHandler 回调
im_event_handler_ = std::make_shared<CZIMEventHandler>();
zim_->setEventHandler(im_event_handler_);

// 3、登录
zim::ZIMUserInfo user_info;
user_info.userID = user_id;
user_info.userName = user_name;

zim_->login(user_info, [=](zim::ZIMError errorInfo){
    // 这里可以获取登录结果返回值，并根据错误码执行用户代码
});

// 4、删除会话的指定消息
std::vector<std::shared_ptr<ZIMMessage>> messageList;
zim::ZIMMessageDeleteConfig config;
//用于确定是否删除服务器消息
config.isAlsoDeleteServerMessage = true;
zim_->deleteMessages(messageList,"conversationID",zim::ZIMConversationTypePeer,config,callback);

删除指定会话的全部消息

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

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

调用接口示例

// 删除指定会话的全部消息
ZIMMessageDeleteConfig config;
config.isAlsoDeleteServerMessage = true;

zim_->deleteAllMessage("converastionID",zim::ZIMConversationTypePeer,config,callback);

参数说明

参数 config，需要通过 ZIMMessageDeleteConfig 类的以下参数进行配置：

示例代码

// 1、创建 ZIM 对象，传入 appID、appSign，目前仅建议一个客户端创建一个zim实例
zim::ZIMAppConfig app_config;
app_config.appID = 12345;     //替换为您申请到的 AppID
app_config.appSign = "appSign";   //替换为您申请到的 AppSign
zim_ = zim::ZIM::create(app_config);

// 2、设置 setEventHandler 回调
im_event_handler_ = std::make_shared<CZIMEventHandler>();
zim_->setEventHandler(im_event_handler_);

// 3、登录
zim::ZIMUserInfo user_info;
user_info.userID = user_id;
user_info.userName = user_name;

zim_->login(user_info, [=](zim::ZIMError errorInfo){
    // 这里可以获取登录结果返回值，并根据错误码执行用户代码
});

// 用于确定是否删除服务器消息
ZIMMessageDeleteConfig config;
config.isAlsoDeleteServerMessage = true;

zim_->deleteAllMessage("converastionID",zim::ZIMConversationTypePeer,config,callback);

删除所有消息

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

删除操作的结果，将通过 ZIMConversationMessagesAllDeletedCallback 回调接口返回。此外，客户端也将收到 [onMessageDeleted] 的通知。

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

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

// 删除所有会话的全部消息

// 设置是否删除存放于服务端的消息
zim::ZIMMessageDeleteConfig config;
config.isAlsoDeleteServerMessage = true;

zim::ZIM::getInstance()->deleteAllConversationMessages(config, [=](const zim::ZIMError& errorInfo) {
    // 删除消息的结果
    if (errorInfo.code == zim::ZIM_ERROR_CODE_SUCCESS) {
        // 删除后的业务逻辑
    }
    else {
        // 请查看错误码文档寻找解决建议
    }
    });