LogoAntiRaid

@discord-types/builders/guild/welcomeScreen/channel

API reference for @discord-types/builders/guild/welcomeScreen/channel

@discord-types/builders/guild/welcomeScreen/channel

Types

WelcomeScreenChannel

Raw Type
type WelcomeScreenChannel = WelcomeScreenChannel.Prototype, & {
	channelId: apiTypes.Snowflake?,

	description: string,

	emojiId: apiTypes.Snowflake?,

	emojiName: string?
}

Intersection with variants:

Variant 2
PropTypeDescription
channelId?
-
description
-
emojiId?
-
emojiName?
-

JSON

Raw Type
type JSON = WelcomeScreenChannel.Prototype.build(nil :: any),

Functions

WelcomeScreenChannel.Prototype.setChannelId

[[ Set the channel id for this welcome screen channel ]]

Function Signature
--[[
	Set the channel id for this welcome screen channel
]]
function WelcomeScreenChannel.Prototype.setChannelId(self: WelcomeScreenChannel, channelId: apiTypes.Snowflake) -> WelcomeScreenChannel end

Arguments

channelId

apiTypes.Snowflake

Returns

ret1

WelcomeScreenChannel

WelcomeScreenChannel.Prototype.setDescription

[[ Set the description for this welcome screen channel ]]

Function Signature
--[[
	Set the description for this welcome screen channel
]]
function WelcomeScreenChannel.Prototype.setDescription(self: WelcomeScreenChannel, description: string) -> WelcomeScreenChannel end

Arguments

description

string

Returns

ret1

WelcomeScreenChannel

WelcomeScreenChannel.Prototype.setEmojiId

[[ Set the emoji id for this welcome screen channel ]]

Function Signature
--[[
	Set the emoji id for this welcome screen channel
]]
function WelcomeScreenChannel.Prototype.setEmojiId(self: WelcomeScreenChannel, emojiId: apiTypes.Snowflake) -> WelcomeScreenChannel end

Arguments

emojiId

apiTypes.Snowflake

Returns

ret1

WelcomeScreenChannel

WelcomeScreenChannel.Prototype.setEmojiName

[[ Set the emoji name for this welcome screen channel ]]

Function Signature
--[[
	Set the emoji name for this welcome screen channel
]]
function WelcomeScreenChannel.Prototype.setEmojiName(self: WelcomeScreenChannel, emojiName: string) -> WelcomeScreenChannel end

Arguments

emojiName

string

Returns

ret1

WelcomeScreenChannel

WelcomeScreenChannel.Prototype.build

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

Function Signature
--[[
	Responsible for building the WelcomeScreenChannelObject JSON that can be parsed by the Discord API.
]]
function WelcomeScreenChannel.Prototype.build(self: WelcomeScreenChannel) -> JSON end

Returns

ret1

JSON

WelcomeScreenChannel.Interface.new

[[ Responsible for creating a new WelcomeScreenChannel.

```lua

``` ]]

Function Signature
--[[
	Responsible for creating a new WelcomeScreenChannel.

	\`\`\`lua
	
	\`\`\`
]]
function WelcomeScreenChannel.Interface.new(resource: {
		channelId: apiTypes.Snowflake?,

		description: string?,

		emojiId: apiTypes.Snowflake?,

		emojiName: string?
	}?) -> WelcomeScreenChannel end

Arguments

resource

This field is optional and may not be specified

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

Returns

ret1

WelcomeScreenChannel

Last updated on