Class ScheduledMessageListQuery

Description

Represents a query for retrieving a list of scheduled messages.

Hierarchy

  • default
    • ScheduledMessageListQuery

Properties

channelUrl limit messageTypeFilter order reverse scheduledStatus

Accessors

hasNext isLoading

Methods

next

Properties

Readonly channelUrl

channelUrl: null | string = null

Description

The scheduled messages in specified channel will be retrieved.

Readonly limit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Readonly messageTypeFilter

messageTypeFilter: MessageTypeFilter = MessageTypeFilter.ALL

Description

Message type filter of scheduled messages.

Readonly order

order: null | ScheduledMessageListOrder = null

Description

The result order of scheduled messages.

Readonly reverse

reverse: boolean = false

Description

Determines whether to list the retrieved messages in reverse order.

Readonly scheduledStatus

scheduledStatus: null | ScheduledStatus[] = null

Description

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

Accessors

hasNext

  • get hasNext(): boolean

  • Returns boolean

    Description

    Whether there is a next page.

isLoading

  • get isLoading(): boolean

  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

next

  • Returns Promise<BaseMessage[]>

    Description

    Requests query result for the scheduled messages.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc