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 theGroupsRequest
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.Set Search Keyword
This method allows you to set the search string based on which the groups are to be fetched.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.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.With Tags
This property when set to true will fetch tags data along with the list of groups.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.
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 thegetGroup()
method.
Parameter | Description |
---|---|
GUID | The GUID of the group for whom the details are to be fetched. |
Group
object containing the details of the group is returned.
Get online group member count
To get the total count of online users in particular groups, you can use thegetOnlineGroupMemberCount()
method.