浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x商业版

设置会话备注

为当前用户的指定会话设置备注。

复制

设置会话备注属于商业版能力。remark 是当前用户维护的会话级备注,不会修改单聊对方的昵称、好友备注或群名称。

import { setConversation } from '@/uni_modules/unix-openim-sdk'

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

传入空字符串可清空备注。展示会话名称时,应根据产品规则在 remark 与会话原始 showName 之间选择,不能把会话备注回写到用户资料、好友关系或群资料中。

Promise 成功表示设置请求已完成。客户端可先将本地对应会话的 remark 字段更新为目标值,收到会话变更事件后,按 conversationID 确认最新状态;需要校准状态时可重新拉取该会话。完整会话事件监听见获取会话列表。