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

Interface ForumChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IMentionable, IPermissionContainer, IPositionableChannel, ISlowmodeChannel, ISnowflake, IThreadContainer, IWebhookContainer, StandardGuildChannel

public interface ForumChannel
extends StandardGuildChannel, IThreadContainer, IWebhookContainer, IAgeRestrictedChannel, ISlowmodeChannel

A Forum Channel which contains Forum Posts.
Forum posts are simply ThreadChannels of type ChannelType.GUILD_PUBLIC_THREAD.

The CREATE POSTS permission that is shown in the official Discord Client, is an alias for Permission.MESSAGE_SEND. Permission.CREATE_PUBLIC_THREADS is ignored for creating forum posts.

See Also:

• Guild.createForumChannel(String, Category)
• createForumPost(String, MessageCreateData)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_FORUM_TOPIC_LENGTH	The maximum length of a forum topic (4096)
static final int	MAX_POST_TAGS	The maximum number of tags that can be applied to a forum post.

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

Method Summary

Modifier and Type	Method	Description
default ChannelAction<ForumChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<ForumChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
ForumPostAction	createForumPost(String name, MessageCreateData message)	Creates a new forum post (thread) in this forum.
default ForumTag	getAvailableTagById(long id)	Retrieves the tag for the provided id.
default ForumTag	getAvailableTagById(String id)	Retrieves the tag for the provided id.
SortedSnowflakeCacheView<ForumTag>	getAvailableTagCache()	The available ForumTags for this forum channel.
default List<ForumTag>	getAvailableTags()	The available ForumTags for this forum channel.
default List<ForumTag>	getAvailableTagsByName(String name, boolean ignoreCase)	The available ForumTags for this forum channel.
EmojiUnion	getDefaultReaction()	The emoji which will show up on new forum posts as default reaction.
ForumChannelManager	getManager()	Returns the ChannelManager for this GuildChannel.
String	getTopic()	The topic set for this channel, this is referred to as Guidelines in the official Discord client.
default ChannelType	getType()	The ChannelType for this channel
default boolean	isTagRequired()	Whether all new forum posts must have a tag.

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

formatTo, getAsMention, getFlags, getJDA, getName

Methods inherited from interface java.lang.Comparable

compareTo

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

delete, getGuild, getJumpUrl, getPermissionContainer

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

isNSFW

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

getParentCategory, getParentCategoryId, getParentCategoryIdLong, isSynced

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

createInvite, retrieveInvites

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

getMembers

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

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

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

getPosition, getPositionRaw

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

getSlowmode

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

createThreadChannel, createThreadChannel, createThreadChannel, createThreadChannel, getDefaultThreadSlowmode, getThreadChannels, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels

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

createWebhook, deleteWebhookById, retrieveWebhooks

Field Details

MAX_FORUM_TOPIC_LENGTH

static final int MAX_FORUM_TOPIC_LENGTH

The maximum length of a forum topic (4096)

See Also:

• Constant Field Values

MAX_POST_TAGS

static final int MAX_POST_TAGS

The maximum number of tags that can be applied to a forum post. (5)

See Also:

• Constant Field Values

Method Details

getType

@Nonnull
default ChannelType getType()

Description copied from interface: Channel

The ChannelType for this channel

Specified by:

getType in interface Channel

Returns:

The channel type

getManager

@Nonnull
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 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

createCopy

@Nonnull
ChannelAction<ForumChannel> 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<ForumChannel> 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!

getAvailableTagCache

@Nonnull
SortedSnowflakeCacheView<ForumTag> getAvailableTagCache()

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

This requires CacheFlag.FORUM_TAGS to be enabled.

Returns:

SortedSnowflakeCacheView of ForumTag

getAvailableTags

@Nonnull
default List<ForumTag> getAvailableTags()

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

This is a shortcut for getAvailableTagCache().asList(). This method will copy the underlying cache into the list, running in O(n) time.

This requires CacheFlag.FORUM_TAGS to be enabled.

Returns:

Immutable List of ForumTag

getAvailableTagsByName

@Nonnull
default List<ForumTag> getAvailableTagsByName(@Nonnull
 String name,
 boolean ignoreCase)

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

This is a shortcut for getAvailableTagCache().getElementsByName(name, ignoreCase). This method will copy the underlying cache into the list, running in O(n) time.

This requires CacheFlag.FORUM_TAGS to be enabled.

Parameters:

name - The name of the tag

ignoreCase - Whether to use String.equalsIgnoreCase(String)

Returns:

Immutable List of ForumTag with the given name

Throws:

IllegalArgumentException - If the name is null

getAvailableTagById

@Nullable
default ForumTag getAvailableTagById(long id)

Retrieves the tag for the provided id.

This requires CacheFlag.FORUM_TAGS to be enabled.

Parameters:

id - The tag id

Returns:

The tag for the provided id, or null if no tag with that id exists

See Also:

• ForumTagSnowflake.fromId(long)

getAvailableTagById

@Nullable
default ForumTag getAvailableTagById(@Nonnull
 String id)

Retrieves the tag for the provided id.

This requires CacheFlag.FORUM_TAGS to be enabled.

Parameters:

id - The tag id

Returns:

The tag for the provided id, or null if no tag with that id exists

Throws:

IllegalArgumentException - If the provided id is null

NumberFormatException - If the provided id is not a valid snowflake

See Also:

• ForumTagSnowflake.fromId(String)

getTopic

@Nullable
String getTopic()

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.

Returns:

Possibly-null String containing the topic of this channel.

isTagRequired

default boolean isTagRequired()

Whether all new forum posts must have a tag.

Returns:

True, if all new posts must have a tag.

getDefaultReaction

@Nullable
EmojiUnion getDefaultReaction()

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

Returns:

The default reaction for new forum posts.

createForumPost

@Nonnull
@Incubating
@CheckReturnValue
ForumPostAction createForumPost(@Nonnull
 String name,
 @Nonnull
 MessageCreateData message)

Creates a new forum post (thread) in this forum.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If the forum channel was deleted
• REQUEST_ENTITY_TOO_LARGE
  If the total sum of uploaded bytes exceeds the guild's upload limit

Parameters:

name - The name of the post (up to 100 characters)

message - The starting message of the post (see MessageCreateBuilder)

Returns:

ForumPostAction

Throws:

InsufficientPermissionException - If the bot does not have Permission.MESSAGE_SEND in the channel

IllegalArgumentException -

• If null is provided
• If the name is empty or longer than 100 characters