Type alias GatewayEvents

GatewayEvents: {
    *: ((payload) => void);
    APPLICATION_COMMAND_PERMISSIONS_UPDATE: ((payload) => void);
    AUTO_MODERATION_ACTION_EXECUTION: ((payload) => void);
    AUTO_MODERATION_RULE_CREATE: ((payload) => void);
    AUTO_MODERATION_RULE_DELETE: ((payload) => void);
    AUTO_MODERATION_RULE_UPDATE: ((payload) => void);
    CHANNEL_CREATE: ((payload) => void);
    CHANNEL_DELETE: ((payload) => void);
    CHANNEL_PINS_UPDATE: ((payload) => void);
    CHANNEL_UPDATE: ((payload) => void);
    GUILD_AUDIT_LOG_ENTRY_CREATE: ((payload) => void);
    GUILD_BAN_ADD: ((payload) => void);
    GUILD_BAN_REMOVE: ((payload) => void);
    GUILD_CREATE: ((payload) => void);
    GUILD_DELETE: ((payload) => void);
    GUILD_EMOJIS_UPDATE: ((payload) => void);
    GUILD_INTEGRATIONS_UPDATE: ((payload) => void);
    GUILD_MEMBERS_CHUNK: ((payload) => void);
    GUILD_MEMBER_ADD: ((payload) => void);
    GUILD_MEMBER_REMOVE: ((payload) => void);
    GUILD_MEMBER_UPDATE: ((payload) => void);
    GUILD_ROLE_CREATE: ((payload) => void);
    GUILD_ROLE_DELETE: ((payload) => void);
    GUILD_ROLE_UPDATE: ((payload) => void);
    GUILD_SCHEDULED_EVENT_CREATE: ((payload) => void);
    GUILD_SCHEDULED_EVENT_DELETE: ((payload) => void);
    GUILD_SCHEDULED_EVENT_UPDATE: ((payload) => void);
    GUILD_SCHEDULED_EVENT_USER_ADD: ((payload) => void);
    GUILD_SCHEDULED_EVENT_USER_REMOVE: ((payload) => void);
    GUILD_STICKERS_UPDATE: ((payload) => void);
    GUILD_UPDATE: ((payload) => void);
    INTEGRATION_CREATE: ((payload) => void);
    INTEGRATION_DELETE: ((payload) => void);
    INTEGRATION_UPDATE: ((payload) => void);
    INTERACTION_CREATE: ((payload) => void);
    INVITE_CREATE: ((payload) => void);
    INVITE_DELETE: ((payload) => void);
    MANAGER_READY: ((successfulSpawns, unsuccessfulSpawns) => void);
    MESSAGE_CREATE: ((payload) => void);
    MESSAGE_DELETE: ((payload) => void);
    MESSAGE_DELETE_BULK: ((payload) => void);
    MESSAGE_REACTION_ADD: ((payload) => void);
    MESSAGE_REACTION_REMOVE: ((payload) => void);
    MESSAGE_REACTION_REMOVE_ALL: ((payload) => void);
    MESSAGE_REACTION_REMOVE_EMOJI: ((payload) => void);
    MESSAGE_UPDATE: ((payload) => void);
    PRESENCE_UPDATE: ((payload) => void);
    READY: ((payload) => void);
    RESUMED: ((payload) => void);
    SENT_PAYLOAD: ((payload) => void);
    SHARD_CONNECTING: ((shard) => void);
    SHARD_DISCONNECTED: ((payload) => void);
    SHARD_GUILDS_READY: ((shard) => void);
    SHARD_IDLE: ((shard) => void);
    SHARD_READY: ((shard) => void);
    STAGE_INSTANCE_CREATE: ((payload) => void);
    STAGE_INSTANCE_DELETE: ((payload) => void);
    STAGE_INSTANCE_UPDATE: ((payload) => void);
    THREAD_CREATE: ((payload) => void);
    THREAD_DELETE: ((payload) => void);
    THREAD_LIST_SYNC: ((payload) => void);
    THREAD_MEMBERS_UPDATE: ((payload) => void);
    THREAD_MEMBER_UPDATE: ((payload) => void);
    THREAD_UPDATE: ((payload) => void);
    TYPING_START: ((payload) => void);
    USER_UPDATE: ((payload) => void);
    VOICE_SERVER_UPDATE: ((payload) => void);
    VOICE_STATE_UPDATE: ((payload) => void);
    WEBHOOKS_UPDATE: ((payload) => void);
}

Gateway events. Note that with the exception of MANAGER_READY, all events are a relay of a gateway shard's event emit (For example, READY signifies a single shard receiving a READY dispatch).

See

Discord API Reference

