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

Interface IThreadContainerMixin<T extends IThreadContainerMixin<T>>

All Superinterfaces:

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

All Known Subinterfaces:

ForumChannelMixin<T>, IPostContainerMixin<T>, MediaChannelMixin<T>, NewsChannelMixin<T>, StandardGuildMessageChannelMixin<T>, TextChannelMixin<T>

All Known Implementing Classes:

AbstractStandardGuildMessageChannelImpl, DetachedForumChannelImpl, DetachedMediaChannelImpl, DetachedNewsChannelImpl, DetachedTextChannelImpl, ForumChannelImpl, MediaChannelImpl, NewsChannelImpl, TextChannelImpl

public interface IThreadContainerMixin<T extends IThreadContainerMixin<T>>
extends IThreadContainer, IThreadContainerUnion, GuildChannelMixin<T>

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, boolean isPrivate)	Creates a new ThreadChannel with the parent channel being this IThreadContainer.
default ThreadChannelAction	createThreadChannel(String name, long messageId)	Creates a new, public ThreadChannel with the parent channel being this IThreadContainer.
default ThreadChannelPaginationAction	retrieveArchivedPrivateJoinedThreadChannels()	Retrieves the archived private ThreadChannels for this channel, that the bot has previously joined or been added to.
default ThreadChannelPaginationAction	retrieveArchivedPrivateThreadChannels()	Retrieves the archived private ThreadChannels for this channel.
default ThreadChannelPaginationAction	retrieveArchivedPublicThreadChannels()	Retrieves the archived public ThreadChannels for this channel.
T	setDefaultThreadSlowmode(int slowmode)

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

getManager, 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, getDefaultThreadSlowmode, getThreadChannels

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

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

Method Details

createThreadChannel

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

Description copied from interface: IThreadContainer

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.

Specified by:

createThreadChannel in interface IThreadContainer

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.

createThreadChannel

@Nonnull
default ThreadChannelAction createThreadChannel(@Nonnull
 String name,
 long 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.

retrieveArchivedPublicThreadChannels

@Nonnull
default ThreadChannelPaginationAction retrieveArchivedPublicThreadChannels()

Description copied from interface: IThreadContainer

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

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

These threads can also represent posts in ForumChannels.

Specified by:

retrieveArchivedPublicThreadChannels in interface IThreadContainer

Returns:

ThreadChannelPaginationAction to iterate over all public archived ThreadChannels

retrieveArchivedPrivateThreadChannels

@Nonnull
default ThreadChannelPaginationAction retrieveArchivedPrivateThreadChannels()

Description copied from interface: IThreadContainer

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 IThreadContainer.retrieveArchivedPublicThreadChannels(), to get all public archived threads.

Note that ForumChannels cannot have private threads.

Specified by:

retrieveArchivedPrivateThreadChannels in interface IThreadContainer

Returns:

ThreadChannelPaginationAction to iterate over all private archived ThreadChannels

retrieveArchivedPrivateJoinedThreadChannels

@Nonnull
default ThreadChannelPaginationAction retrieveArchivedPrivateJoinedThreadChannels()

Description copied from interface: IThreadContainer

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

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

Note that ForumChannels cannot have private threads.

Specified by:

retrieveArchivedPrivateJoinedThreadChannels in interface IThreadContainer

Returns:

ThreadChannelPaginationAction to iterate over all joined private archived ThreadChannels

setDefaultThreadSlowmode

T setDefaultThreadSlowmode(int slowmode)