Class CommandManager

Hierarchy (View Summary, Expand)

Service
- CommandManager

Implements

CommandManagerServiceInterface

Constructors

constructor

new CommandManager(application: Application): CommandManager
Parameters
- application: Application
Returns CommandManager
Inherited from Service.constructor
- Defined in src/framework/typescript/services/Service.ts:32

Properties

`Protected` `Readonly`application

application: Application

`Readonly`argumentParser

argumentParser: ArgumentParser = ...

`Protected` `Readonly`client

client: BaseClient

`Readonly`commands

commands: Collection<string, Command<Legacy | ChatInput>> = ...

`Protected` `Readonly`configManager

configManager: configurationManager

`Protected` `Readonly`logger

logger: Logger

`Readonly`ratelimiter

ratelimiter: CommandRateLimiter = ...

`Readonly`store

store: CommandPermissionOverwriteCacheStore = ...

`Protected` `Static`name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

addCommand

addCommand(
    command: Command,
    loadMetadata?: boolean,
    groups?: null | Record<string, string>,
    defaultGroup?: string,
): void
Parameters
- command: Command
- loadMetadata: boolean = true
- groups: null | Record<string, string> = null
- defaultGroup: string = "default"
Returns void
Implementation of CommandManagerServiceInterface.addCommand
- Defined in src/main/typescript/services/CommandManager.ts:206

boot

boot(): Awaitable<void>
Returns Awaitable<void>
Inherited from Service.boot
- Defined in src/framework/typescript/services/Service.ts:30

checkCommandPermissionOverwrites

checkCommandPermissionOverwrites(
    context: Context,
    name: string,
    alreadyComputedPermissions?: MemberPermissionData,
): Promise<null | { allow: boolean; overwrite: boolean }>
Parameters
- context: Context
- name: string
- OptionalalreadyComputedPermissions: MemberPermissionData
Returns Promise<null | { allow: boolean; overwrite: boolean }>
Implementation of CommandManagerServiceInterface.checkCommandPermissionOverwrites
- Defined in src/main/typescript/services/CommandManager.ts:741

getApplicationCommandDataResolvableList

getApplicationCommandDataResolvableList(): ApplicationCommandDataResolvable[]
Returns ApplicationCommandDataResolvable[]
- Defined in src/main/typescript/services/CommandManager.ts:81

getArgumentParser

getArgumentParser(): ArgumentParser
Returns ArgumentParser
Implementation of CommandManagerServiceInterface.getArgumentParser
- Defined in src/main/typescript/services/CommandManager.ts:194

getCanonicalName

getCanonicalName(name: string): string
Parameters
- name: string
Returns string
- Defined in src/main/typescript/services/CommandManager.ts:261

getCommand

getCommand(name: string): null | Command<Legacy | ChatInput>
Parameters
- name: string
Returns null | Command<Legacy | ChatInput>
Implementation of CommandManagerServiceInterface.getCommand
- Defined in src/main/typescript/services/CommandManager.ts:198

getRateLimiter

getRateLimiter(): CommandRateLimiter
Returns CommandRateLimiter
Implementation of CommandManagerServiceInterface.getRateLimiter
- Defined in src/main/typescript/services/CommandManager.ts:202

invalidatePermissionOverwrite

invalidatePermissionOverwrite(
    overwrite: {
        commands: string[];
        createdAt: Date;
        disabled: null | boolean;
        guildId: string;
        id: number;
        onMatch: CommandPermissionOverwriteAction;
        requiredChannels: unknown;
        requiredDiscordPermissions: unknown;
        requiredLevel: null | number;
        requiredRoles: unknown;
        requiredSystemPermissions: unknown;
        requiredUsers: unknown;
        updatedAt: Date;
    },
): void
Parameters
- overwrite: {
      commands: string[];
      createdAt: Date;
      disabled: null | boolean;
      guildId: string;
      id: number;
      onMatch: CommandPermissionOverwriteAction;
      requiredChannels: unknown;
      requiredDiscordPermissions: unknown;
      requiredLevel: null | number;
      requiredRoles: unknown;
      requiredSystemPermissions: unknown;
      requiredUsers: unknown;
      updatedAt: Date;
  }
Returns void
- Defined in src/main/typescript/services/CommandManager.ts:77

`Protected`mergePermissionOverwrites

mergePermissionOverwrites(
    onMatch: CommandPermissionOverwriteAction,
    base?: CachedCommandPermissionOverwrites,
    other?: CachedMinimalCommandPermissionOverwrite,
): CachedCommandPermissionOverwrites
Parameters
- onMatch: CommandPermissionOverwriteAction
- Optionalbase: CachedCommandPermissionOverwrites
- Optionalother: CachedMinimalCommandPermissionOverwrite
Returns CachedCommandPermissionOverwrites
- Defined in src/main/typescript/services/CommandManager.ts:696

