Interface ThreadChannelManager

All Superinterfaces:

AuditableRestAction<Void>, ChannelManager<ThreadChannel, ThreadChannelManager>, ISlowmodeChannelManager<ThreadChannel, ThreadChannelManager>, Manager<ThreadChannelManager>, RestAction<Void>

public interface ThreadChannelManager
extends ChannelManager<ThreadChannel, ThreadChannelManager>, ISlowmodeChannelManager<ThreadChannel, ThreadChannelManager>

Manager providing functionality common for all ThreadChannels.

Example

manager.setSlowmode(10)
       .setArchived(false)
       .queue();
manager.reset(ChannelManager.SLOWMODE | ChannelManager.NAME)
       .setName("Java is to Javascript as car is to carpet")
       .setLocked(false)
       .setSlowmode(120)
       .queue();

See Also:

• ThreadChannel.getManager()
• ThreadChannel

Field Summary

Fields inherited from interface AuditableRestAction

MAX_REASON_LENGTH

Fields inherited from interface ChannelManager

APPLIED_TAGS, ARCHIVED, AUTO_ARCHIVE_DURATION, AVAILABLE_TAGS, BITRATE, DEFAULT_LAYOUT, DEFAULT_REACTION, DEFAULT_SORT_ORDER, DEFAULT_THREAD_SLOWMODE, HIDE_MEDIA_DOWNLOAD_OPTIONS, INVITEABLE, LOCKED, NAME, NSFW, PARENT, PERMISSION, PINNED, POSITION, REGION, REQUIRE_TAG, SLOWMODE, TOPIC, TYPE, USERLIMIT

Method Summary

Modifier and Type	Method	Description
ThreadChannelManager	setAppliedTags(Collection<? extends ForumTagSnowflake> tags)	Sets the applied ForumTags for this forum post thread.
default ThreadChannelManager	setAppliedTags(ForumTagSnowflake... tags)	Sets the applied ForumTags for this forum post thread.
ThreadChannelManager	setArchived(boolean archived)	Sets the archived state of this ThreadChannel.
ThreadChannelManager	setAutoArchiveDuration(ThreadChannel.AutoArchiveDuration autoArchiveDuration)	Sets the inactive time before autoarchiving of this ThreadChannel.
ThreadChannelManager	setInvitable(boolean invitable)	Sets the invitable state of this ThreadChannel.
ThreadChannelManager	setLocked(boolean locked)	Sets the locked state of this ThreadChannel.
ThreadChannelManager	setPinned(boolean pinned)	Sets the pinned state of this ThreadChannel.

Methods inherited from interface AuditableRestAction

reason

Methods inherited from interface ChannelManager

getChannel, getGuild, reset, reset, setName

Methods inherited from interface ISlowmodeChannelManager

setSlowmode

Methods inherited from interface Manager

deadline, reset, setCheck, timeout

Methods inherited from interface RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Method Details

setAutoArchiveDuration

@Nonnull
@CheckReturnValue
ThreadChannelManager setAutoArchiveDuration(@Nonnull
 ThreadChannel.AutoArchiveDuration autoArchiveDuration)

Sets the inactive time before autoarchiving of this ThreadChannel.

This is limited to the choices offered in ThreadChannel.AutoArchiveDuration

Parameters:

autoArchiveDuration - The new duration before an inactive channel will be autoarchived.

Returns:

this ThreadChannelManager for chaining convenience.

See Also:

• ThreadChannel.getAutoArchiveDuration()

setArchived

@Nonnull
@CheckReturnValue
ThreadChannelManager setArchived(boolean archived)

Sets the archived state of this ThreadChannel.

Parameters:

archived - The new archived state for the selected ThreadChannel

Returns:

this ThreadChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account is not the thread owner or does not have the MANAGE_THREADS permission. Or if the thread is locked (archived by a moderator) and the current account does not have the MANAGE_THREADS permission.

See Also:

• ThreadChannel.isArchived()

setLocked

@Nonnull
@CheckReturnValue
ThreadChannelManager setLocked(boolean locked)

Sets the locked state of this ThreadChannel.

This is the equivalent of archiving as a moderator.

Parameters:

locked - The new locked state for the selected ThreadChannel

Returns:

this ThreadChannelManager for chaining convenience.

Throws:

InsufficientPermissionException - If the currently logged in account is not the thread owner or does not have the MANAGE_THREADS permission.

See Also:

• ThreadChannel.isLocked()

setInvitable

@Nonnull
@CheckReturnValue
ThreadChannelManager setInvitable(boolean invitable)

Sets the invitable state of this ThreadChannel.

This property can only be set on private ThreadChannels.

Parameters:

invitable - The new invitable state for the selected ThreadChannel

Returns:

this ThreadChannelManager for chaining convenience.

Throws:

IllegalStateException - If the selected ThreadChannel is not a private ThreadChannel

InsufficientPermissionException - If the currently logged in account is not the thread owner or does not have the MANAGE_THREADS permission.

See Also:

• ThreadChannel.isInvitable()
• ThreadChannel.isPublic()

setPinned

@Nonnull
@CheckReturnValue
ThreadChannelManager setPinned(boolean pinned)

Sets the pinned state of this ThreadChannel.

This property can only be set on forum post threads.

Parameters:

pinned - The new pinned state for the selected ThreadChannel

Returns:

this ThreadChannelManager for chaining convenience.

Throws:

IllegalStateException - If the selected ThreadChannel is not a forum post thread

InsufficientPermissionException - If the currently logged in account is not the thread owner or does not have the MANAGE_THREADS permission.

See Also:

• ThreadChannel.isPinned()

setAppliedTags

@Nonnull
@CheckReturnValue
ThreadChannelManager setAppliedTags(@Nonnull
 Collection<? extends ForumTagSnowflake> tags)

Sets the applied ForumTags for this forum post thread.
This is only applicable to public threads inside forum channels. The tags must be from the forum channel. You can get the list of available tags with IPostContainer.getAvailableTags().

Parameters:

tags - The new tags for the thread

Returns:

this ThreadChannelManager for chaining convenience.

Throws:

IllegalStateException - If the thread is not a forum post

IllegalArgumentException -

• If null is provided
• If more than 5 tags are provided
• If at least one tag is required and none were provided

setAppliedTags

@Nonnull
@CheckReturnValue
default ThreadChannelManager setAppliedTags(@Nonnull
 ForumTagSnowflake... tags)

Sets the applied ForumTags for this forum post thread.
This is only applicable to public threads inside forum channels. The tags must be from the forum channel. You can get the list of available tags with IPostContainer.getAvailableTags().

Parameters:

tags - The new tags for the thread

Returns:

this ThreadChannelManager for chaining convenience.

Throws:

IllegalStateException - If the thread is not a forum post

IllegalArgumentException -

• If null is provided
• If more than 5 tags are provided
• If at least one tag is required and none were provided