Package com.cometchat.pro.core

Class 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 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 30 and max value is 100
        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

        @Deprecated
public UsersRequest.UsersRequestBuilder setRole​(java.lang.String role)
        Deprecated.
        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

      • setRoles

        public UsersRequest.UsersRequestBuilder setRoles​(java.util.List<java.lang.String> roles)
        method to get list of users based on multiple roles
        Parameters:
        roles - list of roles for which the user list is to be retrieved.
        Returns:
        UsersRequestBuilder object when is called

      • setTags

        public UsersRequest.UsersRequestBuilder setTags​(java.util.List<java.lang.String> tags)
        method to get list of Users that are tagged with the specified tags
        Parameters:
        tags - list of tags for which the user list is to be retrieved.
        Returns:
        UsersRequestBuilder object when is called

      • withTags

        public UsersRequest.UsersRequestBuilder withTags​(boolean withTags)
        method to get list of Users along with the tags specified
        Parameters:
        withTags - boolean to decide if the tags are to be sent along with the users data.
        Returns:
        UsersRequestBuilder object when is called

      • setUIDs

        public UsersRequest.UsersRequestBuilder setUIDs​(java.util.List<java.lang.String> uids)
        method to get list of Users for the specified UIDs
        Parameters:
        uids - The list of UIDs for which the users are to be fetched.
        Returns:
        UsersRequestBuilder object when is called