Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.68 KB

clean.md

File metadata and controls

48 lines (32 loc) · 2.68 KB

clean

This command deletes a large amount of messages from a channel, optionally limited by specifying some deletion criteria. Criteria are options that distinguish messages such as those that contain a specific phrase. Using multiple criteria will narrow the selection to only messages that fit all of them. Due to limitations imposed by Discord, only messages sent within the last 14 days can be deleted.

Required permissions

MoonlightBot requires the following permissions to successfully execute this command:

  • View Channel
  • Send Messages
  • Manage Messages
  • Read Message History

By default, a user is required to have the following permissions to use this command:

  • Manage Messages

For more information on editing permission requirements for specific users/roles, refer to the permissions tutorial

Syntax

/clean [amount] [user] [starts-with] [ends-with] [contains] [bots] [system] [preserve-pins] [no-trace]

Options

  • amount: The amount of messages you want to clean (The default/maximum amount is 100)
  • user: Delete messages sent by a specified user
  • starts-with: Delete messages that start with this value
  • ends-with: Delete messages that end with this value
  • contains: Delete messages that contain this value
  • bots: Whether or not to delete messages sent by bots. If this option is left blank, the bot will not differentiate between messages sent by users and bots. If set to false, the bot will not delete bot messages, but if set to true, the bot will only delete bot messages
  • system: Whether or not to delete system messages. System messages are messages sent by Discord, such as join or pin messages. This uses the same syntax as the bots option
  • preserve-pins: If true, pinned messages will not be deleted
  • no-trace: If true, the confirmation message will only be visible to you

Logs

  • CHANNEL_CLEAN: MoonlightBot will send a message with two things: an HTML file that contains the history of the deleted messages and an embed detailing where messages were cleaned, how many were cleaned, who cleaned them, and the filters applied

An example of logs sent by the bot after a clean command execution

{% hint style="info" %} Rather than rendering them like other downloadable files, Discord displays the raw content of HTML files. To download the HTML file, click the download button at the bottom-right of the file display. Double-click the file, and your computer will open a new tab in your browser to display a visualization of the messages deleted {% endhint %}

For more information on setting up those logs, refer to the log setup tutorial