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, { reason, signal }?)
:
Promise<APIStageInstance>
Creates a new stage instance
| Name | Type | Optional | Description |
|---|---|---|---|
| body | RESTPostAPIStageInstanceJSONBody | No | The data for creating the new stage instance |
| { reason, signal } | Pick<RequestData, 'reason' | 'signal'> | Yes | None |
delete(channelId, { reason, signal }?)
:
Promise<void>
Deletes a stage instance
| Name | Type | Optional | Description |
|---|---|---|---|
| channelId | Snowflake | No | The id of the channel |
| { reason, signal } | Pick<RequestData, 'reason' | 'signal'> | Yes | None |
edit(channelId, body, { reason, signal }?)
:
Promise<APIStageInstance>
Edits a stage instance
| Name | Type | Optional | Description |
|---|---|---|---|
| channelId | Snowflake | No | The id of the channel |
| body | RESTPatchAPIStageInstanceJSONBody | No | The new stage instance data |
| { reason, signal } | Pick<RequestData, 'reason' | 'signal'> | Yes | None |
get(channelId, { signal }?)
:
Promise<APIStageInstance>
Fetches a stage instance
| Name | Type | Optional | Description |
|---|---|---|---|
| channelId | Snowflake | No | The id of the channel |
| { signal } | Pick<RequestData, 'signal'> | Yes | None |