SendbirdChat/com.sendbird.android.params/BaseMessageListParams

BaseMessageListParams

Represents a base for message list params.

Inheritors

Constructors

constructor(previousResultSize: Int, nextResultSize: Int, messageTypeFilter: MessageTypeFilter?, customType: String?, senderUserIds: List<String>?, isInclusive: Boolean, reverse: Boolean, messagePayloadFilter: MessagePayloadFilter)

constructor(previousResultSize: Int, nextResultSize: Int, messageTypeFilter: MessageTypeFilter?, customTypes: Collection<String>?, senderUserIds: List<String>?, isInclusive: Boolean, reverse: Boolean, messagePayloadFilter: MessagePayloadFilter)

constructor()

Properties

customType

var customType: String?

Restricts the search scope only to retrieve the messages with the specified custom message type. When the custom type filtering is not needed, the value should be set to null.

customTypes

var customTypes: Collection<String>?

Restricts the search scope only to retrieve the messages that match any of given custom types. When the custom type filtering is not needed, the value should be set to null. When a empty string is given, messages that does not have a custom type will also be returned.

inclusive

var inclusive: Boolean

Determines whether to include the messages sent exactly on the specified timestamp or have the matching message ID in the results.

messagePayloadFilter

var messagePayloadFilter: MessagePayloadFilter

Sets the MessagePayloadFilter to be used in retrieving message lists. This is more preferred way of setting other include flags.

messageTypeFilter

var messageTypeFilter: MessageTypeFilter

Restricts the search scope only to retrieve the messages with the specified message type.

nextResultSize

var nextResultSize: Int

The number of newer messages added either before the timestamp or the message that has a specific message ID.

previousResultSize

var previousResultSize: Int

The number of previous messages added either before the timestamp or the message that has a specific message ID.

reverse

var reverse: Boolean

Determines whether to sort the retrieved messages in reverse order.

senderUserIds

var senderUserIds: List<String>?

Restricts the search scope only to retrieve the messages sent by the users with the specified user IDs. When the user ID filtering is not needed, the value should be set to null.

Functions

belongsTo

open fun belongsTo(message: BaseMessage): Boolean

Verify that the given channel information matches the current query filter.

open fun belongsTo(params: BaseMessageCreateParams): Boolean

Verify that the given BaseMessageCreateParams information matches the current query filter.

toString

open override fun toString(): String