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

Interface IPostContainer

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IMentionable, IPermissionContainer, ISnowflake, IThreadContainer

All Known Subinterfaces:

ForumChannel, MediaChannel

public interface IPostContainer
extends IThreadContainer

A 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:

• ForumChannel
• MediaChannel
• createForumPost(String, MessageCreateData)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IPostContainer.SortOrder	The order used to sort forum posts.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_POST_CONTAINER_TOPIC_LENGTH	The maximum length of a forum / media channel 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

Method Summary

Modifier and Type	Method	Description
ForumPostAction	createForumPost(String name, MessageCreateData message)	Creates a new forum/media post (thread) in this channel.
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 @Unmodifiable List<ForumTag>	getAvailableTags()	The available ForumTags for this channel.
default @Unmodifiable List<ForumTag>	getAvailableTagsByName(String name, boolean ignoreCase)	The available ForumTags for this channel.
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.
IPostContainerManager<?,?>	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 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, getType

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

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

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

Field Details

MAX_POST_CONTAINER_TOPIC_LENGTH

static final int MAX_POST_CONTAINER_TOPIC_LENGTH

The maximum length of a forum / media channel 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

getManager

@Nonnull
@CheckReturnValue
IPostContainerManager<?,?> 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 IPermissionContainer

Returns:

The ChannelManager of this GuildChannel

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 @Unmodifiable List<ForumTag> getAvailableTags()

The available ForumTags for this 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 @Unmodifiable List<ForumTag> getAvailableTagsByName(@Nonnull
 String name,
 boolean ignoreCase)

The available ForumTags for this 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.

getDefaultSortOrder

@Nonnull
IPostContainer.SortOrder getDefaultSortOrder()

The default order used to show threads.

Returns:

The default order used to show threads.

createForumPost

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

Creates a new forum/media post (thread) in this channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If the channel was deleted
• MESSAGE_BLOCKED_BY_AUTOMOD
  If this message was blocked by an AutoModRule
• MESSAGE_BLOCKED_BY_HARMFUL_LINK_FILTER
  If this message was blocked by the harmful link filter
• REQUEST_ENTITY_TOO_LARGE
  If the total sum of uploaded bytes exceeds the guild's upload limit
• TITLE_BLOCKED_BY_AUTOMOD
  If the forum post name was blocked by an AutoModRule

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