Class PaginationData

Class for storing and modifying pagination data.

Hierarchy

Constructors

constructor

Properties

_afterSending _buttons _collector _collectorOptions _currentPage _embeds _filterOptions _isActive _onStop _time

Accessors

afterSending buttons collector collectorOptions currentPage embeds filterOptions isActive onStop time

Methods

_setActive _setCollector _setCurrentPage _setTime _setup getButtonByCustomId insertEmbeds removeEmbeds setAfterSendingAction setButtons setCollectorOptions setEmbeds setFilterOptions setOnStopAction setTime

Constructors

constructor

Properties

Private _afterSending

_afterSending: AfterSending

Private _buttons

_buttons: ButtonData[] = []

Private _collector

_collector: InteractionCollector<ButtonInteraction<CacheType>>

Private _collectorOptions

_collectorOptions: CollectorOptions

Private _currentPage

_currentPage: number = 0

Private _embeds

_embeds: MessageEmbed[] = []

Private _filterOptions

_filterOptions: FilterOptions = ...

Private _isActive

_isActive: boolean = false

Private _onStop

_onStop: OnStop

Private _time

_time: number = 0

Accessors

afterSending

  • get afterSending(): null | AfterSending

  • Action that will be completed after the pagination was sent.

    Returns null | AfterSending

buttons

  • get buttons(): null | ButtonData[]

  • The buttons of this pagination. By default is an empty array.

    Returns null | ButtonData[]

collector

  • get collector(): null | InteractionCollector<ButtonInteraction<CacheType>>

  • Collector that collects button interactions.

    Returns null | InteractionCollector<ButtonInteraction<CacheType>>

collectorOptions

currentPage

  • get currentPage(): number

  • Current page number. Zero-based. By default is zero.

    Returns number

embeds

  • get embeds(): null | MessageEmbed[]

  • Embeds of this pagination. By default is an empty array.

    Returns null | MessageEmbed[]

filterOptions

  • get filterOptions(): null | FilterOptions

  • Options for filtering button interactions. By default singleUserAccess and noAccessReply are true. And noAccessReplyContent is "You're disallowed to use this very pagination!".

    Returns null | FilterOptions

isActive

  • get isActive(): boolean

  • Indicates whether this pagination sent or not. By default is false.

    Returns boolean

onStop

  • get onStop(): null | OnStop

  • Action that will be completed after the pagination was stopped.

    Returns null | OnStop

time

  • get time(): null | number

  • How long the pagination will exist (in milliseconds). By default is zero.

    Returns null | number

Methods

Protected _setActive

  • _setActive(active?: boolean): boolean

  • Sets active state.

    Returns

    Active state.

    Parameters

    • active: boolean = true

      Whether to set pagination as active.

    Returns boolean

Protected _setCollector

  • _setCollector(collector: InteractionCollector<ButtonInteraction<CacheType>>): InteractionCollector<ButtonInteraction<CacheType>>

  • Sets collector of the pagination.

    Returns

    Collector that collects button interactions.

    Parameters

    • collector: InteractionCollector<ButtonInteraction<CacheType>>

      Collector that collects button interactions.

    Returns InteractionCollector<ButtonInteraction<CacheType>>

Protected _setCurrentPage

  • _setCurrentPage(page?: number): number

  • Sets current page number.

    Returns

    Number of the current page.

    Parameters

    • page: number = 0

      Number of the page.

    Returns number

Protected _setTime

  • _setTime(time: number): number

  • Sets life-time of pagination.

    Returns

    Time in milliseconds.

    Parameters

    • time: number

      Time in milliseconds.

    Returns number

Private _setup

  • _setup(data: PaginationData): void

  • Setups pagination data from another pagination data.

    Returns

    Parameters

    Returns void

getButtonByCustomId

  • Gets ButtonData by it's customId.

    Returns

    Button data.

    Parameters

    • customId: string

      Button's customId. Should be a string.

    Returns undefined | ButtonData

insertEmbeds

  • Inserts embeds.

    Returns

    Pagination.

    Parameters

    • embeds: MessageEmbed | MessageEmbed[]

      Embed(-s) that is/are meant to be inserted.

    • Optional index: number

      Zero-based location in the array there the embed(-s) should be inserted.

    Returns PaginationData

removeEmbeds

  • Removes embed(-s) by it's/theirs index(-es) in the array of embeds.

    Returns

    Pagination.

    Parameters

    • index: number

      Zero-based location in the array from which to start removing embeds.

    • count: number = 1

      Quantity of embeds to remove.

    Returns PaginationData

setAfterSendingAction

setButtons

setCollectorOptions

setEmbeds

  • Sets embed(-s). Overrides current embed(-s).

    Returns

    Pagination.

    Parameters

    • embeds: MessageEmbed | MessageEmbed[]

      Embed(-s) that is/are meant to be set.

    Returns PaginationData

setFilterOptions

setOnStopAction

  • Sets action that will be completed after the pagination was stopped.

    Returns

    Pagination.

    Parameters

    • action: OnStop

      Action that will be completed.

    Returns PaginationData

setTime

  • Sets pagination active phase duration.

    Returns

    Pagination.

    Parameters

    • time: number

      Time in milliseconds.

    • Optional bypassLibraryLimits: boolean

      Should the time bypass library limit or not.

    Returns PaginationData

Settings

Member Visibility

Theme

Generated using TypeDoc