Interface ClientEvents

Hierarchy

ClientEvents

Index

Events

applicationCommandPermissionsUpdate autoModerationActionExecution autoModerationRuleCreate autoModerationRuleDelete autoModerationRuleUpdate channelCreate channelDelete channelPinsUpdate channelUpdate connect debug disconnect error guildAuditLogEntryCreate guildAvailable guildBanAdd guildBanRemove guildCreate guildDelete guildEmojisUpdate guildIntegrationsUpdate guildMemberAdd guildMemberChunk guildMemberRemove guildMemberUpdate guildRoleCreate guildRoleDelete guildRoleUpdate guildScheduledEventCreate guildScheduledEventDelete guildScheduledEventUpdate guildScheduledEventUserAdd guildScheduledEventUserRemove guildStickersUpdate guildUnavailable guildUpdate hello integrationCreate integrationDelete integrationUpdate interactionCreate inviteCreate inviteDelete messageCreate messageDelete messageDeleteBulk messageReactionAdd messageReactionRemove messageReactionRemoveAll messageReactionRemoveEmoji messageUpdate packet presenceUpdate ready request shardDisconnect shardPreReady shardReady shardResume stageInstanceCreate stageInstanceDelete stageInstanceUpdate threadCreate threadDelete threadListSync threadMemberUpdate threadMembersUpdate threadUpdate typingStart unavailableGuildCreate userUpdate voiceChannelEffectSend voiceChannelJoin voiceChannelLeave voiceChannelSwitch voiceStateUpdate warn webhooksUpdate

Events

applicationCommandPermissionsUpdate

applicationCommandPermissionsUpdate: [guild: Uncached | Guild, permissions: GuildApplicationCommandPermissions]

Emitted when an application command's permissions are updated.

autoModerationActionExecution

autoModerationActionExecution: [guild: Uncached | Guild, channel: null | Uncached | AnyTextableGuildChannel, user: Uncached | User, executionOptions: AutoModerationActionExecution]

Emitted when an auto moderation action is executed. Requires the AUTO_MODERATION_EXECUTION intent.

autoModerationRuleCreate

autoModerationRuleCreate: [rule: AutoModerationRule]

Emitted when an auto moderation rule is created. Requires the AUTO_MODERATION_CONFIGURATION intent.

autoModerationRuleDelete

autoModerationRuleDelete: [rule: AutoModerationRule]

Emitted when an auto moderation rule is deleted. Requires the AUTO_MODERATION_CONFIGURATION intent.

autoModerationRuleUpdate

autoModerationRuleUpdate: [rule: AutoModerationRule, oldRule: null | JSONAutoModerationRule]

Emitted when an auto moderation rule is updated. Requires the AUTO_MODERATION_CONFIGURATION intent.

channelCreate

channelCreate: [channel: AnyGuildChannelWithoutThreads | GroupChannel]

Emitted when a channel is created. Guild channels require the GUILDS intent.

channelDelete

channelDelete: [channel: AnyGuildChannelWithoutThreads | PrivateChannel | DeletedPrivateChannel]

Emitted when channel is deleted. Requires the GUILDS intent.

channelPinsUpdate

channelPinsUpdate: [channel: Uncached | AnyTextableChannel, timestamp: null | Date]

Emitted when a channel's pins are updated (message pinned, message unpinned). Requires the GUILDS intent for guild channels, and DIRECT_MESSAGES for direct messages.

channelUpdate

Emitted when a channel is updated. Requires the GUILDS intent.

connect

connect: [id: number]

Emitted when a shard connects.

debug

debug: [info: string, shard?: number]

Emitted with various information for debugging.

disconnect

disconnect: []

Emitted when all shards disconnect.

error

error: [info: string | Error, shard?: number]

Emitted when an error happens. If an error is emitted and no handlers are present, the error will be thrown.

guildAuditLogEntryCreate

guildAuditLogEntryCreate: [guild: Uncached | Guild, auditLogEntry: AuditLogEntry]

Emitted when an audit log entry is created. Requires both the GUILD_MODERATION intent, as well as the VIEW_AUDIT_LOG permission.

