Retrieve Group Members

Learn how to retrieve members of a group.

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.

  1. setLimit(Limit: number) - This method sets the limit i.e. the number of members that should be fetched in a single iteration.

var groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(30)
  .build();

  1. setSearchKeyword(searchString: string) - This method allows you to set the search string based on which the group members are to be fetched.

var groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(30)
  .setSearchKeyword("abc")
  .build();

  1. setScopes(scopes: Array<String>) - This method allows you to fetch group members based on multiple scopes.

var scopes = ["admin", "moderator"];
var groupMembersRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(30)
  .setScopes(scopes)
  .build();

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 where n is the limit set in the builder class.

var GUID = "GUID";
var limit = 30;
var groupMemberRequest = new CometChat.GroupMembersRequestBuilder(GUID)
  .setLimit(limit)
  .build();

groupMemberRequest.fetchNext().then(
  groupMembers => {
    console.log("Group Member list fetched successfully:", groupMembers);
  },
  error => {
    console.log("Group Member list fetching failed with exception:", error);
  }
);

Did this page help you?