Class

ClearChat

ClearChat()

The clear chat command will clear a channel from at most 100 messages that are at least 2 weeks young. Option to keep pinned messages available.

Constructor

# new ClearChat()

View Source commands/a_utility/clear-chat.js, line 14

Extends

PermissionCommand

Members

Type: CommandPermissionInfo

# private permissionInfo

The permission info

Overrides:

PermissionCommand#permissionInfo

View Source classes/permission-command.js, line 40

Methods

# async runCommand(botGuild, message, args)

Parameters:

Name	Type	Description
`botGuild`	BotGuildModel	the botGuild instance given from PermissionCommand
`message`	Message	the message in which the command was run
`args`	Object	the command arguments
`keepPinned`	Boolean	if true any pinned messages will not be removed

Overrides:

PermissionCommand#runCommand

View Source commands/a_utility/clear-chat.js, line 43