Preview deployment

class StageInstanceManager

export class StageInstanceManager extends CachedManager<Snowflake, StageInstance, StageInstanceResolvable>

Manages API methods for StageInstance objects and holds their cache.

readonly
cache : Collection<Key, Holds>

The cache of items for this manager.

Inherited from: DataManager

readonly
client : Client

The client that instantiated this Manager

Inherited from: BaseManager

guild : Guild

The guild this manager belongs to

readonly
holds : Constructable<Holds>

The data structure belonging to this manager.

Inherited from: DataManager

create(
channel: StageChannelResolvable
options: StageInstanceCreateOptions
) : Promise<StageInstance>

Creates a new stage instance.

Examples:
// Create a stage instance
guild.stageInstances.create('1234567890123456789', {
 topic: 'A very creative topic',
 privacyLevel: GuildPrivacyLevel.GuildOnly
})
 .then(stageInstance => console.log(stageInstance))
 .catch(console.error);

delete(
channel: StageChannelResolvable
) : Promise<void>

Deletes an existing stage instance.

edit(
channel: StageChannelResolvable
options: StageInstanceEditOptions
) : Promise<StageInstance>

Edits an existing stage instance.

Examples:
// Edit a stage instance
guild.stageInstances.edit('1234567890123456789', { topic: 'new topic' })
 .then(stageInstance => console.log(stageInstance))
 .catch(console.error);

fetch(
channel: StageChannelResolvable
options?: BaseFetchOptions
) : Promise<StageInstance>

Fetches the stage instance associated with a stage channel, if it exists.

Examples:
// Fetch a stage instance
guild.stageInstances.fetch('1234567890123456789')
 .then(stageInstance => console.log(stageInstance))
 .catch(console.error);

resolve(
idOrInstance: Holds
) : Holds

Resolves a data entry to a data Object.

Returns: An instance from this Manager

resolveId(
idOrInstance: Key | Holds
) : Key

Resolves a data entry to an instance id.

valueOf() : Collection<Key, Holds>

Inherited from: DataManager