io.straas.android.sdk.messaging.message

Class MessageRequest.Builder

java.lang.Object

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

Enclosing class:

MessageRequest

public static final class MessageRequest.Builder
extends Object

Builder of MessageRequest.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor of MessageRequest.Builder.

Method Summary

Modifier and Type	Method and Description
MessageRequest	build() Creates a MessageRequest by this builder.
MessageRequest.Builder	latestDate(Long latestDate) Sets latest date of request messages.
MessageRequest.Builder	oldestDate(Long oldestDate) Sets oldest date of request messages.
MessageRequest.Builder	order(String order) Sets the order of request messages.
MessageRequest.Builder	page(int page) Sets target page of messages.
MessageRequest.Builder	perPage(int perPage) Sets message count per page.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor of MessageRequest.Builder.

Method Detail

perPage

public MessageRequest.Builder perPage(int perPage)

Sets message count per page. Default value is 10.

Parameters:

perPage - Message count per page. This value should be in the range [1..100].

See Also:

page(int)

page

public MessageRequest.Builder page(int page)

Sets target page of messages. The newest message will be at page 1. Default value is 1.

Parameters:

page - Target page. This value should be bigger than 1.

See Also:

perPage(int)

oldestDate

public MessageRequest.Builder oldestDate(Long oldestDate)

Sets oldest date of request messages. The messages sent in the oldest date wouldn't be included.

The value represents the unix time in millisecond.

Ignore this method will disable this filter.

Parameters:

oldestDate - oldest date

latestDate

public MessageRequest.Builder latestDate(Long latestDate)

Sets latest date of request messages. The messages sent in the latest date wouldn't be included.

The value represents the unix time in millisecond.

Ignore this method will disable this filter.

Parameters:

latestDate - latest date

order

public MessageRequest.Builder order(String order)

Sets the order of request messages. Messages will be requested by this order of Message creation time. Default value is MessageRequest.DESCENDING_ORDER.

The order must be one of the following:

• MessageRequest.ASCENDING_ORDER
• MessageRequest.DESCENDING_ORDER

Parameters:

order - the order of Message creation time

build

public MessageRequest build()

Creates a MessageRequest by this builder.