Preview environment

class StageInstance

extends

Base
export class StageInstance extends Base

Represents a stage instance.

readonly
channel : StageChannel | null

The stage channel associated with this stage instance

channelId : Snowflake

The id of the channel associated with the stage channel

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date

The time this stage instance was created at

readonly
createdTimestamp : number

The timestamp this stage instances was created at

deprecated
discoverableDisabled : boolean | null

Whether or not stage discovery is disabled

readonly
guild : Guild | null

The guild this stage instance belongs to

guildId : Snowflake

The id of the guild associated with the stage channel

readonly
guildScheduledEvent : GuildScheduledEvent | null

The associated guild scheduled event of this stage instance

optional
guildScheduledEventId? : Snowflake

The associated guild scheduled event id of this stage instance

id : Snowflake

The stage instance's id

privacyLevel : StageInstancePrivacyLevel

The privacy level of the stage instance

topic : string

The topic of the stage instance

delete() : Promise<StageInstance>

Deletes this stage instance.

Examples:
// Delete a stage instance
stageInstance.delete()
 .then(stageInstance => console.log(stageInstance))
 .catch(console.error);

edit(
options: StageInstanceEditOptions
) : Promise<StageInstance>

Edits this stage instance.

Examples:
// Edit a stage instance
stageInstance.edit({ topic: 'new topic' })
 .then(stageInstance => console.log(stageInstance))
 .catch(console.error)

setTopic(
topic: string
) : Promise<StageInstance>

Sets the topic of this stage instance.

Examples:
// Set topic of a stage instance
stageInstance.setTopic('new topic')
 .then(stageInstance => console.log(`Set the topic to: ${stageInstance.topic}`))
 .catch(console.error);

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

valueOf() : string

Inherited from: Base