浏览 SDKs · HarmonyOS
平台
SDKsHarmonyOS商业版

搜索群成员

按用户 ID 或群内昵称分页搜索指定群组的成员。

复制

该查询适合成员搜索或构建群聊 @ 候选人。

参数说明

参数类型是否必填说明
groupIDstring目标群组 ID。
keywordstring去除首尾空格后的非空关键词。
searchUserIDboolean是否匹配用户 ID。
searchMemberNicknameboolean是否匹配群内昵称。
paginationRequestPagination页码和每页数量。
import sdk, { SearchGroupMembersReq, SearchGroupMembersResp } from '@openimsdk/imsdk';

const request: SearchGroupMembersReq = {
  groupID: groupID,
  keyword: keyword.trim(),
  searchUserID: true,
  searchMemberNickname: true,
  pagination: { pageNumber: 1, showNumber: 30 },
};
const response: SearchGroupMembersResp = await sdk.searchGroupMembers(request);
const members = response.members;

搜索结果是独立结果集,不应替换完整成员列表。关键词或匹配字段变化时,重置页码并替换当前搜索结果。