SendbirdChat/com.sendbird.android.params/MessageListParams

MessageListParams

class MessageListParams : BaseMessageListParams

Represents a message list params.

Since

3.0.130

Constructors

MessageListParams

constructor()

@JvmOverloads

constructor(previousResultSize: Int, nextResultSize: Int, messageTypeFilter: MessageTypeFilter?, customTypes: Collection<String>?, senderUserIds: List<String>?, inclusive: Boolean, reverse: Boolean, messagePayloadFilter: MessagePayloadFilter, replyType: ReplyType, showSubchannelMessagesOnly: Boolean = false)

@JvmOverloads

constructor(previousResultSize: Int, nextResultSize: Int, messageTypeFilter: MessageTypeFilter?, customType: String?, senderUserIds: List<String>?, inclusive: Boolean, reverse: Boolean, messagePayloadFilter: MessagePayloadFilter, replyType: ReplyType, showSubchannelMessagesOnly: Boolean = false)

Types

Companion

object Companion

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.

replyType

var replyType: ReplyType

Determines the reply types to include in the results.

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.

showSubchannelMessagesOnly

var showSubchannelMessagesOnly: Boolean

Whether to show subchannel message only. Defaults to false. This only takes effect when the requested channel is a dynamically partitioned OpenChannel.

Functions

belongsTo

open override fun belongsTo(message: BaseMessage): Boolean

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

open override fun belongsTo(params: BaseMessageCreateParams): Boolean

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

clone

fun clone(): MessageListParams

Clones and returns a new instance of MessageListParams.

copy

fun copy(previousResultSize: Int = this.previousResultSize, nextResultSize: Int = this.nextResultSize, messageTypeFilter: MessageTypeFilter = this.messageTypeFilter, customType: String? = this.customType, customTypes: Collection<String>? = this.refinedCustomTypes, senderUserIds: List<String>? = this.senderUserIds, inclusive: Boolean = this.inclusive, reverse: Boolean = this.reverse, messagePayloadFilter: MessagePayloadFilter = this.messagePayloadFilter, replyType: ReplyType = this.replyType, showSubchannelMessagesOnly: Boolean = this.showSubchannelMessagesOnly): MessageListParams

toString

open override fun toString(): String

MessageListParams

Since

See also

Constructors

Types

Properties

Functions