class StageInstancesAPI

export declare class StageInstancesAPI

Constructors

constructor(
rest: REST
)

Constructs a new instance of the StageInstancesAPI class

create(
body: RESTPostAPIStageInstanceJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIStageInstance>

Creates a new stage instance

See also: https://discord.com/developers/docs/resources/stage-instance#create-stage-instance

delete(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a stage instance

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

edit(
channelId: Snowflake
body: RESTPatchAPIStageInstanceJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIStageInstance>

Edits a stage instance

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

get(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIStageInstance>

Fetches a stage instance

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