SDKsiOS

Retrieve group members by page

Retrieve iOS group members with pagination.

Invoke getGroupMemberList:filter:offset:count:onSuccess:onFailure: to query group members with role-based filtering and pagination:

Parameters

Parameter	Type	Required	Description
`groupID`	`NSString *`	Yes	Target group ID.
`filter`	`OIMGroupMemberFilter`	Yes	Role-based member filter enumeration.
`offset`	`NSInteger`	Yes	Pagination offset index (starts from `0`).
`count`	`NSInteger`	Yes	Maximum number of member records per page.

Member filter enumeration

Enumeration value	Numeric value	Description
`OIMGroupMemberFilterAll`	`0`	All group members.
`OIMGroupMemberFilterOwner`	`1`	Group owner only.
`OIMGroupMemberFilterAdmin`	`2`	Administrators only.
`OIMGroupMemberFilterOrdinaryMember`	`3`	Regular members only.
`OIMGroupMemberFilterAdminAndOrdinaryMember`	`4`	Administrators and regular members.
`OIMGroupMemberFilterOwnerAndAdmin`	`5`	Group owner and administrators.

Code example

[[OIMManager manager] getGroupMemberList:@"group_1001"
                                  filter:OIMGroupMemberFilterAll
                                  offset:0
                                   count:50
                               onSuccess:^(NSArray<OIMGroupMemberInfo *> *members) {
                                   [self replaceFirstPage:members];
                               }
                               onFailure:^(NSInteger code, NSString *message) {
                                   NSLog(@"getGroupMemberList failed: %ld %@", (long)code, message);
                               }];

Return value

The onSuccess callback delivers an array of group member models (NSArray<OIMGroupMemberInfo *> *).

State changes after the call

Snapshot query: This method queries a paginated slice of members without triggering delegate events. Increment offset by the received item count to load subsequent pages.
Mute status inspection: The iOS SDK does not provide a dedicated query endpoint exclusively for muted members; to display muted users, inspect muteEndTime on each OIMGroupMemberInfo model (a timestamp greater than current Unix time indicates an active mute).
Event notification: Member additions, removals, and profile changes broadcast via listener callbacks. For listener setup, refer to Group member queries overview.

Was this page helpful?