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

Constructors

Link copied to clipboard
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

Link copied to clipboard

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

Link copied to clipboard
var limit: Int

The maximum number of items per queried page.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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