浏览 SDKs · React Native
SDKsReact Native

搜索群成员

在指定群组中搜索成员。

复制

调用 searchGroupMembers(),按用户 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[],字段说明见群组概览