Skip to main content

Class: InteractionOptionResolver

@sapphire/discord.js-utilities.InteractionOptionResolver

Utility class for resolving command interaction options while working with the raw API. Based on https://github.com/discordjs/discord.js/blob/main/packages/discord.js/src/structures/CommandInteractionOptionResolver.js

Constructors

constructor

new InteractionOptionResolver(interaction)

Parameters

NameType
interactionAPIApplicationCommandInteraction | APIApplicationCommandAutocompleteInteraction | APIModalSubmitInteraction

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:30

Properties

data

Private Readonly data: any

The interaction options array

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:12


getTypedOption

Private getTypedOption: any

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:83


group

Private Readonly group: any

The name of the subcommand group

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:25


hoistedOptions

Private Readonly hoistedOptions: any

Bottom-level options for the interaction If there is a subcommand (or subcommand and group), this represents the options for the subcommand.

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:21


interaction

Private Readonly interaction: any

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:8


resolved

Private Readonly resolved: any

The interaction resolved data

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:16


subcommand

Private Readonly subcommand: any

The name of the subcommand

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:29

Methods

get

get(name, required?): null | APIApplicationCommandInteractionDataOption

Parameters

NameType
namestring
required?boolean

Returns

null | APIApplicationCommandInteractionDataOption

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:31

get(name, required): APIApplicationCommandInteractionDataOption

Parameters

NameType
namestring
requiredtrue

Returns

APIApplicationCommandInteractionDataOption

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:32


getAttachment

getAttachment(name, required?): null | APIAttachment

Parameters

NameType
namestring
required?boolean

Returns

null | APIAttachment

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:53

getAttachment(name, required): APIAttachment

Parameters

NameType
namestring
requiredtrue

Returns

APIAttachment

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:54


getBoolean

getBoolean(name, required?): null | boolean

Parameters

NameType
namestring
required?boolean

Returns

null | boolean

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:37

getBoolean(name, required): boolean

Parameters

NameType
namestring
requiredtrue

Returns

boolean

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:38


getChannel

getChannel(name, required?): null | APIInteractionDataResolvedChannel

Parameters

NameType
namestring
required?boolean

Returns

null | APIInteractionDataResolvedChannel

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:39

getChannel(name, required): APIInteractionDataResolvedChannel

Parameters

NameType
namestring
requiredtrue

Returns

APIInteractionDataResolvedChannel

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:40


getFocusedOption

getFocusedOption(): { name: string ; type: String ; value: string } | { name: string ; type: Integer ; value: number } | { name: string ; type: Number ; value: number }

Gets the focused option for an autocomplete interaction

Returns

{ name: string ; type: String ; value: string } | { name: string ; type: Integer ; value: number } | { name: string ; type: Number ; value: number }

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:70


getInteger

getInteger(name, required?): null | number

Parameters

NameType
namestring
required?boolean

Returns

null | number

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:43

getInteger(name, required): number

Parameters

NameType
namestring
requiredtrue

Returns

number

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:44


getMember

getMember(name, required?): null | APIInteractionDataResolvedGuildMember

Parameters

NameType
namestring
required?boolean

Returns

null | APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:49

getMember(name, required): APIInteractionDataResolvedGuildMember

Parameters

NameType
namestring
requiredtrue

Returns

APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:50


getMentionable

getMentionable(name, required?): null | APIRole | APIUser | APIInteractionDataResolvedGuildMember

Parameters

NameType
namestring
required?boolean

Returns

null | APIRole | APIUser | APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:55

getMentionable(name, required): APIRole | APIUser | APIInteractionDataResolvedGuildMember

Parameters

NameType
namestring
requiredtrue

Returns

APIRole | APIUser | APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:56


getNumber

getNumber(name, required?): null | number

Parameters

NameType
namestring
required?boolean

Returns

null | number

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:45

getNumber(name, required): number

Parameters

NameType
namestring
requiredtrue

Returns

number

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:46


getRole

getRole(name, required?): null | APIRole

Parameters

NameType
namestring
required?boolean

Returns

null | APIRole

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:51

getRole(name, required): APIRole

Parameters

NameType
namestring
requiredtrue

Returns

APIRole

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:52


getString

getString(name, required?): null | string

Parameters

NameType
namestring
required?boolean

Returns

null | string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:41

getString(name, required): string

Parameters

NameType
namestring
requiredtrue

Returns

string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:42


getSubcommand

getSubcommand(required?): null | string

Parameters

NameType
required?boolean

Returns

null | string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:33

getSubcommand(required): string

Parameters

NameType
requiredtrue

Returns

string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:34


getSubcommandGroup

getSubcommandGroup(required?): null | string

Parameters

NameType
required?boolean

Returns

null | string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:35

getSubcommandGroup(required): string

Parameters

NameType
requiredtrue

Returns

string

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:36


getTargetMember

getTargetMember(required?): null | APIInteractionDataResolvedGuildMember

Parameters

NameType
required?boolean

Returns

null | APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:61

getTargetMember(required): APIInteractionDataResolvedGuildMember

Parameters

NameType
requiredtrue

Returns

APIInteractionDataResolvedGuildMember

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:62


getTargetMessage

getTargetMessage(): APIMessage

Gets the target message for a context menu interaction

Returns

APIMessage

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:66


getTargetUser

getTargetUser(): APIUser

Gets the target user for a context menu interaction

Returns

APIUser

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:60


getUser

getUser(name, required?): null | APIUser

Parameters

NameType
namestring
required?boolean

Returns

null | APIUser

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:47

getUser(name, required): APIUser

Parameters

NameType
namestring
requiredtrue

Returns

APIUser

Defined in

node_modules/@sapphire/discord-utilities/dist/index.d.ts:48