StageInstance

classe · Source

Represents a stage instance.

Extends: Base

Properties

id

id: Snowflake

The stage instance's id Source

guildId

guildId: Snowflake

The id of the guild associated with the stage channel Source

channelId

channelId: Snowflake

The id of the channel associated with the stage channel Source

topic

topic: string

The topic of the stage instance Source

privacyLevel

privacyLevel: PrivacyLevel

The privacy level of the stage instance Source

discoverableDisabled

nullable

discoverableDisabled: boolean

Whether or not stage discovery is disabled Source

guildScheduledEventId

nullable

guildScheduledEventId: Snowflake

The associated guild scheduled event id of this stage instance Source

channel

readonly · nullable

channel: StageChannel

The stage channel associated with this stage instance Source

guildScheduledEvent

readonly · nullable

guildScheduledEvent: GuildScheduledEvent

The associated guild scheduled event of this stage instance Source

deleted

deprecated

deleted: boolean

Whether or not the stage instance has been deleted Source

guild

readonly · nullable

guild: Guild

The guild this stage instance belongs to Source

createdTimestamp

readonly

createdTimestamp: number

The timestamp this stage instances was created at Source

createdAt

readonly

createdAt: Date

The time this stage instance was created at Source

client

readonly

client: Client

The client that instantiated this Source

Methods

edit

edit(options: StageInstanceEditOptions): Promise<StageInstance>

Edits this stage instance. Parameters

Name	Type	Description
options	StageInstanceEditOptions	The options to edit the stage instance

Returns: Promise<StageInstance>

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

Source

delete

async

async delete(): Promise<StageInstance>

Deletes this stage instance. Returns: Promise<StageInstance>

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

Source

setTopic

setTopic(topic: string): Promise<StageInstance>

Sets the topic of this stage instance. Parameters

Name	Type	Description
topic	string	The topic for the stage instance

Returns: Promise<StageInstance>

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

Source