refactor: Use MessageFlags.Ephemeral (#1592)

Jiralite · Jiralite · commit 01fc79feca28 · 2024-11-29T09:36:03.000Z
diff --git a/code-samples/additional-features/cooldowns/index.js b/code-samples/additional-features/cooldowns/index.js
@@ -1,6 +1,6 @@
 const fs = require('node:fs');
 const path = require('node:path');
-const { Client, Collection, Events, GatewayIntentBits } = require('discord.js');
+const { Client, Collection, Events, GatewayIntentBits, MessageFlags } = require('discord.js');
 const { token } = require('./config.json');
 
 const client = new Client({ intents: [GatewayIntentBits.Guilds] });
@@ -53,7 +53,7 @@ client.on(Events.InteractionCreate, async interaction => {
 
 		if (now < expirationTime) {
 			const expiredTimestamp = Math.round(expirationTime / 1000);
-			return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, ephemeral: true });
+			return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, flags: MessageFlags.Ephemeral });
 		}
 	}
 
@@ -65,9 +65,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
diff --git a/code-samples/additional-features/reloading-commands/index.js b/code-samples/additional-features/reloading-commands/index.js
@@ -1,6 +1,6 @@
 const fs = require('node:fs');
 const path = require('node:path');
-const { Client, Collection, Events, GatewayIntentBits } = require('discord.js');
+const { Client, Collection, Events, GatewayIntentBits, MessageFlags } = require('discord.js');
 const { token } = require('./config.json');
 
 const client = new Client({ intents: [GatewayIntentBits.Guilds] });
@@ -53,7 +53,7 @@ client.on(Events.InteractionCreate, async interaction => {
 
 		if (now < expirationTime) {
 			const expiredTimestamp = Math.round(expirationTime / 1000);
-			return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, ephemeral: true });
+			return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, flags: MessageFlags.Ephemeral });
 		}
 	}
 
@@ -65,9 +65,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
diff --git a/code-samples/creating-your-bot/command-deployment/index.js b/code-samples/creating-your-bot/command-deployment/index.js
@@ -1,6 +1,6 @@
 const fs = require('node:fs');
 const path = require('node:path');
-const { Client, Collection, Events, GatewayIntentBits } = require('discord.js');
+const { Client, Collection, Events, GatewayIntentBits, MessageFlags } = require('discord.js');
 const { token } = require('./config.json');
 
 const client = new Client({ intents: [GatewayIntentBits.Guilds] });
@@ -41,9 +41,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
diff --git a/code-samples/creating-your-bot/command-handling/index.js b/code-samples/creating-your-bot/command-handling/index.js
@@ -1,6 +1,6 @@
 const fs = require('node:fs');
 const path = require('node:path');
-const { Client, Collection, Events, GatewayIntentBits } = require('discord.js');
+const { Client, Collection, Events, GatewayIntentBits, MessageFlags } = require('discord.js');
 const { token } = require('./config.json');
 
 const client = new Client({ intents: [GatewayIntentBits.Guilds] });
@@ -41,9 +41,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
diff --git a/code-samples/creating-your-bot/event-handling/events/interactionCreate.js b/code-samples/creating-your-bot/event-handling/events/interactionCreate.js
@@ -1,4 +1,4 @@
-const { Events } = require('discord.js');
+const { Events, MessageFlags } = require('discord.js');
 
 module.exports = {
 	name: Events.InteractionCreate,
@@ -17,9 +17,9 @@ module.exports = {
 		} catch (error) {
 			console.error(error);
 			if (interaction.replied || interaction.deferred) {
-				await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+				await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 			} else {
-				await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+				await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 			}
 		}
 	},
diff --git a/guide/additional-features/cooldowns.md b/guide/additional-features/cooldowns.md
@@ -71,7 +71,7 @@ if (timestamps.has(interaction.user.id)) {
 
 	if (now < expirationTime) {
 		const expiredTimestamp = Math.round(expirationTime / 1_000);
-		return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, ephemeral: true });
+		return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, flags: MessageFlags.Ephemeral });
 	}
 }
 ```
diff --git a/guide/creating-your-bot/command-handling.md b/guide/creating-your-bot/command-handling.md
@@ -123,9 +123,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
diff --git a/guide/creating-your-bot/event-handling.md b/guide/creating-your-bot/event-handling.md
@@ -33,9 +33,9 @@ client.on(Events.InteractionCreate, async interaction => {
 	} catch (error) {
 		console.error(error);
 		if (interaction.replied || interaction.deferred) {
-			await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		} else {
-			await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+			await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 		}
 	}
 });
@@ -82,7 +82,7 @@ module.exports = {
 :::
 ::: code-group-item events/interactionCreate.js
 ```js
-const { Events } = require('discord.js');
+const { Events, MessageFlags } = require('discord.js');
 
 module.exports = {
 	name: Events.InteractionCreate,
@@ -101,9 +101,9 @@ module.exports = {
 		} catch (error) {
 			console.error(error);
 			if (interaction.replied || interaction.deferred) {
-				await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });
+				await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 			} else {
-				await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });
+				await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });
 			}
 		}
 	},
diff --git a/guide/popular-topics/collectors.md b/guide/popular-topics/collectors.md
@@ -143,7 +143,7 @@ collector.on('collect', i => {
 	if (i.user.id === interaction.user.id) {
 		i.reply(`${i.user.id} clicked on the ${i.customId} button.`);
 	} else {
-		i.reply({ content: `These buttons aren't for you!`, ephemeral: true });
+		i.reply({ content: `These buttons aren't for you!`, flags: MessageFlags.Ephemeral });
 	}
 });
 
