ModalSubmitFields

Class

On this page

ModalSubmitFields is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

class Module 1.2.4 Source

Constructor

ModalSubmitFields.new(interaction)

The class table is callable, so ModalSubmitFields(interaction) is the same as .new.

Name	Type	Required	Behavior
`interaction`	`any`	required	Passed through to the implementation as written.

lua

local discord = require("discord")
local object = discord.ModalSubmitFields({})

Properties

ModalSubmitFields.client

# readonly

Name: client
Type: any
Access: readonly
Description: Owning Client instance used for REST, cache, and event dispatch.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

ModalSubmitFields.components

# readonly

Name: components
Type: any
Access: readonly
Description: Instance field ModalSubmitFields.components. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

ModalSubmitFields.data

# readonly

Name: data
Type: any
Access: readonly
Description: Instance field ModalSubmitFields.data. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

ModalSubmitFields.fields

# readonly

Name: fields
Type: Collection
Access: readonly
Description: Instance field ModalSubmitFields.fields. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.
Related: Collection

ModalSubmitFields.hoistedComponents

# readonly

Name: hoistedComponents
Type: any
Access: readonly
Description: Instance field ModalSubmitFields.hoistedComponents. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

ModalSubmitFields.interaction

# readonly

Name: interaction
Type: any
Access: readonly
Description: Instance field ModalSubmitFields.interaction. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

ModalSubmitFields.resolved

# readonly

Name: resolved
Type: any
Access: readonly
Description: Instance field ModalSubmitFields.resolved. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this ModalSubmitFields.

Methods

ModalSubmitFields:get()

Performs get on this ModalSubmitFields. Call it from bot code when you need that operation on the current object.

Signature

ModalSubmitFields:get(customId, required)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.
`required`	`any`	required	Passed through to the implementation as written.

Returns

ModalSubmitFields — the same instance, for chaining.

Throws

ValidationError

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:get("123", required)

ModalSubmitFields:getCheckbox()

Read the Checkbox value from this ModalSubmitFields.

Signature

ModalSubmitFields:getCheckbox(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getCheckbox("123")

ModalSubmitFields:getCheckboxGroup()

Read the CheckboxGroup value from this ModalSubmitFields.

Signature

ModalSubmitFields:getCheckboxGroup(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getCheckboxGroup("123")

ModalSubmitFields:getComponent()

Read the Component value from this ModalSubmitFields.

Signature

ModalSubmitFields:getComponent(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

any.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getComponent("123")

ModalSubmitFields:getField()

Read the Field value from this ModalSubmitFields.

Signature

ModalSubmitFields:getField(customId, required)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.
`required`	`any`	required	Passed through to the implementation as written.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getField("123", required)

ModalSubmitFields:getRadioGroup()

Read the RadioGroup value from this ModalSubmitFields.

Signature

ModalSubmitFields:getRadioGroup(customId, required)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.
`required`	`any`	required	Passed through to the implementation as written.

Returns

ModalSubmitFields — the same instance, for chaining.

Throws

ValidationError

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getRadioGroup("123", required)

ModalSubmitFields:getSelectedChannels()

Read the SelectedChannels value from this ModalSubmitFields.

Signature

ModalSubmitFields:getSelectedChannels(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getSelectedChannels("123")

ModalSubmitFields:getSelectedMembers()

Read the SelectedMembers value from this ModalSubmitFields.

Signature

ModalSubmitFields:getSelectedMembers(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getSelectedMembers("123")

ModalSubmitFields:getSelectedMentionables()

Read the SelectedMentionables value from this ModalSubmitFields.

Signature

ModalSubmitFields:getSelectedMentionables(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getSelectedMentionables("123")

ModalSubmitFields:getSelectedRoles()

Read the SelectedRoles value from this ModalSubmitFields.

Signature

ModalSubmitFields:getSelectedRoles(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

any.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getSelectedRoles("123")

ModalSubmitFields:getSelectedUsers()

Read the SelectedUsers value from this ModalSubmitFields.

Signature

ModalSubmitFields:getSelectedUsers(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

any.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getSelectedUsers("123")

ModalSubmitFields:getStringSelectValues()

Read the StringSelectValues value from this ModalSubmitFields.

Signature

ModalSubmitFields:getStringSelectValues(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

any.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getStringSelectValues("123")

ModalSubmitFields:getTextInputValue()

Read the TextInputValue value from this ModalSubmitFields.

Signature

ModalSubmitFields:getTextInputValue(customId, required)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.
`required`	`any`	required	Passed through to the implementation as written.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getTextInputValue("123", required)

ModalSubmitFields:getUploadedFiles()

Read the UploadedFiles value from this ModalSubmitFields.

Signature

ModalSubmitFields:getUploadedFiles(customId)

Parameters

Name	Type	Required	Behavior
`customId`	`string`	required	Snowflake id string.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:getUploadedFiles("123")

ModalSubmitFields:toJSON()

Serialize this ModalSubmitFields into a Lua table suitable for REST or debugging.

Signature

ModalSubmitFields:toJSON()

Parameters

No parameters.

Returns

ModalSubmitFields — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a ModalSubmitFields
object:toJSON()

Examples

lua

local discord = require("discord")
local object = discord.ModalSubmitFields({})

ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment

Version: discord 1.2.4 · runtime 1.0.0