PreviousMessageListQuery (Sendbird Chat SDK for Android reference)

java.lang.Object
- com.sendbird.android.PreviousMessageListQuery

```
public class PreviousMessageListQuery
extends java.lang.Object
```
A class representing query to retrieve previous message list for channels.
Currently, 1 kind of message list can be queried.
- The list of previous messages for a channel.
  The query can be get by calling BaseChannel.createPreviousMessageListQuery() or BaseChannel.createPreviousMessageListQuery().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PreviousMessageListQuery.MessageListQueryResult
MessageListQueryResult handler.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PreviousMessageListQuery.MessageListQueryResult` MessageListQueryResult handler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BaseChannel`	`getChannel()` Current channel.
`java.lang.String`	`getCustomTypeFilter()` Returns the custom type filter of message.
`int`	`getLimit()` Returns the maximum number of messages per page.
`long`	`getMessageTimestamp()` Returns the time of a request.
`BaseChannel.MessageTypeFilter`	`getMessageTypeFilter()` Returns the `BaseChannel.MessageTypeFilter`.
`java.util.List<java.lang.String>`	`getSenderUserIdsFilter()` Returns the sender user ids filter.
`boolean`	`hasMore()` Checks if there are more previous messages.
`boolean`	`isIncludeThreadInfo()` Returns whether to include the thread information of the returned messages in the results when the results contain parent messages.
`boolean`	`isLoading()` Checks if the current query is in communication progress with server.
`void`	`load(int limit, boolean reverse, PreviousMessageListQuery.MessageListQueryResult handler)` Requests query result for the previous messages.
`void`	`load(PreviousMessageListQuery.MessageListQueryResult handler)` Requests query result for the previous messages.
`void`	`setCustomTypeFilter(java.lang.String customType)` Sets custom type filter.
`void`	`setCustomTypesFilter(java.util.Collection<java.lang.String> customTypes)` Sets custom type filter.
`void`	`setIncludeMetaArray(boolean includeMetaArray)` Sets message meta array.
`void`	`setIncludeParentMessageText(boolean includeParentMessageText)` Determines whether to include the parent message text in the results when the updated messages are replies in a thread.
`void`	`setIncludeReactions(boolean includeReactions)` Sets message reactions.
`void`	`setIncludeReplies(boolean includeReplies)` Determines whether replies are included in the results.
`void`	`setIncludeThreadInfo(boolean includeThreadInfo)` Determines whether to include the thread information of the returned messages in the results when the results contain parent messages.
`void`	`setLimit(int limit)` Sets the maximum number of messages per queried page.
`void`	`setMessageTypeFilter(BaseChannel.MessageTypeFilter messageType)` Sets message type filter.
`void`	`setReverse(boolean reverse)` Sets reverse.
`void`	`setSenderUserIdsFilter(java.util.List<java.lang.String> senderUserIds)` Sets sender user ids filter.
`void`	`setShowSubchannelMessagesOnly(boolean showSubchannelMessagesOnly)` If set to true, only messages that belong to current user's subchannel is fetched.
`boolean`	`shouldIncludeMetaArray()` Returns whether the meta array should be included in the results.
`boolean`	`shouldIncludeParentMessageText()` Returns whether the text of a parent message should be included in the reply messages included in the results.
`boolean`	`shouldIncludeReactions()` Returns whether the reaction data should be included in the results.
`boolean`	`shouldIncludeReplies()` Returns whether the replies should be included in the results.
`boolean`	`shouldReverse()` Returns whether the results should be reversed.
`boolean`	`shouldShowSubchannelMessagesOnly()` If set to true, only messages that belong to current user's subchannel is fetched.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - hasMore
```
public boolean hasMore()
```
    Checks if there are more previous messages.
    
    Returns:
    
    true if there are more previous messages.
  - isLoading
```
public boolean isLoading()
```
    Checks if the current query is in communication progress with server.
    
    Returns:
    
    true if the current query is not finished.
  - setLimit
