上云无忧 > 文档中心 > 环信IM即时通讯使用教程(Windows) - 从服务器获取会话和消息(消息漫游)
IM即时通讯
环信IM即时通讯使用教程(Windows) - 从服务器获取会话和消息(消息漫游)

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

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

提示

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

实现原理

使用环信即时通讯 IM SDK 可以通过 IChatManager 类的以下方法从服务器获取和删除历史消息:

  • GetConversationsFromServerWithPage 分页获取服务器保存的会话列表;
  • FetchHistoryMessagesFromServer 获取服务器保存的指定会话中的消息;
  • RemoveMessagesFromServer 单向删除服务端的历史消息;
  • DeleteConversationFromServer 删除服务端的会话及其历史消息。

前提条件

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

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

实现方法

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

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

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

提示

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

示例代码如下:

SDKClient.Instance.ChatManager.GetConversationsFromServerWithPage(pageNum, pageSize, new ValueCallBack
<List<Conversation>>( //获取会话成功后的处理逻辑。 //list 为 List<Conversation> 类型。 onSuccess: (list) =>
 { }, onError: (code, desc) => { } )); 
 

对于还不支持 GetConversationsFromServerWithPage 接口的用户,可以调用 GetConversationsFromServer 从服务端获取会话列表,SDK 默认可拉取 7 天内的 10 个会话(每个会话包含最新一条历史消息),如需调整会话数量或时间限制请联系商务。

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

你可以调用 FetchHistoryMessagesFromServer 方法从服务器分页获取指定会话的历史消息,实现消息漫游。

为确保数据可靠,我们建议你多次调用该方法,且每次获取的消息数小于 50 条。获取到数据后,SDK 会自动将消息更新到本地数据库。

SDKClient.Instance.ChatManager.FetchHistoryMessagesFromServer(conversationId, type, startId, pageSize, new
 ValueCallBack<CursorResult<Message>>( //获取历史消息成功。 //result 为 CursorResult<Message> 类型。
 onSuccess: (result) => { }, //获取历史消息失败。 onError:(code, desc) => { } )); 
 

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

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

提示

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

SDKClient.Instance.ChatManager.RemoveMessagesFromServer(convId, ctype, time, new CallBack( onSuccess: () =>
 { }, onError: (code, desc) => { } )); SDKClient.Instance.ChatManager.RemoveMessagesFromServer(convId, ctype,
 msgList, new CallBack( onSuccess: () => { }, onError: (code, desc) => { } )); 
 

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

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

SDKClient.Instance.ChatManager.DeleteConversationFromServer(conversationId, conversationType, isDeleteServerMessages,
 new CallBack( onSuccess: () => { }, onError: (code, desc) => { } ));

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