TIMFriendshipGetFriendProfileList
功能介绍
获取好友列表
此接口通过回调返回所有好友资料FriendProfile.
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| getFriendProfileListParam | GetFriendProfileListParams | 是 | 获取好友列表的参数 |
返回模板
Promise<commonResult<Array<FriendProfile>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<FriendProfile> | undefined;
json_params?: Array<FriendProfile> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< FriendProfile > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< FriendProfile > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetFriendProfileListParams } from "im_electron_sdk/dist/interfaces";
let param:GetFriendProfileListParams = {
user_data: "123" //选填
}
const {code} = await timRenderInstance.TIMFriendshipGetFriendProfileList(param);
if(code == 0){
// 成功
}