消息置顶
消息置顶
消息置顶指将会话中的消息固定在会话顶部，方便会话中的所有用户快速查看重要消息。
单聊、群组聊天和聊天室均支持该功能。若要使用该功能，需联系声网商务开通。
前提条件
开始前，请确保满足以下条件：
技术原理
即时通讯 IM 支持消息置顶，主要方法如下：
AgoraChatManager#pinMessage：置顶消息。AgoraChatManager#unpinMessage：取消置顶消息。AgoraChatManager#getPinnedMessagesFromServer：从服务端获取单个会话的置顶消息列表。
置顶消息
你可以调用 AgoraChatManager#pinMessage 方法置顶消息。消息置顶状态变化后，会话中的其他用户会收到 AgoraChatManagerDelegate#onMessagePinChanged 事件。多设备登录情况下，更新的置顶状态会同步到其他登录设备，其他设备分别会收到 AgoraChatManagerDelegate#onMessagePinChanged 事件。
在会话中，支持多个用户置顶同一条消息，最新的消息置顶信息会覆盖较早的信息，即 AgoraChatMessagePinInfo 的置顶消息的操作者的用户 ID 和置顶时间为最新置顶操作的相关信息。
若消息在本地存储，而在服务端因过期而删除，则消息置顶失败。
对于单个会话来说，默认可置顶 20 条消息。你可以联系声网商务提升该上限，最大可调整至 100。
[AgoraChatClient.sharedClient.chatManager pinMessage:@"messageId" completion:^(AgoraChatMessage * _Nullable message, AgoraChatError * _Nullable aError) {
}];
取消置顶消息
你可以调用 AgoraChatManager#unpinMessage 方法取消置顶消息。与置顶消息相同，取消置顶消息后，会话中的其他用户会收到 AgoraChatManagerDelegate#onMessagePinChanged 事件。多设备登录情况下，更新的置顶状态会同步到其他登录设备，其他设备分别会收到 AgoraChatManagerDelegate#onMessagePinChanged 事件。
单聊、群组或聊天室中的所有用户均可取消置顶消息，不论该消息是由哪个用户进行置顶的。取消置顶消息后，AgoraChatMessagePinInfo 中的信息为空，该会话的置顶消息列表中也不再包含该消息。
[AgoraChatClient.sharedClient.chatManager unpinMessage:@"messageId" completion:^(AgoraChatMessage * _Nullable message, AgoraChatError * _Nullable aError) {
}];
获取单个会话中的置顶消息
你可以调用 AgoraChatManager#getPinnedMessagesFromServer 方法从服务端获取单个会话的置顶消息列表。SDK 按照消息置顶时间的倒序返回。
提示
- 若消息置顶后，消息在服务端过期或用户从服务端单向删除了该消息，当前用户拉漫游消息时拉不到该消息，但当前用户和其他用户均可以在置顶消息列表中拉取到该消息。
- 若消息置顶后，用户撤回了该消息，则该消息从服务端移除，所有用户在从服务器拉取置顶消息列表时无法拉取到该消息。
[AgoraChatClient.sharedClient.chatManager getPinnedMessagesFromServer:@"conversationId" completion:^(NSArray<AgoraChatMessage *> * _Nullable messages, AgoraChatError * _Nullable aError) {
}];