TIMProfileGetUserProfileList
Introduction
Get user profile list
Get user profile, including self profile.
The profile of a non-friend user cannot be modified.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| param | TIMProfileGetUserProfileListParam | yes | Param of getting user profile list |
Returned template
Promise<commonResult<Array<userProfile>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<userProfile> | undefined;
json_params?: Array<userProfile> | undefined;
user_data?: string | undefined;
}
Return value details
| name | type | description |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | Request result: Error codes. 0 means success. |
| desc | string ｜ undefined | The description of the error. It will be empty if success. |
| json_param | Array< userProfile > ｜ undefined | Return value of calling API |
| json_params | Array< userProfile > ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
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], // required
friendship_getprofilelist_param_force_update: false, // required
}
let param: TIMProfileGetUserProfileListParam = {
json_get_user_profile_list_param: listParam, // required
user_data: "TIMProfileGetUserProfileList",
}
let { code } = await timRenderInstance.TIMProfileGetUserProfileList(param)
if (code == 0) {
// success
}