FileUploadBuilder
BuilderOn this page
FileUploadBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
FileUploadBuilder.new() The class table is callable, so FileUploadBuilder() is the same as .new.
No parameters.
local discord = require("discord")
local object = discord.FileUploadBuilder()Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
FileUploadBuilder.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 FileUploadBuilder.
Methods
Performs from on this FileUploadBuilder. Call it from bot code when you need that operation on the current object.
Signature
FileUploadBuilder.from(data) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
data |
any |
required | Passed through to the implementation as written. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
FileUploadBuilder.from(data)FileUploadBuilder:setCustomId()
#Set the CustomId field. Builders return this FileUploadBuilder so setters can be chained.
Signature
FileUploadBuilder:setCustomId(id) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
id |
string |
required | Snowflake id string. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:setCustomId("123")FileUploadBuilder:setId()
#Set the Id field. Builders return this FileUploadBuilder so setters can be chained.
Signature
FileUploadBuilder:setId(id) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
id |
string |
required | Snowflake id string. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:setId("123")FileUploadBuilder:setMaxValues()
#Set the MaxValues field. Builders return this FileUploadBuilder so setters can be chained.
Signature
FileUploadBuilder:setMaxValues(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:setMaxValues(value)FileUploadBuilder:setMinValues()
#Set the MinValues field. Builders return this FileUploadBuilder so setters can be chained.
Signature
FileUploadBuilder:setMinValues(value) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
value |
any |
required | Passed through to the implementation as written. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:setMinValues(value)FileUploadBuilder:setRequired()
#Set the Required field. Builders return this FileUploadBuilder so setters can be chained.
Signature
FileUploadBuilder:setRequired(required) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
required |
any |
required | Passed through to the implementation as written. |
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:setRequired(required)FileUploadBuilder:toJSON()
#Serialize this FileUploadBuilder into a Lua table suitable for REST or debugging.
Signature
FileUploadBuilder:toJSON() Parameters
No parameters.
Returns
FileUploadBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileUploadBuilder
object:toJSON()Examples
local discord = require("discord")
local object = discord.FileUploadBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder
Version: discord 1.2.4 · runtime 1.0.0