Skip to content

StageInstanceShorter

High level helper around the stage instance endpoints. Discord addresses every instance route by its stage channel, not by the instance id from the payload, so this shorter (and the cache behind it) is keyed by channel id to match https://docs.discord.com/developers/resources/stage-instance.

Signature

export declare class StageInstanceShorter extends BaseShorter

Properties

0

No properties.

Methods

5

Methods

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

Fetches the live stage instance of a stage channel.

Parameters
channelId
The stage channel id.
force
Skip the cache and hit Discord directly.
raw(channelId: string, force?: boolean): Promise<APIStageInstance>;

Fetches the live stage instance of a stage channel without transforming it.

Parameters
channelId
The stage channel id.
force
Skip the cache and hit Discord directly.
delete(channelId: string, reason?: string): Promise<void>;

Deletes a stage instance, ending the live stage.

Parameters
channelId
The stage channel id.
reason
The audit-log reason.