TIMGroupSearchGroupMembers
功能介绍
搜索群成员列表
SDK 会在本地搜索指定群 ID 列表中，群成员信息（名片、好友备注、昵称、userID）包含于关键字列表 keywordList 的所有群成员并返回群 ID 和群成员列表的 map，关键字列表最多支持5个。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| searchMemberParams | SearchMemberParams | 是 | 搜索群成员列表的参数 |
返回模板
Promise<commonResult<Array<SearchMemberResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<SearchMemberResult> | undefined;
json_params?: Array<SearchMemberResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< SearchMemberResult > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< SearchMemberResult > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { SearchMemberParams,MemberSearchParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let keyword = ''
let field = 0
let searchParams:MemberSearchParams = {
group_search_member_params_groupid_list: [groupId], //必填
group_search_member_params_keyword_list: [keyword],//必填
group_search_member_params_field_list: [field]//必填
}
let param : SearchMemberParams = {
searchParams: searchParams,//必填
data: ''//选填
}
const {code} = await timRenderInstance.TIMGroupSearchGroupMembers(param)
if(code == 0){
//成功
}