diff --git a/guide/slash-commands/response-methods.md b/guide/slash-commands/response-methods.md
@@ -32,14 +32,14 @@ Initially an interaction token is only valid for three seconds, so that's the ti
 
 You may not always want everyone who has access to the channel to see a slash command's response. Previously, you would have had to DM the user to achieve this, potentially encountering the high rate limits associated with DM messages, or simply being unable to do so, if the user's DMs were disabled. 
 
-Thankfully, Discord provides a way to hide response messages from everyone but the executor of the slash command. This type of message is called an `ephemeral` message and can be set by providing `ephemeral: true` in the `InteractionReplyOptions`, as follows:
+Thankfully, Discord provides a way to hide response messages from everyone but the executor of the slash command. This is called an ephemeral message and can be set by providing `flags: MessageFlags.Ephemeral` in the `InteractionReplyOptions`, as follows:
 
 ```js {5}
 client.on(Events.InteractionCreate, async interaction => {
 	if (!interaction.isChatInputCommand()) return;
 
 	if (interaction.commandName === 'ping') {
-		await interaction.reply({ content: 'Secret Pong!', ephemeral: true });
+		await interaction.reply({ content: 'Secret Pong!', flags: MessageFlags.Ephemeral });
 	}
 });
 ```
@@ -108,12 +108,10 @@ client.on(Events.InteractionCreate, async interaction => {
 
 If you have a command that performs longer tasks, be sure to call `deferReply()` as early as possible.
 
-Note that if you want your response to be ephemeral, you must pass an `ephemeral` flag to the `InteractionDeferReplyOptions` here:
-
-<!-- eslint-skip -->
+Note that if you want your response to be ephemeral, utilize `flags` from `InteractionDeferReplyOptions` here:
 
 ```js
-await interaction.deferReply({ ephemeral: true });
+await interaction.deferReply({ flags: MessageFlags.Ephemeral });
 ```
 
 It is not possible to edit a reply to change its ephemeral state once sent.
@@ -158,12 +156,12 @@ If you run this code you should end up having something that looks like this:
 	</DiscordMessage>
 </DiscordMessages>
 
-You can also pass an `ephemeral` flag to the `InteractionReplyOptions`:
+You can also pass the ephemeral flag to the `InteractionReplyOptions`:
 
 <!-- eslint-skip -->
 
 ```js
-await interaction.followUp({ content: 'Pong again!', ephemeral: true });
+await interaction.followUp({ content: 'Pong again!', flags: MessageFlags.Ephemeral });
 ```
 
 <DiscordMessages>

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`const fs = require('node:fs');`
`2`	`2`	`const path = require('node:path');`
`3`		`-const { Client, Collection, Events, GatewayIntentBits } = require('discord.js');`
	`3`	`+const { Client, Collection, Events, GatewayIntentBits, MessageFlags } = require('discord.js');`
`4`	`4`	`const { token } = require('./config.json');`
`5`	`5`
`6`	`6`	`const client = new Client({ intents: [GatewayIntentBits.Guilds] });`
`@@ -53,7 +53,7 @@ client.on(Events.InteractionCreate, async interaction => {`
`53`	`53`
`54`	`54`	`if (now < expirationTime) {`
`55`	`55`	`const expiredTimestamp = Math.round(expirationTime / 1000);`
`56`		- return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, ephemeral: true });
	`56`	+ return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, flags: MessageFlags.Ephemeral });
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`
`@@ -65,9 +65,9 @@ client.on(Events.InteractionCreate, async interaction => {`
`65`	`65`	`} catch (error) {`
`66`	`66`	`console.error(error);`
`67`	`67`	`if (interaction.replied \|\| interaction.deferred) {`
`68`		`- await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });`
	`68`	`+ await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });`
`69`	`69`	`} else {`
`70`		`- await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });`
	`70`	`+ await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`	`});`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ if (timestamps.has(interaction.user.id)) {`
`71`	`71`
`72`	`72`	`if (now < expirationTime) {`
`73`	`73`	`const expiredTimestamp = Math.round(expirationTime / 1_000);`
`74`		- return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, ephemeral: true });
	`74`	+ return interaction.reply({ content: `Please wait, you are on a cooldown for \`${command.data.name}\`. You can use it again <t:${expiredTimestamp}:R>.`, flags: MessageFlags.Ephemeral });
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`	```
Original file line number	Diff line number	Diff line change
`@@ -123,9 +123,9 @@ client.on(Events.InteractionCreate, async interaction => {`
`123`	`123`	`} catch (error) {`
`124`	`124`	`console.error(error);`
`125`	`125`	`if (interaction.replied \|\| interaction.deferred) {`
`126`		`- await interaction.followUp({ content: 'There was an error while executing this command!', ephemeral: true });`
	`126`	`+ await interaction.followUp({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });`
`127`	`127`	`} else {`
`128`		`- await interaction.reply({ content: 'There was an error while executing this command!', ephemeral: true });`
	`128`	`+ await interaction.reply({ content: 'There was an error while executing this command!', flags: MessageFlags.Ephemeral });`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`	`});`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ collector.on('collect', i => {`
`143`	`143`	`if (i.user.id === interaction.user.id) {`
`144`	`144`	i.reply(`${i.user.id} clicked on the ${i.customId} button.`);
`145`	`145`	`} else {`
`146`		- i.reply({ content: `These buttons aren't for you!`, ephemeral: true });
	`146`	+ i.reply({ content: `These buttons aren't for you!`, flags: MessageFlags.Ephemeral });
`147`	`147`	`}`
`148`	`148`	`});`
`149`	`149`