StageInstancesAPI

export declare class StageInstancesAPI
export declare class StageInstancesAPI

No summary provided.

constructor(rest)
Constructs a new instance of the StageInstancesAPI class
NameTypeOptionalDescription
restRESTNoNone
create(body, options?):Promise<APIStageInstance>
NameTypeOptionalDescription
bodyRESTPostAPIStageInstanceJSONBodyNoThe data for creating the new stage instance
optionsPick<RequestData, 'reason' | 'signal'>YesThe options for creating the new stage instance
delete(channelId, options?):Promise<void>
NameTypeOptionalDescription
channelIdSnowflakeNoThe id of the channel
optionsPick<RequestData, 'reason' | 'signal'>YesThe options for deleting the stage instance
edit(channelId, body, options?):Promise<APIStageInstance>
NameTypeOptionalDescription
channelIdSnowflakeNoThe id of the channel
bodyRESTPatchAPIStageInstanceJSONBodyNoThe new stage instance data
optionsPick<RequestData, 'reason' | 'signal'>YesThe options for editing the stage instance
get(channelId, options?):Promise<APIStageInstance>
NameTypeOptionalDescription
channelIdSnowflakeNoThe id of the channel
optionsPick<RequestData, 'signal'>YesThe options for fetching the stage instance