Class ScheduleCommand

Hierarchy (View Summary, Expand)

Command
- ScheduleCommand

Index

Constructors

constructor

Accessors

file hasSubcommands initialized

Constructors

constructor

new ScheduleCommand(application: Application): ScheduleCommand
Creates a new instance of the Command class.
Parameters
- application: Application
  The client instance.
Returns ScheduleCommand
Inherited from Command.constructor
- Defined in src/framework/typescript/commands/Command.ts:247

Properties

`Readonly`aliases

aliases: string[] = []

`Protected` `Readonly`application

application: Application

The client instance.

`Readonly`beta

beta: boolean = false

Whether the command is in beta.

`Protected` `Readonly`configManager

configManager: configurationManager

`Optional` `Readonly`cooldown

cooldown?: number

The cooldown of the command in milliseconds.

`Readonly`defer

defer: true

Whether the command should be deferred.

`Readonly`deprecated

deprecated: boolean = false

Whether the command is deprecated.

`Readonly`description

description: string = "Sends a message after a specified time."

`Optional` `Readonly`detailedDescription

detailedDescription?: string

`Protected` `Readonly`directiveParsingService

directiveParsingService: DirectiveParsingService

`Readonly`disabled

disabled: boolean = false

Whether the command is disabled.

`Readonly`ephemeral

ephemeral: boolean = false

Whether the command should be ephemeral.

group

group: string

`Readonly`guards

guards: CommandGuardLike[] = []

The permission guards for the command.

`Readonly`isolatedSubcommands

isolatedSubcommands: boolean = false

Whether the subcommands of the command are isolated in their own file.

`Protected` `Readonly`logger

logger: Logger

The logger for the command.

`Readonly`maxAttempts

maxAttempts: number = 1

The maximum number of attempts for the command, during the cooldown period.

`Readonly`name

name: "schedule"

`Readonly`options

options: Record<string, string> = {}

Options for the command. The keys are the options without dashes at the beginning, and the values are the description of the option.

`Readonly`permissionCheckingMode

permissionCheckingMode: "or" | "and" = "and"

The mode for checking permissions.

permissions

The required permissions for the member running this command. Can be modified or removed by the permission manager.

`Optional` `Readonly`persistentCustomPermissions

persistentCustomPermissions?: SystemOnlyPermissionResolvable[]

The persistent custom permissions for the member running this command.

These permissions are not affected by the permission manager.

`Optional` `Readonly`persistentDiscordPermissions

The persistent discord permissions for the member running this command.

These permissions are not affected by the permission manager.

`Protected` `Readonly`queueService

queueService: QueueService

`Readonly`since

since: string = "1.0.0"

The version of the bot when this command was introduced.

`Readonly`subcommandMeta

subcommandMeta: Record<string, SubcommandMeta> = {}

The metadata for the subcommands of the command.

`Readonly`subcommands

subcommands: string[] = []

The subcommands of the command.

`Readonly`supportedContexts

supportedContexts: readonly (Legacy | ChatInput)[] = ...

The supported contexts of the command.

`Readonly`systemAdminOnly

systemAdminOnly: boolean = false

Whether the command can only be run by system admins.

`Protected` `Readonly`systemAuditLogging

systemAuditLogging: SystemAuditLoggingService

`Readonly`systemPermissions

systemPermissions: never[] = []

The required permissions for the bot system to run this command.

`Readonly`usage

usage: string[] = ...

The usage(s) of the command.

Accessors

file

get file(): undefined | string
A wrapper for the _file private property.

Returns undefined | string
Inherited from Command.file
- Defined in src/framework/typescript/commands/Command.ts:267

hasSubcommands

get hasSubcommands(): boolean
Checks if this command has subcommands.

Returns boolean
True if the command has subcommands, false otherwise.
Inherited from Command.hasSubcommands
- Defined in src/framework/typescript/commands/Command.ts:535

initialized

get initialized(): boolean
A wrapper for the _initialized private property.

Returns boolean
Inherited from Command.initialized
- Defined in src/framework/typescript/commands/Command.ts:260

Methods

`Protected`abort

abort(reason?: string): never
Aborts the execution of a command.
Parameters
- Optionalreason: string
  The reason for aborting
Returns never
Throws
CommandAbortedError
Inherited from Command.abort
- Defined in src/framework/typescript/commands/Command.ts:526

`Protected`authorize

authorize<K extends "">(
contextOrUser: User | Context<CommandMessage>,
options: AuthorizeOptions<K>,
): Promise<boolean>
Attempts to authorize the user to perform an action.
Type Parameters
- K extends ""
Parameters
- contextOrUser: User | Context<CommandMessage>
  The context or user to authorize.
- options: AuthorizeOptions<K>
  The options for the authorization.
Returns Promise<boolean>
True if the user is authorized, false otherwise.

