StageChannel
StageChannel ⇐ VoiceBasedChannels
Section titled “StageChannel ⇐ VoiceBasedChannels”Represents a stage channel, which is a type of voice-based channel.
Kind: global class
Extends: VoiceBasedChannels
- StageChannel ⇐
VoiceBasedChannels- new StageChannel([data], guildId, client)
- .stageInstance ⇒
StageInstance|null - .createStageInstance(options) ⇒
Promise.<StageInstance>
new StageChannel([data], guildId, client)
Section titled “new StageChannel([data], guildId, client)”Constructs a new instance of the class.
| Param | Type | Description |
|---|---|---|
| [data] | Object | The data object to initialize the instance with. |
| guildId | string | The ID of the guild associated with the instance. |
| client | Client | The client instance associated with the instance. |
stageChannel.stageInstance ⇒ StageInstance | null
Section titled “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>
Section titled “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.
| Param | Type | Description |
|---|---|---|
| options | Object | The options for creating the stage instance. |