guildAvailable

guildAvailable: [guild: Guild]

Emitted when a guild becomes available. Requires the GUILDS intent.

guildBanAdd

guildBanAdd: [guild: Uncached | Guild, user: User]

Emitted when a guild ban is created. Requires the GUILD_BANS intent.

guildBanRemove

guildBanRemove: [guild: Uncached | Guild, user: User]

Emitted when a guild ban is revoked. Requires the GUILD_BANS intent.

guildCreate

guildCreate: [guild: Guild]

Emitted when the client joins a new guild. Requires the GUILDS intent.

guildDelete

guildDelete: [guild: Uncached | Guild]

Emitted when the client leaves a guild. Requires the GUILDS intent.

guildEmojisUpdate

guildEmojisUpdate: [guild: Uncached | Guild, emojis: GuildEmoji[], oldEmojis: null | GuildEmoji[]]

Emitted when a guild's emojis are updated. Requires the GUILD_EMOJIS_AND_STICKERS intent.

guildIntegrationsUpdate

guildIntegrationsUpdate: [guild: Uncached | Guild]

Emitted when a guild's integrations are updated. Requires the GUILD_INTEGRATIONS intent.

guildMemberAdd

guildMemberAdd: [member: Member]

Emitted when a member joins a guild. Requires the GUILD_MEMBERS intent.

guildMemberChunk

guildMemberChunk: [members: Member[]]

Emitted when a chunk of guild members is received from Discord.

guildMemberRemove

guildMemberRemove: [member: Member | User, guild: Uncached | Guild]

Emitted when a member leaves a guild. Requires the GUILD_MEMBERS intent. If the member is uncached, the first parameter will be a user. If the guild is uncached, the first parameter will be a user, and the second will be an object with only an id.

guildMemberUpdate

guildMemberUpdate: [member: Member, oldMember: null | JSONMember]

Emitted when a guild member is updates. Requires the GUILD_MEMBERS intent.

guildRoleCreate

guildRoleCreate: [role: Role]

Emitted when a role is created. Requires the GUILDS intent.

guildRoleDelete

guildRoleDelete: [role: Uncached | Role, guild: Uncached | Guild]

Emitted when a role is deleted. Requires the GUILDS intent.

guildRoleUpdate

guildRoleUpdate: [role: Role, oldRole: null | JSONRole]

Emitted when a role is updated. Requires the GUILDS intent.

guildScheduledEventCreate

guildScheduledEventCreate: [event: GuildScheduledEvent]

Emitted when a scheduled event is created. Requires the GUILD_SCHEDULED_EVENTS intent.

guildScheduledEventDelete

guildScheduledEventDelete: [event: GuildScheduledEvent]

Emitted when a scheduled event is deleted. Requires the GUILD_SCHEDULED_EVENTS intent.

guildScheduledEventUpdate

guildScheduledEventUpdate: [event: GuildScheduledEvent, oldEvent: null | JSONScheduledEvent]

Emitted when a scheduled event is updated. Requires the GUILD_SCHEDULED_EVENTS intent.

guildScheduledEventUserAdd

guildScheduledEventUserAdd: [event: Uncached | GuildScheduledEvent, user: Uncached | User]

Emitted when a user subscribes to a scheduled event. Requires the GUILD_SCHEDULED_EVENTS intent.

guildScheduledEventUserRemove

guildScheduledEventUserRemove: [event: Uncached | GuildScheduledEvent, user: Uncached | User]

Emitted when a user unsubscribes from a scheduled event. Requires the GUILD_SCHEDULED_EVENTS intent.

guildStickersUpdate

guildStickersUpdate: [guild: Uncached | Guild, stickers: Sticker[], oldStickers: null | Sticker[]]

Emitted when a guild's stickers are updated. Requires the GUILD_EMOJIS_AND_STICKERS intent.

guildUnavailable

guildUnavailable: [guild: UnavailableGuild]

Emitted when a guild becomes unavailable. Requires the GUILDS intent.