Throws
If the user is not authorized.
Inherited from Command.authorize
- Defined in src/framework/typescript/commands/Command.ts:791

build

build(): Buildable[]
Builds the command data.

Returns Buildable[]
An array of command builders.
Overrides Command.build
- Defined in src/main/typescript/commands/automation/ScheduleCommand.ts:93

`Protected`buildChatInput

buildChatInput(): SlashCommandBuilder
Builds the chat input command.

Returns SlashCommandBuilder
The chat input command builder.
Inherited from Command.buildChatInput
- Defined in src/framework/typescript/commands/Command.ts:364

`Protected`buildContextMenu

buildContextMenu(): ContextMenuCommandBuilder
Builds the context menu command.

Returns ContextMenuCommandBuilder
The context menu command builder.
Inherited from Command.buildContextMenu
- Defined in src/framework/typescript/commands/Command.ts:376

`Protected`checkGuards

checkGuards(context: Context): Promise<boolean>
Checks the guards of the command.
Parameters
- context: Context
  The command context.
Returns Promise<boolean>
True if the guards are met, false otherwise.
Inherited from Command.checkGuards
- Defined in src/framework/typescript/commands/Command.ts:771

`Protected`checkPermissions

checkPermissions(
context: Context,
state: CommandExecutionState<true>,
): Promise<boolean>
Checks the permissions of the command.
Parameters
- context: Context
  The command context.
- state: CommandExecutionState<true>
Returns Promise<boolean>
True if the permissions are met, false otherwise.
Inherited from Command.checkPermissions
- Defined in src/framework/typescript/commands/Command.ts:656

`Protected`checkPreconditions

checkPreconditions(
context: Context,
state: CommandExecutionState<false>,
): Promise<boolean>
Checks the preconditions of the command.
Parameters
- context: Context
  The command context.
- state: CommandExecutionState<false>
Returns Promise<boolean>
True if the preconditions are met, false otherwise.
Inherited from Command.checkPreconditions
- Defined in src/framework/typescript/commands/Command.ts:560

`Protected`computePersistentPermissions

computePersistentPermissions(): Promise<void>
Returns Promise<void>
Inherited from Command.computePersistentPermissions
- Defined in src/framework/typescript/commands/Command.ts:622

execute

execute(context: Context, args: ScheduleCommandArgs): Promise<void>
Executes the actual command logic.
Parameters
- context: Context
  The command context.
- args: ScheduleCommandArgs
  The command arguments.
Returns Promise<void>
Overrides Command.execute
- Defined in src/main/typescript/commands/automation/ScheduleCommand.ts:125

`Optional`initialize

initialize(): Awaitable<void>
Initializes the command. This method gets called when the command is loaded.

Returns Awaitable<void>
- Nothing, or a promise that resolves when the command is initialized.
Inherited from Command.initialize
- Defined in src/framework/typescript/commands/Command.ts:277

isDisabled

isDisabled(guildId?: string): boolean
Parameters
- OptionalguildId: string
Returns boolean
Inherited from Command.isDisabled
- Defined in src/framework/typescript/commands/Command.ts:341

`Optional`onSubcommandNotFound

onSubcommandNotFound(
    context: Context,
    subcommand: string,
    errorType: "not_found" | "not_specified",
): Promise<void>
Handles the case when a subcommand is not found.
Parameters
- context: Context
  The command context.
- subcommand: string
  The subcommand that was not found.
- errorType: "not_found" | "not_specified"
  The type of error that occurred.
Returns Promise<void>
Inherited from Command.onSubcommandNotFound
- Defined in src/framework/typescript/commands/Command.ts:434

run

run(context: Context, rootCommand?: Command<Legacy | ChatInput>): Promise<void>
Prepares and begins to execute the command.
Parameters
- context: Context
  The command context.
- OptionalrootCommand: Command<Legacy | ChatInput>
  The root command.
Returns Promise<void>
Inherited from Command.run
- Defined in src/framework/typescript/commands/Command.ts:471

runPreconditions

runPreconditions(context: Context): Promise<PreconditionExecutionResult>
Runs the preconditions of the command.
Parameters
- context: Context
  The command context.
Returns Promise<PreconditionExecutionResult>
The result of the precondition check.
Inherited from Command.runPreconditions
- Defined in src/framework/typescript/commands/Command.ts:446

setFile

setFile(file: string): void
Sets the file associated with the command.
Parameters
- file: string
  The path to the file associated with the command.
Returns void
Inherited from Command.setFile
- Defined in src/framework/typescript/commands/Command.ts:284

supportsChatInput

supportsChatInput(): this is Command<ChatInput>
Checks if the command supports chat input context.

