Class: InteractionOptions

Constructor

new InteractionOptions() → {InteractionOptions}

Source: structures/InteractionOptions.js, line 20

Returns:

Type:: InteractionOptions

Example

const subCommandOption = interaction.options.getSubCommand(); // returns the subcommand option
const subCommandGroupOption = interaction.options.getSubCommandGroup(); // returns the subcommand group option
const stringOption = interaction.options.getStringOption("optionName"); // returns the string option
const integerOption = interaction.options.getIntegerOption("optionName"); // returns the integer option
const booleanOption = interaction.options.getBooleanOption("optionName"); // returns the boolean option
const userOption = interaction.options.getUserOption("optionName"); // returns the user option
const memberOption = interaction.options.getMemberOption("optionName"); // returns the member option
const channelOption = interaction.options.getChannelOption("optionName"); // returns the channel option
const roleOption = interaction.options.getRoleOption("optionName"); // returns the role option
const numberOption = interaction.options.getNumberOption("optionName"); // returns the number option
const mentionableOption = interaction.options.getMentionableOption("optionName"); // returns the mentionable option

Members

data :Array.<object>

the interaction option data

Type:

Array.<object>

Source: structures/InteractionOptions.js, line 26

Methods

getAttachmentOption() → {InteractionOptionsType.structure}

Get the interaction option "Attachment"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 146

Returns:

Type:: InteractionOptionsType.structure

Example

const attachmentOption = interaction.options.getAttachmentOption("optionName"); // returns the attachment

getBooleanOption() → {InteractionOptionsType.structure}

Get the interaction option "Boolean"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 80

Returns:

Type:: InteractionOptionsType.structure

Example

const booleanOption = interaction.options.getBooleanOption("optionName"); // returns the boolean

getChannelOption() → {InteractionOptionsType.structure}

Get the interaction option "Channel"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 102

Returns:

Type:: InteractionOptionsType.structure

Example

const channelOption = interaction.options.getChannelOption("optionName"); // returns the channel

getIntegerOption() → {InteractionOptionsType.structure}

Get the interaction option "String"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 69

Returns:

Type:: InteractionOptionsType.structure

Example

const integerOption = interaction.options.getIntegerOptionOption("optionName"); // returns the integer

getMentionableOption() → {InteractionOptionsType.structure}

Get the interaction option "Mentionable"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 124

Returns:

Type:: InteractionOptionsType.structure

Example

const mentionableOption = interaction.options.getMentionableOption("optionName"); // returns the mentionable

getNumberOption() → {InteractionOptionsType.structure}

Get the interaction option "Number"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 135

Returns:

Type:: InteractionOptionsType.structure

Example

const numberOption = interaction.options.getNumberOption("optionName"); // returns the number

getOptions() → {Array.<object>}

Get the interaction options

Source: structures/InteractionOptions.js, line 156

Returns:

Type:: Array.<object>

Example

const options = interaction.options.getOptions(); // returns the options

getRoleOption() → {InteractionOptionsType.structure}

Get the interaction option "Role"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 113

Returns:

Type:: InteractionOptionsType.structure

Example

const roleOption = interaction.options.getRoleOption("optionName"); // returns the role

getStringOption() → {InteractionOptionsType.structure}

Get the interaction option "String"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 58

Returns:

Type:: InteractionOptionsType.structure

Example

const stringOption = interaction.options.getStringOption("optionName"); // returns the string

getSubCommand() → {InteractionOptionsType.structure}

Get the interaction option "Sub Command"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 36

Returns:

Type:: InteractionOptionsType.structure

Example

const subCommandOption = interaction.options.getSubCommand(); // returns the subcommand

getSubCommandGroup() → {InteractionOptionsType.structure}

Get the interaction option "Sub Command Group"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 47

Returns:

Type:: InteractionOptionsType.structure

Example

const subCommandGroupOption = interaction.options.getSubCommandGroup(); // returns the subcommand group

getUserOption() → {InteractionOptionsType.structure}

Get the interaction option "User"

Properties

Name	Type	Description
`name`	string	The name of the option

Source: structures/InteractionOptions.js, line 91

Returns:

Type:: InteractionOptionsType.structure

Example

const userOption = interaction.options.getUserOption("optionName"); // returns the user