WelcomeScreen

Implementation of discords WelcomeScreen object as a Luau builder.

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen-json-params

Properties

The WelcomeScreen instance has no set properties!

Methods

The WelcomeScreen instance has no set methods!

Functions

setEnabled

WelcomeScreen . setEnabled (

     self: WelcomeScreen
     enabled: boolean

)  -> ()

Set weather the welcome screen is enabled or not.

setDescription

WelcomeScreen . setDescription (

     self: WelcomeScreen
     description: string

)  -> ()

Set the description of the welcome screen.

addChannel

WelcomeScreen . addChannel (

     self: WelcomeScreen
     channel: WelcomeScreenChannel.JSON

)  -> ()

Add an welcome screen channel to the welcome screen

build

WelcomeScreen . build (

     self: WelcomeScreen

)  -> ()

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

new

WelcomeScreen . new (

     resource: {
       enabled: boolean?,
       description: string?,
       welcomeChannels: { WelcomeScreenChannel.JSON,
    }

)  -> ()

Responsible for creating a new WelcomeScreen.