```
public void setLimit(int limit)
```
    Sets the maximum number of messages per queried page.
    
    Parameters:
    
    limit - The maximum number of messages per page.
    
    Since:
    
    3.0.66
  - setReverse
```
public void setReverse(boolean reverse)
```
    Sets reverse.
    
    Parameters:
    
    reverse - If true the queried result will be returned by creation time descending order.
    
    Since:
    
    3.0.66
  - setMessageTypeFilter
```
public void setMessageTypeFilter(BaseChannel.MessageTypeFilter messageType)
```
    Sets message type filter.
    
    Parameters:
    
    messageType - Message type. Refer to BaseChannel.MessageTypeFilter.
    
    Since:
    
    3.0.66
  - setCustomTypeFilter
```
public void setCustomTypeFilter(java.lang.String customType)
```
    Sets custom type filter.
    
    Parameters:
    
    customType - Custom type.
    
    Since:
    
    3.0.66
  - setCustomTypesFilter
```
public void setCustomTypesFilter(java.util.Collection<java.lang.String> customTypes)
```
    Sets custom type filter. when set, only messages with customType that equals to one of customTypes will be returned. When a customType is an empty string (""), all messages without a custom type will be returned.
    
    Parameters:
    
    customTypes - Custom types.
    
    Since:
    
    3.0.154
  - setSenderUserIdsFilter
```
public void setSenderUserIdsFilter(java.util.List<java.lang.String> senderUserIds)
```
    Sets sender user ids filter.
    
    Parameters:
    
    senderUserIds - Sender user IDs.
    
    Since:
    
    3.0.66
  - setIncludeMetaArray
```
public void setIncludeMetaArray(boolean includeMetaArray)
```
    Sets message meta array.
    
    Parameters:
    
    includeMetaArray - If true the queried result will be returned with message meta array.
    
    Since:
    
    3.0.76
  - setIncludeReactions
```
public void setIncludeReactions(boolean includeReactions)
```
    Sets message reactions.
    
    Parameters:
    
    includeReactions - If true the queried result will be returned with message reactions.
    
    Since:
    
    3.0.112
  - setIncludeThreadInfo
```
public void setIncludeThreadInfo(boolean includeThreadInfo)
```
    Determines whether to include the thread information of the returned messages in the results when the results contain parent messages.
    
    Parameters:
    
    includeThreadInfo - If true the queried result will be returned with thread information.
    
    Since:
    
    3.0.130
  - setIncludeReplies
```
public void setIncludeReplies(boolean includeReplies)
```
    Determines whether replies are included in the results.
    
    Parameters:
    
    includeReplies - If true the queried result will be returned with reply messages as well.
    
    Since:
    
    3.0.130
  - setIncludeParentMessageText
```
public void setIncludeParentMessageText(boolean includeParentMessageText)
```
    Determines whether to include the parent message text in the results when the updated messages are replies in a thread. If the type of the parent message is UserMessage, the value is a BaseMessage.getMessage() of the parent message. If it is FileMessage, the value is the name of the uploaded file.
    
    Parameters:
    
    includeParentMessageText - If true the queried result will be returned with parent message's text for reply messages. setIncludeReplies(boolean) must be set to true.
    
    Since:
    
    3.0.130
  - setShowSubchannelMessagesOnly
```
public void setShowSubchannelMessagesOnly(boolean showSubchannelMessagesOnly)
```
    If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.
    
    Parameters:
    
    showSubchannelMessagesOnly - If false, all messages will be returned. If true, only messages in the subchannel will be returned.
    
    Since:
    
    3.0.149
  - load
```
public void load(PreviousMessageListQuery.MessageListQueryResult handler)
```
    Requests query result for the previous messages. The queried result is passed to handler as list.
    
    Parameters:
    
    handler - Callback handler.
    
    Since:
    
    3.0.66
  - load
```
public void load(int limit,
                 boolean reverse,
                 PreviousMessageListQuery.MessageListQueryResult handler)
```
    Requests query result for the previous messages. The queried result is passed to handler as list.
    
    Parameters:
    
    limit - Maximum number of previous messages to load.
    
    reverse - If true the queried result will be returned by creation time descending order.
    
    handler - Callback handler.
  - getChannel
