Package net.dv8tion.jda.internal.entities.channel.concrete

Class StageChannelImpl

java.lang.Object

net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl<StageChannelImpl>

net.dv8tion.jda.internal.entities.channel.middleman.AbstractGuildChannelImpl<StageChannelImpl>

net.dv8tion.jda.internal.entities.channel.middleman.AbstractStandardGuildChannelImpl<StageChannelImpl>

net.dv8tion.jda.internal.entities.channel.concrete.StageChannelImpl

All Implemented Interfaces:

Comparable<GuildChannel>, Formattable, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IPermissionContainer, IPositionableChannel, ISlowmodeChannel, IWebhookContainer, Channel, StageChannel, AudioChannel, GuildChannel, GuildMessageChannel, MessageChannel, StandardGuildChannel, AudioChannelUnion, ChannelUnion, GuildChannelUnion, GuildMessageChannelUnion, IPermissionContainerUnion, IWebhookContainerUnion, MessageChannelUnion, IDetachableEntity, IMentionable, ISnowflake, IAgeRestrictedChannelMixin<StageChannelImpl>, ICategorizableChannelMixin<StageChannelImpl>, IInviteContainerMixin<StageChannelImpl>, IPermissionContainerMixin<StageChannelImpl>, IPositionableChannelMixin<StageChannelImpl>, ISlowmodeChannelMixin<StageChannelImpl>, IWebhookContainerMixin<StageChannelImpl>, ChannelMixin<StageChannelImpl>, StageChannelMixin<StageChannelImpl>, AudioChannelMixin<StageChannelImpl>, GuildChannelMixin<StageChannelImpl>, GuildMessageChannelMixin<StageChannelImpl>, MessageChannelMixin<StageChannelImpl>, StandardGuildChannelMixin<StageChannelImpl>, IDetachableEntityMixin

public class StageChannelImpl
extends AbstractStandardGuildChannelImpl<StageChannelImpl>
implements StageChannel, StageChannelMixin<StageChannelImpl>

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

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

JUMP_URL

Fields inherited from interface net.dv8tion.jda.api.entities.channel.attribute.ISlowmodeChannel

MAX_SLOWMODE

Fields inherited from interface net.dv8tion.jda.api.entities.channel.concrete.StageChannel

MAX_USERLIMIT

Constructor Summary

Constructors

Constructor	Description
StageChannelImpl(long id, GuildImpl guild)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	cancelRequestToSpeak()	Cancels the Request-to-Speak.
boolean	canTalk(Member member)	Whether the specified Member can send messages in this channel.
StageInstanceAction	createStageInstance(String topic)	Create a new StageInstance for this stage channel.
int	getBitrate()	The audio bitrate of the voice audio that is transmitted in this channel.
GuildImpl	getGuild()	Returns the Guild that this GuildChannel is part of.
long	getLatestMessageIdLong()	The id for the most recent message sent in this current MessageChannel.
StageChannelManager	getManager()	Returns the ChannelManager for this GuildChannel.
List<Member>	getMembers()	A List of all Members that are in this GuildChannel For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.
String	getRegionRaw()	The raw region name for this channel.
int	getSlowmode()	The slowmode set for this channel.
StageInstance	getStageInstance()	StageInstance attached to this stage channel.
ChannelType	getType()	The ChannelType for this channel
int	getUserLimit()	The maximum amount of Members that be in an audio connection within this channel concurrently.
boolean	isDetached()	Whether this entity is detached.
boolean	isNSFW()	Whether this channel is considered as age-restricted, also known as NSFW (Not-Safe-For-Work)
RestAction<Void>	requestToSpeak()	Sends a request-to-speak indicator to the stage instance moderators.
StageChannelImpl	setBitrate(int bitrate)
StageChannelImpl	setLatestMessageIdLong(long latestMessageId)
StageChannelImpl	setNSFW(boolean ageRestricted)
StageChannelImpl	setRegion(String region)
StageChannelImpl	setSlowmode(int slowmode)
StageChannelImpl	setStageInstance(StageInstance instance)
StageChannelImpl	setUserLimit(int userlimit)

Methods inherited from class net.dv8tion.jda.internal.entities.channel.middleman.AbstractStandardGuildChannelImpl

getParentCategoryIdLong, getPermissionOverrideMap, getPositionRaw, setParentCategory, setPosition

Methods inherited from class net.dv8tion.jda.internal.entities.channel.middleman.AbstractGuildChannelImpl

compareTo

Methods inherited from class net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel, getIdLong, getJDA, getName, setName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getRegion

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.AudioChannelMixin

checkCanAccess

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.AudioChannelUnion

asGuildMessageChannel, asStageChannel, asVoiceChannel

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

formatTo, getAsMention, getFlags, getJDA, getName

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin

