StageInstance

class StageInstance

The live session attached to a stage channel.

Properties

Property

Type

Description

channelId

string

Stage channel ID.

createdAt

Date | null

When this stage instance was created, decoded from the stage instance snowflake.

guildId

string

Guild ID this stage belongs to.

id

string

Stage instance ID.

privacyLevel

StageInstancePrivacyLevel

Privacy level of the stage.

topic

string

The topic/subject of the stage.

Methods

async StageInstance.delete(reason: string) → Promise<void>

Delete this stage instance.

Parameters:
  • reason: Reason for deletion, shown in audit log.

async StageInstance.edit(options: StageInstanceEditOptions) → Promise<StageInstance>

Edit stage instance properties.

Parameters:
  • options: Stage properties to update.

Returns:

The updated stage instance.