浏览 SDKs · uni-app / uni-app x
SDKsuni-app

更新好友资料

批量更新好友备注、置顶和扩展字段,并说明商业版单用户入口。

复制

updateFriends() 可批量更新好友关系上的备注、置顶或扩展字段。只传要修改的字段。

参数说明

参数类型是否必填说明
friendUserIDsstring[]要更新的好友用户 ID 列表;同一组更新值会应用到全部目标。
remarkstringnull新备注。
isPinnedbooleannull是否置顶好友。
exstringnull新扩展字符串,会完整覆盖旧值。
import { updateFriends } from '@/uni_modules/unix-openim-sdk'

await updateFriends({
  friendUserIDs: ['user_a', 'user_b'],
  remark: '项目成员',
  isPinned: true,
})

friendUserIDs 不能为空;除目标列表外,至少提供一个实际更新字段。不同好友需要不同值时应分别调用。ex 是完整字符串,不会自动合并 JSON 字段。

Promise 成功表示更新请求完成,不等同于好友事件已经到达。最终资料通过 onFriendInfoChangeduserID 合并,完整监听见分页获取好友列表;必要时重新查询校准。

商业版还提供 updateFriend()商业版 商业版,参数为单个 userID,字段名使用 pinned

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

await updateFriend({ userID: 'user_a', pinned: true, remark: '负责人' })

updateFriend()商业版 使用单个 userID,并把置顶字段命名为 pinned;其 remarkex 仍是完整覆盖值。不要同时对同一好友并发调用两个入口;选择一种并让好友 store 串行合并结果。