Skip to content
Discord Luau

WelcomeScreen

Implementation of the Discord WelcomeScreen class in Luau

https://discord.com/developers/docs/resources/guild#welcome-screen-object

Summary

Properties

WelcomeScreen.welcomeChannels :: { Classes.Guild.WelcomeScreenChannel }WelcomeScreen.description :: string?

Methods

WelcomeScreen:sync(welcomeScreenData: apiTypes.WelcomeScreenObject)

Functions

WelcomeScreen.new(welcomeScreenData: apiTypes.WelcomeScreenObject) → WelcomeScreen

Properties

Section titled “Properties”

welcomeChannels

Section titled “welcomeChannels”
WelcomeScreen.welcomeChannels  :: WelcomeScreenChannel }

An array of welcome screen channel objects linked to the guild’s welcome screen. These channels are shown to new members when they join the guild.

description

Section titled “description”
WelcomeScreen.description  :: string?

The server description shown in the welcome screen. This description provides new members with information about the guild when they first join.

Methods

Section titled “Methods”

sync

Section titled “sync”
WelcomeScreen : sync ( welcomeScreenData )  -> ()

Responsible for syncing data to this welcome screen object. This is typically called by the API when this object is created or updated.

Parameters

welcomeScreenData: WelcomeScreenObject

Functions

Section titled “Functions”

new

Section titled “new”
WelcomeScreen . new ( welcomeScreenData )  -> WelcomeScreen

Responsible for constructing this class.

Parameters

welcomeScreenData: WelcomeScreenObject

Returns

WelcomeScreen