DiscordLua
discorddiscord
v1.2.4
Install

StageChannel

channel
On this page

StageChannel is a DiscordLua channel representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

channel Module 1.2.4 Source
Inherited properties (45)
appliedTags · inherited from Channelarchived · inherited from ChannelarchiveTimestamp · inherited from ChannelautoArchiveDuration · inherited from ChannelavailableTags · inherited from Channelbitrate · inherited from Channelchildren · inherited from Channelclient · inherited from ChanneldefaultAutoArchiveDuration · inherited from ChanneldefaultForumLayout · inherited from ChanneldefaultReactionEmoji · inherited from ChanneldefaultSortOrder · inherited from ChanneldefaultThreadRateLimitPerUser · inherited from Channelflags · inherited from ChannelguildId · inherited from Channelicon · inherited from Channelid · inherited from Channelinvitable · inherited from Channelinvites · inherited from ChannellastMessageId · inherited from ChannellastPinTimestamp · inherited from Channellocked · inherited from ChannelmemberCount · inherited from Channelmembers · inherited from ChannelmessageCount · inherited from Channelmessages · inherited from Channelname · inherited from Channelnsfw · inherited from ChannelownerId · inherited from ChannelparentId · inherited from ChannelpermissionOverwrites · inherited from Channelposition · inherited from ChannelrateLimitPerUser · inherited from Channelraw · inherited from Channelrecipient · inherited from ChannelrecipientId · inherited from ChannelrecipientIds · inherited from Channelrecipients · inherited from ChannelrtcRegion · inherited from Channelthreads · inherited from Channeltopic · inherited from ChanneltotalMessageSent · inherited from Channeltype · inherited from ChanneluserLimit · inherited from ChannelvideoQualityMode · inherited from Channel

Methods

StageChannel:createStageInstance()

#

Create StageInstance through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.

Signature

StageChannel:createStageInstance(options, callback)

Parameters

NameTypeRequiredBehavior
options table optional Lua option table. Field names match the corresponding DiscordLua option type when one exists.
callback function optional Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:createStageInstance({}, function(err, result)
    if err then error(err) end
end)

StageChannel:fetchStageInstance()

#

Fetch StageInstance from REST and update the local cache when the request succeeds.

Signature

StageChannel:fetchStageInstance(callback)

Parameters

NameTypeRequiredBehavior
callback function optional Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:fetchStageInstance(function(err, result)
    if err then error(err) end
end)

StageChannel:full()

#

Performs full on this StageChannel. Call it from bot code when you need that operation on the current object.

Signature

StageChannel:full()

Parameters

No parameters.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:full()

StageChannel:join()

#

Join the voice channel represented by this object.

Signature

StageChannel:join(options, callback)

Parameters

NameTypeRequiredBehavior
options table optional Lua option table. Field names match the corresponding DiscordLua option type when one exists.
callback function optional Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error.

Returns

StageChannel — the same instance, for chaining.

Throws

A DiscordLua error when arguments are invalid or the request fails without a callback.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:join({}, function(err, result)
    if err then error(err) end
end)

StageChannel:joinable()

#

Performs joinable on this StageChannel. Call it from bot code when you need that operation on the current object.

Signature

StageChannel:joinable()

Parameters

No parameters.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:joinable()

StageChannel:leave()

#

Leave the associated voice connection.

Signature

StageChannel:leave()

Parameters

No parameters.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:leave()

StageChannel:setBitrate()

#

Set the Bitrate field. Builders return this StageChannel so setters can be chained.

Signature

StageChannel:setBitrate(bitrate)

Parameters

NameTypeRequiredBehavior
bitrate any required Passed through to the implementation as written.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:setBitrate(bitrate)

StageChannel:setRTCRegion()

#

Set the RTCRegion field. Builders return this StageChannel so setters can be chained.

Signature

StageChannel:setRTCRegion(region)

Parameters

NameTypeRequiredBehavior
region any required Passed through to the implementation as written.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:setRTCRegion(region)

StageChannel:setUserLimit()

#

Set the UserLimit field. Builders return this StageChannel so setters can be chained.

Signature

StageChannel:setUserLimit(userLimit)

Parameters

NameTypeRequiredBehavior
userLimit any required Passed through to the implementation as written.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:setUserLimit(userLimit)

StageChannel:setVideoQualityMode()

#

Set the VideoQualityMode field. Builders return this StageChannel so setters can be chained.

Signature

StageChannel:setVideoQualityMode(mode)

Parameters

NameTypeRequiredBehavior
mode any required Passed through to the implementation as written.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:setVideoQualityMode(mode)

StageChannel:stageInstance()

#

Performs stage instance on this StageChannel. Call it from bot code when you need that operation on the current object.

Signature

StageChannel:stageInstance()

Parameters

No parameters.

Returns

StageChannel — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a StageChannel
object:stageInstance()
Inherited methods (54)
Channel:addFollowerChannel:awaitMessageComponentChannel:awaitMessagesChannel:bulkDeleteChannel:cloneChannel:createdAtChannel:createdTimestampChannel:createInteractionCollectorChannel:createInviteChannel:createMessageCollectorChannel:createMessageComponentCollectorChannel:createWebhookChannel:deletableChannel:deleteChannel:editChannel:equalsChannel:fetchChannel:fetchInvitesChannel:fetchMessagesChannel:fetchWebhooksChannel:guildChannel:iconURLChannel:isDMBasedChannel:isSendableChannel:isTextBasedChannel:isThreadChannel:isThreadOnlyChannel:isVoiceBasedChannel:lastMessageChannel:lastPinAtChannel:lockPermissionsChannel:manageableBaseGuildVoiceChannel:membersChannel:parentChannel:partialChannel:permissionsForChannel:permissionsLockedChannel:rawPositionChannel:sendChannel:sendTypingChannel:setDefaultAutoArchiveDurationChannel:setNameChannel:setNSFWChannel:setParentChannel:setPositionChannel:setRateLimitPerUserChannel:setSlowmodeChannel:setTopicChannel:setTypeChannel:startTypingChannel:toJSONChannel:toStringChannel:urlChannel:viewable

Examples

Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.

BaseGuildTextChannel · BaseGuildVoiceChannel · CategoryChannel · Channel · DirectoryChannel · DMChannel · ForumChannel · GuildChannel

Version: discord 1.2.4 · runtime 1.0.0

Search Ctrl K Navigate Open Esc