Skip to main content
Version: v4

Retrieve Groups

Retrieve List of Groups​

In other words, as a logged-in user, how do I retrieve the list of groups I've joined and groups that are available?

In order to fetch the list of groups, you can use the GroupsRequest class. To use this class i.e to create an object of the GroupsRequest class, you need to use the GroupsRequestBuilder class. The GroupsRequestBuilder class allows you to set the parameters based on which the groups are to be fetched.

The GroupsRequestBuilder class allows you to set the below parameters:

Set Limit​

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

let limit = 30;
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.build();

Set Search Keyword​

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

let limit = 30;
let searchKeyword = "group";
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.setSearchKeyword(searchKeyword)
                  	.build();

Joined Only​

This method when used, will ask the SDK to only return the groups that the user has joined or is a part of.

let limit = 30;
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.joinedOnly(true)
                  	.build();

Set Tags​

This method accepts a list of tags based on which the list of groups is to be fetched. The list fetched will only contain the groups that have been tagged with the specified tags.

let limit = 30;
let tags = ["tag1", "tag2"];
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.setTags(tags)
                  	.build();

With Tags​

This property when set to true will fetch tags data along with the list of groups.

let limit = 30;
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.withTags(true)
                  	.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 GroupsRequest class.

Once you have the object of the GroupsRequest class, you need to call the fetchNext() method. Calling this method will return a list of Group objects containing n number of groups where n is the limit set in the builder class.

The list of groups fetched will only have the public and password type groups. The private groups will only be available if the user is a member of the group.

let limit = 30;
let groupsRequest = new CometChat.GroupsRequestBuilder()
                  	.setLimit(limit)
                  	.build();

groupsRequest.fetchNext().then(
groupList => {
  console.log("Groups list fetched successfully", groupList);
}, error => {
  console.log("Groups list fetching failed with error", error);
}
);

Retrieve Particular Group Details​

In other words, as a logged-in user, how do I retrieve information for a specific group?

To get the information of a group, you can use the getGroup() method.

var GUID = "GUID";
CometChat.getGroup(GUID).then(
group => {
  console.log("Group details fetched successfully:", group);
}, error => {
  console.log("Group details fetching failed with exception:", error);
}
);
ParameterDescription
GUIDThe GUID of the group for whom the details are to be fetched

It returns Group object containing the details of the group.

Get online group member count​

To get the total count of online users in particular groups, you can use the getOnlineGroupMemberCount() method.

let guids = ["cometchat-guid-1"];
CometChat.getOnlineGroupMemberCount(guids).then(
groupMemberCount => {
  console.log("Total online user for specified groups:", groupMemberCount);
}, error => {
  console.log("Online group member count fetching failed with error:", error);
}
);

This method returns a JSON Object with the GUID as the key and the online member count for that group as the value.