WelcomeScreenChannel

Implementation of discords WelcomeScreenChannel object as a Luau builder.

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

Summary

Properties

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

Methods

WelcomeScreenChannel:setChannelId(channelId: apiTypes.Snowflake) → WelcomeScreenChannelWelcomeScreenChannel:setDescription(description: string) → WelcomeScreenChannelWelcomeScreenChannel:setEmojiId(emojiId: apiTypes.Snowflake) → WelcomeScreenChannelWelcomeScreenChannel:setEmojiName(emojiName: string) → WelcomeScreenChannelWelcomeScreenChannel:build() → JSON

Functions

WelcomeScreenChannel.new(resource: { channelId: apiTypes.Snowflake?, description: string?, emojiId: apiTypes.Snowflake?, emojiName: string?, }?) → WelcomeScreenChannel

Properties

channelId

WelcomeScreenChannel.channelId  :: string?

---

The id of the channel shown in the welcome screen.

description

WelcomeScreenChannel.description  :: string

---

The description shown for the channel in the welcome screen.

emojiId

WelcomeScreenChannel.emojiId  :: string?

---

The id of the emoji shown in the welcome screen channel.

emojiName

WelcomeScreenChannel.emojiName  :: string?

---

The name of the emoji shown in the welcome screen channel.

Methods

setChannelId

WelcomeScreenChannel : setChannelId ( channelId )  -> WelcomeScreenChannel

Set the channel id for this welcome screen channel

Parameters

channelId: Snowflake

Returns

WelcomeScreenChannel

setDescription

WelcomeScreenChannel : setDescription ( description )  -> WelcomeScreenChannel

Set the description for this welcome screen channel

Parameters

description: string

Returns

WelcomeScreenChannel

setEmojiId

WelcomeScreenChannel : setEmojiId ( emojiId )  -> WelcomeScreenChannel

Set the emoji id for this welcome screen channel

Parameters

emojiId: Snowflake

Returns

WelcomeScreenChannel

setEmojiName

WelcomeScreenChannel : setEmojiName ( emojiName )  -> WelcomeScreenChannel

Set the emoji name for this welcome screen channel

Parameters

emojiName: string

Returns

WelcomeScreenChannel

build

WelcomeScreenChannel : build ( )  -> JSON

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

Returns

JSON

Functions

new

WelcomeScreenChannel . new ( resource )  -> WelcomeScreenChannel

Responsible for creating a new WelcomeScreenChannel.

Parameters

resource: { channelId: apiTypes.Snowflake?, description: string?, emojiId: apiTypes.Snowflake?, emojiName: string?, }

Returns

WelcomeScreenChannel