TIMProfileGetUserProfileList
功能介绍
获取指定用户列表的个人资料
可以通过该接口获取任何人的个人资料,包括自己的个人资料。
PS:用户资料相关接口 资料系统简介
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
param | TIMProfileGetUserProfileListParam | 是 | 获取指定用户列表的个人资料的参数 |
返回模板
Promise<commonResult<Array<userProfile>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<userProfile> | undefined;
json_params?: Array<userProfile> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | Array< userProfile > | undefined | 根据具具体接口返回 |
json_params | Array< userProfile > | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import {jsonGetUserProfileListParam,TIMProfileGetUserProfileListParam } from "im_electron_sdk/dist/interfaces";
let userID = "";
let listParam:jsonGetUserProfileListParam ={
friendship_getprofilelist_param_identifier_array: [userID], //必填,想要获取目标用户资料的UserID列表
friendship_getprofilelist_param_force_update:false, //必填,是否强制更新
}
let param:TIMProfileGetUserProfileListParam = {
json_get_user_profile_list_param: listParam, //必填
user_data: "TIMProfileGetUserProfileList",
}
let {code} = await timRenderInstance.TIMProfileGetUserProfileList(param)
if(code == 0){
// 获取成功
}