浏览 SDKs · Flutter
平台
SDKsFlutter商业版

置顶或取消置顶消息

使用 Flutter SDK 置顶或取消置顶一条消息。

复制

在会话中将指定消息置顶显示,或取消已有消息的置顶状态:

参数说明

参数类型是否必填说明
conversationIDString是消息所属会话 ID。
clientMsgIDString是待置顶或取消置顶消息的客户端消息 ID。
pinnedbool是置顶状态:true 表示置顶,false 表示取消置顶。
await OpenIM.iMManager.messageManager.setConversationPinnedMsg(
  conversationID: conversationID,
  clientMsgID: clientMsgID,
  pinned: true,
);

返回结果

Future 成功表示服务端已接受置顶或取消置顶请求。

Future 成功不代表所有端事件已经到达。会话置顶状态可先在本地更新,若需拉取当前会话的最新置顶消息全量快照,请参考查询会话置顶消息。

监听置顶消息变更

置顶消息变更事件 onChangedPinnedMsg 属于高级消息监听器 OnAdvancedMsgListener。当其他端或管理员修改了置顶状态时,会话内的客户端将收到该事件通知。客户端应按 conversationID 定位目标会话,并按 clientMsgID 去重合并置顶消息列表。全局 listener 的统一注册与管理请参考事件概览。