SDKsHarmonyOSEnterprise

Search group members

Paginate and search members in a specified group by user ID or member nickname.

Use this method to search members or build candidate selection lists when Creating @ mention messages.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`keyword`	`string`	Yes	Non-empty search keyword trimmed of whitespace.
`searchUserID`	`boolean`	Yes	Whether to match member user IDs.
`searchMemberNickname`	`boolean`	Yes	Whether to match in-group member nicknames.
`pagination`	`RequestPagination`	Yes	Pagination configuration containing page number and page size.

Code example

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;

Return value

Returns a Promise resolving to SearchGroupMembersResp:

Property	Type	Description
`members`	`GroupMemberItem[]`	Array of matching group member items.

Search results represent an isolated query view and should not replace your application's primary member roster. When search terms or field flags change, reset the page index and swap out search results. For managing the primary member roster, see Retrieve group member list.

Was this page helpful?

Parameters

Code example

Return value

State changes after the call