Skip to content

StageChannel

StageChannel ⇐ VoiceBasedChannels

Represents a stage channel, which is a type of voice-based channel.

Kind: global class
Extends: VoiceBasedChannels

new StageChannel([data], guildId, client)

Constructs a new instance of the class.

ParamTypeDescription
[data]ObjectThe data object to initialize the instance with.
guildIdstringThe ID of the guild associated with the instance.
clientClientThe client instance associated with the instance.

stageChannel.stageInstance ⇒ StageInstance | null

Retrieves the stage instance associated with the channel.

Kind: instance property of StageChannel
Returns: StageInstance | null - The stage instance object if found, otherwise null.

stageChannel.createStageInstance(options) ⇒ Promise.<StageInstance>

Creates a stage instance in the specified channel.

Kind: instance method of StageChannel
Returns: Promise.<StageInstance> - A promise that resolves to the created stage instance.

ParamTypeDescription
optionsObjectThe options for creating the stage instance.