浏览 SDKs · React Native
平台
SDKsReact Native

搜索群成员

在指定群组中搜索成员。

复制

在指定群组中按用户 ID 或群内昵称关键词搜索匹配的群成员。

const members = await OpenIMSDK.searchGroupMembers({
  groupID: 'group-001',
  keywordList: ['张'],
  isSearchUserID: false,
  isSearchMemberNickname: true,
  offset: 0,
  count: 50,
});

参数说明

参数类型必填含义
groupIDstring是目标群组 ID。
keywordListstring[]是搜索关键词列表。
isSearchUserIDboolean是是否匹配用户 ID。
isSearchMemberNicknameboolean是是否匹配群内昵称。
offsetnumber是分页偏移量,第一页传 0。
countnumber是本次读取的成员数量。

返回结果

调用完成后返回当前页匹配的 GroupMemberItem[]。返回数量少于 count 时表示已拉取到最后一页;客户端在展示或合并搜索结果时,应使用复合标识 groupID:userID 唯一区分每位成员。各字段详细说明见群组概览。