Returns this is Command<ChatInput>
True if the command supports chat input context, false otherwise.
Inherited from Command.supportsChatInput
- Defined in src/framework/typescript/commands/Command.ts:302

supportsContextMenu

supportsContextMenu(): this is Command<MessageContextMenu | UserContextMenu>
Checks if the command supports any context menu.

Returns this is Command<MessageContextMenu | UserContextMenu>
True if the command supports any context menu, false otherwise.
Inherited from Command.supportsContextMenu
- Defined in src/framework/typescript/commands/Command.ts:329

supportsInteraction

supportsInteraction(): this is Command<
    ChatInput
    | MessageContextMenu
    | UserContextMenu,
>
Returns this is Command<ChatInput | MessageContextMenu | UserContextMenu>
Inherited from Command.supportsInteraction
- Defined in src/framework/typescript/commands/Command.ts:335

supportsLegacy

supportsLegacy(): this is Command<Legacy>
Checks if the command supports legacy context.

Returns this is Command<Legacy>
True if the command supports legacy context, false otherwise.
Inherited from Command.supportsLegacy
- Defined in src/framework/typescript/commands/Command.ts:293

supportsMessageContextMenu

supportsMessageContextMenu(): this is Command<MessageContextMenu>
Checks if the command supports message context menu.

Returns this is Command<MessageContextMenu>
True if the command supports message context menu, false otherwise.
Inherited from Command.supportsMessageContextMenu
- Defined in src/framework/typescript/commands/Command.ts:311

supportsUserContextMenu

supportsUserContextMenu(): this is Command<UserContextMenu>
Checks if the command supports user context menu.

Returns this is Command<UserContextMenu>
True if the command supports user context menu, false otherwise.
Inherited from Command.supportsUserContextMenu
- Defined in src/framework/typescript/commands/Command.ts:320

Class ScheduleCommand

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScheduleCommand

Properties

Readonlyaliases

Protected Readonlyapplication

Readonlybeta

Protected ReadonlyconfigManager

Optional Readonlycooldown

Readonlydefer

Readonlydeprecated

Readonlydescription

Optional ReadonlydetailedDescription

Protected ReadonlydirectiveParsingService

Readonlydisabled

Readonlyephemeral

group

Readonlyguards

ReadonlyisolatedSubcommands

Protected Readonlylogger

ReadonlymaxAttempts

Readonlyname

Readonlyoptions

ReadonlypermissionCheckingMode

permissions

Optional ReadonlypersistentCustomPermissions

Optional ReadonlypersistentDiscordPermissions

Protected ReadonlyqueueService

Readonlysince

ReadonlysubcommandMeta

Readonlysubcommands

ReadonlysupportedContexts

ReadonlysystemAdminOnly

Protected ReadonlysystemAuditLogging

ReadonlysystemPermissions

Readonlyusage

Accessors

file

Returns undefined | string

hasSubcommands

Returns boolean

initialized

Returns boolean

Methods

Protectedabort

Parameters

Returns never

Throws

Protectedauthorize

Type Parameters

Parameters

Returns Promise<boolean>

Throws

build

Returns Buildable[]

ProtectedbuildChatInput

Returns SlashCommandBuilder

ProtectedbuildContextMenu

Returns ContextMenuCommandBuilder

ProtectedcheckGuards

Parameters

Returns Promise<boolean>

ProtectedcheckPermissions

Parameters

Returns Promise<boolean>

ProtectedcheckPreconditions

Parameters

Returns Promise<boolean>

ProtectedcomputePersistentPermissions

Returns Promise<void>

execute

Parameters

`Readonly`aliases

`Protected` `Readonly`application

`Readonly`beta

`Protected` `Readonly`configManager

`Optional` `Readonly`cooldown

`Readonly`defer

`Readonly`deprecated

`Readonly`description

`Optional` `Readonly`detailedDescription

`Protected` `Readonly`directiveParsingService

`Readonly`disabled

`Readonly`ephemeral

`Readonly`guards

`Readonly`isolatedSubcommands

`Protected` `Readonly`logger

`Readonly`maxAttempts

`Readonly`name

`Readonly`options

`Readonly`permissionCheckingMode

`Optional` `Readonly`persistentCustomPermissions

`Optional` `Readonly`persistentDiscordPermissions

`Protected` `Readonly`queueService

`Readonly`since

`Readonly`subcommandMeta

`Readonly`subcommands

`Readonly`supportedContexts

`Readonly`systemAdminOnly

`Protected` `Readonly`systemAuditLogging

`Readonly`systemPermissions

`Readonly`usage

`Protected`abort

`Protected`authorize

`Protected`buildChatInput

`Protected`buildContextMenu

`Protected`checkGuards

`Protected`checkPermissions

`Protected`checkPreconditions

`Protected`computePersistentPermissions

`Optional`initialize

`Optional`onSubcommandNotFound