TIMGroupGetMemberInfoList
功能介绍
获取群成员信息列表
任何群组类型都可以获取成员列表。
直播大群只能拉取部分成员列表：包括群主、管理员和部分成员。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| getGroupMemberInfoParams | GetGroupMemberInfoParams | 是 | 获取群成员信息列表的参数 |
返回模板
Promise<commonResult<GetMemberInfoResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: GetMemberInfoResult | undefined;
json_params?: GetMemberInfoResult | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | GetMemberInfoResult ｜ undefined | 根据具具体接口返回 |
| json_params | GetMemberInfoResult ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetGroupMemberInfoParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let param : GetGroupMemberInfoParams= {
params: {
group_get_members_info_list_param_group_id: groupId,//必填
group_get_members_info_list_param_next_seq: 0,//选填
group_get_members_info_list_param_identifier_array: [''],//选填
group_get_members_info_list_param_option: {
group_member_get_info_option_info_flag: 0,//选填
group_member_get_info_option_role_flag: 0,//选填
group_member_get_info_option_custom_array: ['']//选填
}
},
data:''//选填
}
const {code} = await timRenderInstance.TIMGroupGetMemberInfoList(param)
if(code == 0){
//获取成功
}