onReady

onReady(): Promise<void>
Returns Promise<void>
- Defined in src/main/typescript/services/CommandManager.ts:73

`Protected`performChecks

performChecks(
    action: CommandPermissionOverwriteAction,
    cachedOverwrite: CachedMinimalCommandPermissionOverwrite,
    context: Context,
    memberPermissions: MemberPermissionData,
): Promise<boolean>
Parameters
- action: CommandPermissionOverwriteAction
- cachedOverwrite: CachedMinimalCommandPermissionOverwrite
- context: Context
- memberPermissions: MemberPermissionData
Returns Promise<boolean>
- Defined in src/main/typescript/services/CommandManager.ts:795

registerApplicationCommands

registerApplicationCommands(): Promise<void>
Returns Promise<void>
- Defined in src/main/typescript/services/CommandManager.ts:126

reloadCommand

reloadCommand(command: Command): Promise<void>
Parameters
- command: Command
Returns Promise<void>
- Defined in src/main/typescript/services/CommandManager.ts:241

`Protected`requirementCheckChannels

requirementCheckChannels(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    channels: null | string[],
): boolean
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- channels: null | string[]
Returns boolean
- Defined in src/main/typescript/services/CommandManager.ts:486

`Protected`requirementCheckLevel

requirementCheckLevel(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    level: null | number,
): Promise<boolean>
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- level: null | number
Returns Promise<boolean>
- Defined in src/main/typescript/services/CommandManager.ts:535

`Protected`requirementCheckPermissions

requirementCheckPermissions(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    permissions:
        | null
        | CommandOverwriteLogic<
            | "BanMembers"
            | "KickMembers"
            | "ModerateMembers"
            | "ManageMessages"
            | "CreateInstantInvite"
            | "Administrator"
            | "ManageChannels"
            | "ManageGuild"
            | "AddReactions"
            | "ViewAuditLog"
            | "PrioritySpeaker"
            | "Stream"
            | "ViewChannel"
            | "SendMessages"
            | "SendTTSMessages"
            | "EmbedLinks"
            | "AttachFiles"
            | "ReadMessageHistory"
            | "MentionEveryone"
            | "UseExternalEmojis"
            | "ViewGuildInsights"
            | "Connect"
            | "Speak"
            | "MuteMembers"
            | "DeafenMembers"
            | "MoveMembers"
            | "UseVAD"
            | "ChangeNickname"
            | "ManageNicknames"
            | "ManageRoles"
            | "ManageWebhooks"
            | "ManageEmojisAndStickers"
            | "ManageGuildExpressions"
            | "UseApplicationCommands"
            | "RequestToSpeak"
            | "ManageEvents"
            | "ManageThreads"
            | "CreatePublicThreads"
            | "CreatePrivateThreads"
            | "UseExternalStickers"
            | "SendMessagesInThreads"
            | "UseEmbeddedActivities"
            | "ViewCreatorMonetizationAnalytics"
            | "UseSoundboard"
            | "CreateGuildExpressions"
            | "CreateEvents"
            | "UseExternalSounds"
            | "SendVoiceMessages"
            | "SendPolls"
            | "UseExternalApps",
        >,
    memberPermissions: PermissionResolvable[],
): boolean
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- permissions:
      | null
      | CommandOverwriteLogic<
          | "BanMembers"
          | "KickMembers"
          | "ModerateMembers"
          | "ManageMessages"
          | "CreateInstantInvite"
          | "Administrator"
          | "ManageChannels"
          | "ManageGuild"
          | "AddReactions"
          | "ViewAuditLog"
          | "PrioritySpeaker"
          | "Stream"
          | "ViewChannel"
          | "SendMessages"
          | "SendTTSMessages"
          | "EmbedLinks"
          | "AttachFiles"
          | "ReadMessageHistory"
          | "MentionEveryone"
          | "UseExternalEmojis"
          | "ViewGuildInsights"
          | "Connect"
          | "Speak"
          | "MuteMembers"
          | "DeafenMembers"
          | "MoveMembers"
          | "UseVAD"
          | "ChangeNickname"
          | "ManageNicknames"
          | "ManageRoles"
          | "ManageWebhooks"
          | "ManageEmojisAndStickers"
          | "ManageGuildExpressions"
          | "UseApplicationCommands"
          | "RequestToSpeak"
          | "ManageEvents"
          | "ManageThreads"
          | "CreatePublicThreads"
          | "CreatePrivateThreads"
          | "UseExternalStickers"
          | "SendMessagesInThreads"
          | "UseEmbeddedActivities"
          | "ViewCreatorMonetizationAnalytics"
          | "UseSoundboard"
          | "CreateGuildExpressions"
          | "CreateEvents"
          | "UseExternalSounds"
          | "SendVoiceMessages"
          | "SendPolls"
          | "UseExternalApps",
      >
