No summary provided.
constructor(rest)
Constructs a new instance of the
StageInstancesAPI
className | Type | Optional | Description |
---|---|---|---|
rest | REST | No | None |
Creates a new 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 |
Deletes a 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 |
Edits a 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 |
Fetches a 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 |