Package com.cometchat.pro.core

Class GroupsRequest.GroupsRequestBuilder

java.lang.Object

com.cometchat.pro.core.GroupsRequest.GroupsRequestBuilder

Enclosing class:

GroupsRequest

public static class GroupsRequest.GroupsRequestBuilder
extends java.lang.Object

Builder class to set various parameters to fetch list of Groups

Constructor Summary

Constructors

Constructor	Description
GroupsRequestBuilder()

Method Summary

Modifier and Type	Method	Description
GroupsRequest	build()
GroupsRequest.GroupsRequestBuilder	joinedOnly(boolean joinedOnly)	A method to set parameter to get edited/updated messages
GroupsRequest.GroupsRequestBuilder	setLimit(int limit)	A method to set limit if default value in the builder is 30 and max value is 100
GroupsRequest.GroupsRequestBuilder	setSearchKeyWord(java.lang.String searchKeyword)	A method set Search user with specified name or GUID while fetching the list of Groups
GroupsRequest.GroupsRequestBuilder	setTags(java.util.List<java.lang.String> tags)	A method to set tags based on which the groups are to be fetched
GroupsRequest.GroupsRequestBuilder	withTags(boolean withTags)	method to get list of Groups along with the tags specified

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupsRequestBuilder

public GroupsRequestBuilder()

Method Detail

setLimit

public GroupsRequest.GroupsRequestBuilder setLimit(int limit)

A method to set limit if default value in the builder is 30 and max value is 100

Parameters:

limit - Integer value specified by the Developer

Returns:

GroupsRequestBuilder object when is called

Since:

v1

setSearchKeyWord

public GroupsRequest.GroupsRequestBuilder setSearchKeyWord(java.lang.String searchKeyword)

A method set Search user with specified name or GUID while fetching the list of Groups

Parameters:

searchKeyword - keyword which developer wants to search in the Group list

Returns:

GroupsRequestBuilder object when is called

Since:

v1

joinedOnly

public GroupsRequest.GroupsRequestBuilder joinedOnly(boolean joinedOnly)

A method to set parameter to get edited/updated messages

Parameters:

joinedOnly - boolean parameter get joined Groups only

Returns:

GroupsRequestBuilder object when is called

setTags

public GroupsRequest.GroupsRequestBuilder setTags(java.util.List<java.lang.String> tags)

A method to set tags based on which the groups are to be fetched

Parameters:

tags - List of tags based on which the groups are to be fetched.

Returns:

GroupsRequestBuilder object when is called

withTags

public GroupsRequest.GroupsRequestBuilder withTags(boolean withTags)

method to get list of Groups along with the tags specified

Parameters:

withTags - boolean to decide if the tags are to be sent along with the groups data.

Returns:

GroupsRequestBuilder object when is called

build

public GroupsRequest build()