浏览 SDKs · WASM
SDKsWASM商业版

置顶或取消置顶消息

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

复制

参数说明

参数类型是否必填说明
conversationIDstring消息所在的会话 ID。
clientMsgIDstring要置顶或取消置顶的消息 ID。
pinnedbooleantrue 表示置顶,false 表示取消置顶。
await openimsdk.setConversationPinnedMsg({
  conversationID,
  clientMsgID: message.clientMsgID,
  pinned: true,
});

权限、消息类型和数量限制由 OpenIMServer 校验。Promise 成功表示置顶请求已完成,不表示变更事件已经到达。

本页唯一归属 CbEvents.OnChangedPinnedMsg。处理函数按 conversationID 替换置顶集合,并按 item.msg.clientMsgID 去重;注册时使用稳定引用并在账号作用域结束时用同一引用调用 off()

const handlePinnedChanged = ({ data }) =>
  replacePinnedMessageDetails(data.conversationID, data.msgs);
openimsdk.on(CbEvents.OnChangedPinnedMsg, handlePinnedChanged);
const removePinnedListener = () =>
  openimsdk.off(CbEvents.OnChangedPinnedMsg, handlePinnedChanged);