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

Interface IThreadContainer

All Superinterfaces:

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

All Known Subinterfaces:

ForumChannel, IPostContainer, IThreadContainerUnion, MediaChannel, NewsChannel, StandardGuildMessageChannel, TextChannel

public interface IThreadContainer
extends GuildChannel, IPermissionContainer

Abstraction of all channel types, which can contain or manage ThreadChannels.

See Also:

• ThreadChannel.getParentChannel()
• IThreadContainerUnion

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

Method Summary

Modifier and Type	Method	Description
default ThreadChannelAction	createThreadChannel(String name)	Creates a new public ThreadChannel with the parent channel being this IThreadContainer.
ThreadChannelAction	createThreadChannel(String name, boolean isPrivate)	Creates a new ThreadChannel with the parent channel being this IThreadContainer.
ThreadChannelAction	createThreadChannel(String name, long messageId)	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.
int	getDefaultThreadSlowmode()	The default slowmode for thread channels that is copied on thread creation.
default @Unmodifiable List<ThreadChannel>	getThreadChannels()	Finds all ThreadChannels whose parent is this channel.
ThreadChannelPaginationAction	retrieveArchivedPrivateJoinedThreadChannels()	Retrieves the archived private ThreadChannels for this channel, that the bot has previously joined or been added to.
ThreadChannelPaginationAction	retrieveArchivedPrivateThreadChannels()	Retrieves the archived private ThreadChannels for this channel.
ThreadChannelPaginationAction	retrieveArchivedPublicThreadChannels()	Retrieves the archived public ThreadChannels for this channel.

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

isDetached

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

getManager, getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

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

getId, getIdLong, getTimeCreated

Method Details

getDefaultThreadSlowmode

int getDefaultThreadSlowmode()

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.

Returns:

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

getThreadChannels

@Nonnull
default @Unmodifiable List<ThreadChannel> getThreadChannels()

Finds all ThreadChannels whose parent is this channel.

These threads can also represent posts in ForumChannels.

Returns:

Immutable list of all ThreadChannel children.

Throws:

DetachedEntityException - If this entity is detached

createThreadChannel

@Nonnull
@CheckReturnValue
default ThreadChannelAction createThreadChannel(@Nonnull
 String name)

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.

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.

Throws:

IllegalArgumentException - If the provided name is null, blank, empty, or longer than 100 characters

UnsupportedOperationException - If this is a forum channel. You must use createForumPost(...) instead.

InsufficientPermissionException -

• If the bot does not have Permission.VIEW_CHANNEL
• If the bot does not have Permission.CREATE_PUBLIC_THREADS

DetachedEntityException - If this entity is detached

createThreadChannel

@Nonnull
@CheckReturnValue
ThreadChannelAction createThreadChannel(@Nonnull
 String name,
 boolean isPrivate)

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

The resulting ThreadChannel may be one of:

• ChannelType.GUILD_PUBLIC_THREAD
• ChannelType.GUILD_NEWS_THREAD
• ChannelType.GUILD_PRIVATE_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.
• ErrorResponse.MISSING_PERMISSIONS
  Due to missing private thread permissions.

Parameters:

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

isPrivate - The public/private status of the new ThreadChannel. If true, the new ThreadChannel will be private.

Returns:

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

Throws:

IllegalArgumentException - If the provided name is null, blank, empty, or longer than 100 characters.

IllegalStateException - If the guild does have the feature flag "PRIVATE_THREADS" enabled.

UnsupportedOperationException - If this is a forum channel. You must use createForumPost(...) instead.

InsufficientPermissionException -

• If the bot does not have Permission.VIEW_CHANNEL
• If the thread is private, and the bot does not have Permission.CREATE_PRIVATE_THREADS
• If the thread is not private, and the bot does not have Permission.CREATE_PUBLIC_THREADS

DetachedEntityException - If this entity is detached

createThreadChannel

@Nonnull
@CheckReturnValue
ThreadChannelAction createThreadChannel(@Nonnull
 String name,
 long messageId)

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.

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.

Throws:

IllegalArgumentException - If the provided name is null, blank, empty, or longer than 100 characters

UnsupportedOperationException - If this is a forum channel. You must use createForumPost(...) instead.

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

DetachedEntityException - If this entity is detached

createThreadChannel

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

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.

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.

Throws:

IllegalArgumentException - If the provided name is null, blank, empty, or longer than 100 characters. Or the message id is not a valid snowflake.

UnsupportedOperationException - If this is a forum channel. You must use createForumPost(...) instead.

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

DetachedEntityException - If this entity is detached

retrieveArchivedPublicThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPublicThreadChannels()

Retrieves the archived public ThreadChannels for this channel.
This will iterate over all previously opened public threads, that have been archived.

You can use retrieveArchivedPrivateThreadChannels(), to get all private archived threads.

These threads can also represent posts in ForumChannels.

Returns:

ThreadChannelPaginationAction to iterate over all public archived ThreadChannels

Throws:

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

DetachedEntityException - If this entity is detached

retrieveArchivedPrivateThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPrivateThreadChannels()

Retrieves the archived private ThreadChannels for this channel.
This will iterate over all previously opened private threads, that have been archived. This is a moderator restricted method, since private threads are only visible to members with Permission.MANAGE_THREADS.

You can use retrieveArchivedPublicThreadChannels(), to get all public archived threads.

Note that ForumChannels cannot have private threads.

Returns:

ThreadChannelPaginationAction to iterate over all private archived ThreadChannels

Throws:

InsufficientPermissionException - If the bot does not have Permission.MESSAGE_HISTORY or Permission.MANAGE_THREADS in this channel

DetachedEntityException - If this entity is detached

retrieveArchivedPrivateJoinedThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPrivateJoinedThreadChannels()

Retrieves the archived private ThreadChannels for this channel, that the bot has previously joined or been added to.
Unlike retrieveArchivedPrivateThreadChannels(), this only checks for threads which the bot has joined, and thus does not require permissions to manage threads.

You can use retrieveArchivedPrivateThreadChannels(), to get all private archived threads.

Note that ForumChannels cannot have private threads.

Returns:

ThreadChannelPaginationAction to iterate over all joined private archived ThreadChannels

Throws:

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

DetachedEntityException - If this entity is detached