会话置顶

会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。

若使用会话置顶功能，你需要确保产品套餐包支持从服务端获取会话列表的功能。

前提条件

开始前，请确保满足以下条件：

• 完成 SDK 初始化，并连接到服务器，详见 初始化文档。
• 了解即时通讯 IM 的使用限制，详见 使用限制。
• 产品套餐包支持从服务端获取会话列表功能。

技术原理

即时通讯 IM 支持会话置顶，主要方法如下：

• ChatManager#pinConversation：置顶/取消置顶会话。
• ChatManager#fetchPinnedConversations：分页获取服务器保存的置顶会话列表。

实现方法

置顶/取消置顶会话

你可以调用 pinConversation 方法设置是否置顶会话。多设备登录情况下，更新的置顶状态会同步到其他登录设备，其他设备分别会收到 ChatMultiDevicesEvent.CONVERSATION_PINNED 和 ChatMultiDevicesEvent.CONVERSATION_UNPINNED 事件。

你最多可以置顶 50 个会话。

示例代码如下：

try {
  await ChatClient.getInstance.chatManager.pinConversation(
    conversationId: conversationId,
    isPinned: true,
  );
} on ChatError catch (e) {}

你可以通过 ChatConversation 对象的 isPinned 字段检查会话是否为置顶状态，或者调用 getPinnedTime 方法获取会话置顶时间。

获取服务端的置顶会话列表

你可以调用 fetchConversationsByOptions 方法从服务端分页获取置顶会话列表。SDK 按照会话置顶时间的倒序返回。

你最多可以拉取 50 个置顶会话。

示例代码如下：

ChatCursorResult<ChatConversation> result = await ChatClient.getInstance.chatManager.fetchConversationsByOptions(
      options: ConversationFetchOptions.pinned(),
    )