Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InteractionRequest<Body>

Type parameters

  • Body = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new InteractionRequest<Body>(interaction: CommandInteraction<CacheType>): InteractionRequest<Body>

Properties

Readonly appId

appId: null | string

body

body: Body

Arguments and options passed from the command

Readonly channel

channel: null | TextBasedChannel

Readonly channelId

channelId: null | string

Readonly client

client: null | Client<boolean>

command

command: [command?: string, subcommandGroup?: string, subcommand?: string] = []

Command details. Note that for message commands, positional arguments are inserted even if they may not be subcommands or subcommand groups.

example
// A command that looks like this
const input = "!myCommand arg1 arg2 arg3"

// Will output this
const output = {
    body: {
        _: ["arg1", "arg2", "arg4"],
    },
    command: ["myCommand", "arg1", "arg2"],
}

Because of this ambiguity, the decision of how to treat this behaviour is up to the programmer later on. Note that this behaviour is properly handled by discord-express.

Readonly createdAt

createdAt: Date

Readonly createdTimestamp

createdTimestamp: number

Readonly guild

guild: null | Guild

Readonly guildId

guildId: null | string

Readonly id

id: string

Readonly interaction

interaction: CommandInteraction<CacheType>

Readonly isInteractionRequest

isInteractionRequest: true = true

Readonly isMessageRequest

isMessageRequest: false = false

Readonly member

member: null | GuildMember | APIInteractionGuildMember

Optional Readonly message

message?: undefined = undefined

metadata

metadata: {} = {}

Extra metadata that can be stored for any purpose

Type declaration

  • [key: string]: unknown

Readonly requestType

requestType: "interaction" = ...

Readonly startAt

startAt: Date = ...

Readonly trigger

trigger: CommandInteraction<CacheType>

What triggered the command. In this case, it's a command interaction

Readonly type

type: "APPLICATION_COMMAND" | "PING" | "MESSAGE_COMPONENT" | "APPLICATION_COMMAND_AUTOCOMPLETE"

Readonly user

user: User

User who triggered the request

alias

author

Accessors

author

  • get author(): User

  • Author of the request

    alias

    user

    Returns User

Generated using TypeDoc