删除消息

大约 2 分钟

删除消息

本文介绍用户如何单向删除服务端以及本地的历史消息。

技术原理

使用环信即时通讯 IM Android SDK 可以通过 EMConversationEMChatManager 类从服务器单向删除历史消息,主要方法如下:

  • EMChatManager#asyncDeleteAllMsgsAndConversations:清空当前用户的聊天记录,包括消息和会话,同时可以选择是否单向清除服务端的聊天记录。
  • EMConversation#removeMessagesFromServer:按消息时间或消息 ID 单向删除服务端的历史消息。
  • EMChatManager#clearAllMessages:删除本地指定会话的所有消息。
  • EMChatManager#removeMessages(startTime, endTime):删除指定时间段的本地消息。
  • EMChatManager#removeMessage(targetMessageId):删除本地单个会话的指定消息。

前提条件

开始前,请确保满足以下条件:

  • 完成 SDK 初始化并连接到服务器,详见 快速开始
  • 了解环信即时通讯 IM API 的使用限制,详见 使用限制

清空聊天记录

你可以调用 EMChatManager#asyncDeleteAllMsgsAndConversations 方法清空当前用户的聊天记录,包括消息和会话。同时你也可以选择是否清除服务端的聊天记录。若你清除了服务端的聊天记录,当前用户无法从服务端拉取到该消息。其他用户不受该操作影响。

提示

若使用该功能,需将 SDK 升级至 V4.4.0 或以上版本。

 EMClient.getInstance().chatManager().asyncDeleteAllMsgsAndConversations(true, new EMCallBack() {
    @Override
    public void onSuccess() {
        
    }

    @Override
    public void onError(int code, String error) {
        
    }
    });

单向删除服务端的历史消息

你可以调用 removeMessagesFromServer 方法单向删除服务端的历史消息,每次最多可删除 50 条消息。删除后,消息自动从设备本地移除且该用户无法从服务端拉取到该消息。其他用户不受该操作影响。

登录该账号的其他设备会收到 EMMultiDeviceListener 中的 onMessageRemoved 回调,已删除的消息自动从设备本地移除。

提示

若使用该功能,需将 SDK 升级至 V3.9.8 或以上版本并联系商务开通。

示例代码如下:

// 按时间删除消息
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(username);
conversation.removeMessagesFromServer(time, new EMCallBack() {
                    @Override
                    public void onSuccess() {
                       
                    }

                    @Override
                    public void onError(int code, String desc) {
                       
                    }
                });

// 按消息 ID 删除消息
 conversation.removeMessagesFromServer(msgIdList, new EMCallBack() {
                    @Override
                    public void onSuccess() {
                       
                    }

                    @Override
                    public void onError(int code, String desc) {
                       
                    }
                });  

删除本地指定会话的所有消息

你可以删除本地指定会话的所有消息,示例代码如下:

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
if(conversation != null) {
    conversation.clearAllMessages();
}

删除指定时间段的本地消息

你可以删除本地指定会话在一段时间内的本地消息,示例代码如下:

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
if(conversation != null) {
    conversation.removeMessages(startTime, endTime);
}

删除本地单个会话的指定消息

你可以删除本地单个会话的指定消息,示例代码如下:

EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
if(conversation != null) {
    conversation.removeMessage(messageId);
}