tencent cloud

功能描述

用户在登录 App 后，可以像微信或 QQ 那样展示最近会话列表，方便找到目标会话。
会话列表功能主要分为获取会话列表、处理会话列表更新。
本文将为您介绍具体的实现细节。

获取会话列表

您可以调用 getConversationList(Details) 获取会话列表。该接口拉取的是本地缓存的会话，如果服务器会话有更新，SDK 内部会自动同步，然后在 V2TIMConversationListener 回调告知客户。

用户的会话以列表的形式返回，列表中存储的是 V2TIMConversation 对象。目前 IM SDK 对会话列表的排序规则为：

• 该接口获取的会话列表默认已经按照会话对象的 orderKey 做了排序。orderKey 值越大，代表该会话排序越靠前。orderKey 字段是整型数，当发送新消息、接收新消息、设置草稿或置顶会话时，会话被激活，orderKey 字段会增大。

您可以使用 getConversationList 实现一次性拉取或分页拉取。参见下文说明。

一次性拉取

一次性拉取适合会话数量比较少的情况（100 个以内）。此时可以将拉取的 count 设置为 INT_MAX（一般会话数量不会达到 INT_MAX 这么多）。

示例代码如下：

const nextSeq = "0";
const count = 100;
const convList = await TencentImSDKPlugin.v2TIMManager
.getConversationManager()
.getConversationList(count, nextSeq);

分页拉取

如果您的应用场景会产生较多的会话数，考虑到加载效率、网络省流，我们建议您采用分页拉取的方式。每次分页拉取的数量建议不超过 100 个。

分页拉取的步骤：

1. 首次调用 getConversationList 时，指定参数 nextSeq 为 0（表示从头开始拉取会话列表），指定 count 为 50（表示一次拉取 50 个会话对象）。

2. 首次拉取会话列表成功后，getConversationList 的回调结果 V2TIMConversationResult 中会包含 nextSeq（下次分页拉取的字段）、isFinish（会话拉取是否完成）。

   • 如果 isFinished 为 true，表示所有会话已经拉取完成。
   • 如果 isFinished 为 false，表示还有更多的会话可以拉取。此时并不意味着要立刻开始拉取 “下一页” 的会话列表。在常见的通信软件中，分页拉取通常由用户的滑动操作触发的，用户每上拉一次会话列表就触发一次分页拉取。

3. 当用户继续上拉会话列表时，如果还有更多的会话可以拉取，可以继续调用 getConversationList 接口，并传入新一轮的 nextSeq 和 count 参数（数值来自上一次拉取返回的 V2TIMConversationResult 对象）。

4. 重复执行【步骤 3】直至 isFinished 返回 true。

示例代码如下：

const nextSeq = "0";
const count = 100;
const convList = await TencentImSDKPlugin.v2TIMManager
.getConversationManager()
.getConversationList(count, nextSeq);
const seq = convList.data.nextSeq;
if (!convList.data.isFinished) {
// 如果未完全拉取
 const convList = await TencentImSDKPlugin.v2TIMManager
  .getConversationManager()
  .getConversationList(count, seq);
}

会话列表更新

IM SDK 会在登录成功后、用户上线后、以及断线重连后，自动更新会话列表。
为了获取会话列表的更新，您需要操作如下几步：

1. 添加会话监听器。
2. 接收会话变更通知并处理。
3. 移除会话监听器。非必须，可按照业务逻辑按需调用。

添加会话监听器

您可以调用 addConversationListener(Details) 添加会话监听器。添加监听器后，您才能接收到会话变更事件。

示例代码如下：

TencentImSDKPlugin.v2TIMManager
.getConversationManager()
.addConversationListener({
  onConversationChanged: (conversationList) => {},
  //其他                                                                                                                ));
});

会话新增变更通知

您可以在 V2TIMConversationListener(Details) 中的事件，获取会话列表变更的通知。

目前 IM SDK 支持的会话变更事件有：

示例代码如下：

// 监听会话
TencentImSDKPlugin.v2TIMManager
.getConversationManager()
.addConversationListener({
  onConversationChanged: (conversationList) => {},
  onNewConversation: (conv) => {},
  onSyncServerFailed: () => {},
  onSyncServerFinish: () => {},
  onSyncServerStart: () => {},
  onTotalUnreadMessageCountChanged: (count) => {},
});

移除会话监听器

您可以调用 removeConversationListener(Details) 移除会话监听器。移除后，您将无法再接收到会话变更事件。
该步骤不是必须的，您可以按照自己的业务逻辑按需调用。

示例代码如下：

conversationManager.removeConversationListener(conversationListener);

发送不更新 lastMessage 的消息

会话列表界面，通常需要展示每个会话的最新一条消息预览及发送时间，此时您可以使用 V2TIMConversation 的 lastMessage 作为数据源实现。但是某些场景下，如果您不希望一些消息（例如系统提示等）显示为会话的最新消息，可以在 sendMessage 时设置 isExcludedFromLastMessage 为 false/no。

发送消息参见 发送消息。