Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventsHandler<Events>

Responsible for handling all of the Bot's events

Type parameters

  • Events

Hierarchy

  • TypedEventEmitter
    • EventsHandler

Implements

Index

Events

CHANNEL_CREATE

  • CHANNEL_CREATE(channel: Channel): any

CHANNEL_DELETE

  • CHANNEL_DELETE(channel: Channel): any

CHANNEL_PINS_UPDATE

  • Sent when a message is pinned or unpinned in a text channel. This is not sent when a pinned message is deleted

    asmemberof

    EventsHandler

    Parameters

    • channel: TextBasedChannel

      The channel which pins were updated

    • oldPinTimestamp: Timestamp | undefined

      The previous last pin timestamp

    Returns any

CHANNEL_UPDATE

GUILD_BAN_ADD

GUILD_BAN_REMOVE

  • GUILD_BAN_REMOVE(ban: GuildBan | undefined): any
  • Sent when a user is unbanned from a guild.

    asmemberof

    EventsHandler

    Parameters

    • ban: GuildBan | undefined

      The guild ban object. Possibly undefined if the ban is yet to be cached

    Returns any

GUILD_CREATE

GUILD_DELETE

GUILD_EMOJIS_UPDATE

GUILD_INTEGRATIONS_UPDATE

  • GUILD_INTEGRATIONS_UPDATE(guild: Guild): any

GUILD_MEMBERS_CHUNK

  • Sent in response to a Guild Members request

    asmemberof

    EventsHandler

    Parameters

    • guild: Guild

      The guild whose members were requested

    • nonce: string | undefined

      The nonce used in the Guild Members Request

    • chunk: GuildMembersChunk

      The information for the chunk that activated this event

    Returns any

GUILD_MEMBERS_CHUNK_FINISH

  • GUILD_MEMBERS_CHUNK_FINISH(guild: Guild, nonce: string | undefined): any
  • Sent when all Guild Member Chunks for a request are collected

    asmemberof

    EventsHandler

    Parameters

    • guild: Guild

      The guild whose members were requested

    • nonce: string | undefined

      The nonce used in the Guild Members Request

    Returns any

GUILD_MEMBER_ADD

  • GUILD_MEMBER_ADD(member: Member): any

GUILD_MEMBER_REMOVE

GUILD_MEMBER_UPDATE

  • Sent when a guild member is updated. This will also fire when the user object of a guild member changes.

    asmemberof

    EventsHandler

    Parameters

    • before: Member

      The member before being updated

    • after: Member

      The member after being updated

    Returns any

GUILD_ROLE_CREATE

  • GUILD_ROLE_CREATE(role: Role): any

GUILD_ROLE_DELETE

  • GUILD_ROLE_DELETE(role: Role): any

GUILD_ROLE_UPDATE

  • GUILD_ROLE_UPDATE(before: Role, after: Role): any

GUILD_UPDATE

INVITE_CREATE

  • INVITE_CREATE(invite: Invite): any

INVITE_DELETE

MESSAGE_CREATE

  • MESSAGE_CREATE(message: Message): any

MESSAGE_DELETE

MESSAGE_DELETE_BULK

MESSAGE_REACTION_ADD

MESSAGE_REACTION_REMOVE

MESSAGE_REACTION_REMOVE_ALL

  • MESSAGE_REACTION_REMOVE_ALL(message: Message): any
  • Sent when a user explicitly removes all reactions from a message.

    asmemberof

    EventsHandler

    Parameters

    • message: Message

      The message of which reactions were removed

    Returns any

MESSAGE_REACTION_REMOVE_EMOJI

  • MESSAGE_REACTION_REMOVE_EMOJI(reaction: MessageReaction | undefined): any
  • Sent when a bot removes all instances of a given emoji from the reactions of a message.

    asmemberof

    EventsHandler

    Parameters

    • reaction: MessageReaction | undefined

      The reaction associated to the emoji which was removed in its original state.

    Returns any

MESSAGE_UPDATE

PRESENCE_UPDATE

READY

  • READY(): any

SHARD_CLOSE

SHARD_READY

TYPING_START

  • Sent when a user starts typing in a channel.

    asmemberof

    EventsHandler

    Parameters

    • channel: TextBasedChannel | undefined

      The channel the user started typing in

    • user: Member | User | undefined

      The user that started typing

    • startedAt: number

      The unix time (in seconds) of when the user started typing

    Returns any

USER_UPDATE

  • USER_UPDATE(before: User, after: User): any
  • Sent when properties about the Bot's user change

    asmemberof

    EventsHandler

    Parameters

    • before: User

      The user before being updated

    • after: User

      The user after being updated

    Returns any

WEBHOOKS_UPDATE

Methods

addListener

  • addListener<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

emit

  • emit<E>(event: E, ...args: Arguments<Events[E]>): boolean
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • Rest ...args: Arguments<Events[E]>

    Returns boolean

eventNames

  • eventNames(): (string | symbol | keyof Events)[]
  • Returns (string | symbol | keyof Events)[]

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount<E>(event: E): number
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E

    Returns number

listeners

  • listeners<E>(event: E): Function[]
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E

    Returns Function[]

off

  • off<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

on

  • on<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

once

  • once<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

prependListener

  • prependListener<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

prependOnceListener

  • prependOnceListener<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

rawListeners

  • rawListeners<E>(event: E): Function[]
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E

    Returns Function[]

register

  • register<T>(event: Event<T>): void

removeAllListeners

  • removeAllListeners<E>(event?: E): this
  • Type parameters

    • E: keyof Events

    Parameters

    • Optional event: E

    Returns this

removeListener

  • removeListener<E>(event: E, listener: Events[E]): this
  • Type parameters

    • E: keyof Events

    Parameters

    • event: E
    • listener: Events[E]

    Returns this

setMaxListeners

  • setMaxListeners(maxListeners: number): this
  • Parameters

    • maxListeners: number

    Returns this

wait

  • wait<T, TParams>(name: T): Promise<TParams>
  • Asynchronously waits until an event is executed, and returns its arguments in an array

    example
    // Waits until the event is called
    const [ message ] = await bot.events.wait(BotEvents.MessageCreate);
    // You can now use 'message'...

    @param {T} name The name of the event @returns {Promise} The arguments of the event in an array @template E - the event name

    Type parameters

    • T: keyof Events

    • TParams: Parameters<Events[T]>

    Parameters

    • name: T

    Returns Promise<TParams>

Generated using TypeDoc