SDKsFlutter

Search group members

Search members within a specified group with the OpenIM Flutter SDK.

searchGroupMembers() searches one specified group. Trim the keyword before requesting and do not submit an empty keyword.

Parameters

Parameter	Type	Required	Description
`groupID`	`String`	Yes	Target group ID.
`keywordList`	`List<String>`	No	Search terms; the current call uses the first non-empty item.
`isSearchUserID`	`bool`	No	Whether to match member user IDs.
`isSearchMemberNickname`	`bool`	No	Whether to match in-group nicknames.
`offset`	`int`	No	Starting offset.
`count`	`int`	No	Number of items to retrieve.

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

A successful Future returns the current matching page as List<GroupMembersInfo>. Reset offset when the keyword or matched fields change. Search results establish a snapshot only and do not trigger member events.

Was this page helpful?