SDKsReact Native

分页获取好友列表

OpenIM React Native SDK 分页获取好友列表。

分页获取当前用户的好友列表。

const friends = await OpenIMSDK.getFriendListPage({
  offset: 0,
  count: 50,
  filterBlack: true,
});

参数说明

参数	类型	必填	含义
`offset`	`number`	是	分页偏移量，从 `0` 开始。
`count`	`number`	是	本次获取的好友数量。
`filterBlack`	`boolean`	否	是否过滤已加入黑名单的用户；默认为 `false`。

返回结果

调用完成后返回当前页的 FriendUserItem[] 好友列表。

好友信息字段

FriendUserItem 常用字段如下：

字段	类型	含义
`userID`	`string`	好友用户 ID，客户端合并与更新好友记录的唯一标识。
`nickname`	`string`	好友昵称。
`faceURL`	`string`	好友头像地址。
`remark`	`string`	当前用户为好友设置的备注名。
`isPinned`	`boolean`	是否置顶该好友。
`ownerUserID`	`string`	好友关系所属用户 ID。
`operatorUserID`	`string`	最近执行关系操作的用户 ID。
`addSource`	`number`	好友关系添加来源。
`createTime`	`number`	好友关系创建时间。
`ex`	`string`	好友关系扩展字段。
`attachedInfo`	`string`	SDK 附加信息。

remark、isPinned 和 ex 属于好友关系，不是账号级用户信息。

监听好友变化

好友关系变化时，触发 OnFriendAdded、OnFriendInfoChanged 或 OnFriendDeleted 事件。事件直接携带对应的好友信息：

const handleFriendAdd = (friend: FriendUserItem) => {
  // 新增好友
};
const handleFriendChanged = (friend: FriendUserItem) => {
  // 按 friend.userID 更新好友列表
};
const handleFriendDeleted = (friend: FriendUserItem) => {
  // 按 friend.userID 从好友列表移除
};

// 设置监听
OpenIMSDK.on(OpenIMEvent.OnFriendAdded, handleFriendAdd);
OpenIMSDK.on(OpenIMEvent.OnFriendInfoChanged, handleFriendChanged);
OpenIMSDK.on(OpenIMEvent.OnFriendDeleted, handleFriendDeleted);

// 取消监听
OpenIMSDK.off(OpenIMEvent.OnFriendAdded, handleFriendAdd);
OpenIMSDK.off(OpenIMEvent.OnFriendInfoChanged, handleFriendChanged);
OpenIMSDK.off(OpenIMEvent.OnFriendDeleted, handleFriendDeleted);

退出登录、切换账号或销毁好友列表状态时，取消这些监听。

这个页面有帮助吗？