SDKsFlutter

Search group members

Search members within a specified group by keyword using the OpenIM Flutter SDK.

Search member rosters within a target group matching keywords across user IDs or in-group nicknames:

Parameters

Parameter	Type	Required	Description
`groupID`	`String`	Yes	Target group ID.
`keywordList`	`List<String>`	Yes	List of search keywords; trim whitespace before submitting.
`isSearchUserID`	`bool`	No	Whether to match against member user IDs.
`isSearchMemberNickname`	`bool`	No	Whether to match against in-group nicknames.
`offset`	`int`	No	Zero-based pagination offset index.
`count`	`int`	No	Maximum number of search results to return per page.

Code example

final members = await OpenIM.iMManager.groupManager.searchGroupMembers(
  groupID: groupID,
  keywordList: [keyword.trim()],
  isSearchUserID: true,
  isSearchMemberNickname: true,
  offset: 0,
  count: 50,
);

Return value

A successful Future returns a list of matching group member records for the requested page (List<GroupMembersInfo>).

When keywords or search dimensions change, reset offset to 0. Searches return temporary snapshot results and do not emit member listener events. For subsequent member change events and incremental merging rules, see Retrieving group members overview.

Was this page helpful?