guildUpdate

guildUpdate: [guild: Guild, oldGuild: null | JSONGuild]

Emitted when a guild is updated. Requires the GUILDS intent.

hello

hello: [interval: number, shard: number]

Emitted when a shard receives the HELLO packet.

integrationCreate

integrationCreate: [guild: Uncached | Guild, integration: Integration]

Emitted when an integration is created. Requires the GUILD_INTEGRATIONS intent.

integrationDelete

integrationDelete: [guild: Uncached | Guild, integration: PossiblyUncachedIntegration]

Emitted when an integration is deleted. Requires the GUILD_INTEGRATIONS intent.

integrationUpdate

integrationUpdate: [guild: Uncached | Guild, integration: Integration, oldIntegration: null | JSONIntegration]

Emitted when an integration is updated. Requires the GUILD_INTEGRATIONS intent.

interactionCreate

interactionCreate: [interaction: AnyInteractionGateway]

Emitted when an interaction is created.

inviteCreate

inviteCreate: [invite: Invite<"withMetadata", Uncached | AnyInviteChannel>]

Emitted when an invite is created. Requires the GUILD_INVITES intent, and the MANAGE_CHANNELS permission on the channel.

inviteDelete

inviteDelete: [invite: PossiblyUncachedInvite]

Emitted when an invite is deleted. Requires the GUILD_INVITES intent, and the MANAGE_CHANNELS permission on the channel.

messageCreate

messageCreate: [message: Message<Uncached | AnyTextableChannel>]

Emitted when a message is created. Requires the GUILD_MESSAGES intent for guild messages, DIRECT_MESSAGES for direct messages. The MESSAGE_CONTENT intent is required for content, embeds, and similar to be present on most messages.

messageDelete

messageDelete: [message: PossiblyUncachedMessage]

messageDeleteBulk

messageDeleteBulk: [messages: PossiblyUncachedMessage[]]

Emitted when messages are bulk deleted. Requires the GUILD_MESSAGES intent. The MESSAGE_CONTENT intent is required for content, embeds, and similar to be present on most messages.

messageReactionAdd

messageReactionAdd: [message: Object, reactor: Uncached | Member | User, reaction: PartialEmoji]

Emitted when a reaction is added to a message. For uncached messages, author will not be present if the reaction was added to a webhook message. Requires the GUILD_MESSAGE_REACTIONS for guild messages, and DIRECT_MESSAGE_REACTIONS for direct messages.

messageReactionRemove

messageReactionRemove: [message: PossiblyUncachedMessage, reactor: Uncached | Member | User, reaction: PartialEmoji]

Emitted when a reaction is removed from a message. Requires the GUILD_MESSAGE_REACTIONS for guild messages, and DIRECT_MESSAGE_REACTIONS for direct messages.

messageReactionRemoveAll

messageReactionRemoveAll: [message: PossiblyUncachedMessage]

Emitted when all reactions are removed from a message. Requires the GUILD_MESSAGE_REACTIONS for guild messages, and DIRECT_MESSAGE_REACTIONS for direct messages.

messageReactionRemoveEmoji

messageReactionRemoveEmoji: [message: PossiblyUncachedMessage, reaction: PartialEmoji]

Emitted when a specific reaction is removed for all users from a message. Requires the GUILD_MESSAGE_REACTIONS for guild messages, and DIRECT_MESSAGE_REACTIONS for direct messages.

messageUpdate

messageUpdate: [message: Message<Uncached | AnyTextableChannel>, oldMessage: null | JSONMessage]

Emitted when a message is updated. Requires the GUILD_MESSAGES intent for guild messages, DIRECT_MESSAGES for direct messages. The MESSAGE_CONTENT intent is required for content, embeds, and similar to be present on most messages.

packet

packet: [data: AnyDispatchPacket, shard: number]

Emitted when a raw dispatch packet is received.

presenceUpdate

presenceUpdate: [guild: Uncached | Guild, member: Uncached | Member, presence: Presence, oldPresence: null | Presence]

Emitted when a guild member's presence, or user is updated. Requires the GUILD_PRESENCES intent.

