Get group member list with pagination
Query group members with role filters and pagination using the OpenIM Flutter SDK.
Query member rosters within a target group using pagination and optional role filters. The caller typically must already be a member of the group:
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
groupID | String | Yes | Target group ID. |
filter | int | No | Role filter: 0 all members, 1 group owner, 2 administrators, 3 regular members. Defaults to 0. |
offset | int | No | Zero-based pagination offset index. |
count | int | No | Maximum number of members to fetch per page. |
Code example
final members = await OpenIM.iMManager.groupManager.getGroupMemberList(
groupID: groupID,
filter: 0,
offset: 0,
count: 50,
);Return value
A successful Future returns a list of group member objects for the requested page (List<GroupMembersInfo>).
When fetching subsequent pages, advance offset by the total number of items requested so far. Do not use local list lengths that fluctuate with incremental event arrivals as pagination offsets. To query group leadership directly, see Get group owner and admin.
This query returns an immediate data snapshot and does not emit event notifications. For subsequent member change events and incremental merging rules, see Retrieving group members overview.
Was this page helpful?