Skip to content
Discord Luau

File

Implementation of Discord’s File component as a Luau builder. The URL must be an attachment:// reference pointing to an uploaded file.

https://discord.com/developers/docs/components/reference#file

Summary

Properties

File.url :: string?File.spoiler :: boolean?

Methods

File:setFile(url: string) → FileFile:setSpoiler(spoiler: boolean) → FileFile:build() → JSON

Functions

File.new(resource: { url: string?, spoiler: boolean?, }?) → File

Properties

Section titled “Properties”

url

Section titled “url”
File.url  :: string?

The attachment URL (must use attachment://filename format).

spoiler

Section titled “spoiler”
File.spoiler  :: boolean?

Whether the file is blurred as a spoiler.

Methods

Section titled “Methods”

setFile

Section titled “setFile”
File : setFile ( url )  -> File

Sets the attachment URL. Must use the attachment://filename format.

Parameters

url: string

Returns

File

setSpoiler

Section titled “setSpoiler”
File : setSpoiler ( spoiler )  -> File

Sets whether the file is blurred as a spoiler.

Parameters

spoiler: boolean

Returns

File

build

Section titled “build”
File : build ( )  -> JSON

Responsible for building the File JSON that can be parsed by the Discord API.

Returns

JSON

Functions

Section titled “Functions”

new

Section titled “new”
File . new ( resource )  -> File

Responsible for creating a new File.

Parameters

resource: {
url: string?,
spoiler: boolean?,
}

Returns

File