Constructor Detail

• MessageRetrievalParams

  MessageRetrievalParams(String channelUrl, BaseChannel.ChannelType channelType, long messageId)

  Create a MessageRetrievalParams 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 - If true 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 - If true 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 - If true 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 - If true 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.

• toString

   String toString()