Package net.dv8tion.jda.api.entities

Interface IThreadContainer

All Superinterfaces:

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

All Known Subinterfaces:

IThreadContainerUnion, NewsChannel, StandardGuildMessageChannel, TextChannel

public interface IThreadContainer
extends GuildChannel, IPermissionContainer

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.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.
default List<ThreadChannel>	getThreadChannels()	Finds all ThreadChannels whose parent is this channel.
ThreadChannelPaginationAction	retrieveArchivedPrivateJoinedThreadChannels()
ThreadChannelPaginationAction	retrieveArchivedPrivateThreadChannels()
ThreadChannelPaginationAction	retrieveArchivedPublicThreadChannels()

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

formatTo, getAsMention, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

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

delete, getGuild, getJumpUrl, getPermissionContainer

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

getManager, getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

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

getId, getIdLong, getTimeCreated

Method Details

getThreadChannels

default List<ThreadChannel> getThreadChannels()

Finds all ThreadChannels whose parent is this channel.

Returns:

a list of all ThreadChannel children.

createThreadChannel

@Nonnull
@CheckReturnValue
default ThreadChannelAction createThreadChannel(String name)

Creates a new, public ThreadChannel with the parent channel being this IThreadContainer. This requires the bot to have the Permission.VIEW_CHANNEL and Permission.CREATE_PUBLIC_THREADS permissions. 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

Returns:

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

createThreadChannel

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

Creates a new ThreadChannel with the parent channel being this IThreadContainer. This requires the bot to have the Permission.VIEW_CHANNEL and Permission.CREATE_PUBLIC_THREADS permissions. 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

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:

InsufficientPermissionException - if the ThreadChannel is set to private, and the logged in account does not have Permission.CREATE_PRIVATE_THREADS.

createThreadChannel

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

Creates a new, public ThreadChannel with the parent channel being this IThreadContainer. This ThreadChannel will be spawned from the given messageID, and will consequently share its ID with the message. This requires the bot to have Permission.VIEW_CHANNEL and Permission.CREATE_PUBLIC_THREADS permissions. 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

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.

createThreadChannel

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

Creates a new, public ThreadChannel with the parent channel being this IThreadContainer. This ThreadChannel will be spawned from the given messageID, and will consequently share its ID with the message. This requires the bot to have Permission.VIEW_CHANNEL and Permission.CREATE_PUBLIC_THREADS permissions. 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

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.

retrieveArchivedPublicThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPublicThreadChannels()

retrieveArchivedPrivateThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPrivateThreadChannels()

retrieveArchivedPrivateJoinedThreadChannels

@Nonnull
@CheckReturnValue
ThreadChannelPaginationAction retrieveArchivedPrivateJoinedThreadChannels()