InviteStageInstance
ClassOn this page
InviteStageInstance 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
channelId- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.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 InviteStageInstance.
- 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 InviteStageInstance.
- Name
guildId- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.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 InviteStageInstance.
- Name
invite- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.invite. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this InviteStageInstance.
- Name
members- Type
- Collection
- Access
- readonly
- Description
- Instance field
InviteStageInstance.members. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this InviteStageInstance.
- Related
- Collection
- Name
participantCount- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.participantCount. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this InviteStageInstance.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.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 InviteStageInstance.
- Name
speakerCount- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.speakerCount. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this InviteStageInstance.
- Name
topic- Type
any- Access
- readonly
- Description
- Instance field
InviteStageInstance.topic. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this InviteStageInstance.
Methods
InviteStageInstance:channel()
#Performs channel on this InviteStageInstance. Call it from bot code when you need that operation on the current object.
Signature
InviteStageInstance:channel() Parameters
No parameters.
Returns
InviteStageInstance — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a InviteStageInstance
object:channel()InviteStageInstance:guild()
#Performs guild on this InviteStageInstance. Call it from bot code when you need that operation on the current object.
Signature
InviteStageInstance:guild() Parameters
No parameters.
Returns
InviteStageInstance — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a InviteStageInstance
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