com.cometchat.pro.core

Class MessagesRequest.MessagesRequestBuilder

java.lang.Object

com.cometchat.pro.core.MessagesRequest.MessagesRequestBuilder

Enclosing class:

MessagesRequest

public static class MessagesRequest.MessagesRequestBuilder
extends java.lang.Object

Builder class to set various parameters to fetch list of Messages

Constructor Summary

Constructors

Constructor and Description
MessagesRequestBuilder()

Method Summary

Modifier and Type	Method and Description
MessagesRequest	build()
MessagesRequest.MessagesRequestBuilder	hideMessagesFromBlockedUsers(boolean hideMessagesFromBlockedUsers) Method to set parameters to hide or show message from blocked users while fetching
MessagesRequest.MessagesRequestBuilder	setCategory(java.lang.String category) A method to set parameter to get the messages belonging to a specific category.
MessagesRequest.MessagesRequestBuilder	setGUID(java.lang.String GUID) A method to set GUID of a Group to get messages of particular conversation
MessagesRequest.MessagesRequestBuilder	setLimit(int limit) A method to set limit if default value in the builder is and max value is
MessagesRequest.MessagesRequestBuilder	setMessageId(int messageId) A method to set Message Id of a particular message from which developer can call or fetchPrevious()
MessagesRequest.MessagesRequestBuilder	setSearchKeyword(java.lang.String searchKeyword) A method set Search keyword while fetching the messages
MessagesRequest.MessagesRequestBuilder	setTimestamp(long timestamp) A method to set timestamp from which developer can call or fetchPrevious()
MessagesRequest.MessagesRequestBuilder	setType(java.lang.String type) A method to set parameter to get the messages belonging to a specific type.
MessagesRequest.MessagesRequestBuilder	setUID(java.lang.String UID) A method to set UID of a User to get messages of particular conversation
MessagesRequest.MessagesRequestBuilder	setUndelivered(boolean undelivered) Method to set undelivered message while fetching
MessagesRequest.MessagesRequestBuilder	setUnread(boolean unread) Method to set unread message while fetching
MessagesRequest.MessagesRequestBuilder	setUpdatedAfter(long updatedAfter) A method set timestamp to get fetch messages updated/edited after that timestamp
MessagesRequest.MessagesRequestBuilder	updatesOnly(boolean updatesOnly) A method to set parameter to get edited/updated messages

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesRequestBuilder

public MessagesRequestBuilder()

Method Detail

setLimit

public MessagesRequest.MessagesRequestBuilder 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:

MessagesRequestBuilder object when is called

Since:

v1

setUID

public MessagesRequest.MessagesRequestBuilder setUID(java.lang.String UID)

A method to set UID of a User to get messages of particular conversation

Parameters:

UID - Unique Identifier of a User

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setGUID

public MessagesRequest.MessagesRequestBuilder setGUID(java.lang.String GUID)

A method to set GUID of a Group to get messages of particular conversation

Parameters:

GUID - Unique Identifier of a Group

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setMessageId

public MessagesRequest.MessagesRequestBuilder setMessageId(int messageId)

A method to set Message Id of a particular message from which developer can call or fetchPrevious()

Parameters:

messageId - Unique Id of a message

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setUnread

public MessagesRequest.MessagesRequestBuilder setUnread(boolean unread)

Method to set unread message while fetching

Parameters:

unread - boolean parameter to consider or avoid unread messages while fetching messages using MessagesRequest

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setUndelivered

public MessagesRequest.MessagesRequestBuilder setUndelivered(boolean undelivered)

Method to set undelivered message while fetching

Parameters:

undelivered - boolean parameter to consider or avoid undelivered messages while fetching messages using MessagesRequest

Returns:

MessagesRequestBuilder object when is called

Since:

v1

hideMessagesFromBlockedUsers

public MessagesRequest.MessagesRequestBuilder hideMessagesFromBlockedUsers(boolean hideMessagesFromBlockedUsers)

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

Parameters:

hideMessagesFromBlockedUsers - boolean parameter to consider or avoid messages from blocked users while fetching messages using MessagesRequest

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setTimestamp

public MessagesRequest.MessagesRequestBuilder setTimestamp(long timestamp)

A method to set timestamp from which developer can call or fetchPrevious()

Parameters:

timestamp - timestamp from which developer wants to fetch previous or next messsages

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setSearchKeyword

public MessagesRequest.MessagesRequestBuilder setSearchKeyword(java.lang.String searchKeyword)

A method set Search keyword while fetching the messages

Parameters:

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

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setUpdatedAfter

public MessagesRequest.MessagesRequestBuilder setUpdatedAfter(long updatedAfter)

A method set timestamp to get fetch messages updated/edited after that timestamp

Parameters:

updatedAfter - timestamp to get messages updated after the specified timestamp

Returns:

MessagesRequestBuilder object when is called

Since:

v1

updatesOnly

public MessagesRequest.MessagesRequestBuilder updatesOnly(boolean updatesOnly)

A method to set parameter to get edited/updated messages

Parameters:

updatesOnly - boolean parameter show or hide edited/updated messages only

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setCategory

public MessagesRequest.MessagesRequestBuilder setCategory(java.lang.String category)

A method to set parameter to get the messages belonging to a specific category.

Parameters:

category - The category for which the messages are to be fetched.

Returns:

MessagesRequestBuilder object when is called

Since:

v1

setType

public MessagesRequest.MessagesRequestBuilder setType(java.lang.String type)

A method to set parameter to get the messages belonging to a specific type.

Parameters:

type - The type for which the messages are to be fetched.

Returns:

MessagesRequestBuilder object when is called

Since:

v1

build

public MessagesRequest build()