Type declaration

  • *: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayDispatchPayload

        Returns void

  • APPLICATION_COMMAND_PERMISSIONS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayApplicationCommandPermissionsUpdateDispatch

        Returns void

  • AUTO_MODERATION_ACTION_EXECUTION: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayAutoModerationActionExecutionDispatch

        Returns void

  • AUTO_MODERATION_RULE_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayAutoModerationRuleCreateDispatch

        Returns void

  • AUTO_MODERATION_RULE_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayAutoModerationRuleDeleteDispatch

        Returns void

  • AUTO_MODERATION_RULE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayAutoModerationRuleUpdateDispatch

        Returns void

  • CHANNEL_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayChannelCreateDispatch

        Returns void

  • CHANNEL_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayChannelDeleteDispatch

        Returns void

  • CHANNEL_PINS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayChannelPinsUpdateDispatch

        Returns void

  • CHANNEL_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayChannelUpdateDispatch

        Returns void

  • GUILD_AUDIT_LOG_ENTRY_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildAuditLogEntryCreateDispatch

        Returns void

  • GUILD_BAN_ADD: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildBanAddDispatch

        Returns void

  • GUILD_BAN_REMOVE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildBanRemoveDispatch

        Returns void

  • GUILD_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildCreateDispatch

        Returns void

  • GUILD_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildDeleteDispatch

        Returns void

  • GUILD_EMOJIS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildEmojisUpdateDispatch

        Returns void

  • GUILD_INTEGRATIONS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildIntegrationsUpdateDispatch

        Returns void

  • GUILD_MEMBERS_CHUNK: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildMembersChunkDispatch

        Returns void

  • GUILD_MEMBER_ADD: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildMemberAddDispatch

        Returns void

  • GUILD_MEMBER_REMOVE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildMemberRemoveDispatch

        Returns void

  • GUILD_MEMBER_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildMemberUpdateDispatch

        Returns void

  • GUILD_ROLE_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildRoleCreateDispatch

        Returns void

  • GUILD_ROLE_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildRoleDeleteDispatch

        Returns void

  • GUILD_ROLE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildRoleUpdateDispatch

        Returns void

  • GUILD_SCHEDULED_EVENT_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildScheduledEventCreateDispatch

        Returns void

  • GUILD_SCHEDULED_EVENT_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildScheduledEventDeleteDispatch

        Returns void

  • GUILD_SCHEDULED_EVENT_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildScheduledEventUpdateDispatch

        Returns void

  • GUILD_SCHEDULED_EVENT_USER_ADD: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildScheduledEventUserAddDispatch

        Returns void

  • GUILD_SCHEDULED_EVENT_USER_REMOVE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildScheduledEventUserRemoveDispatch

        Returns void

  • GUILD_STICKERS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildStickersUpdateDispatch

        Returns void

  • GUILD_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayGuildUpdateDispatch

        Returns void

  • INTEGRATION_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayIntegrationCreateDispatch

        Returns void

  • INTEGRATION_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayIntegrationDeleteDispatch

        Returns void

  • INTEGRATION_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayIntegrationUpdateDispatch

        Returns void

  • INTERACTION_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayInteractionCreateDispatch

        Returns void

  • INVITE_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayInviteCreateDispatch

        Returns void

  • INVITE_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayInviteDeleteDispatch

        Returns void

  • MANAGER_READY: ((successfulSpawns, unsuccessfulSpawns) => void)
      • (successfulSpawns, unsuccessfulSpawns): void

      • When all shards are ready.

        Parameters

        • successfulSpawns: number
        • unsuccessfulSpawns: number

        Returns void

  • MESSAGE_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageCreateDispatch

        Returns void

  • MESSAGE_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageDeleteDispatch

        Returns void

  • MESSAGE_DELETE_BULK: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageDeleteBulkDispatch

        Returns void

  • MESSAGE_REACTION_ADD: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageReactionAddDispatch

        Returns void

  • MESSAGE_REACTION_REMOVE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageReactionRemoveDispatch

        Returns void

  • MESSAGE_REACTION_REMOVE_ALL: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageReactionRemoveAllDispatch

        Returns void

  • MESSAGE_REACTION_REMOVE_EMOJI: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageReactionRemoveEmojiDispatch

        Returns void

  • MESSAGE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayMessageUpdateDispatch

        Returns void

  • PRESENCE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayPresenceUpdateDispatch

        Returns void

  • READY: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayReadyDispatch

        Returns void

  • RESUMED: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayResumedDispatch

        Returns void

  • SENT_PAYLOAD: ((payload) => void)
      • (payload): void

      • When a payload is sent.

        Parameters

        • payload: string

        Returns void

  • SHARD_CONNECTING: ((shard) => void)
  • SHARD_DISCONNECTED: ((payload) => void)
  • SHARD_GUILDS_READY: ((shard) => void)
  • SHARD_IDLE: ((shard) => void)
  • SHARD_READY: ((shard) => void)
  • STAGE_INSTANCE_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayStageInstanceCreateDispatch

        Returns void

  • STAGE_INSTANCE_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayStageInstanceDeleteDispatch

        Returns void

  • STAGE_INSTANCE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayStageInstanceUpdateDispatch

        Returns void

  • THREAD_CREATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadCreateDispatch

        Returns void

  • THREAD_DELETE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadDeleteDispatch

        Returns void

  • THREAD_LIST_SYNC: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadListSyncDispatch

        Returns void

  • THREAD_MEMBERS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadMembersUpdateDispatch

        Returns void

  • THREAD_MEMBER_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadMemberUpdateDispatch

        Returns void

  • THREAD_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayThreadUpdateDispatch

        Returns void

  • TYPING_START: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayTypingStartDispatch

        Returns void

  • USER_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayUserUpdateDispatch

        Returns void

  • VOICE_SERVER_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayVoiceServerUpdateDispatch

        Returns void

  • VOICE_STATE_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayVoiceStateUpdateDispatch

        Returns void

  • WEBHOOKS_UPDATE: ((payload) => void)
      • (payload): void

      • Parameters

        • payload: DiscordTypes.GatewayWebhooksUpdateDispatch

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc