Package discord4j.rest.entity

Class RestStageInstance

java.lang.Object
discord4j.rest.entity.RestStageInstance
public class RestStageInstance extends Object
Represents a stage instance entity in Discord.

  • Method Details

    • create

      public static RestStageInstance create(RestClient restClient, Snowflake channelId)
      Create a RestStageInstance for a given channel ID. This method does not perform any API request.
      Parameters:
      restClient - the client to make API requests
      channelId - the channel ID of this entity
      Returns:
      a RestStageInstance represented by this .

    • getChannelId

      public Snowflake getChannelId()
      Returns the channel ID.
      Returns:
      The channel ID of this stage instance

    • getData

      public Mono<discord4j.discordjson.json.StageInstanceData> getData()
      Retrieve this stage instance's data upon subscription.
      Returns:
      a Mono where, upon successful completion, emits the StageInstanceData belonging to this stage instance. If an error is received, it is emitted through the Mono.

    • edit

      public Mono<discord4j.discordjson.json.StageInstanceData> edit(discord4j.discordjson.json.StageInstanceModifyRequest request, @Nullable String reason)
      Requests to edit this stage instance.
      Parameters:
      request - A StageInstanceModifyRequest to parameterize this request.
      reason - The reason, if present.
      Returns:
      A Mono where, upon successful completion, emits the edited StageInstanceData. If an error is received, it is emitted through the Mono.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object