Important

Currently the documentation here pertains to the canary tag of Dressed (dressed@1.10.0-canary.5.x), keep in mind that some items (especially talked about in the deployment guides) are not available / work slightly differently in the @latest version.

Interactions

All interaction types share a set of core response methods. Additional methods are available for specific interaction types.

Base methods

These methods are available on most interactions:

  1. Reply

    Sends an immediate response to the interaction.

    Parameters

    • data: The message content or options.
    await interaction.reply({ content: "Hello!", ephemeral: true });

  2. Defer Reply
    Acknowledges the interaction, showing a "thinking..." indicator to the user, with an option to edit or respond later.

    Parameters

    • data (optional): Options for deferral, such as whether it's ephemeral:
    await interaction.deferReply({ ephemeral: true });

  3. Edit Reply
    Edits the initial response to the interaction.

    Parameters

    • data: The updated message content or options.
    await interaction.editReply("Updated message content");

  4. Follow Up
    Sends an additional message related to the interaction.

    Parameters

    • data: The follow-up message content or options.
    await interaction.followUp({
  content: "Another message!",
  ephemeral: true,
});

  5. Show Modal
    Responds with a modal dialog. This is not available on modal submission interactions.

    Parameters

    • data: Modal data, including components and title.
    await interaction.showModal({
 title: "Example Modal",
 custom_id: "modal_id",
 components: [...],
});

Command interactions

This method is only available for command interactions

getOption

Retrieves an option from the command, provides functions to retrieve the value.

Parameters

  • name: Name of the option.
  • required: If true, throws an error if the option is not present.
const user = interaction.getOption("user", true).user();

Command autocomplete interactions

This method is only available for command autocomplete interactions

sendChoices

Provides a list of choices for the user to prompt the user to select from.

Parameters

  • choices: The choices to suggest.
interaction.sendChoices([
  { name: "Dog", value: "dog" },
  { name: "Cat", value: "cat" },
]);

Message component interactions

This method is only available for components

update

Edits the original message containing the component.

Parameters

  • data: New content or message options.
await interaction.update("Updated content");

This method is only available for modal responses

getField

Retrieves a field from the modal submission, provides functions to retrieve the value.

Parameters

  • name: Name of the field.
  • required: If true, throws an error if the field is not present.
const selectedLibraries = interaction.getField("library", true).stringSelect();