外观
获取好友列表
约 294 字小于 1 分钟
2025-03-25
1. 描述
getFriendList()
获取好友列表,该方法为异步函数
,调用后会返回一个 Promise
对象,可以通过该对象获取好友列表。
2. 参数
参数名称 | 是否必选 | 类型 | 说明 |
---|---|---|---|
keywords | 否 | String | 关键词,用于搜索指定好友 |
page | 否 | Number | 页码,用于分页获取好友列表,默认为 1 |
pageSize | 否 | Number | 每页数量,用于分页获取好友列表,默认为20 |
3. 返回值
返回一个 Promise
对象,该对象会在 resolve
时返回好友列表数组,在 reject
时返回错误信息。
字段 | 类型 | 说明 |
---|---|---|
list | Array | 好友列表数组,格式见下 |
isComplete | Number | 是否加载完,0-否,1-是 |
- list 字段说明:
字段 | 类型 | 说明 |
---|---|---|
userId | String | 好友用户 ID |
name | String | 用户名 |
avatar | String | 好友头像 |
gender | String | 性别,unknown-未知,male-男,female-女 |
String | 加密后的邮箱 | |
phone | String | 加密后的手机号 |
isOnline | Number | 是否在线,0-否,1-是 |
4. 示例代码
XBCIM.getFriendList({
keywords: '小米',
page: 1,
pageSize: 20
}).then((friendList) => {
console.log('获取好友列表成功', friendList);
}).catch((error) => {
console.log('获取好友列表失败', error);
});