WelcomeChannel
channelOn this page
WelcomeChannel is a DiscordLua channel representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- Name
channelId- Type
any- Access
- readonly
- Description
- Instance field
WelcomeChannel.channelId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
- Name
client- Type
any- Access
- readonly
- Description
- Owning Client instance used for REST, cache, and event dispatch.
- Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
- Name
description- Type
any- Access
- readonly
- Description
- Instance field
WelcomeChannel.description. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
- Name
emoji- Type
any- Access
- readonly
- Description
- Instance field
WelcomeChannel.emoji. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
- Name
guildId- Type
any- Access
- readonly
- Description
- Instance field
WelcomeChannel.guildId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
WelcomeChannel.raw. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this WelcomeChannel.
Methods
WelcomeChannel:channel()
#Performs channel on this WelcomeChannel. Call it from bot code when you need that operation on the current object.
Signature
WelcomeChannel:channel() Parameters
No parameters.
Returns
WelcomeChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a WelcomeChannel
object:channel()WelcomeChannel:guild()
#Performs guild on this WelcomeChannel. Call it from bot code when you need that operation on the current object.
Signature
WelcomeChannel:guild() Parameters
No parameters.
Returns
WelcomeChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a WelcomeChannel
object:guild()Examples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
BaseGuildTextChannel · BaseGuildVoiceChannel · CategoryChannel · Channel · DirectoryChannel · DMChannel · ForumChannel · GuildChannel
Version: discord 1.2.4 · runtime 1.0.0