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

更新好友资料

批量更新好友备注、置顶状态或扩展字段。

复制

更新好友资料接口会把同一组修改应用到 friendUserIDs 中的所有好友。不同好友需要设置不同内容时,应分别调用。

参数说明

参数类型是否必填说明
friendUserIDsstring[]是要更新的好友用户 ID 列表。
remarkstring否新的好友备注。
isPinnedboolean否是否在联系人列表中置顶好友。
exstring否新的好友关系扩展字符串,会完整覆盖旧值。

除 friendUserIDs 外,至少传入一个确实需要修改的字段。

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

await updateFriends({
  friendUserIDs: [friendUserID],
  remark: remark.trim(),
  isPinned: true,
})

Promise 成功表示本次更新请求已成功返回,不表示好友资料变化事件已经到达各端。收到好友信息变更事件后,客户端按事件数据中的 userID 更新对应好友;需要校准状态时重新查询好友资料。完整事件监听与处理逻辑请参考分页获取好友列表。ex 是完整字符串,SDK 不会自动合并其中的 JSON 字段。