FileBuilder
BuilderOn this page
FileBuilder is a fluent payload builder. Chain setters, then pass the builder to send, reply, or command registration.
Constructor
FileBuilder.new() The class table is callable, so FileBuilder() is the same as .new.
No parameters.
local discord = require("discord")
local object = discord.FileBuilder()Properties
- Name
data- Type
any- Access
- readonly
- Description
- Instance field
FileBuilder.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 FileBuilder.
Methods
FileBuilder:setSpoiler()
#Set the Spoiler field. Builders return this FileBuilder so setters can be chained.
Signature
FileBuilder:setSpoiler(spoiler) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
spoiler |
any |
required | Passed through to the implementation as written. |
Returns
FileBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileBuilder
object:setSpoiler(spoiler)FileBuilder:setURL()
#Set the URL field. Builders return this FileBuilder so setters can be chained.
Signature
FileBuilder:setURL(url) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
url |
any |
required | Passed through to the implementation as written. |
Returns
FileBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileBuilder
object:setURL(url)FileBuilder:toJSON()
#Serialize this FileBuilder into a Lua table suitable for REST or debugging.
Signature
FileBuilder:toJSON() Parameters
No parameters.
Returns
FileBuilder — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a FileBuilder
object:toJSON()Examples
local discord = require("discord")
local object = discord.FileBuilder({})Related APIs
ActionRowBuilder · AttachmentBuilder · ButtonBuilder · ChannelSelectMenuBuilder · CheckboxBuilder · ContainerBuilder · ContextMenuCommandBuilder · EmbedBuilder
Version: discord 1.2.4 · runtime 1.0.0