上云无忧 > 文档中心 > 环信IM即时通讯使用教程(Android) - 管理服务端的会话和消息
IM即时通讯
环信IM即时通讯使用教程(Android) - 管理服务端的会话和消息

文档简介:
环信即时通讯 IM 提供消息漫游功能,即将用户的所有会话的历史消息保存在消息服务器,用户在任何一个终端设备上都能获取到历史信息,使用户在多个设备切换使用的情况下也能保持一致的会话场景。本文介绍用户如何获取和删除服务端的会话和消息。
*此产品及展示信息均由环信官方提供。免费试用 咨询热线:400-826-7010,为您提供专业的售前咨询,让您快速了解云产品,助您轻松上云! 微信咨询
  免费试用、价格特惠

环信即时通讯 IM 提供消息漫游功能,即将用户的所有会话的历史消息保存在消息服务器,用户在任何一个终端设备上都能获取到历史信息,使用户在多个设备切换使用的情况下也能保持一致的会话场景。本文介绍用户如何获取和删除服务端的会话和消息。

提示

本文介绍的功能均为增值服务,需在环信即时通讯 IM 管理后台 (opens new window)开通。

技术原理

使用环信即时通讯 IM SDK 可以从服务器获取历史消息。

  • asyncFetchConversationsFromServer 分页获取服务器保存的会话列表;
  • fetchHistoryMessages 获取服务器保存的指定会话中的消息;
  • removeMessagesFromServer 单向删除服务端的历史消息;
  • deleteConversationFromServer 删除服务端的会话及其历史消息。

前提条件

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

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

实现方法

从服务器分页获取会话列表

对于单聊或群聊,用户发消息时会自动将对方添加到用户的会话列表。

你可以调用 asyncFetchConversationsFromServer 方法从服务端分页获取会话列表,每个会话包含最新一条历史消息。

提示

  1. 若使用该功能,需将 SDK 升级至 4.0.0。
  2. 建议在 app 安装时或本地没有会话时调用该方法,否则调用 getAllConversations 方法即可。
  3. 获取的会话列表中不包含最新一条消息通过 RESTful 接口发送的会话。若需获取该类会话,需要联系商务开通将通过 RESTful 接口发送的消息写入会话列表的功能。

示例代码如下:

// 异步方法。同步方法为 fetchConversationsFromServer()。 // pageNum:当前页面,从 1 开始。
 // pageSize:每页获取的会话数量。取值范围为 [1,20]。 EMClient.getInstance().chatManager().
asyncFetchConversationsFromServer(pageNum, pageSize, new EMValueCallBack<Map<String, EMConversation>>()
 { @Override public void onSuccess(Map<String, EMConversation> value) { } @Override public void onError
(int error, String errorMsg) { } }); 
 

对于使用 asyncFetchConversationsFromServer 方法未实现分页获取会话列表的用户,SDK 默认可拉取 7 天内的 10 个会话(每个会话包含最新一条历史消息),如需调整会话数量或时间限制请联系商务。

分页获取指定会话的历史消息

对于单聊或群聊,用户发消息时,会自动将对方添加到用户的会话列表。

你可以调用 asyncFetchHistoryMessage 方法从服务器获取指定会话的消息(消息漫游)。你可以指定消息查询方向,即明确按时间顺序或逆序获取。为确保数据可靠,我们建议你每次最多获取 50 条消息,可多次获取。拉取后,SDK 会自动将消息更新到本地数据库。

// 异步方法。同步方法为 fetchHistoryMessages(String, EMConversationType, int, String, EMConversation.EMSearchDirection)。
 EMClient.getInstance().chatManager().asyncFetchHistoryMessage( conversationId, conversationType, 
pageSize, startMsgId, searchDirection, new EMValueCallBack<EMCursorResult<EMMessage>>() { @Override
 public void onSuccess(EMCursorResult<EMMessage> value) { } @Override public void onError
(int error, String errorMsg) { } } ); 
 

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

你可以调用 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) { } }); 
 

删除服务端会话及其历史消息

你可以调用 deleteConversationFromServer 方法删除服务器端会话和历史消息。会话删除后,当前用户和其他用户均无法从服务器获取该会话。若该会话的历史消息也删除,所有用户均无法从服务器获取该会话的消息。

调用该方法之前,需调用 getConversation 方法获取会话 ID。

示例代码如下:

//获取指定的会话 ID。 EMConversation conversation = EMClient.getInstance().chatManager().getConversation(username);
 // 删除指定会话。如果需要保留历史消息,`isDeleteServerMessages` 传 `false`。 EMClient.getInstance().chatManager()
.deleteConversationFromServer(conversationId, conversationType, isDeleteServerMessages, new EMCallBack()
 { @Override public void onSuccess() { } @Override public void onError(int code, String error) { } });

相似文档
  • 单聊会话支持消息送达回执、会话已读回执和消息已读回执,发送方发送消息后可及时了解接收方是否及时收到并阅读了信息,也可以了解整个会话是否已读。
  • 为方便用户在聊天过程中对文字消息进行翻译,环信即时通讯 IM SDK 集成了 Microsoft Azure Translation API,支持在发送或接收消息时对文本消息进行按需翻译或自动翻译:
  • 用户属性指实时消息互动用户的信息,如用户昵称、头像、邮箱、电话、性别、签名、生日等。 例如,在招聘场景下,利用用户属性功能可以存储性别、邮箱、用户类型(面试者)、职位类型(web 研发)等。查看用户信息时,可以直接查询服务器存储的用户属性信息。
  • 用户登录后,可进行添加联系人、获取好友列表等操作。 SDK 提供用户关系管理功能,包括好友列表管理和黑名单管理: 好友列表管理:查询好友列表、申请添加好友、同意好友申请、拒绝好友申请和删除好友等操作。 黑名单管理:查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。
  • 功能描述: 群组是支持多人沟通的即时通讯系统,成员关系相对稳定。所有群成员可以收到群中的消息,可以在群中发送消息。群成员离线时可以收到推送消息。群组成员支持多种角色:群主、群管理员和普通成员。群组提供丰富的管理能力,如群组禁言、群公告和群文件等。
官方微信
联系客服
400-826-7010
7x24小时客服热线
分享
  • QQ好友
  • QQ空间
  • 微信
  • 微博
返回顶部