diff --git a/packages/discord.js/src/structures/MessagePayload.js b/packages/discord.js/src/structures/MessagePayload.js
index dad8ffedb026..48519d0a5682 100644
--- a/packages/discord.js/src/structures/MessagePayload.js
+++ b/packages/discord.js/src/structures/MessagePayload.js
@@ -92,6 +92,7 @@ class MessagePayload {
* Whether or not the target is an {@link BaseInteraction} or an {@link InteractionWebhook}
* @type {boolean}
* @readonly
+ * @deprecated This will no longer serve a purpose in the next major version.
*/
get isInteraction() {
const BaseInteraction = getBaseInteraction();
diff --git a/packages/discord.js/src/structures/interfaces/InteractionResponses.js b/packages/discord.js/src/structures/interfaces/InteractionResponses.js
index 440242a34e56..dac44bf01597 100644
--- a/packages/discord.js/src/structures/interfaces/InteractionResponses.js
+++ b/packages/discord.js/src/structures/interfaces/InteractionResponses.js
@@ -1,14 +1,16 @@
'use strict';
+const process = require('node:process');
const { deprecate } = require('node:util');
const { isJSONEncodable } = require('@discordjs/util');
const { InteractionResponseType, MessageFlags, Routes, InteractionType } = require('discord-api-types/v10');
const { DiscordjsError, ErrorCodes } = require('../../errors');
-const MessageFlagsBitField = require('../../util/MessageFlagsBitField');
const InteractionCollector = require('../InteractionCollector');
const InteractionResponse = require('../InteractionResponse');
const MessagePayload = require('../MessagePayload');
+let deprecationEmittedForEphemeralOption = false;
+
/**
* @typedef {Object} ModalComponentData
* @property {string} title The title of the modal
@@ -24,7 +26,10 @@ class InteractionResponses {
/**
* Options for deferring the reply to an {@link BaseInteraction}.
* @typedef {Object} InteractionDeferReplyOptions
- * @property {boolean} [ephemeral] Whether the reply should be ephemeral
+ * @property {boolean} [ephemeral] Whether the reply should be ephemeral.
+ * This option is deprecated. Use `flags` instead.
+ * @property {MessageFlagsResolvable} [flags] Flags for the reply.
+ * Only `MessageFlags.Ephemeral` can be set.
* @property {boolean} [fetchReply] Whether to fetch the reply
*/
@@ -37,10 +42,11 @@ class InteractionResponses {
/**
* Options for a reply to a {@link BaseInteraction}.
* @typedef {BaseMessageOptionsWithPoll} InteractionReplyOptions
+ * @property {boolean} [ephemeral] Whether the reply should be ephemeral.
+ * This option is deprecated. Use `flags` instead.
* @property {boolean} [tts=false] Whether the message should be spoken aloud
- * @property {boolean} [ephemeral] Whether the reply should be ephemeral
* @property {boolean} [fetchReply] Whether to fetch the reply
- * @property {MessageFlags} [flags] Which flags to set for the message.
+ * @property {MessageFlagsResolvable} [flags] Which flags to set for the message.
* Only `MessageFlags.Ephemeral`, `MessageFlags.SuppressEmbeds`, and `MessageFlags.SuppressNotifications`
* can be set.
*/
@@ -62,24 +68,41 @@ class InteractionResponses {
* .catch(console.error)
* @example
* // Defer to send an ephemeral reply later
- * interaction.deferReply({ ephemeral: true })
+ * interaction.deferReply({ flags: MessageFlags.Ephemeral })
* .then(console.log)
* .catch(console.error);
*/
async deferReply(options = {}) {
if (this.deferred || this.replied) throw new DiscordjsError(ErrorCodes.InteractionAlreadyReplied);
- this.ephemeral = options.ephemeral ?? false;
+
+ if ('ephemeral' in options) {
+ if (!deprecationEmittedForEphemeralOption) {
+ process.emitWarning(
+ `Supplying "ephemeral" for interaction response options is deprecated. Utilize flags instead.`,
+ );
+
+ deprecationEmittedForEphemeralOption = true;
+ }
+ }
+
+ let { flags } = options;
+
+ if (options.ephemeral) {
+ flags |= MessageFlags.Ephemeral;
+ }
+
await this.client.rest.post(Routes.interactionCallback(this.id, this.token), {
body: {
type: InteractionResponseType.DeferredChannelMessageWithSource,
data: {
- flags: options.ephemeral ? MessageFlags.Ephemeral : undefined,
+ flags,
},
},
auth: false,
});
- this.deferred = true;
+ this.deferred = true;
+ this.ephemeral = Boolean(flags & MessageFlags.Ephemeral);
return options.fetchReply ? this.fetchReply() : new InteractionResponse(this);
}
@@ -97,21 +120,29 @@ class InteractionResponses {
* // Create an ephemeral reply with an embed
* const embed = new EmbedBuilder().setDescription('Pong!');
*
- * interaction.reply({ embeds: [embed], ephemeral: true })
+ * interaction.reply({ embeds: [embed], flags: MessageFlags.Ephemeral })
* .then(() => console.log('Reply sent.'))
* .catch(console.error);
*/
async reply(options) {
if (this.deferred || this.replied) throw new DiscordjsError(ErrorCodes.InteractionAlreadyReplied);
+ if ('ephemeral' in options) {
+ if (!deprecationEmittedForEphemeralOption) {
+ process.emitWarning(
+ `Supplying "ephemeral" for interaction response options is deprecated. Utilize flags instead.`,
+ );
+
+ deprecationEmittedForEphemeralOption = true;
+ }
+ }
+
let messagePayload;
if (options instanceof MessagePayload) messagePayload = options;
else messagePayload = MessagePayload.create(this, options);
const { body: data, files } = await messagePayload.resolveBody().resolveFiles();
- this.ephemeral = new MessageFlagsBitField(data.flags).has(MessageFlags.Ephemeral);
-
await this.client.rest.post(Routes.interactionCallback(this.id, this.token), {
body: {
type: InteractionResponseType.ChannelMessageWithSource,
@@ -120,8 +151,9 @@ class InteractionResponses {
files,
auth: false,
});
- this.replied = true;
+ this.ephemeral = Boolean(data.flags & MessageFlags.Ephemeral);
+ this.replied = true;
return options.fetchReply ? this.fetchReply() : new InteractionResponse(this);
}
diff --git a/packages/discord.js/src/util/MessageFlagsBitField.js b/packages/discord.js/src/util/MessageFlagsBitField.js
index 71f1fd6c5c08..e6764b2fd791 100644
--- a/packages/discord.js/src/util/MessageFlagsBitField.js
+++ b/packages/discord.js/src/util/MessageFlagsBitField.js
@@ -23,6 +23,15 @@ class MessageFlagsBitField extends BitField {
* @param {BitFieldResolvable} [bits=0] Bit(s) to read from
*/
+/**
+ * Data that can be resolved to give a message flags bit field. This can be:
+ * * A string (see {@link MessageFlagsBitField.Flags})
+ * * A message flag
+ * * An instance of {@link MessageFlagsBitField}
+ * * An array of `MessageFlagsResolvable`
+ * @typedef {string|number|MessageFlagsBitField|MessageFlagsResolvable[]} MessageFlagsResolvable
+ */
+
/**
* Bitfield of the packed bits
* @type {number}
diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
index 8f7da19e47bc..e9982abc2013 100644
--- a/packages/discord.js/typings/index.d.ts
+++ b/packages/discord.js/typings/index.d.ts
@@ -2389,9 +2389,11 @@ export type MessageFlagsString = keyof typeof MessageFlags;
export class MessageFlagsBitField extends BitField {
public static Flags: typeof MessageFlags;
- public static resolve(bit?: BitFieldResolvable): number;
+ public static resolve(bit?: MessageFlagsResolvable): number;
}
+export type MessageFlagsResolvable = BitFieldResolvable;
+
export class MessageMentions {
private constructor(
message: Message,
@@ -2441,6 +2443,7 @@ export class MessagePayload {
public get isWebhook(): boolean;
public get isMessage(): boolean;
public get isMessageManager(): boolean;
+ /** @deprecated This will no longer serve a purpose in the next major version. */
public get isInteraction(): boolean;
public files: RawFile[] | null;
public options: MessagePayloadOption;
@@ -6351,15 +6354,23 @@ export interface InteractionCollectorOptions<
}
export interface InteractionDeferReplyOptions {
+ /** @deprecated Use {@link InteractionDeferReplyOptions.flags} instead. */
ephemeral?: boolean;
+ flags?: BitFieldResolvable<
+ Extract,
+ MessageFlags.Ephemeral | MessageFlags.SuppressEmbeds | MessageFlags.SuppressNotifications
+ >;
fetchReply?: boolean;
}
-export interface InteractionDeferUpdateOptions extends Omit {}
+export interface InteractionDeferUpdateOptions {
+ fetchReply?: boolean;
+}
export interface InteractionReplyOptions extends BaseMessageOptionsWithPoll {
- tts?: boolean;
+ /** @deprecated Use {@link InteractionReplyOptions.flags} instead. */
ephemeral?: boolean;
+ tts?: boolean;
fetchReply?: boolean;
flags?: BitFieldResolvable<
Extract,