TIMGroupGetGroupInfoList
功能介绍
获取群组信息列表
该接口支持一次传入多个 groupID，批量获取多个群的群资料。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| getGroupListParams | GetGroupListParams | 是 | 获取群组信息列表的参数 |
返回模板
Promise<commonResult<Array<GroupInfoResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<GroupInfoResult> | undefined;
json_params?: Array<GroupInfoResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< GroupInfoResult > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< GroupInfoResult > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetGroupListParams } from "im_electron_sdk/dist/interfaces";
let groupID = ''
let param : GetGroupListParams = {
groupIds: [groupID],//必填
data: '' //选填
}
let {code} = await timRenderInstance.TIMGroupGetGroupInfoList(param)
if(code == 0){
//获取成功
}