Overview#
Auto purge clears a channel on a schedule. Pick the channel, how often, what time of day, and how many messages each run should delete. Nobody has to remember to sweep it.
Each schedule is independent, so a bot commands channel can clear nightly while a memes channel clears weekly. Every run is written to the log channel.
Setup#
- Open the dashboard and go to Moderation > Auto Purge, then turn the module on.
- Press Add Schedule.
- Pick the Channel, a Frequency of daily or weekly, and the Time in UTC.
- Set Messages to delete (1-1000) for each run.
- Set a Log Channel so you can see the runs happen, then save.
Settings#
SettingTypeDefaultWhat it does
Enable Auto PurgeToggleOffThe master switch. No schedule runs while it is off.
ChannelChannel-The channel this schedule clears. One schedule per channel.
FrequencyChoiceDailyDaily or weekly.
Time (HH:MM, UTC)Text00:00When the run happens. Always UTC, not your local time.
Messages to delete (1-1000)Number100How many messages each run removes, newest first.
Log ChannelChannelNoneWhere purge runs are recorded. Leave empty for no logging.
Commands#
CommandWhat it doesRequires
.autopurge helpAdd, list and remove schedules from chat.Manage Messages
/purge all <count>Clear a channel now, by hand, instead of waiting for the schedule.Manage Messages
Permissions#
PermissionWhy Iris needs it
Manage MessagesDeletes the messages. Nothing runs without it.
Read Message HistoryFinds the messages to delete.
View ChannelsSees the scheduled channel and the log channel.
Send MessagesWrites the log entry.
What it looks like#
Tips and gotchas#
Nothing was deleted.
Check the module is on, that Iris holds Manage Messages in that channel, and that the messages are under 14 days old.
Can one channel have two schedules?
No. It is one schedule per channel. Raise the count or the frequency instead.
Are pinned messages deleted?
Yes. A run clears everything it can reach, pins included. Keep anything worth keeping in a channel that is not on a schedule.