删除消息
功能简介
ZIM SDK 支持单聊消息、群组消息、房间消息等的收发,以及查询历史消息、删除消息等功能。可广泛应用于娱乐社交、电商购物、在线教育、互动直播等多种场景下。
本文档介绍了如何使用 ZIM SDK 的接口,实现删除某个会话中指定的消息,或者删除某个会话的全部消息的功能。
注意
ZIM SDK 目前支持删除“单聊/群组”会话消息,暂不支持删除“房间”会话消息。
实现流程
ZIM SDK 支持删除某个会话中指定的消息,或者删除某个会话的全部消息。删除消息分为“删除本地消息记录”和“删除服务端消息记录”,开发者可以通过 ZIMMessageDeleteConfig 对象,设置删除消息相关的高级属性配置。
以客户端 A 删除与客户端 B 的某些消息、或全部消息为例:
删除会话的指定消息
如果客户端 A 想要删除与客户端 B 的指定消息记录:
- 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
- 客户端 A 需要获取与 B 的会话记录时:
- 客户端 A 首先登录 ZIM SDK。
- 客户端 A 调用 deleteMessages 接口,传入参数 messageList、config,删除指定的消息。
- 删除操作的结果,将通过 ZIMMessageDeletedCallback 回调接口通知给客户端 A。
示例代码
示例代码
// 删除会话的指定消息
String conversationID = "xxxx";
ArrayList<ZIMMessage> deleteMessageList = new ArrayList();
ZIMMessageDeleteConfig config = new ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = false;
zim.deleteMessages(deleteMessageList, conversationID, ZIMConversationType.Peer, config, new ZIMMessageDeletedCallback() {
@Override
public void onMessageDeleted(ZIMError error) {
// 开发者可以通过该回调监听消息是否删除成功。
}
});
1
删除指定会话的全部消息
如果客户端 A 想要删除与客户端 B 的指定会话的全部消息记录:
- 客户端 A、B 登录 ZIM SDK,并相互发送、接收单聊消息。
- 客户端 A 需要获取与 B 的会话记录时:
- 客户端 A 首先登录 ZIM SDK。
- 客户端 A 调用 deleteAllMessage 接口,传入参数 conversationID、conversationType、config,配置删除指定会话的全部消息。
- 删除操作的结果,将通过 ZIMMessageDeletedCallback 回调接口通知给客户端 A。
示例代码
示例代码
// 删除指定会话的全部消息
String conversationID = "xxxx";
ZIMMessageDeleteConfig config = new ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = false;
zim.deleteAllMessage(conversationID, ZIMConversationType.Peer, config, new ZIMMessageDeletedCallback() {
@Override
public void onMessageDeleted(ZIMError error) {
// 开发者可以通过该回调监听消息是否删除成功。
}
});
1
删除所有消息
登录 ZIM SDK 后,调用 deleteAllConversationMessages 接口,传入参数 ZIMMessageDeleteConfig ,配置是否删除存放在服务端的消息,即可删除所有单聊和群聊会话的全部消息。
删除操作的结果,将通过 ZIMConversationMessagesAllDeletedCallback 回调接口返回。此外,客户端也将收到 onMessageDeleted 的通知。
清空所有会话的全部消息后:
Untitled
// 删除所有会话的全部消息
// 设置是否删除存放于服务端的消息
ZIMMessageDeleteConfig config = new ZIMMessageDeleteConfig();
config.isAlsoDeleteServerMessage = true;
zim.deleteAllConversationMessages(config, new ZIMConversationMessagesAllDeletedCallback() {
@Override
public void onConversationMessagesAllDeleted(ZIMError error) {
// 开发者可以通过该回调监听消息是否删除成功。
}
});
1