delete, setName

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.ChannelUnion

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface java.lang.Comparable

compareTo

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

getJumpUrl

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.GuildChannelMixin

checkCanManage, checkPermission, checkPermission, delete, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion

asAudioChannel, asCategory, asForumChannel, asGuildMessageChannel, asMediaChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildMessageChannel

canTalk, clearReactionsById, clearReactionsById, deleteMessages, removeReactionById, sendStickers

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.GuildMessageChannelMixin

canDeleteOtherUsersMessages, checkCanAddReactions, checkCanControlMessagePins, checkCanRemoveReactions, checkCanSendFiles, checkCanSendMessage, checkCanSendMessageEmbeds, checkCanViewHistory, clearReactionsById, clearReactionsById, deleteMessagesByIds, removeReactionById, sendStickers

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.GuildMessageChannelUnion

asAudioChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

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

getParentCategory, getParentCategoryId, getParentCategoryIdLong, getPositionInCategory

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.ICategorizableChannelMixin

isSynced, setParentCategory

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IInviteContainerMixin

createInvite, retrieveInvites

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

getMemberPermissionOverrides, getRolePermissionOverrides

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IPermissionContainerMixin

getPermissionContainer, getPermissionOverride, getPermissionOverrideMap, getPermissionOverrides, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.IPermissionContainerUnion

asAudioChannel, asCategory, asForumChannel, asGuildMessageChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadContainer, asVoiceChannel

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

getPosition, getPositionRaw

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IPositionableChannelMixin

setPosition

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

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IWebhookContainerMixin

createWebhook, deleteWebhookById, retrieveWebhooks

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.IWebhookContainerUnion

asAudioChannel, asForumChannel, asGuildMessageChannel, asMediaChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.api.entities.channel.middleman.MessageChannel

addReactionById, deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, endPollById, endPollById, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getLatestMessageId, pinMessageById, purgeMessages, purgeMessagesById, purgeMessagesById, removeReactionById, retrieveMessageById, retrievePollVotersById, retrievePollVotersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFiles, sendMessageComponents, sendMessageComponents, sendMessageFormat, unpinMessageById

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.MessageChannelMixin

addReactionById, bulkDeleteMessages, deleteMessageById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageEmbedsById, getHistory, getHistoryAfter, getHistoryAround, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, pinMessageById, purgeMessages, purgeMessagesById, removeReactionById, retrieveMessageById, retrievePinnedMessages, retrieveReactionUsersById, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessagePoll, sendTyping, unpinMessageById

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.MessageChannelUnion

asAudioChannel, asGroupChannel, asGuildMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.api.entities.channel.concrete.StageChannel

createCopy, isModerator

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.concrete.StageChannelMixin

createCopy

Constructor Details

StageChannelImpl

public StageChannelImpl(long id,
 GuildImpl guild)

Method Details

isDetached

public boolean isDetached()

Description copied from interface: IDetachableEntity

Whether this entity is detached.

If this returns true, this entity cannot be retrieved, will never be updated, and most methods that would otherwise return a RestAction will throw a DetachedEntityException instead.

Specified by:

isDetached in interface IDetachableEntity

Returns:

True, if the entity is detached

getGuild

@Nonnull
public GuildImpl getGuild()

Description copied from interface: GuildChannel

Returns the Guild that this GuildChannel is part of.

Specified by:

getGuild in interface GuildChannel

Overrides:

getGuild in class AbstractGuildChannelImpl<StageChannelImpl>

Returns:

Never-null Guild that this GuildChannel is part of.

getType

@Nonnull
public ChannelType getType()

Description copied from interface: Channel

The ChannelType for this channel

Specified by:

getType in interface Channel

Returns:

The channel type

getBitrate

public int getBitrate()

Description copied from interface: AudioChannel

The audio bitrate of the voice audio that is transmitted in this channel. While higher bitrates can be sent to this channel, it will be scaled down by the client.
Default and recommended value is 64000

Specified by:

getBitrate in interface AudioChannel

Returns:

The audio bitrate of this audio channel.

getUserLimit

public int getUserLimit()

Description copied from interface: AudioChannel

The maximum amount of Members that be in an audio connection within this channel concurrently.
Returns 0 if there is no limit.

Moderators with the VOICE_MOVE_OTHERS permission can bypass this limit.

Specified by:

getUserLimit in interface AudioChannel

Returns:

The maximum connections allowed in this channel concurrently

getRegionRaw

@Nullable
public String getRegionRaw()

Description copied from interface: AudioChannel

The raw region name for this channel.
This will return null if the region is set to Automatic.

Specified by:

getRegionRaw in interface AudioChannel

Returns:

Raw region name, or null if the region is set to automatic.

getStageInstance

@Nullable
public StageInstance getStageInstance()

Description copied from interface: StageChannel

StageInstance attached to this stage channel.

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

Specified by:

getStageInstance in interface StageChannel

Returns:

The StageInstance or null if this stage is not live

getMembers

@Nonnull
public List<Member> getMembers()

Description copied from interface: IMemberContainer

A List of all Members that are in this GuildChannel
For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.
For VoiceChannels, this returns all Members that joined that VoiceChannel.
For Categories, this returns all Members who are in its child channels.

Specified by:

getMembers in interface IMemberContainer

Returns:

An immutable List of Members that are in this GuildChannel.

createStageInstance

@Nonnull
public StageInstanceAction createStageInstance(@Nonnull
 String topic)

Description copied from interface: StageChannel

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

Specified by:

createStageInstance in interface StageChannel

Parameters:

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

Returns:

StageInstanceAction

getSlowmode

public int getSlowmode()

Description copied from interface: ISlowmodeChannel

The slowmode set for this channel.
If slowmode is set, this returns an int between 1 and 21600.
Otherwise, if no slowmode is set, this returns 0.

Note bots are unaffected by this.
Having MESSAGE_MANAGE or MANAGE_CHANNEL permission also grants immunity to slowmode.

Special case
ForumChannels use this to limit how many posts a user can create. The client refers to this as the post slowmode.

Specified by:

getSlowmode in interface ISlowmodeChannel

Returns:

The slowmode for this channel, between 1 and 21600, or 0 if no slowmode is set.

isNSFW

public boolean isNSFW()

Description copied from interface: IAgeRestrictedChannel

Whether this channel is considered as age-restricted, also known as NSFW (Not-Safe-For-Work)

Specified by:

isNSFW in interface IAgeRestrictedChannel

Returns:

True, If this channel is age-restricted by the official Discord Client

canTalk

public boolean canTalk(@Nonnull
 Member member)

Description copied from interface: GuildMessageChannel

Whether the specified Member can send messages in this channel.
Checks for both Permission.VIEW_CHANNEL and Permission.MESSAGE_SEND.

Specified by:

canTalk in interface GuildMessageChannel

Parameters:

member - The Member to check

Returns:

True, if the specified member is able to read and send messages in this channel

getLatestMessageIdLong

public long getLatestMessageIdLong()

Description copied from interface: MessageChannel

The id for the most recent message sent in this current MessageChannel.

This value is updated on each MessageReceivedEvent and the value might point to an already deleted message since the value is not cleared when the message is deleted, so calling MessageChannel.retrieveMessageById(long) with this id can result in an UNKNOWN_MESSAGE error

Specified by:

getLatestMessageIdLong in interface MessageChannel

Returns:

The most recent message's id or 0 if no messages are present

getManager

@Nonnull
public 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().

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 ISlowmodeChannel

Specified by:

getManager in interface StageChannel

Specified by:

getManager in interface StandardGuildChannel

Returns:

The ChannelManager of this GuildChannel

See Also:

• ChannelManager, for modifying fields each guild channel provides
• ChannelField, for all possible channel fields

requestToSpeak

@Nonnull
public RestAction<Void> requestToSpeak()

Description copied from interface: StageChannel

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.

Specified by:

requestToSpeak in interface StageChannel

Returns:

RestAction

See Also:

• StageChannel.cancelRequestToSpeak()

cancelRequestToSpeak

@Nonnull
public RestAction<Void> cancelRequestToSpeak()

Description copied from interface: StageChannel

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.

Specified by:

cancelRequestToSpeak in interface StageChannel

Returns:

RestAction

See Also:

• StageChannel.requestToSpeak()

setBitrate

public StageChannelImpl setBitrate(int bitrate)

Specified by:

setBitrate in interface AudioChannelMixin<StageChannelImpl>

setUserLimit

public StageChannelImpl setUserLimit(int userlimit)

Specified by:

setUserLimit in interface AudioChannelMixin<StageChannelImpl>

setRegion

public StageChannelImpl setRegion(String region)

Specified by:

setRegion in interface AudioChannelMixin<StageChannelImpl>

setStageInstance

public StageChannelImpl setStageInstance(StageInstance instance)

setNSFW

public StageChannelImpl setNSFW(boolean ageRestricted)

Specified by:

setNSFW in interface IAgeRestrictedChannelMixin<StageChannelImpl>

setSlowmode

public StageChannelImpl setSlowmode(int slowmode)

Specified by:

setSlowmode in interface ISlowmodeChannelMixin<StageChannelImpl>

setLatestMessageIdLong

public StageChannelImpl setLatestMessageIdLong(long latestMessageId)

Specified by:

setLatestMessageIdLong in interface MessageChannelMixin<StageChannelImpl>