Class: 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
new InteractionOptionResolver()
new InteractionOptionResolver(
interaction
:APIApplicationCommandInteraction
|APIApplicationCommandAutocompleteInteraction
|APIModalSubmitInteraction
):InteractionOptionResolver
Parameters
Parameter | Type |
---|---|
interaction | APIApplicationCommandInteraction | APIApplicationCommandAutocompleteInteraction | APIModalSubmitInteraction |
Returns
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:30
Methods
get()
get(name, required)
get(
name
:string
,required
?:boolean
):null
|APIApplicationCommandInteractionDataOption
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIApplicationCommandInteractionDataOption
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:31
get(name, required)
get(
name
:string
,required
:true
):APIApplicationCommandInteractionDataOption
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIApplicationCommandInteractionDataOption
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:32
getAttachment()
getAttachment(name, required)
getAttachment(
name
:string
,required
?:boolean
):null
|APIAttachment
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIAttachment
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:53
getAttachment(name, required)
getAttachment(
name
:string
,required
:true
):APIAttachment
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIAttachment
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:54
getBoolean()
getBoolean(name, required)
getBoolean(
name
:string
,required
?:boolean
):null
|boolean
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| boolean
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:37
getBoolean(name, required)
getBoolean(
name
:string
,required
:true
):boolean
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
boolean
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:38
getChannel()
getChannel(name, required)
getChannel(
name
:string
,required
?:boolean
):null
|APIInteractionDataResolvedChannel
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIInteractionDataResolvedChannel
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:39
getChannel(name, required)
getChannel(
name
:string
,required
:true
):APIInteractionDataResolvedChannel
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIInteractionDataResolvedChannel
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:40
getFocusedOption()
getFocusedOption():
object
|object
|object
Gets the focused option for an autocomplete interaction
Returns
object
| object
| object
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:70
getInteger()
getInteger(name, required)
getInteger(
name
:string
,required
?:boolean
):null
|number
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| number
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:43
getInteger(name, required)
getInteger(
name
:string
,required
:true
):number
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
number
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:44
getMember()
getMember(name, required)
getMember(
name
:string
,required
?:boolean
):null
|APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:49
getMember(name, required)
getMember(
name
:string
,required
:true
):APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:50
getMentionable()
getMentionable(name, required)
getMentionable(
name
:string
,required
?:boolean
):null
|APIRole
|APIUser
|APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIRole
| APIUser
| APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:55
getMentionable(name, required)
getMentionable(
name
:string
,required
:true
):APIRole
|APIUser
|APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIRole
| APIUser
| APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:56
getNumber()
getNumber(name, required)
getNumber(
name
:string
,required
?:boolean
):null
|number
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| number
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:45
getNumber(name, required)
getNumber(
name
:string
,required
:true
):number
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
number
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:46
getRole()
getRole(name, required)
getRole(
name
:string
,required
?:boolean
):null
|APIRole
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIRole
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:51
getRole(name, required)
getRole(
name
:string
,required
:true
):APIRole
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIRole
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:52
getString()
getString(name, required)
getString(
name
:string
,required
?:boolean
):null
|string
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:41
getString(name, required)
getString(
name
:string
,required
:true
):string
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:42
getSubcommand()
getSubcommand(required)
getSubcommand(
required
?:boolean
):null
|string
Parameters
Parameter | Type |
---|---|
required ? | boolean |
Returns
null
| string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:33
getSubcommand(required)
getSubcommand(
required
:true
):string
Parameters
Parameter | Type |
---|---|
required | true |
Returns
string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:34
getSubcommandGroup()
getSubcommandGroup(required)
getSubcommandGroup(
required
?:boolean
):null
|string
Parameters
Parameter | Type |
---|---|
required ? | boolean |
Returns
null
| string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:35
getSubcommandGroup(required)
getSubcommandGroup(
required
:true
):string
Parameters
Parameter | Type |
---|---|
required | true |
Returns
string
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:36
getTargetMember()
getTargetMember(required)
getTargetMember(
required
?:boolean
):null
|APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
required ? | boolean |
Returns
null
| APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:61
getTargetMember(required)
getTargetMember(
required
:true
):APIInteractionDataResolvedGuildMember
Parameters
Parameter | Type |
---|---|
required | true |
Returns
APIInteractionDataResolvedGuildMember
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:62
getTargetMessage()
getTargetMessage():
APIMessage
Gets the target message for a context menu interaction
Returns
APIMessage
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:66
getTargetUser()
getTargetUser():
APIUser
Gets the target user for a context menu interaction
Returns
APIUser
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:60
getUser()
getUser(name, required)
getUser(
name
:string
,required
?:boolean
):null
|APIUser
Parameters
Parameter | Type |
---|---|
name | string |
required ? | boolean |
Returns
null
| APIUser
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:47
getUser(name, required)
getUser(
name
:string
,required
:true
):APIUser
Parameters
Parameter | Type |
---|---|
name | string |
required | true |
Returns
APIUser
Defined in
node_modules/@sapphire/discord-utilities/dist/esm/index.d.mts:48