discord.js | StageInstancesAPI

You are reading the documentation for the next version of discord.js. Documentation for v13/v14+ has been moved to old.discordjs.dev

/

/

/

/

/

StageInstancesAPI%3AClass

Search...

K

StageInstancesAPI

export declare class StageInstancesAPI

export declare class StageInstancesAPI

No summary provided.

constructor(rest)

Constructs a new instance of the StageInstancesAPI class

Name	Type	Optional	Description
rest	REST	No	None

create(body, options?):Promise<APIStageInstance>

Creates a new stage instance

See Also

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

Name	Type	Optional	Description
body	RESTPostAPIStageInstanceJSONBody	No	The data for creating the new stage instance
options	Pick<RequestData, 'reason' \| 'signal'>	Yes	The options for creating the new stage instance

delete(channelId, options?):Promise<void>

Deletes a stage instance

See Also

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel
options	Pick<RequestData, 'reason' \| 'signal'>	Yes	The options for deleting the stage instance

edit(channelId, body, options?):Promise<APIStageInstance>

Edits a stage instance

See Also

https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel
body	RESTPatchAPIStageInstanceJSONBody	No	The new stage instance data
options	Pick<RequestData, 'reason' \| 'signal'>	Yes	The options for editing the stage instance

get(channelId, options?):Promise<APIStageInstance>

Fetches a stage instance

See Also

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel
options	Pick<RequestData, 'signal'>	Yes	The options for fetching the stage instance