SDKsReact Native

Search group members

Search members within a group by user ID or nickname using the OpenIM React Native SDK.

Search for group members matching user ID or group nickname keywords:

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

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group ID.
`keywordList`	`string[]`	Yes	Array of keyword strings to search for.
`isSearchUserID`	`boolean`	Yes	Whether to match search keywords against member user IDs.
`isSearchMemberNickname`	`boolean`	Yes	Whether to match search keywords against member group nicknames.
`offset`	`number`	Yes	Pagination offset; pass `0` for the first page.
`count`	`number`	Yes	Number of matching member items to retrieve.

Return value

A resolved Promise returns GroupMemberItem[] matching the search query for the current page. If the returned array contains fewer items than count, all matching results have been retrieved. Correlate and display members using the composite key groupID:userID. For field definitions, see Group overview.

Was this page helpful?