searchGroupMembers
功能介绍
搜索群成员
SDK 会在本地搜索指定群 ID 列表中，群成员信息（名片、好友备注、昵称、userID）包含于关键字列表 keywordList 的所有群成员并返回群 ID 和群成员列表的 map，如搜索不到请先调用getGroupMemberList将成员信息存储到本地数据库再调用此接口进行搜索，关键字列表最多支持5个。
直播群（AVChatRoom）不在本地存储群成员，无法使用群成员搜索功能。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| keywordList | string[] | 是 | 关键字列表 此参数为传入参数对象的参数 |
| groupIDList | string[] | 否 | 群组id列表 此参数为传入参数对象的参数 |
| isSearchMemberUserID | boolean | 否 | 是否支持搜索成员id 此参数为传入参数对象的参数 |
| isSearchMemberNickName | boolean | 否 | 是否支持搜索成员昵称 此参数为传入参数对象的参数 |
| isSearchMemberRemark | boolean | 否 | 是否支持搜索成员备注 此参数为传入参数对象的参数 |
| isSearchMemberNameCard | boolean | 否 | 是否支持搜索成员名片 此参数为传入参数对象的参数 |
返回模板
V2TimValueCallback<{groupMemberSearchResultItems: StringMap}>
{
code : number
desc : string
data : {
groupMemberSearchResultItems : StringMap// 群成员搜索结果
}
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | number | 请求结果错误码 |
| desc | string | 请求结果描述符 |
| data | {groupMemberSearchResultItems: StringMap} | 群成员搜索结果 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
//搜索参数设置
const param = {
groupIDList: [], // 指定群 ID 列表，若为 null 则搜索全部群中的群成员
isSearchMemberNameCard: true, // 设置是否搜索群成员名片，默认为true
isSearchMemberRemark: true, // 设置是否搜索群成员备注，默认为true
isSearchMemberNickName: true, // 设置是否搜索群成员昵称，默认为true
isSearchMemberUserID: true, // 设置是否搜索群成员 userID，默认为true
keywordList: [],
}; // 搜索关键字列表，最多支持5个
//搜索群成员
const searchGroupMembersRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.searchGroupMembers(param); // 搜索群成员的搜索参数
if (searchGroupMembersRes.code === 0) {
// 搜索成功
searchGroupMembersRes.data?.groupMemberSearchResultItems; // 群成员搜索结果
}