getFriendsInfo
功能介绍
获取指定好友资料
- 从回调信息中通过
V2TIMFriendInfoResult
的relation
字段可以得到该用户与自己的关系。
注意:
userIDList 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
userIDList | List< String > | 是 | 需要查询的用户id列表 |
返回值
V2TimValueCallback<List<V2TimFriendInfoResult>>
{
code : int
desc : String
data : List<V2TimFriendInfoResult>//查询到的结果信息
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | int | 请求结果错误码 |
desc | String | 请求结果描述 |
data | List< V2TimFriendInfoResult > | 查询到的结果信息 |
代码示例
// 获取指定好友资料
V2TimValueCallback<List<V2TimFriendInfoResult>> getFriendsInfoRes =
await TencentImSDKPlugin.v2TIMManager
.getFriendshipManager()
.getFriendsInfo(userIDList: []);//需要查询的用户id列表
if (getFriendsInfoRes.code == 0) {
// 查询成功
getFriendsInfoRes.data?.forEach((element) {
element.relation;//好友类型 0:不是好友 1:对方在我的好友列表中 2:我在对方的好友列表中 3:互为好友
element.resultCode;//此条记录的查询结果错误码
element.resultInfo;//此条查询结果描述
//friendInfo为好友个人资料,如果不是好友,除了 userID 字段,其他字段都为空
element.friendInfo?.friendCustomInfo;//好友自定义字段 首先要在 控制台 (功能配置 -> 好友自定义字段) 配置好友自定义字段,然后再调用接口进行设置
element.friendInfo?.friendGroups;//好友所在分组列表
element.friendInfo?.friendRemark;//好友备注
element.friendInfo?.userID;//用户的id
element.friendInfo?.userProfile?.allowType;//用户的好友验证方式 0:允许所有人加我好友 1:不允许所有人加我好友 2:加我好友需我确认
element.friendInfo?.userProfile?.birthday;//用户生日
element.friendInfo?.userProfile?.customInfo;//用户的自定义状态
element.friendInfo?.userProfile?.faceUrl;//用户头像 url
element.friendInfo?.userProfile?.gender;//用户的性别 1:男 2:女
element.friendInfo?.userProfile?.level;//用户的等级
element.friendInfo?.userProfile?.nickName;//用户昵称
element.friendInfo?.userProfile?.role;//用户的角色
element.friendInfo?.userProfile?.selfSignature;//用户的签名
element.friendInfo?.userProfile?.userID;//用户 ID
});
}