-
public class MessageRetrievalParams
Represents a message list params. getMessage.
-
-
Field Summary
Fields Modifier and Type Field Description protected final String
channelUrl
protected final BaseChannel.ChannelType
channelType
protected final long
messageId
protected MessagePayloadFilter
messagePayloadFilter
protected boolean
includeMetaArray
protected boolean
includeThreadInfo
protected boolean
includeParentMessageText
private boolean
includePollDetails
-
Constructor Summary
Constructors Constructor Description MessageRetrievalParams(String channelUrl, BaseChannel.ChannelType channelType, long messageId)
Create a MessageRetrievalParams
to use in getMessage.
-
Method Summary
Modifier and Type Method Description String
getChannelUrl()
Returns the channel url. BaseChannel.ChannelType
getChannelType()
Returns the BaseChannel.ChannelType. long
getMessageId()
Returns the message ID. MessagePayloadFilter
getMessagePayloadFilter()
Returns the MessagePayloadFilter set in this param. void
setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
Sets the MessagePayloadFilter to be used in retrieving message.This is more preferred way of setting other include flags. void
setIncludeMetaArray(boolean includeMetaArray)
Determines whether a meta array of the message is included in the results. void
setIncludeThreadInfo(boolean includeThreadInfo)
Determines whether the thread information is included in the results set when the returned message is a parent message. void
setIncludeParentMessageText(boolean includeParentMessageText)
Determines whether the text of a parent message is included in the results when the returned message is a reply in a thread. void
setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results. boolean
shouldIncludeMetaArray()
Returns whether the result message should include meta array. boolean
shouldIncludeThreadInfo()
Returns whether the thread information is included in the results set when the returned message is a parent message. boolean
shouldIncludeParentMessageText()
Returns whether the text of a parent message is included in the results when the returned message is a reply in a thread. boolean
shouldIncludePollDetails()
Returns whether to include the poll of the returned messages in the results. MessageRetrievalParams
clone()
Clones and returns a new instance of MessageRetrievalParams
.String
toString()
-
-
Constructor Detail
-
MessageRetrievalParams
MessageRetrievalParams(String channelUrl, BaseChannel.ChannelType channelType, long messageId)
Create aMessageRetrievalParams
to use in getMessage.- Parameters:
channelUrl
- Specifies the URL of the channel to retrieve the message.channelType
- Specifies the type of the channel.messageId
- Specifies the unique ID of the message to retrieve.
-
-
Method Detail
-
getChannelUrl
String getChannelUrl()
Returns the channel url.
-
getChannelType
BaseChannel.ChannelType getChannelType()
Returns the BaseChannel.ChannelType.
-
getMessageId
long getMessageId()
Returns the message ID.
-
getMessagePayloadFilter
MessagePayloadFilter getMessagePayloadFilter()
Returns the MessagePayloadFilter set in this param.
-
setMessagePayloadFilter
void setMessagePayloadFilter(MessagePayloadFilter messagePayloadFilter)
Sets the MessagePayloadFilter to be used in retrieving message.This is more preferred way of setting other include flags.
- Parameters:
messagePayloadFilter
- MessagePayloadFilter with preferred filters set.
-
setIncludeMetaArray
void setIncludeMetaArray(boolean includeMetaArray)
Determines whether a meta array of the message is included in the results.Internally, this will be set on setIncludeMetaArray.
- Parameters:
includeMetaArray
- Iftrue
the result will be returned with meta arrays included.
-
setIncludeThreadInfo
void setIncludeThreadInfo(boolean includeThreadInfo)
Determines whether the thread information is included in the results set when the returned message is a parent message.Internally, this will be set on setIncludeThreadInfo.
- Parameters:
includeThreadInfo
- Iftrue
the result will be returned with thread information included.
-
setIncludeParentMessageText
@Deprecated() void setIncludeParentMessageText(boolean includeParentMessageText)
Determines whether the text of a parent message is included in the results when the returned message is a reply in a thread.Internally, this will be set on setIncludeParentMessageInfo.
- Parameters:
includeParentMessageText
- Iftrue
the result will be returned with messages with parent's message's text, if the message is a reply message.
-
setIncludePollDetails
void setIncludePollDetails(boolean includePollDetails)
Determines whether to include the poll of the returned messages in the results.Internally, this will be set on setIncludePollDetails.
- Parameters:
includePollDetails
- Iftrue
the queried result will be returned with poll.
-
shouldIncludeMetaArray
boolean shouldIncludeMetaArray()
Returns whether the result message should include meta array.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeThreadInfo
boolean shouldIncludeThreadInfo()
Returns whether the thread information is included in the results set when the returned message is a parent message.Can also be checked by getMessagePayloadFilter.
-
shouldIncludeParentMessageText
@Deprecated() boolean shouldIncludeParentMessageText()
Returns whether the text of a parent message is included in the results when the returned message is a reply in a thread.Can also be checked by getMessagePayloadFilter.
-
shouldIncludePollDetails
boolean shouldIncludePollDetails()
Returns whether to include the poll of the returned messages in the results.Can also be checked by getMessagePayloadFilter.
-
clone
MessageRetrievalParams clone()
Clones and returns a new instance of
MessageRetrievalParams
.
-
-
-
-