StageInstance

class StageInstance()

The live session attached to a stage channel.

exported from lib.weeble.d

Properties

StageInstance.channelId

type: readonly string

Stage channel ID.

StageInstance.createdAt

type: readonly Date | null

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

StageInstance.guildId

type: readonly string

Guild ID this stage belongs to.

StageInstance.id

type: readonly string

Stage instance ID.

StageInstance.privacyLevel

type: readonly StageInstancePrivacyLevel

Privacy level of the stage.

StageInstance.topic

type: readonly 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.