com.cometchat.pro.core

Class UsersRequest.UsersRequestBuilder

java.lang.Object

com.cometchat.pro.core.UsersRequest.UsersRequestBuilder

Enclosing class:

UsersRequest

public static class UsersRequest.UsersRequestBuilder
extends java.lang.Object

Builder class to set various parameters to fetch list of Users

Constructor Summary

Constructors

Constructor and Description
UsersRequestBuilder()

Method Summary

Modifier and Type	Method and Description
UsersRequest	build()
UsersRequest.UsersRequestBuilder	friendsOnly(boolean friendsOnly) method to get friends for the logged in user
UsersRequest.UsersRequestBuilder	hideBlockedUsers(boolean hideBlockedUsers) Method to set parameters to hide or show message from blocked users while fetching
UsersRequest.UsersRequestBuilder	setLimit(int limit) A method to set limit if default value in the builder is and max value is
UsersRequest.UsersRequestBuilder	setRole(java.lang.String role) method to get list of users based on user role
UsersRequest.UsersRequestBuilder	setSearchKeyword(java.lang.String searchKeyword) A method set Search user with specified name or UID while fetching the messages
UsersRequest.UsersRequestBuilder	setUserStatus(java.lang.String userStatus) method to get list of users based on user status

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersRequestBuilder

public UsersRequestBuilder()

Method Detail

setLimit

public UsersRequest.UsersRequestBuilder setLimit(int limit)

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

Parameters:

limit - Integer value specified by the Developer

Returns:

UsersRequestBuilder object when is called

Since:

v1

setSearchKeyword

public UsersRequest.UsersRequestBuilder setSearchKeyword(java.lang.String searchKeyword)

A method set Search user with specified name or UID while fetching the messages

Parameters:

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

Returns:

UsersRequestBuilder object when is called

Since:

v1

hideBlockedUsers

public UsersRequest.UsersRequestBuilder hideBlockedUsers(boolean hideBlockedUsers)

Method to set parameters to hide or show message from blocked users while fetching

Parameters:

hideBlockedUsers - boolean parameter to consider or avoid blocked users while fetching list of users using UsersRequest

Returns:

UsersRequestBuilder object when is called

Since:

v1

setUserStatus

public UsersRequest.UsersRequestBuilder setUserStatus(java.lang.String userStatus)

method to get list of users based on user status

Parameters:

userStatus - parameter to set status UsersRequest.USER_STATUS_ONLINE or UsersRequest.USER_STATUS_OFFLINE

Returns:

UsersRequestBuilder object when is called

setRole

public UsersRequest.UsersRequestBuilder setRole(java.lang.String role)

method to get list of users based on user role

Parameters:

role - parameter to set role while fetching the list of users

Returns:

UsersRequestBuilder object when is called

friendsOnly

public UsersRequest.UsersRequestBuilder friendsOnly(boolean friendsOnly)

method to get friends for the logged in user

Parameters:

friendsOnly - parameter if set to true will return only friends and not all the users for the app.

Returns:

UsersRequestBuilder object when is called

build

public UsersRequest build()