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

Interface ForumChannel

All Superinterfaces:

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

public interface ForumChannel
extends StandardGuildChannel, IPostContainer, 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)
• IPostContainer.createForumPost(String, MessageCreateData)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ForumChannel.Layout	The layout used to sort forum posts.

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

IPostContainer.SortOrder

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

MAX_POST_CONTAINER_TOPIC_LENGTH

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.
ForumChannel.Layout	getDefaultLayout()	The default layout used to show threads.
ForumChannelManager	getManager()	Returns the ChannelManager for this GuildChannel.
default ChannelType	getType()	The ChannelType for this channel

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

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity

isDetached

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

createForumPost, getAvailableTagById, getAvailableTagById, getAvailableTagCache, getAvailableTags, getAvailableTagsByName, getDefaultReaction, getDefaultSortOrder, getTopic, isTagRequired

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

createCopy

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

getDefaultLayout

@Nonnull
ForumChannel.Layout getDefaultLayout()

The default layout used to show threads.

Returns:

The default layout used to show threads.