Retrieve Group Members

Fetch and filter group members by scope, status, and search keyword using the CometChat iOS SDK with pagination support.

AI Integration Quick Reference

// Fetch group members
let request = GroupMembersRequest.GroupMembersRequestBuilder(guid: "GUID")
    .set(limit: 30).build()
request.fetchNext(onSuccess: { members in }, onError: { error in })

// Filter by scope
let scopeRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: "GUID")
    .set(limit: 30).set(scopes: ["admin", "moderator"]).build()

// Search members
let searchRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: "GUID")
    .set(limit: 30).set(searchKeyword: "john").build()

Fetch the members of a group with filtering by scope and search keyword. Results are returned as GroupMember objects, which extend User with group-specific fields like scope.

Retrieve the List of Group Members

Use GroupMembersRequestBuilder to fetch members of a group. The GUID must be specified in the constructor.

Set Limit

Sets the number of members to fetch per request.

Swift

let groupMembersRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: "cometchat-guid-1")
    .set(limit: 30)
    .build()

Set Search Keyword

Filters members by a search string.

Swift

let groupMembersRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: "cometchat-guid-1")
    .set(limit: 30)
    .set(searchKeyword: "abc")
    .build()

Set Scopes

Filters members by one or more scopes (.admin, .moderator, .participant).

Swift

let groupMembersRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: "cometchat-guid-1")
    .set(limit: 30)
    .set(scopes: ["admin", "participant"])
    .build()

Fetch Group Members

After configuring the builder, call build() to create the request, then fetchNext() to retrieve members. Call fetchNext() repeatedly on the same instance to paginate.

Swift

let limit = 30
let guid = "cometchat-guid-1"

let groupMembersRequest = GroupMembersRequest.GroupMembersRequestBuilder(guid: guid)
    .set(limit: limit)
    .build()

groupMembersRequest.fetchNext(onSuccess: { (groupMembers) in
    for member in groupMembers {
        print("Member: \(member.stringValue())")
    }
}, onError: { (error) in
    print("Error: \(error?.errorDescription)")
})

Objective C

NSString *guid = @"cometchat-guid-1";
NSInteger limit = 30;

GroupMembersRequest *groupMemberRequest = [[[[GroupMembersRequestBuilder alloc]initWithGuid:guid] setLimitWithLimit:limit] build];

[groupMemberRequest fetchNextOnSuccess:^(NSArray<GroupMember *> * groupMembers) {
    for (GroupMember *member in groupMembers) {
        NSLog(@"Member: %@", [member stringValue]);
    }
} onError:^(CometChatException * error) {
    NSLog(@"Error: %@", [error errorDescription]);
}];

The fetchNext() method returns an array of GroupMember objects. GroupMember extends User and adds group-specific fields like scope and joinedAt.

---

Next Steps

Add Members

Add users to a group programmatically

Kick & Ban Members

Remove or ban members from a group