浏览 SDKs · React Native
平台
SDKsReact Native

置顶或取消置顶会话

置顶或取消置顶会话。

复制

设置指定会话的置顶状态。置顶设置属于当前登录账号,开启后该会话将在会话列表中靠前展示。

await OpenIMSDK.pinConversation({
  conversationID,
  isPinned: true,
});

参数说明

参数类型必填含义
conversationIDstring是要设置的会话 ID。
isPinnedboolean是true 置顶会话,false 取消置顶。

返回结果

调用完成后,会话的置顶状态已更新。

更新成功后会触发 OnConversationChanged 事件;客户端应使用 conversationID 定位目标会话,并合并最新的 isPinned 状态,以便即时调整列表展示顺序。完整监听方式见获取会话列表。