Skip to content

StageInstance

A live stage in a stage channel. Discord keys the fetch/edit/delete routes by channel, while the payload carries its own instance id. The structure keeps both around so callers can work from either side without digging through raw payloads. https://docs.discord.com/developers/resources/stage-instance#stage-instance-object

Signature

export interface StageInstance extends DiscordBase, ObjectToLower<APIStageInstance>

Private types

StageInstanceChannelResultTypeAlias
type StageInstanceChannelResult = Awaited<ReturnType<UsingClient['channels']['fetch']>>;

Properties

get isGuildOnly(): boolean;

Short check for the only usable privacy level Discord documents right now.

get createdTimestamp(): number;

Create a timestamp for the current object.

get createdAt(): Date;

createdAt gets the creation Date instace of the current object.

Methods

fetch(force?: boolean): Promise<StageInstanceStructure>;

Refetches this stage instance from Discord.

Parameters
force
Skip the cache and hit Discord directly.
delete(reason?: string): Promise<void>;

Deletes this stage instance, ending the live stage.

Parameters
reason
The audit-log reason.