Interface StageInstance
- All Superinterfaces:
ISnowflake
This instance indicates an active stage channel with speakers, usually to host events such as presentations or meetings.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThe privacy level for a stage instance. -
Method Summary
Modifier and TypeMethodDescriptiondelete()Deletes this stage instanceAll current audience members of this stage instance.TheStageChannelfor this stage instancegetGuild()TheGuildthis stage instance is inTheStageInstanceManagerused to update this stage instance.TheStageInstance.PrivacyLevelof this stage instanceAll current speakers of this stage instance.getTopic()The topic of this stage instanceMethods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Method Details
-
getGuild
TheGuildthis stage instance is in- Returns:
- The
Guild
-
getChannel
TheStageChannelfor this stage instance- Returns:
- The
StageChannel
-
getTopic
The topic of this stage instance- Returns:
- The topic
-
getPrivacyLevel
TheStageInstance.PrivacyLevelof this stage instance- Returns:
- The
StageInstance.PrivacyLevel
-
getSpeakers
All current speakers of this stage instance.A member is considered a speaker when they are currently connected to the stage channel and their voice state is not
suppressed. When a member is not a speaker, they are part of theaudience.Only
stage moderatorscan promote or invite speakers. A stage moderator can move between speaker and audience at any time. -
getAudience
All current audience members of this stage instance.A member is considered part of the audience when they are currently connected to the stage channel and their voice state is
suppressed. When a member is not part of the audience, they are considered aspeaker.Only
stage moderatorscan promote or invite speakers. A stage moderator can move between speaker and audience at any time. -
delete
Deletes this stage instancePossible
ErrorResponsesinclude:UNKNOWN_STAGE_INSTANCE
If this stage instance is already deletedUNKNOWN_CHANNEL
If the channel was deleted
- Returns:
RestAction- Throws:
InsufficientPermissionException- If the self member is not astage moderator
-
getManager
TheStageInstanceManagerused to update this stage instance.This can be used to update multiple fields such as topic and privacy level in one request
If this stage instance is already deleted, this will fail with
ErrorResponse.UNKNOWN_STAGE_INSTANCE.- Returns:
- The
StageInstanceManager - Throws:
InsufficientPermissionException- If the self member is not astage moderator
-