Package net.dv8tion.jda.api.entities

Interface StageChannel

All Superinterfaces:

AudioChannel, Channel, Comparable<GuildChannel>, Formattable, GuildChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IMentionable, IPermissionContainer, IPositionableChannel, ISnowflake, StandardGuildChannel

public interface StageChannel
extends GuildChannel, AudioChannel, StandardGuildChannel

Represents a Stage Channel.

This is a specialized AudioChannel that can be used to host events with speakers and listeners.

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	cancelRequestToSpeak()	Cancels the Request-to-Speak.
default ChannelAction<StageChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<StageChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
default StageInstanceAction	createStageInstance(String topic)	Create a new StageInstance for this stage channel.
StageChannelManager	getManager()	Returns the ChannelManager for this GuildChannel.
StageInstance	getStageInstance()	StageInstance attached to this stage channel.
default boolean	isModerator(Member member)	Whether this member is considered a moderator for this stage channel.
RestAction<Void>	requestToSpeak()	Sends a request-to-speak indicator to the stage instance moderators.

Methods inherited from interface net.dv8tion.jda.api.entities.AudioChannel

getBitrate, getRegion, getRegionRaw

Methods inherited from interface net.dv8tion.jda.api.entities.Channel

formatTo, getAsMention, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel

delete, getGuild, getJumpUrl, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.api.entities.ICategorizableChannel

getParentCategory, getParentCategoryId, getParentCategoryIdLong, isSynced

Methods inherited from interface net.dv8tion.jda.api.entities.IInviteContainer

createInvite, retrieveInvites

Methods inherited from interface net.dv8tion.jda.api.entities.IMemberContainer

getMembers

Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionContainer

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.IPositionableChannel

getPosition, getPositionRaw

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getStageInstance

@Nullable
StageInstance getStageInstance()

StageInstance attached to this stage channel.

This indicates whether a stage channel is currently "live".

Returns:

The StageInstance or null if this stage is not live

createStageInstance

@Nonnull
@CheckReturnValue
default StageInstanceAction createStageInstance(@Nonnull
 String topic)

Create a new StageInstance for this stage channel.

Possible ErrorResponses include:

• STAGE_ALREADY_OPEN
  If there already is an active StageInstance for this channel
• UNKNOWN_CHANNEL
  If the channel was deleted

Parameters:

topic - The topic of this stage instance, must be 1-120 characters long

Returns:

StageInstanceAction

Throws:

InsufficientPermissionException - If the self member is not a stage moderator. (See isModerator(Member))

IllegalArgumentException - If the topic is null, empty, or longer than 120 characters

isModerator

default boolean isModerator(@Nonnull
 Member member)

Whether this member is considered a moderator for this stage channel.
Moderators can modify the Stage Instance and promote speakers. To promote a speaker you can use GuildVoiceState.inviteSpeaker() or GuildVoiceState.approveSpeaker() if they have already raised their hand (indicated by GuildVoiceState.getRequestToSpeakTimestamp()). A stage moderator can move between speaker and audience without raising their hand. This can be done with Guild.requestToSpeak() and Guild.cancelRequestToSpeak() respectively.

A member is considered a stage moderator if they have these permissions in the stage channel:

• Permission.MANAGE_CHANNEL
• Permission.VOICE_MUTE_OTHERS
• Permission.VOICE_MOVE_OTHERS

Parameters:

member - The member to check

Returns:

True, if the provided member is a stage moderator

Throws:

IllegalArgumentException - If the provided member is null or not from this guild

createCopy

@Nonnull
ChannelAction<StageChannel> createCopy(@Nonnull
 Guild guild)

Description copied from interface: ICopyableChannel

Creates a copy of the specified GuildChannel in the specified Guild.
If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface ICopyableChannel

Specified by:

createCopy in interface StandardGuildChannel

Parameters:

guild - The Guild to create the channel in

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

createCopy

@Nonnull
default ChannelAction<StageChannel> createCopy()

Description copied from interface: ICopyableChannel

Creates a copy of the specified GuildChannel.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface ICopyableChannel

Specified by:

createCopy in interface StandardGuildChannel

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

getManager

@Nonnull
StageChannelManager getManager()

Description copied from interface: GuildChannel

Returns the ChannelManager for this GuildChannel.
In the ChannelManager, you can modify the name, topic and position of this GuildChannel. You modify multiple fields in one request by chaining setters before calling RestAction.queue().

This is a lazy idempotent getter. The manager is retained after the first call. This getter is not thread-safe and would require guards by the user.

Specified by:

getManager in interface AudioChannel

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface ICategorizableChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Specified by:

getManager in interface StandardGuildChannel

Returns:

The ChannelManager of this GuildChannel

requestToSpeak

@Nonnull
@CheckReturnValue
RestAction<Void> requestToSpeak()

Sends a request-to-speak indicator to the stage instance moderators.

If the self member has Permission.VOICE_MUTE_OTHERS this will immediately promote them to speaker.

Returns:

RestAction

Throws:

IllegalStateException - If the self member is not currently connected to the channel

See Also:

• cancelRequestToSpeak()

cancelRequestToSpeak

@Nonnull
@CheckReturnValue
RestAction<Void> cancelRequestToSpeak()

Cancels the Request-to-Speak.
This can also be used to move back to the audience if you are currently a speaker.

If there is no request to speak or the member is not currently connected to an active StageInstance, this does nothing.

Returns:

RestAction

Throws:

IllegalStateException - If the self member is not currently connected to the channel

See Also:

• requestToSpeak()