Package discord4j.core.object.entity
Class StageInstance
java.lang.Object
discord4j.core.object.entity.StageInstance
- All Implemented Interfaces:
DiscordObject
,Entity
A Discord stage instance.
-
Constructor Summary
ConstructorDescriptionStageInstance
(GatewayDiscordClient gateway, discord4j.discordjson.json.StageInstanceData data) Constructs aStageInstance
with an associatedGatewayDiscordClient
and Discord data. -
Method Summary
Modifier and TypeMethodDescriptionedit
(discord4j.core.spec.StageInstanceEditSpec spec) Requests to edit this stage instance.boolean
Gets the channel ID associated to this stage instance.Returns theGatewayDiscordClient
that created this object.discord4j.discordjson.json.StageInstanceData
getData()
Gets the data of the stage instance.getId()
Gets the stage instance ID.int
hashCode()
inviteMemberToStageSpeakers
(Member member) Requests to invite the specified to the speakers of the stage channel associated with this stage instance.moveMemberToStageAudience
(Member member) Requests to move the specified to the audience of the stage channel associated with this stage instance.toString()
-
Constructor Details
-
StageInstance
public StageInstance(GatewayDiscordClient gateway, discord4j.discordjson.json.StageInstanceData data) Constructs aStageInstance
with an associatedGatewayDiscordClient
and Discord data.- Parameters:
gateway
- TheGatewayDiscordClient
associated to this object, must be non-null.data
- The raw stage instance data as represented by Discord, must be non-null.
-
-
Method Details
-
edit
Requests to edit this stage instance.- Parameters:
spec
- an immutable object that specifies how to edit this stage instance- Returns:
- A
Mono
where, upon successful completion, emits the editedStageInstance
. If an error is received, it is emitted through theMono
.
-
inviteMemberToStageSpeakers
Requests to invite the specified to the speakers of the stage channel associated with this stage instance.- Parameters:
member
- The member to invite to the stage speakers- Returns:
- A
Mono
where, upon successful completion, emits nothing; indicating that the specified has been invited to the speakers of the stage channel associated with this stage instance. If an error is received, it is emitted through theMono
.
-
moveMemberToStageAudience
Requests to move the specified to the audience of the stage channel associated with this stage instance.- Parameters:
member
- The member to move to the stage audience- Returns:
- A
Mono
where, upon successful completion, emits nothing; indicating that the specified has been moved to the audience of the stage channel associated with this stage instance. If an error is received, it is emitted through theMono
.
-
getClient
Description copied from interface:DiscordObject
Returns theGatewayDiscordClient
that created this object. Methods in it are exclusively based on the entity cache orStore
in use. Refer to callinggetClient().rest()
to access aDiscordClient
that is capable of requesting entities directly from the REST API.- Specified by:
getClient
in interfaceDiscordObject
- Returns:
- The
GatewayDiscordClient
associated to this object.
-
getData
public discord4j.discordjson.json.StageInstanceData getData()Gets the data of the stage instance.- Returns:
- The data of the stage instance.
-
getId
Gets the stage instance ID. -
getChannelId
Gets the channel ID associated to this stage instance.- Returns:
- The channel ID associated to this stage instance.
-
equals
-
hashCode
public int hashCode() -
toString
-