gluon
    Preparing search index...

    Class SlashCommand

    Represents a slash command.

    https://discord.com/developers/docs/interactions/slash-commands

    Hierarchy (View Summary)

    Implements

    • SlashCommand
    Index

    Constructors

    constructor

    Accessors

    channel channelId data guild guildId id member memberId options token type

    Methods

    [custom] acknowledge autocompleteResponse delete edit reply textPrompt toJSON toString delete edit

    Constructors

    • Creates a slash command interaction structure.

      Parameters

      • client: Client

        The client instance.

      • data:
            | APIApplicationCommandAutocompleteGuildInteraction
            | APIChatInputApplicationCommandGuildInteraction

        The raw interaction data from Discord.

      Returns SlashCommand

    Accessors

    • get channel(): AllChannels

      The channel that this interaction belongs to.

      Returns AllChannels

    • get channelId(): string

      The id of the channel that this interaction belongs to.

      Returns string

    • get data(): | APIChatInputApplicationCommandInteractionData
      | APIChatInputApplicationCommandInteractionData & Required<
          Pick<APIChatInputApplicationCommandInteractionData, "options">,
      >

      The raw slash command data from Discord.

      Returns
          | APIChatInputApplicationCommandInteractionData
          | APIChatInputApplicationCommandInteractionData & Required<
              Pick<APIChatInputApplicationCommandInteractionData, "options">,
          >

    • get guild(): Guild

      The guild that this interaction belongs to.

      Returns Guild

    • get guildId(): string

      The id of the guild that this interaction belongs to.

      Returns string

    • get id(): string

      The id of the interaction.

      Returns string

    • get member(): undefined | null | Member

      The member that triggered the interaction, if it was run in a guild.

      Returns undefined | null | Member

    • get memberId(): string

      The id of the member that triggered the interaction, if it was run in a guild.

      Returns string

    • get options(): APIApplicationCommandInteractionDataOption[]

      The options provided with the slash command.

      Returns APIApplicationCommandInteractionDataOption[]

    • get token(): string

      The token of the interaction.

      Returns string

    • get type(): | ApplicationCommand
      | MessageComponent
      | ApplicationCommandAutocomplete
      | ModalSubmit

      The type of interaction.

      Returns
          | ApplicationCommand
          | MessageComponent
          | ApplicationCommandAutocomplete
          | ModalSubmit

    Methods

    • Responds to autocomplete interactions.

      Parameters

      • options: { choices: CommandChoiceBuilder[] }

        Autocompletion options.

        • choices: CommandChoiceBuilder[]

          The choices to send back.

      Returns Promise<void>

    • Deletes a response to an interaction. Works up to 15 minutes after the response was sent.

      Returns Promise<any>

    • Edits a response to an interaction. Works up to 15 minutes after the response was sent.

      Parameters

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
        }

        The new interaction response options.

        • Optionalcomponents?: MessageComponents

          The new components to send with the interaction response.

        • Optionalcontent?: string

          The new content of the interaction response.

        • Optionalembeds?: Embed[]

          The new embeds to send with the interaction response.

        • Optionalfiles?: FileUpload[]

          The new files to send with the interaction response.

      Returns Promise<any>

    • Replies to an interaction.

      Parameters

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
            quiet?: boolean;
        }

        An embed, components, and whether the response should be as an ephemeral message.

        • Optionalcomponents?: MessageComponents

          The components to send with the interaction response.

        • Optionalcontent?: string

          The content of the interaction response.

        • Optionalembeds?: Embed[]

          The embeds to send with the interaction response.

        • Optionalfiles?: FileUpload[]

          The files to send with the interaction response.

        • Optionalquiet?: boolean

          Whether the response should be an ephemeral message.

      Returns Promise<SlashCommand>

    • Prompts a user to enter text using a modal.

      Parameters

      • options: { customId: string; textInputModal: TextInputBuilder; title: string }

        Modal options.

        • customId: string

          The custom id of the modal.

        • textInputModal: TextInputBuilder

          The text input modal.

        • title: string

          The title of the modal.

      Returns Promise<void>

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns SlashCommandCacheJSON | SlashCommandStorageJSON | SlashCommandDiscordJSON

    • Deletes a response to an interaction. Works up to 15 minutes after the response was sent.

      Parameters

      • client: Client

        The client instance.

      • interactionToken: string

        The interaction token.

      Returns Promise<any>

    • Edits a response to an interaction. Works up to 15 minutes after the response was sent.

      Parameters

      • client: Client

        The client instance.

      • interactionToken: string

        The interaction token.

      • Optionaloptions: {
            components?: MessageComponents;
            content?: string;
            embeds?: Embed[];
            files?: FileUpload[];
        }

        The new interaction response options.

        • Optionalcomponents?: MessageComponents

          The new components to send with the interaction response.

        • Optionalcontent?: string

          The new content of the interaction response.

        • Optionalembeds?: Embed[]

          The new embeds to send with the interaction response.

        • Optionalfiles?: FileUpload[]

          The new files to send with the interaction response.

      Returns Promise<any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods