Interface ScheduledMessageListQueryParams

interface ScheduledMessageListQueryParams {
    channelUrl?: string;
    limit?: number;
    messageTypeFilter?: MessageTypeFilter;
    order?: ScheduledMessageListOrder;
    reverse?: boolean;
    scheduledStatus?: ScheduledStatus[];
}

Hierarchy

BaseListQueryParams
- ScheduledMessageListQueryParams

Index

Properties

channelUrl? limit? messageTypeFilter? order? reverse? scheduledStatus?

Properties

`Optional`channelUrl

channelUrl?: string

Description

The scheduled messages in specified channel will be retrieved.

`Optional`limit

limit?: number

Description

The maximum number of data per queried page.

`Optional`messageTypeFilter

messageTypeFilter?: MessageTypeFilter

Description

Message type filter of scheduled messages.

`Optional`order

order?: ScheduledMessageListOrder

Description

The result order of scheduled messages.

`Optional`reverse

reverse?: boolean

Description

Determines whether to list the retrieved messages in reverse order.

`Optional`scheduledStatus

scheduledStatus?: ScheduledStatus[]

Description

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