Create a new Stage Instance Method Handler
Usually SnowTransfer creates a method handler for you, this is here for completion
You can access the methods listed via client.stageInstance.method, where client is an initialized SnowTransfer instance
request handler that calls the rest api
Creates a new stage instance associated to a stage channel
a stage instance object
| Permissions needed | Condition |
|---|---|
| MANAGE_CHANNELS | always |
| MUTE_MEMBERS | always |
| MOVE_MEMBERS | always |
// Create a new stage instance for channel id and the topic "This My House"
const client = new SnowTransfer("TOKEN")
const instance = await client.stageInstance.createStageInstance({ channel_id: "channel id", topic: "This My House" })
The options for creating a stage instance
Optional privacy_Optional reason?: stringOptional send_Delete an existing stage instance
a stage instance object
| Permissions needed | Condition |
|---|---|
| MANAGE_CHANNELS | always |
| MUTE_MEMBERS | always |
| MOVE_MEMBERS | always |
const client = new SnowTransfer("TOKEN")
client.stageInstance.deleteStageInstance("channel id", "They already know who's house this is")
Id of the stage channel
Optional reason: stringUpdates an existing stage instance
a stage instance object
| Permissions needed | Condition |
|---|---|
| MANAGE_CHANNELS | always |
| MUTE_MEMBERS | always |
| MOVE_MEMBERS | always |
const client = new SnowTransfer("TOKEN")
const instance = await client.stageInstance.updateStageInstance("channel id", { topic: "This my city, this my town" })
Id of the stage channel
The new data to send
Optional privacy_Optional reason?: stringGets the stage instance assocuated to a stage channel if it exists
a stage instance object
const client = new SnowTransfer("TOKEN")
const instance = await client.stageInstance.getStageInstance("channel id")
Id of the stage channel
Generated using TypeDoc
Methods for interacting with Stage instances