Skip to content
Discord Luau

WelcomeScreenChannel

Implementation of the Discord WelcomeScreenChannel class in Luau

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

Summary

Properties

WelcomeScreenChannel.channelId :: stringWelcomeScreenChannel.description :: stringWelcomeScreenChannel.emojiId :: stringWelcomeScreenChannel.emojiName :: string

Methods

WelcomeScreenChannel:sync(welcomeScreenData: apiTypes.WelcomeScreenChannelObject)

Functions

WelcomeScreenChannel.new(roleTagData: apiTypes.WelcomeScreenChannelObject) → WelcomeScreenChannel

Properties

Section titled “Properties”

channelId

Section titled “channelId”
WelcomeScreenChannel.channelId  :: string

The id of the channel that is shown in the welcome screen

description

Section titled “description”
WelcomeScreenChannel.description  :: string

The description shown for the channel in the welcome screen

emojiId

Section titled “emojiId”
WelcomeScreenChannel.emojiId  :: string

The id of the emoji that is shown alongside the channel

emojiName

Section titled “emojiName”
WelcomeScreenChannel.emojiName  :: string

The name of the emoji that is shown alongside the channel

Methods

Section titled “Methods”

sync

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

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

Parameters

welcomeScreenData: WelcomeScreenChannelObject

Functions

Section titled “Functions”

new

Section titled “new”
WelcomeScreenChannel . new ( roleTagData )  -> WelcomeScreenChannel

Responsible for constructing this class.

Parameters

roleTagData: WelcomeScreenChannelObject

Returns

WelcomeScreenChannel