Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StageInstanceMethods

Methods for interacting with Stage instances

Hierarchy

  • StageInstanceMethods

Index

Constructors

  • 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

    Parameters

    Returns <internal>.StageInstanceMethods

Properties

requestHandler: <internal>.RequestHandler

Methods

  • Delete an existing stage instance

    Parameters

    • channelId: string

      Id of the stage channel

    Returns Promise<<internal>.StageInstance>

    a stage instance object

    Permissions needed Condition
    MANAGE_CHANNELS always
    MUTE_MEMBERS always
    MOVE_MEMBERS always
  • Gets the stage instance assocuated to a stage channel if it exists

    Parameters

    • channelId: string

      Id of the stage channel

    Returns Promise<<internal>.StageInstance>

    a stage instance object

Generated using TypeDoc