Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DiscordEmbedMenu

Hierarchy

  • EventEmitter
    • DiscordEmbedMenu

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DiscordEmbedMenu(channel: TextChannel, user: User, pages: any[], timeout?: number, deleteOnTimeout?: boolean, mention?: boolean, keepUserReactionOnStop?: boolean, loadingMessage?: string): DiscordEmbedMenu

  • Parameters

    • channel: TextChannel
    • user: User
    • pages: any[]
    • timeout: number = 300000
    • deleteOnTimeout: boolean = true
    • mention: boolean = true
    • keepUserReactionOnStop: boolean = true
    • Optional loadingMessage: string

    Returns DiscordEmbedMenu

Properties

channel

channel: TextChannel

currentPage

currentPage: DiscordEmbedMenuPage

data

data: any = {}

deleteOnTimeout

deleteOnTimeout: boolean

Private isDM

isDM: boolean

keepUserReactionOnStop

keepUserReactionOnStop: boolean

loadingMessage

loadingMessage: string

mention

mention: boolean

menu

menu: null | Message = null

pageIndex

pageIndex: number

pages

pages: any[]

reactionCollector

reactionCollector: null | ReactionCollector = null

timeout

timeout: number

user

user: User

Private userTag

userTag: string

Static Private LOADING_MESSAGE

LOADING_MESSAGE: string = 'Loading, please be patient...'

Static Private Readonly REQUIRED_PERMS

REQUIRED_PERMS: PermissionString[] = ...

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

Private addReactions

  • addReactions(): Promise<MessageReaction[]>

Private awaitReactions

  • awaitReactions(): void

Private clearReactions

  • clearReactions(): Promise<void | Message>

delete

  • delete(): Promise<void | Message>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

on

  • on(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

once

  • once(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns DiscordEmbedMenu

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): DiscordEmbedMenu

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns DiscordEmbedMenu

setMaxListeners

  • Parameters

    • n: number

    Returns DiscordEmbedMenu

setPage

  • setPage(page?: string | number): Promise<void>

start

  • start(): Promise<void>

stop

  • stop(): Promise<void | Message>

Private stopReactions

  • stopReactions(triggerEnd?: boolean): void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc