Retrieve Group Members - CometChat Docs

AI Integration Quick Reference

Field	Value
Package	`cometchat_sdk`
Import	`import 'package:cometchat_sdk/cometchat_sdk.dart';`
Purpose	Fetch CometChat group members in Flutter apps with group GUID, pagination limits, search keywords, and member scopes.
Key classes	`Group` · `CometChatUserStatus` · `CometChatException` · `GroupMember`
Prerequisites	SDK initialised via `CometChat.init()` and a logged-in user via `CometChat.login()`.
Related	Add Members To A Group · Change Member Scope
Full reference	`Group` · `CometChatException` · `GroupMember`

Retrieve the List of Group Members

In order to fetch the list of groups members for a group, you can use the GroupMembersRequest class. To use this class i.e to create an object of the GroupMembersRequest class, you need to use the GroupMembersRequestBuilder class. The GroupMembersRequestBuilder class allows you to set the parameters based on which the groups are to be fetched. The GroupMembersRequestBuilder class allows you to set the below parameters: The GUID of the group for which the members are to be fetched must be specified in the constructor of the GroupMembersRequestBuilder class.

Set Limit

This method sets the limit i.e. the number of members that should be fetched in a single iteration.

Dart

String GUID = "GUID";
  GroupMembersRequest  groupMembersRequest = (GroupMembersRequestBuilder(GUID)
  ..limit = 20
  ).build();

Set Search Keyword

With offline support on, this filter is answered by the server only; the cached page is empty.

This method allows you to set the search string based on which the group members are to be fetched.

Dart

String GUID = "GUID";
GroupMembersRequest  groupMembersRequest = (GroupMembersRequestBuilder(GUID)
  ..limit = 20
  ..searchKeyword = "abc"
  ).build();

Set Scopes

This method allows you to fetch group members based on the specified scopes.

Dart

List<String> scopes =[];
scopes.add("admin");
scopes.add("moderator");
String GUID = "GUID";
GroupMembersRequest  groupMembersRequest = (GroupMembersRequestBuilder(GUID)
  ..limit = 20
  ..scopes = scopes
  ).build();

Set Status

With offline support on, this filter is answered by the server only; the cached page is empty.

This method allows you to filter group members based on their online/offline status.

Dart

String GUID = "GUID";
GroupMembersRequest groupMembersRequest = (GroupMembersRequestBuilder(GUID)
  ..limit = 20
  ..status = CometChatUserStatus.online  // or CometChatUserStatus.offline
  ).build();

The status parameter can contain one of the below two values:

CometChatUserStatus.online - will return only online group members.
CometChatUserStatus.offline - will return only offline group members.

If this parameter is not set, all group members will be returned regardless of their status. Finally, once all the parameters are set to the builder class, you need to call the build() method to get the object of the GroupMembersRequest class. Once you have the object of the GroupMembersRequest class, you need to call the fetchNext() method. Calling this method will return a list of GroupMember objects containing N number of members depending on the limit set.

Starting with v5.1.0, `fetchNext()` accepts a listener: parameter. Pass a `GroupMemberFetchListener` to receive the on-device cached result. The listener: parameter requires cometchat_sdk 5.1.0 or later, so on 5.0.x keep using onSuccess/onError. With offline support off, the listener behaves exactly like the callbacks: onError is unchanged, and the server result arrives in the onServer… callback instead of onSuccess. With offline support on, the listener also delivers the cached result first, then the server result. onSuccess/onError keep working and receive only the server result. See Show Cached Data.

Dart

class Class_Name extends GroupMemberFetchListener {
  @override
  void onCachedGroupMembers(List<GroupMember> members) {
    // Cached page: fires first (even when empty). Render immediately.
    debugPrint("Cached group members: ${members.length}");
  }

  @override
  void onServerGroupMembers(List<GroupMember> members) {
    // Server page: reconcile your displayed list, keyed by uid.
    debugPrint("Server group members: ${members.length}");
  }

  @override
  void onError(CometChatException e) {
    // Handle failure (offline: ERR_CONNECTION after the cached page).
    debugPrint("Group Members fetch failed with exception: ${e.message}");
  }
}

String GUID = "GUID";
GroupMembersRequest  groupMembersRequest = (GroupMembersRequestBuilder(GUID)
  ..limit = 20
  ).build();

groupMembersRequest.fetchNext(onSuccess: null, onError: null, listener: Class_Name());

Offline Behaviour

With offline support enabled, GroupMembersRequest.fetchNext() with a GroupMemberFetchListener first delivers onCachedGroupMembers from the device (empty when nothing was recorded), then onServerGroupMembers with the live page to reconcile by uid. Offline, the read ends with onError with code ERR_CONNECTION (details ERROR_INTERNET_UNAVAILABLE) after the cached page. A request that uses a server-only filter records nothing, so its cached page is always empty. See Show Cached Data.

Builder option	Offline
`limit`	Cached
`scopes`	Cached
`searchKeyword`	Server only — cached page is empty
`status`	Server only — cached page is empty

​Retrieve the List of Group Members

​Set Limit

​Set Search Keyword

​Set Scopes

​Set Status

​Offline Behaviour

Retrieve the List of Group Members

Set Limit

Set Search Keyword

Set Scopes

Set Status

Offline Behaviour