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

Class ForumChannelImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

Comparable<GuildChannel>, Formattable, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IPermissionContainer, IPositionableChannel, IPostContainer, ISlowmodeChannel, IThreadContainer, IWebhookContainer, Channel, ForumChannel, GuildChannel, StandardGuildChannel, ChannelUnion, GuildChannelUnion, IPermissionContainerUnion, IThreadContainerUnion, IWebhookContainerUnion, IDetachableEntity, IMentionable, ISnowflake, IAgeRestrictedChannelMixin<ForumChannelImpl>, ICategorizableChannelMixin<ForumChannelImpl>, IInviteContainerMixin<ForumChannelImpl>, IPermissionContainerMixin<ForumChannelImpl>, IPositionableChannelMixin<ForumChannelImpl>, IPostContainerMixin<ForumChannelImpl>, ISlowmodeChannelMixin<ForumChannelImpl>, IThreadContainerMixin<ForumChannelImpl>, ITopicChannelMixin<ForumChannelImpl>, IWebhookContainerMixin<ForumChannelImpl>, ChannelMixin<ForumChannelImpl>, ForumChannelMixin<ForumChannelImpl>, GuildChannelMixin<ForumChannelImpl>, StandardGuildChannelMixin<ForumChannelImpl>, IDetachableEntityMixin

public class ForumChannelImpl
extends AbstractGuildChannelImpl<ForumChannelImpl>
implements ForumChannel, GuildChannelUnion, ForumChannelMixin<ForumChannelImpl>

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.channel.concrete.ForumChannel

ForumChannel.Layout

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IPostContainer

IPostContainer.SortOrder

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.concrete.ForumChannel

MAX_FORUM_TOPIC_LENGTH, MAX_POST_TAGS

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.IPostContainer

MAX_POST_CONTAINER_TOPIC_LENGTH, MAX_POST_TAGS

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

MAX_SLOWMODE

Constructor Summary

Constructors

Constructor	Description
ForumChannelImpl(long id, GuildImpl guild)

Method Summary

Modifier and Type	Method	Description
SortedSnowflakeCacheViewImpl<ForumTag>	getAvailableTagCache()	The available ForumTags for this forum channel.
ForumChannel.Layout	getDefaultLayout()	The default layout used to show threads.
EmojiUnion	getDefaultReaction()	The emoji which will show up on new forum posts as default reaction.
IPostContainer.SortOrder	getDefaultSortOrder()	The default order used to show threads.
int	getDefaultThreadSlowmode()	The default slowmode for thread channels that is copied on thread creation.
EnumSet<ChannelFlag>	getFlags()	The flags configured for this channel.
GuildImpl	getGuild()	Returns the Guild that this GuildChannel is part of.
ForumChannelManager	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.
long	getParentCategoryIdLong()	Get the snowflake of the Category that contains this channel.
gnu.trove.map.TLongObjectMap<PermissionOverride>	getPermissionOverrideMap()
int	getPositionRaw()	The actual position of the GuildChannel as stored and given by Discord.
int	getRawFlags()
int	getRawLayout()
int	getRawSortOrder()
int	getSlowmode()	The slowmode set for this channel.
String	getTopic()	The topic set for this channel, this is referred to as Guidelines in the official Discord client.
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)
ForumChannelImpl	setDefaultLayout(int layout)
ForumChannelImpl	setDefaultReaction(DataObject emoji)
ForumChannelImpl	setDefaultSortOrder(int defaultSortOrder)
ForumChannelImpl	setDefaultThreadSlowmode(int defaultThreadSlowmode)
ForumChannelImpl	setFlags(int flags)
ForumChannelImpl	setNSFW(boolean nsfw)
ForumChannelImpl	setParentCategory(long parentCategoryId)
ForumChannelImpl	setPosition(int position)
ForumChannelImpl	setSlowmode(int slowmode)
ForumChannelImpl	setTopic(String topic)

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.Channel

formatTo, getAsMention, 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.concrete.ForumChannel

createCopy, getType

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

createCopy

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

checkCanAccess, 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.attribute.ICategorizableChannel

getParentCategory, getParentCategoryId, getPositionInCategory

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

isSynced

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, 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

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

getAvailableTagById, getAvailableTagById, getAvailableTags, getAvailableTagsByName, isTagRequired

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

createForumPost, createThreadChannel, createThreadChannel

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

getId, getIdLong, getTimeCreated

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

getThreadChannels

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

createThreadChannel, createThreadChannel, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels

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

asForumChannel, asGuildMessageChannel, asMediaChannel, asNewsChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel

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

Constructor Details

ForumChannelImpl

