Description

A class representing query to retrieve lists related to pinned messages.

Hierarchy

  • default
    • PinnedMessageListQuery

Properties

channelType: ChannelType

Description

A channel type.

channelUrl: string

Description

A channel URL.

includeMetaArray?: boolean

Description

Whether the meta arrays should be included in the results. If the value is null, it follows the default value.

includeParentMessageInfo?: boolean

Description

Whether the information of a parent message should be included in the reply messages included in the results.

includePollDetails?: boolean

Description

Whether the poll details should be included in the results.

includeReactions?: boolean

Description

Whether the reaction data should be included in the results. If the value is null, it follows the default value.

includeThreadInfo?: boolean

Description

Whether the thread information should be included in the results. If the value is null, it follows the default value.

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Description

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<PinnedMessage[]>

    Description

    Gets the list of PinnedMessages. If this method is repeatedly called after each next is finished, it retrieves the following pages of the PinnedMessage list. If there is no more pages to be read, an empty List (not null) is returned.

Generated using TypeDoc