- memberPermissions: PermissionResolvable[]
Returns boolean
- Defined in src/main/typescript/services/CommandManager.ts:567

`Protected`requirementCheckRoles

requirementCheckRoles(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    roles: null | CommandOverwriteLogic<string>,
): boolean
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- roles: null | CommandOverwriteLogic<string>
Returns boolean
- Defined in src/main/typescript/services/CommandManager.ts:494

`Protected`requirementCheckSystemPermissions

requirementCheckSystemPermissions(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    permissions: null | CommandOverwriteLogic<"system.admin">,
    permissionStrings: "system.admin"[],
): boolean
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- permissions: null | CommandOverwriteLogic<"system.admin">
- permissionStrings: "system.admin"[]
Returns boolean
- Defined in src/main/typescript/services/CommandManager.ts:611

`Protected`requirementCheckUsers

requirementCheckUsers(
    _action: CommandPermissionOverwriteAction,
    context: Context,
    users: null | CommandOverwriteLogic<string>,
): boolean
Parameters
- _action: CommandPermissionOverwriteAction
- context: Context
- users: null | CommandOverwriteLogic<string>
Returns boolean
- Defined in src/main/typescript/services/CommandManager.ts:653

runCommandFromInteraction

runCommandFromInteraction(
interaction: CommandInteraction,
): Promise<undefined | boolean>
Parameters
- interaction: CommandInteraction
Returns Promise<undefined | boolean>
- Defined in src/main/typescript/services/CommandManager.ts:411

runCommandFromMessage

runCommandFromMessage(
message: Message<true>,
): Promise<undefined | boolean | Message<boolean>>
Parameters
- message: Message<true>
Returns Promise<undefined | boolean | Message<boolean>>
- Defined in src/main/typescript/services/CommandManager.ts:265

updateApplicationCommands

updateApplicationCommands(
__namedParameters?: ApplicationCommandUpdateOptions,
): Promise<number>
Parameters
- __namedParameters: ApplicationCommandUpdateOptions = {}
Returns Promise<number>
- Defined in src/main/typescript/services/CommandManager.ts:95

`Static`getName

getName(): string
Returns string
Inherited from Service.getName
- Defined in src/framework/typescript/services/Service.ts:38

Class CommandManager

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommandManager

Properties

Protected Readonlyapplication

ReadonlyargumentParser

Protected Readonlyclient

Readonlycommands

Protected ReadonlyconfigManager

Protected Readonlylogger

Readonlyratelimiter

Readonlystore

Protected Staticname

Methods

addCommand

Parameters

Returns void

boot

Returns Awaitable<void>

checkCommandPermissionOverwrites

Parameters

Returns Promise<null | { allow: boolean; overwrite: boolean }>

getApplicationCommandDataResolvableList

Returns ApplicationCommandDataResolvable[]

getArgumentParser

Returns ArgumentParser

getCanonicalName

Parameters

Returns string

getCommand

Parameters

Returns null | Command<Legacy | ChatInput>

getRateLimiter

Returns CommandRateLimiter

invalidatePermissionOverwrite

Parameters

Returns void

ProtectedmergePermissionOverwrites

Parameters

Returns CachedCommandPermissionOverwrites

onReady

Returns Promise<void>

ProtectedperformChecks

Parameters

Returns Promise<boolean>

registerApplicationCommands

Returns Promise<void>

reloadCommand

Parameters

Returns Promise<void>

ProtectedrequirementCheckChannels

Parameters

Returns boolean

ProtectedrequirementCheckLevel

Parameters

Returns Promise<boolean>

ProtectedrequirementCheckPermissions

Parameters

Returns boolean

ProtectedrequirementCheckRoles

Parameters

Returns boolean

ProtectedrequirementCheckSystemPermissions

Parameters

Returns boolean

ProtectedrequirementCheckUsers

Parameters

Returns boolean

runCommandFromInteraction

Parameters

Returns Promise<undefined | boolean>

runCommandFromMessage

`Protected` `Readonly`application

`Readonly`argumentParser

`Protected` `Readonly`client

`Readonly`commands

`Protected` `Readonly`configManager

`Protected` `Readonly`logger

`Readonly`ratelimiter

`Readonly`store

`Protected` `Static`name

`Protected`mergePermissionOverwrites

`Protected`performChecks

`Protected`requirementCheckChannels

`Protected`requirementCheckLevel

`Protected`requirementCheckPermissions

`Protected`requirementCheckRoles

`Protected`requirementCheckSystemPermissions

`Protected`requirementCheckUsers

`Static`getName