public ForumChannelImpl(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<ForumChannelImpl>

Returns:

Never-null Guild that this GuildChannel is part of.

getManager

@Nonnull
public ForumChannelManager 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 ForumChannel

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 IPostContainer

Specified by:

getManager in interface ISlowmodeChannel

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

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.

getFlags

@Nonnull
public EnumSet<ChannelFlag> getFlags()

Description copied from interface: Channel

The flags configured for this channel.
This feature is currently primarily used for ForumChannels.

Specified by:

getFlags in interface Channel

Returns:

EnumSet of the configured ChannelFlags, changes to this enum set are not reflected in the API.

getAvailableTagCache

@Nonnull
public SortedSnowflakeCacheViewImpl<ForumTag> getAvailableTagCache()

Description copied from interface: IPostContainer

The available ForumTags for this forum channel.
Tags are sorted by their position ascending.

This requires CacheFlag.FORUM_TAGS to be enabled.

Specified by:

getAvailableTagCache in interface IPostContainer

Specified by:

getAvailableTagCache in interface IPostContainerMixin<ForumChannelImpl>

Returns:

SortedSnowflakeCacheView of ForumTag

getPermissionOverrideMap

public gnu.trove.map.TLongObjectMap<PermissionOverride> getPermissionOverrideMap()

Specified by:

getPermissionOverrideMap in interface IPermissionContainerMixin<ForumChannelImpl>

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

getPositionRaw

public int getPositionRaw()

Description copied from interface: IPositionableChannel

The actual position of the GuildChannel as stored and given by Discord.

Channel positions are actually based on a pairing of the creation time (as stored in the snowflake id) and the position. If 2 or more channels share the same position then they are sorted based on their creation date. The more recent a channel was created, the lower it is in the hierarchy. This is handled by IPositionableChannel.getPosition() and it is most likely the method you want. If, for some reason, you want the actual position of the channel then this method will give you that value.

Specified by:

getPositionRaw in interface IPositionableChannel

Returns:

The true, Discord stored, position of the GuildChannel.

getParentCategoryIdLong

public long getParentCategoryIdLong()

Description copied from interface: ICategorizableChannel

Get the snowflake of the Category that contains this channel.

This will return 0 if this channel doesn't have a parent category.

Specified by:

getParentCategoryIdLong in interface ICategorizableChannel

Returns:

The Discord ID snowflake of the parent channel as a long.

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.

getTopic

public String getTopic()

Description copied from interface: IPostContainer

The topic set for this channel, this is referred to as Guidelines in the official Discord client.
If no topic has been set, this returns null.

Specified by:

getTopic in interface IPostContainer

Specified by:

getTopic in interface ITopicChannelMixin<ForumChannelImpl>

Returns:

Possibly-null String containing the topic of this channel.

getDefaultReaction

public EmojiUnion getDefaultReaction()

Description copied from interface: IPostContainer

The emoji which will show up on new forum posts as default reaction.

Specified by:

getDefaultReaction in interface IPostContainer

Returns:

The default reaction for new forum posts.

getDefaultThreadSlowmode

public int getDefaultThreadSlowmode()

Description copied from interface: IThreadContainer

The default slowmode for thread channels that is copied on thread creation.
Users have to wait this amount of seconds before sending another message to the same thread.

Specified by:

getDefaultThreadSlowmode in interface IThreadContainer

Returns:

The default slowmode seconds for new threads, or 0 if unset

getDefaultSortOrder

@Nonnull
public IPostContainer.SortOrder getDefaultSortOrder()

Description copied from interface: IPostContainer

The default order used to show threads.

Specified by:

getDefaultSortOrder in interface IPostContainer

Returns:

The default order used to show threads.

getDefaultLayout

@Nonnull
public ForumChannel.Layout getDefaultLayout()

Description copied from interface: ForumChannel

The default layout used to show threads.

Specified by:

getDefaultLayout in interface ForumChannel

Returns:

The default layout used to show threads.

getRawFlags

public int getRawFlags()

Specified by:

getRawFlags in interface IPostContainerMixin<ForumChannelImpl>

getRawSortOrder

public int getRawSortOrder()

Specified by:

getRawSortOrder in interface IPostContainerMixin<ForumChannelImpl>

getRawLayout

public int getRawLayout()

setParentCategory

public ForumChannelImpl setParentCategory(long parentCategoryId)

Specified by:

setParentCategory in interface ICategorizableChannelMixin<ForumChannelImpl>

setPosition

public ForumChannelImpl setPosition(int position)

Specified by:

setPosition in interface IPositionableChannelMixin<ForumChannelImpl>

setDefaultThreadSlowmode

public ForumChannelImpl setDefaultThreadSlowmode(int defaultThreadSlowmode)

Specified by:

setDefaultThreadSlowmode in interface IThreadContainerMixin<ForumChannelImpl>

setNSFW

public ForumChannelImpl setNSFW(boolean nsfw)

Specified by:

setNSFW in interface IAgeRestrictedChannelMixin<ForumChannelImpl>

setSlowmode

public ForumChannelImpl setSlowmode(int slowmode)

Specified by:

setSlowmode in interface ISlowmodeChannelMixin<ForumChannelImpl>

setTopic

public ForumChannelImpl setTopic(String topic)

Specified by:

setTopic in interface ITopicChannelMixin<ForumChannelImpl>

setFlags

public ForumChannelImpl setFlags(int flags)

Specified by:

setFlags in interface IPostContainerMixin<ForumChannelImpl>

setDefaultReaction

public ForumChannelImpl setDefaultReaction(DataObject emoji)

Specified by:

setDefaultReaction in interface IPostContainerMixin<ForumChannelImpl>

setDefaultSortOrder

public ForumChannelImpl setDefaultSortOrder(int defaultSortOrder)

Specified by:

setDefaultSortOrder in interface IPostContainerMixin<ForumChannelImpl>

setDefaultLayout

public ForumChannelImpl setDefaultLayout(int layout)

Specified by:

setDefaultLayout in interface ForumChannelMixin<ForumChannelImpl>