```
public BaseChannel getChannel()
```
    Current channel.
    
    Returns:
    
    a current group channel.
    
    Since:
    
    3.0.136
  - getMessageTimestamp
```
public long getMessageTimestamp()
```
    Returns the time of a request.
    
    Returns:
    
    Timestamp in milliseconds.
    
    Since:
    
    3.0.136
  - getLimit
```
public int getLimit()
```
    Returns the maximum number of messages per page.
    
    Returns:
    
    the number of messages per page.
    
    Since:
    
    3.0.136
  - shouldReverse
```
public boolean shouldReverse()
```
    Returns whether the results should be reversed.
    
    Returns:
    
    Whether the results should be reversed.
    
    Since:
    
    3.0.136
  - getMessageTypeFilter
```
public BaseChannel.MessageTypeFilter getMessageTypeFilter()
```
    Returns the BaseChannel.MessageTypeFilter.
    
    Returns:
    
    BaseChannel.MessageTypeFilter.
    
    Since:
    
    3.0.136
  - getCustomTypeFilter
```
public java.lang.String getCustomTypeFilter()
```
    Returns the custom type filter of message.
    
    Returns:
    
    Custom type filter of message.
    
    Since:
    
    3.0.136
  - getSenderUserIdsFilter
```
public java.util.List<java.lang.String> getSenderUserIdsFilter()
```
    Returns the sender user ids filter.
    
    Returns:
    
    The sender user ids filter.
    
    Since:
    
    3.0.136
  - shouldIncludeMetaArray
```
public boolean shouldIncludeMetaArray()
```
    Returns whether the meta array should be included in the results.
    
    Returns:
    
    Whether the meta array should be included in the results.
    
    Since:
    
    3.0.136
  - shouldIncludeReactions
```
public boolean shouldIncludeReactions()
```
    Returns whether the reaction data should be included in the results.
    
    Returns:
    
    Whether the reaction data should be included in the results.
    
    Since:
    
    3.0.136
  - isIncludeThreadInfo
```
public boolean isIncludeThreadInfo()
```
    Returns whether to include the thread information of the returned messages in the results when the results contain parent messages.
    
    Returns:
    
    Whether to include the thread information of the returned messages in the results when the results contain parent messages.
    
    Since:
    
    3.0.136
  - shouldIncludeReplies
```
public boolean shouldIncludeReplies()
```
    Returns whether the replies should be included in the results.
    
    Returns:
    
    Whether the replies should be included in the results.
    
    Since:
    
    3.0.136
  - shouldIncludeParentMessageText
```
public boolean shouldIncludeParentMessageText()
```
    Returns whether the text of a parent message should be included in the reply messages included in the results.
    
    Returns:
    
    Whether the text of a parent message should be included in the reply messages included in the results.
    
    Since:
    
    3.0.136
  - shouldShowSubchannelMessagesOnly
```
public boolean shouldShowSubchannelMessagesOnly()
```
    If set to true, only messages that belong to current user's subchannel is fetched. If set to false, all messages will be fetched. Default is false. Takes effect only when the requested channel is a dynamically partitioned open channel.
    
    Returns:
    
    whether only the messages that belong to a subchannel should be fetched.
    
    Since:
    
    3.0.149

Class PreviousMessageListQuery

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasMore

isLoading

setLimit

setReverse

setMessageTypeFilter

setCustomTypeFilter

setCustomTypesFilter

setSenderUserIdsFilter

setIncludeMetaArray

setIncludeReactions

setIncludeThreadInfo

setIncludeReplies

setIncludeParentMessageText

setShowSubchannelMessagesOnly

load

load

getChannel

getMessageTimestamp

getLimit

shouldReverse

getMessageTypeFilter

getCustomTypeFilter

getSenderUserIdsFilter

shouldIncludeMetaArray

shouldIncludeReactions

isIncludeThreadInfo

shouldIncludeReplies

shouldIncludeParentMessageText

shouldShowSubchannelMessagesOnly