@discord-types/builders/guild/welcomeScreen/welcomeScreen
API reference for @discord-types/builders/guild/welcomeScreen/welcomeScreen
@discord-types/builders/guild/welcomeScreen/welcomeScreen
Types
WelcomeScreen
Raw Type
type WelcomeScreen = WelcomeScreen.Prototype, & {
enabled: boolean?,
description: string?,
welcomeChannels: {WelcomeScreenChannel.JSON}
}
Intersection with variants:
Variant 2
Prop | Type | Description |
---|---|---|
enabled? | - | |
description? | - | |
welcomeChannels | - |
JSON
Raw Type
type JSON = WelcomeScreen.Prototype.build(nil :: any),
Functions
WelcomeScreen.Prototype.setEnabled
[[ Set weather the welcome screen is enabled or not. ]]
Function Signature
--[[
Set weather the welcome screen is enabled or not.
]]
function WelcomeScreen.Prototype.setEnabled(self: WelcomeScreen, enabled: boolean) -> WelcomeScreen end
Arguments
enabled
Returns
ret1
WelcomeScreen.Prototype.setDescription
[[ Set the description of the welcome screen. ]]
Function Signature
--[[
Set the description of the welcome screen.
]]
function WelcomeScreen.Prototype.setDescription(self: WelcomeScreen, description: string) -> WelcomeScreen end
Arguments
description
Returns
ret1
WelcomeScreen.Prototype.addChannel
[[ Add an welcome screen channel to the welcome screen ]]
Function Signature
--[[
Add an welcome screen channel to the welcome screen
]]
function WelcomeScreen.Prototype.addChannel(self: WelcomeScreen, channel: WelcomeScreenChannel.JSON) -> WelcomeScreen end
Arguments
channel
Returns
ret1
WelcomeScreen.Prototype.build
[[ Responsible for building the WelcomeScreenObject JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the WelcomeScreenObject JSON that can be parsed by the Discord API.
]]
function WelcomeScreen.Prototype.build(self: WelcomeScreen) -> JSON end
Returns
ret1
WelcomeScreen.Interface.new
[[ Responsible for creating a new WelcomeScreen.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new WelcomeScreen.
\`\`\`lua
\`\`\`
]]
function WelcomeScreen.Interface.new(resource: {
enabled: boolean?,
description: string?,
welcomeChannels: {WelcomeScreenChannel.JSON}?
}?) -> WelcomeScreen end
Arguments
resource
This field is optional and may not be specified
{enabled: boolean?, description: string?, welcomeChannels: {WelcomeScreenChannel.JSON}?}?
Returns
ret1
Last updated on