SendbirdChat/com.sendbird.android.params/ScheduledMessageListQueryParams

ScheduledMessageListQueryParams

data class ScheduledMessageListQueryParams @JvmOverloads constructor(var order: ScheduledMessageListQuery.Order = Order.CREATED_AT, var messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, var reverse: Boolean = false, var channelUrl: String? = null, var scheduledStatus: List<ScheduledStatus>? = null, var limit: Int = QUERY_DEFAULT_LIMIT)

Params for creating a ScheduledMessageListQuery object.

Since

4.0.0

See also

ScheduledMessageListQuery

SendbirdChat.createScheduledMessageListQuery

Constructors

ScheduledMessageListQueryParams

constructor(order: ScheduledMessageListQuery.Order = Order.CREATED_AT, messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL, reverse: Boolean = false, channelUrl: String? = null, scheduledStatus: List<ScheduledStatus>? = null, limit: Int = QUERY_DEFAULT_LIMIT)

Properties

var channelUrl: String?

The scheduled messages in specified channel will be retrieved. Defaults to null.

The maximum number of items per queried page.

messageTypeFilter

var messageTypeFilter: MessageTypeFilter

Message type filter of scheduled messages. Defaults to MessageTypeFilter.ALL.

var order: ScheduledMessageListQuery.Order

The result order of scheduled messages. Defaults to Order.CREATED_AT.

var reverse: Boolean

Determines whether to list the retrieved messages in reverse order. Defaults to false.

scheduledStatus

var scheduledStatus: List<ScheduledStatus>?

The target scheduled status of the scheduled messages to be retrieved. Defaults to null.