GuildOnboarding
ClassOn this page
GuildOnboarding is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- 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 GuildOnboarding.
- Name
defaultChannels- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.defaultChannels. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildOnboarding.
- Name
enabled- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.enabled. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildOnboarding.
- Name
guildId- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.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 GuildOnboarding.
- Name
mode- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.mode. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildOnboarding.
- Name
prompts- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.prompts. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildOnboarding.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
GuildOnboarding.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 GuildOnboarding.
Methods
GuildOnboarding:guild()
#Performs guild on this GuildOnboarding. Call it from bot code when you need that operation on the current object.
Signature
GuildOnboarding:guild() Parameters
No parameters.
Returns
GuildOnboarding — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a GuildOnboarding
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
ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment
Version: discord 1.2.4 · runtime 1.0.0