ready

ready: []

Emitted when all shards are ready.

request

request: [rawRequest: RawRequest]

Emitted when a request is made.

shardDisconnect

shardDisconnect: [err: Error, id: number]

Emitted when this shard disconnects.

shardPreReady

shardPreReady: [id: number]

Emitted when this shard has processed the READY packet from Discord.

shardReady

shardReady: [id: number]

Emitted when a shard is fully ready.

shardResume

shardResume: [id: number]

Emitted when a shard resumes a connection.

stageInstanceCreate

stageInstanceCreate: [instance: StageInstance]

Emitted when a stage instance is created.

stageInstanceDelete

stageInstanceDelete: [instance: StageInstance]

Emitted when a stage instance is deleted.

stageInstanceUpdate

stageInstanceUpdate: [instance: StageInstance, oldInstance: null | JSONStageInstance]

Emitted when a stage instance is updated.

threadCreate

threadCreate: [thread: AnyThreadChannel]

Emitted when a thread is created. Requires the GUILDS intent.

threadDelete

threadDelete: [thread: PossiblyUncachedThread]

Emitted when a thread is deleted. Requires the GUILDS intent.

threadListSync

threadListSync: [threads: AnyThreadChannel[], members: ThreadMember[]]

Emitted when a guild's threads are synced. Requires the GUILDS intent.

threadMemberUpdate

threadMemberUpdate: [thread: MinimalPossiblyUncachedThread, member: ThreadMember, oldMember: null | ThreadMember]

Emitted when the client's thread member is updated. Requires the GUILDS intent.

threadMembersUpdate

threadMembersUpdate: [thread: MinimalPossiblyUncachedThread, addedMembers: ThreadMember[], removedMembers: (ThreadMember | UncachedThreadMember)[]]

Emitted when the members of a thread are updated. Requires the GUILDS intent. The received information will be different if GUILD_MEMBERS is also used.

threadUpdate

Emitted when a thread is updated. Requires the GUILDS intent.

typingStart

typingStart: [channel: Uncached | PrivateChannel, user: Uncached | User, startTimestamp: Date] | [channel: Uncached | AnyTextableGuildChannel, member: Member, startTimestamp: Date]

Emitted when a user starts typing. Requires the GUILD_MESSAGE_TYPING for guilds, and DIRECT_MESSAGE_TYPING for direct messages.

unavailableGuildCreate

unavailableGuildCreate: [guild: UnavailableGuild]

Emitted when a guild is created, but is unavailable. Requires the GUILDS intent.

userUpdate

userUpdate: [user: User, oldUser: null | JSONUser]

Emitted when a user is updated.

voiceChannelEffectSend

voiceChannelEffectSend: [channel: AnyVoiceChannel | Uncached & {
guild: Uncached | Guild;
}, user: Uncached | Member | User, effect: VoiceChannelEffect]

Emitted when a user uses an effect in a voice channel. Requires the GUILD_VOICE_STATES event.

voiceChannelJoin

voiceChannelJoin: [member: Member, channel: Uncached | VoiceChannel | StageChannel]

Emitted when a user joins a voice channel. Requires the GUILD_VOICE_STATES intent.

voiceChannelLeave

voiceChannelLeave: [member: Member, channel: Uncached | VoiceChannel | StageChannel]

Emitted when a user leaves a voice channel. Requires the GUILD_VOICE_STATES intent.

voiceChannelSwitch

Emitted when a user switches voice channels. Requires the GUILD_VOICE_STATES intent.

voiceStateUpdate

voiceStateUpdate: [member: Member, oldState: null | JSONVoiceState]

Emitted when a user's voice state is updated. Requires the GUILD_VOICE_STATES intent.

warn

warn: [info: string, shard?: number]

Emitted with various warning information.

webhooksUpdate

webhooksUpdate: [guild: Uncached | Guild, channel: Uncached | AnyGuildChannelWithoutThreads]

Emitted when a guild's webhooks are updated. Requires the GUILD_WEBHOOKS intent.