discord.js | StageInstance

Search...

StageInstance

export class StageInstance extends Base

export class StageInstance extends Base

Represents a stage instance.

Extends

Base

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

See https://github.com/discord/discord-api-docs/pull/4296 for more information

Deprecated

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

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.

Example

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

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

edit(options):Promise<StageInstance>

Edits this stage instance.

Example

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

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

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

setTopic(topic):Promise<StageInstance>

Sets the topic of this stage instance.

Example

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

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

Name	Type	Optional	Description
topic	string	No	The topic for the stage instance

toJSON(...props):unknown

Name	Type	Optional	Description
...props	Record<string, boolean \| string>[]	No	None

Inherited from Base

valueOf():string