Package net.dv8tion.jda.internal.entities.channel.mixin.attribute

Interface IPostContainerMixin<T extends IPostContainerMixin<T>>

All Superinterfaces:

Channel, ChannelMixin<T>, ChannelUnion, Comparable<GuildChannel>, Formattable, GuildChannel, GuildChannelMixin<T>, GuildChannelUnion, IDetachableEntity, IDetachableEntityMixin, IMentionable, IPermissionContainer, IPostContainer, ISnowflake, IThreadContainer, IThreadContainerMixin<T>, IThreadContainerUnion

All Known Subinterfaces:

ForumChannelMixin<T>, MediaChannelMixin<T>

All Known Implementing Classes:

DetachedForumChannelImpl, DetachedMediaChannelImpl, ForumChannelImpl, MediaChannelImpl

public interface IPostContainerMixin<T extends IPostContainerMixin<T>>
extends IPostContainer, IThreadContainerMixin<T>

Nested Class Summary

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.middleman.GuildChannel

JUMP_URL

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

MAX_POST_CONTAINER_TOPIC_LENGTH, MAX_POST_TAGS

Method Summary

Modifier and Type	Method	Description
default ForumPostAction	createForumPost(String name, MessageCreateData message)	Creates a new forum/media post (thread) in this channel.
default ThreadChannelAction	createThreadChannel(String name)	Creates a new public ThreadChannel with the parent channel being this IThreadContainer.
default ThreadChannelAction	createThreadChannel(String name, String messageId)	Creates a new, public ThreadChannel with the parent channel being this IThreadContainer.
SortedSnowflakeCacheViewImpl<ForumTag>	getAvailableTagCache()	The available ForumTags for this forum channel.
int	getRawFlags()
int	getRawSortOrder()
T	setDefaultReaction(DataObject emoji)
T	setDefaultSortOrder(int defaultSortOrder)
T	setFlags(int flags)

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

formatTo, getAsMention, getFlags, getJDA, getName, getType

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

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

getGuild, getJumpUrl, getPermissionContainer

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.detached.IDetachableEntity

isDetached

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

checkAttached, detachedException, detachedRequiresChannelException

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

getAvailableTagById, getAvailableTagById, getAvailableTags, getAvailableTagsByName, getDefaultReaction, getDefaultSortOrder, getManager, getTopic, isTagRequired

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

getDefaultThreadSlowmode, getThreadChannels

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

createThreadChannel, createThreadChannel, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels, setDefaultThreadSlowmode

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

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

Method Details

getAvailableTagCache

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

Returns:

SortedSnowflakeCacheView of ForumTag

createForumPost

@Nonnull
default ForumPostAction createForumPost(@Nonnull
 String name,
 @Nonnull
 MessageCreateData message)

Description copied from interface: IPostContainer

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

Specified by:

createForumPost in interface IPostContainer

Parameters:

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

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

Returns:

ForumPostAction

createThreadChannel

@Nonnull
default ThreadChannelAction createThreadChannel(@Nonnull
 String name)

Description copied from interface: IThreadContainer

Creates a new public ThreadChannel with the parent channel being this IThreadContainer.

The resulting ThreadChannel may be either one of:

• ChannelType.GUILD_PUBLIC_THREAD
• ChannelType.GUILD_NEWS_THREAD

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded
• ErrorResponse.MAX_ACTIVE_THREADS
  The maximum number of active threads has been reached, and no more may be created.

Specified by:

createThreadChannel in interface IThreadContainer

Parameters:

name - The name of the new ThreadChannel (up to 100 characters)

Returns:

A specific ThreadChannelAction that may be used to configure the new ThreadChannel before its creation.

createThreadChannel

@Nonnull
default ThreadChannelAction createThreadChannel(@Nonnull
 String name,
 @Nonnull
 String messageId)

Description copied from interface: IThreadContainer

Creates a new, public ThreadChannel with the parent channel being this IThreadContainer.
The starting message will copy the message for the provided id, and will be of type MessageType.THREAD_STARTER_MESSAGE.

The resulting ThreadChannel may be one of:

• ChannelType.GUILD_PUBLIC_THREAD
• ChannelType.GUILD_NEWS_THREAD

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MAX_CHANNELS
  The maximum number of channels were exceeded
• ErrorResponse.THREAD_WITH_THIS_MESSAGE_ALREADY_EXISTS
  This message has already been used to create a thread
• ErrorResponse.MAX_ACTIVE_THREADS
  The maximum number of active threads has been reached, and no more may be created.

Specified by:

createThreadChannel in interface IThreadContainer

Parameters:

name - The name of the new ThreadChannel (up to 100 characters)

messageId - The ID of the message from which this ThreadChannel will be spawned.

Returns:

A specific ThreadChannelAction that may be used to configure the new ThreadChannel before its creation.

setDefaultReaction

T setDefaultReaction(DataObject emoji)

setDefaultSortOrder

T setDefaultSortOrder(int defaultSortOrder)

setFlags

T setFlags(int flags)

getRawSortOrder

int getRawSortOrder()

getRawFlags

int getRawFlags()