ZIM SDK 支持单聊消息、群组消息、房间消息等的收发,以及查询历史消息、删除消息等功能。可广泛应用于娱乐社交、电商购物、在线教育、互动直播等多种场景下。
本文档介绍了如何使用 ZIM SDK 的接口,实现删除某个会话中指定的消息,或者删除某个会话的全部消息的功能。
ZIM SDK 目前支持删除“单聊/群组”会话消息,暂不支持删除“房间”会话消息。
在实现“删除消息”功能之前,请确保:
ZIM SDK 支持删除某个会话中指定的消息,或者删除某个会话的全部消息。删除消息分为“删除本地消息记录”和“删除服务端消息记录”,开发者可以通过 ZIMMessageDeleteConfig 对象,设置删除消息相关的高级属性配置。
以客户端 A 删除与客户端 B 的某些消息、或全部消息为例:
如果客户端 A 想要删除与客户端 B 的指定消息记录:
//存放待删除消息的数组
std::vector<std::shared_ptr<ZIMMessage>> messageList;
zim::ZIMMessageDeleteConfig config;
//用于确定是否删除服务器消息
config.isAlsoDeleteServerMessage = true;
zim_->deleteMessages(messageList,"conversationID",zim::ZIMConversationTypePeer,config,callback);
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
messageList | ArrayList | 是 | 删除的指定消息列表。 |
conversationID | string | 是 | 删除消息的指定会话 ID。
|
conversationType | ZIMConversationType | 是 | 会话类型。
|
config | ZIMMessageDeleteConfig | 是 | 删除指定消息的高级属性设置。 |
callback | ZIMMessageDeletedCallback | 是 | 删除指定消息操作的结果回调。 |
参数 config
,需要通过 ZIMMessageDeleteConfig 类的以下参数进行配置:
参数 | 类型 | 说明 |
---|---|---|
isAlsoDeleteServerMessage |
Boolean |
是否删除服务端的消息。
|
// 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 的指定会话的全部消息记录:
// 删除指定会话的全部消息
ZIMMessageDeleteConfig config;
config.isAlsoDeleteServerMessage = true;
zim_->deleteAllMessage("converastionID",zim::ZIMConversationTypePeer,config,callback);
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
conversationID | string | 是 | 删除消息的指定会话 ID。
|
conversationType | ZIMConversationType | 是 | 会话类型。
|
config | ZIMMessageDeleteConfig | 是 | 删除指定会话的全部消息的高级属性设置。 |
callback | ZIMMessageDeletedCallback | 是 | 删除指定会话的全部消息操作的结果回调。 |
参数 config
,需要通过 ZIMMessageDeleteConfig 类的以下参数进行配置:
参数 | 类型 | 说明 |
---|---|---|
isAlsoDeleteServerMessage |
Boolean |
是否删除服务端的消息。
|
// 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] 的通知。
清空所有会话的全部消息后:
// 删除所有会话的全部消息
// 设置是否删除存放于服务端的消息
zim::ZIMMessageDeleteConfig config;
config.isAlsoDeleteServerMessage = true;
zim::ZIM::getInstance()->deleteAllConversationMessages(config, [=](const zim::ZIMError& errorInfo) {
// 删除消息的结果
if (errorInfo.code == zim::ZIM_ERROR_CODE_SUCCESS) {
// 删除后的业务逻辑
}
else {
// 请查看错误码文档寻找解决建议
}
});
联系我们
文档反馈