浏览 SDKs · React Native
平台
SDKsReact Native商业版

设置会话备注

设置会话备注。

复制

设置当前登录账号对指定会话的自定义备注名称。

await OpenIMSDK.setConversation({
  conversationID,
  remark: '项目讨论',
});

参数说明

参数类型必填含义
conversationIDstring是要设置的会话 ID。
remarkstring否会话备注。传入空字符串可清除已有备注。

渲染会话名称时,建议优先使用 remark,若没有设置备注则回退使用原有的 showName。会话备注仅保存在会话维度,不会改变好友或群组本身的真实名称。

返回结果

调用完成后,会话备注已更新。

更新成功后会触发 OnConversationChanged 事件;客户端应使用 conversationID 定位目标会话,并合并最新的 remark 属性。完整监听方式见获取会话列表。