消息置顶

消息置顶指将会话中的消息固定在会话顶部，方便会话中的所有用户快速查看重要消息。

若要使用单聊、群组和聊天室的消息置顶功能，你需要将 IM SDK 升级至 1.4.0 版本并联系环信商务开通。

前提条件

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

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

技术原理

环信即时通讯 IM 支持消息置顶，主要方法和类如下：

• ChatManager#pinMessage：置顶消息。
• ChatManager#unpinMessage：取消置顶消息。
• ChatManager#fetchPinnedMessagesFromServer：从服务端获取单个会话的置顶消息列表。
• Conversation#getPinnedMessages：从本地获取单个会话的置顶消息列表。
• ChatMessagePinInfo：消息的置顶详情。

置顶消息

你可以调用 ChatManager#pinMessage 方法在会话中置顶消息。消息置顶状态变化后，会话中的其他成员会收到 ChatMessageListener#onMessagePinChanged 事件。多设备登录情况下，更新的置顶状态会同步到其他登录设备，其他设备分别会收到 ChatMessageListener#onMessagePinChanged 事件。

在会话中，支持多个用户置顶同一条消息，最新的消息置顶信息会覆盖较早的信息，即 ChatMessagePinInfo 的置顶消息的操作者的用户 ID 和置顶时间为最新置顶操作的相关信息。

若消息在本地存储，而在服务端因过期而删除，则消息置顶失败。

对于单个会话来说，默认可置顶 20 条消息。你可以联系环信商务提升该上限，最大可调整至 100。

ChatClient.getInstance().chatManager()?.pinMessage(messageId).then(() => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

取消置顶消息

你可以调用 ChatManager#unpinMessage 方法在会话中取消置顶消息。与置顶消息相同，取消置顶消息后，会话中的其他成员会收到 ChatMessageListener#onMessagePinChanged 事件。多设备登录情况下，更新的置顶状态会同步到其他登录设备，其他设备分别会收到 ChatMessageListener#onMessagePinChanged 事件。

单聊、群组或聊天室中的所有成员均可取消置顶消息，不论该消息由哪个成员置顶。取消置顶消息后，该会话的置顶消息列表中不再包含该消息。

ChatClient.getInstance().chatManager()?.unpinMessage(messageId).then(() => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

获取单个会话中的置顶消息

你可以调用 ChatManager#fetchPinnedMessagesFromServer 方法从服务端获取单个会话中的置顶消息。SDK 按照消息置顶时间的倒序返回。

提示

1. 若消息置顶后，消息在服务端过期或用户从服务端单向删除了该消息，当前用户拉漫游消息时拉不到该消息，但当前用户和其他用户均可以在置顶消息列表中拉取到该消息。
2. 若消息置顶后，用户撤回了该消息，则该消息从服务端移除，所有用户在从服务器拉取置顶消息列表时无法拉取到该消息。

ChatClient.getInstance().chatManager()?.fetchPinnedMessagesFromServer(conversationId).then((result: Array<ChatMessage>) => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

你可以调用 Conversation#getPinnedMessages 方法从本地取单个会话中的置顶消息。

// conversationId：会话 ID。
const conversation = ChatClient.getInstance().chatManager()?.getConversation(conversationId);
conversation?.getPinnedMessages().then((result: Array<ChatMessage>) => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
})

获取单条消息的置顶详情

你可以通过 ChatMessagePinInfo 类获取单条消息的置顶详情。

• 若消息为置顶状态，该类返回消息置顶的时间以及操作者的用户 ID。
• 若消息为非置顶状态，该类返回 undefined。

const pinnedInfo = message.getPinnedInfo()
if (pinnedInfo) {
  // 获取消息置顶信息
  const pinTime = pinnedInfo.pinTime();
  const operatorId = pinnedInfo.operatorId();
}else {
  // 消息没有被置顶，则没有置顶信息
}

监听消息置顶事件

ChatClient.getInstance().chatManager()?.addMessageListener({
  onMessageReceived:(messages: Array<ChatMessage>) => {
    // received logic
  },
  onMessagePinChanged: (messageId: string, conversationId: string, pinOperation: PinOperation, pinInfo: ChatMessagePinInfo) => {
    switch (pinOperation) {
      case PinOperation.PIN:
        // 消息置顶
        break;
      case PinOperation.UNPIN:
        // 消息取消置顶
        break;
    }
  }
});