io.straas.android.sdk.messaging.message

Class MessageRequest

java.lang.Object

io.straas.android.sdk.messaging.message.MessageRequest

public class MessageRequest
extends Object

The request rule of ChatroomManager.getMessages(MessageRequest). You could use MessageRequest.Builder to create this object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageRequest.Builder Builder of MessageRequest.
static interface	MessageRequest.Order Defines the order.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASCENDING_ORDER Indicates the ascending order.
static String	DESCENDING_ORDER Indicates the descending order.

Method Summary

Modifier and Type	Method and Description
Long	getLatestDate() Gets the latest date of messages request.
Long	getOldestDate() Gets oldest date of messages request.
String	getOrder() Gets the Message creation time order of the messages request.
int	getPage() Gets target page of messages request.
int	getPerPage() Gets message count per page of messages request.

Methods inherited from class java.lang.Object

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

Field Detail

ASCENDING_ORDER

public static final String ASCENDING_ORDER

Indicates the ascending order.

See Also:

MessageRequest.Builder.order(String), getOrder(), Constant Field Values

DESCENDING_ORDER

public static final String DESCENDING_ORDER

Indicates the descending order.

See Also:

MessageRequest.Builder.order(String), getOrder(), Constant Field Values

Method Detail

getPerPage

public int getPerPage()

Gets message count per page of messages request.

Returns:

message count per page

getPage

public int getPage()

Gets target page of messages request.

Returns:

target page

getOldestDate

public Long getOldestDate()

Gets oldest date of messages request.

Returns:

oldest date

getLatestDate

public Long getLatestDate()

Gets the latest date of messages request.

Returns:

latest date

getOrder

public String getOrder()

Gets the Message creation time order of the messages request.

Order will be one of the following:

• ASCENDING_ORDER
• DESCENDING_ORDER

Returns:

the order of Message creation time