Documentation/detritus-client/Interaction

InteractionCommand<ParsedArgsFinished>class

The most basic Structure class, every structure extends this

On this page

Overview
Constructor1
Properties24
Accessors13
Methods34

The most basic Structure class, every structure extends this

import { Interaction } from 'detritus-client';

Interaction.InteractionCommand;

Hierarchy

StructureInteractionCommand

Type parameters

35 properties23 methods10 inheritedsrc/interaction/command.ts:302

Constructor

new InteractionCommand

src/interaction/command.ts:350

new InteractionCommand<ParsedArgsFinished = ParsedArgs>(data?: InteractionCommandOptions)

Properties

_file?

string

readonlyoptional

_options?

BaseCollection<string, InteractionCommandOption<ParsedArgs>>

optional

contexts

InteractionContextTypes[] | null

Default null

defaultMemberPermissions

bigint | null

Default null

defaultPermission

boolean

Default true

description

string

Default ''

descriptionLocalizations

Record<string, string | undefined> | null

Default null

disableDm?

boolean

optional

dmPermission

boolean

Default true

global

boolean

Default true

guildIds?

BaseSet<string>

optional

ids

BaseCollection<string, string>

integrationTypes?

ApplicationIntegrationTypes[]

optional

metadata

Record<string, any>

Default {}

name

string

Default ''

nameLocalizations

Record<string, string | undefined> | null

Default null

nsfw

boolean

Default false

permissions?

bigint[]

optional

permissionsClient?

bigint[]

optional

permissionsIgnoreClientOwner?

boolean

optional

ratelimits

CommandRatelimit[]

Default []

triggerLoadingAfter?

number

optional

triggerLoadingAsEphemeral?

boolean

optional

type

ApplicationCommandTypes

Default ApplicationCommandTypes.CHAT_INPUT

Accessors

fullName

string

get

hash

string

get

hasRun

boolean

get

invokers

(InteractionCommandOption<ParsedArgs> | InteractionCommand<ParsedArgs>)[]

get

isContextCommand

boolean

get

isContextCommandMessage

boolean

get

isContextCommandUser

boolean

get

isGroup

boolean

get

isSlashCommand

boolean

get

key

string

get

length

number

get

lengthOptions

number

get

options

InteractionCommandOption<ParsedArgs>[] | undefined

get · set

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from Structure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from Structure._setFromSnake

_transferValuesToChildren()

src/interaction/command.ts:610

_transferValuesToChildren(): void

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from Structure.[custom]

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from Structure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from Structure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from Structure.differencesBetween

getInvoker()

src/interaction/command.ts:519

getInvoker(data: InteractionDataApplicationCommand): InteractionCommandInvoker | null

getInvokerForAutoComplete()

src/interaction/command.ts:529

getInvokerForAutoComplete(
  data: InteractionDataApplicationCommand,
): InteractionCommandInvoker | null

getInvokerOption()

src/interaction/command.ts:571

getInvokerOption(
  options: BaseCollection<string, InteractionDataApplicationCommandOption>,
): InteractionCommandOption<ParsedArgs> | null

getInvokerOptionForAutoComplete()

src/interaction/command.ts:588

getInvokerOptionForAutoComplete(
  options: BaseCollection<string, InteractionDataApplicationCommandOption>,
): InteractionCommandOption<ParsedArgs> | null

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from Structure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from Structure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from Structure.hasDifferencesBetween

merge()

src/structures/basestructure.ts:323

merge(data?: BaseStructureData): void

Inherited from Structure.merge

mergeValue()

src/interaction/command.ts:618

mergeValue(key: string, value: any): void

Overrides Structure.mergeValue

onAutoComplete()

optional src/interaction/command.ts:332

onAutoComplete(context: InteractionAutoCompleteContext): unknown

onAutoCompleteError()

optional src/interaction/command.ts:333

onAutoCompleteError(context: InteractionAutoCompleteContext, error: any): unknown

onBefore()

optional src/interaction/command.ts:336

onBefore(context: InteractionContext): boolean | Promise<boolean>

onBeforeRun()

optional src/interaction/command.ts:337

onBeforeRun(context: InteractionContext, args: ParsedArgs): boolean | Promise<boolean>

onCancel()

optional src/interaction/command.ts:338

onCancel(context: InteractionContext): unknown

onCancelRun()

optional src/interaction/command.ts:339

onCancelRun(context: InteractionContext, args: ParsedArgs): unknown

onDmBlocked()

optional src/interaction/command.ts:334

onDmBlocked(context: InteractionContext): unknown

onError()

optional src/interaction/command.ts:340

onError(context: InteractionContext, args: ParsedArgs, error: any): unknown

onFinally()

optional src/interaction/command.ts:341

onFinally(context: InteractionContext): unknown

onLoadingTrigger()

optional src/interaction/command.ts:335

onLoadingTrigger(context: InteractionContext): unknown

onPermissionsFail()

optional src/interaction/command.ts:342

onPermissionsFail(context: InteractionContext, permissions: FailedPermissions): unknown

onPermissionsFailClient()

optional src/interaction/command.ts:343

onPermissionsFailClient(
  context: InteractionContext,
  permissions: FailedPermissions,
): unknown

onRatelimit()

optional src/interaction/command.ts:344

onRatelimit(
  context: InteractionContext,
  ratelimits: CommandRatelimitInfo[],
  metadata: CommandRatelimitMetadata,
): unknown

onRunError()

optional src/interaction/command.ts:346

onRunError(context: InteractionContext, args: ParsedArgs, error: any): unknown

onSuccess()

optional src/interaction/command.ts:347

onSuccess(context: InteractionContext, args: ParsedArgs): unknown

onValueError()

optional src/interaction/command.ts:348

onValueError(context: InteractionContext, args: ParsedArgs, errors: ParsedErrors): unknown

run()

optional src/interaction/command.ts:345

run(context: InteractionContext, args: ParsedArgs): unknown

toJSON()

src/interaction/command.ts:649

toJSON(): object

Overrides Structure.toJSON