Class PaginationSent

Class that represents pagination that is already sent.

Hierarchy

  • PaginationSent

Constructors

constructor

Properties

_collector _state

Accessors

attachedTo data isActive page state

Methods

_buildActionRows _buildPagedActionRows _collected _formCollector _formFilter _stopped delete getButtonByCustomId init setPage stop update

Constructors

constructor

  • Class that represents pagination that is already sent.

    Parameters

    • _data: PaginationData

      Embeds, buttons and so on.

    • _message: Message<boolean> | Interaction<CacheType> & InteractionResponseFields<CacheType>

      Message or interaction that pagination should be assigned to.

    • _page: number = 0

      Page which pagination should start from.

    • _beforeStopAction: StopAction = undefined

      Action that is completed before the pagination is stopped.

    • _onStopAction: StopAction = undefined

      Action that is completed after the pagination is stopped.

    Returns PaginationSent

Properties

Private _collector

_collector: InteractionCollector<ButtonInteraction<CacheType>>

Private _state

_state: PaginationState = PaginationState.NotReady

Accessors

attachedTo

  • get attachedTo(): Message<boolean> | Interaction<CacheType> & InteractionResponseFields<CacheType>

  • Returns

    Message or interaction that pagination should be assigned to.

    Returns Message<boolean> | Interaction<CacheType> & InteractionResponseFields<CacheType>

data

isActive

  • get isActive(): boolean

  • Returns

    Is pagination active or not.

    Returns boolean

page

  • get page(): number

  • Returns

    Current page.

    Returns number

state

Methods

Private _buildActionRows

  • _buildActionRows(disabled?: boolean): MessageActionRow<MessageButton, MessageActionRowComponentResolvable, APIActionRowComponent<APIMessageActionRowComponent>>[]

  • Builds action rows with enabled or disabled buttons.

    Returns

    Parameters

    • disabled: boolean = false

      Should be buttons disabled or not.

    Returns MessageActionRow<MessageButton, MessageActionRowComponentResolvable, APIActionRowComponent<APIMessageActionRowComponent>>[]

Private _buildPagedActionRows

  • _buildPagedActionRows(): Promise<MessageActionRow<MessageButton, MessageActionRowComponentResolvable, APIActionRowComponent<APIMessageActionRowComponent>>[]>

  • Builds action rows for specific page.

    Returns

    Returns Promise<MessageActionRow<MessageButton, MessageActionRowComponentResolvable, APIActionRowComponent<APIMessageActionRowComponent>>[]>

Private _collected

  • _collected(interaction: ButtonInteraction<CacheType>): Promise<void>

  • Called than the collector collects interaction.

    Returns

    Parameters

    • interaction: ButtonInteraction<CacheType>

      Interaction that is fired.

    Returns Promise<void>

Private _formCollector

  • _formCollector(): Promise<void>

  • Forms collector for pages.

    Returns

    Returns Promise<void>

Private _formFilter

  • _formFilter(messageId: string): ((interaction: ButtonInteraction<CacheType>) => Promise<boolean>)

  • Forms filtering function for collector.

    Returns

    Parameters

    • messageId: string

      Reply id.

    Returns ((interaction: ButtonInteraction<CacheType>) => Promise<boolean>)

      • (interaction: ButtonInteraction<CacheType>): Promise<boolean>

      • Forms filtering function for collector.

        Returns

        Parameters

        • interaction: ButtonInteraction<CacheType>

        Returns Promise<boolean>

Private _stopped

  • _stopped(reason: string): Promise<void>

  • Called than the pagination stopped.

    Returns

    Parameters

    • reason: string

      Reason why the pagination is stopped.

    Returns Promise<void>

delete

  • Deletes pagination and stops it. If pagination is an ephemeral interaction stops it instead.

    Returns

    Returns Promise<void>

getButtonByCustomId

  • Gets button by custom id.

    Returns

    Button wrapper.

    Parameters

    • customId: string

      Custom id.

    Returns ButtonWrapper

init

  • Initializes pagination. Can be called only once. Default pagination wrapper calls it so you shouldn't.

    Returns

    Returns Promise<PaginationSent>

setPage

  • Switches pagination to the next page. It does not update the pagination, so you should call update by yourself!

    Returns

    Parameters

    • page: number

      Page number.

    Returns PaginationSent

stop

  • Stops pagination.

    Returns

    Returns void

update

  • Updates pagination state.

    Returns

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc