Package net.dv8tion.jda.internal.requests.restaction

Class ThreadChannelActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<ThreadChannel>

net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<ThreadChannel>

net.dv8tion.jda.internal.requests.restaction.ThreadChannelActionImpl

All Implemented Interfaces:

RestAction<ThreadChannel>, AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>, AuditableRestAction<ThreadChannel>, FluentAuditableRestAction<ThreadChannel,ThreadChannelAction>, ThreadChannelAction

public class ThreadChannelActionImpl
extends AuditableRestActionImpl<ThreadChannel>
implements ThreadChannelAction

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Constructor Summary

Constructors

Constructor	Description
ThreadChannelActionImpl(GuildChannel channel, String name, String parentMessageId)
ThreadChannelActionImpl(GuildChannel channel, String name, ChannelType type)

Method Summary

Modifier and Type	Method	Description
ThreadChannelActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
Guild	getGuild()	The guild to create this GuildChannel for.
ChannelType	getType()	The ChannelType for the resulting channel.
ThreadChannelActionImpl	reason(String reason)	Applies the specified reason as audit-log reason field.
ThreadChannelAction	setAutoArchiveDuration(ThreadChannel.AutoArchiveDuration autoArchiveDuration)	Sets the ThreadChannel.AutoArchiveDuration for the new thread.
ThreadChannelActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ThreadChannelAction	setInvitable(boolean invitable)	Sets whether this channel allows all members to add new members.
ThreadChannelActionImpl	setName(String name)	Sets the name for the new GuildChannel.
ThreadChannelAction	setSlowmode(int slowmode)	Sets the slowmode for the new thread.
ThreadChannelActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.FluentAuditableRestAction

addCheck

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

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

Constructor Details

ThreadChannelActionImpl

public ThreadChannelActionImpl(GuildChannel channel,
 String name,
 ChannelType type)

ThreadChannelActionImpl

public ThreadChannelActionImpl(GuildChannel channel,
 String name,
 String parentMessageId)

Method Details

reason

@Nonnull
public ThreadChannelActionImpl reason(String reason)

Description copied from interface: AuditableRestAction

Applies the specified reason as audit-log reason field.
When the provided reason is empty or null it will be treated as not set. If the provided reason is longer than 512<T> characters, it will be truncated to fit the limit.

Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.retrieveAuditLogs()! For guild bans, this is also accessible via Guild.Ban.getReason().

This will specify the reason via the X-Audit-Log-Reason Request Header.

Specified by:

reason in interface AuditableRestAction<ThreadChannel>

Specified by:

reason in interface FluentAuditableRestAction<ThreadChannel,ThreadChannelAction>

Overrides:

reason in class AuditableRestActionImpl<ThreadChannel>

Parameters:

reason - The reason for this action which should be logged in the Guild's AuditLogs (up to 512<T> characters)

Returns:

The current AuditableRestAction instance for chaining convenience

See Also:

• ThreadLocalReason

setCheck

@Nonnull
public ThreadChannelActionImpl setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface AuditableRestAction<ThreadChannel>

Specified by:

setCheck in interface FluentAuditableRestAction<ThreadChannel,ThreadChannelAction>

Specified by:

setCheck in interface RestAction<ThreadChannel>

Overrides:

setCheck in class AuditableRestActionImpl<ThreadChannel>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public ThreadChannelActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface AuditableRestAction<ThreadChannel>

Specified by:

timeout in interface FluentAuditableRestAction<ThreadChannel,ThreadChannelAction>

Specified by:

timeout in interface RestAction<ThreadChannel>

Overrides:

timeout in class AuditableRestActionImpl<ThreadChannel>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public ThreadChannelActionImpl deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface AuditableRestAction<ThreadChannel>

Specified by:

deadline in interface FluentAuditableRestAction<ThreadChannel,ThreadChannelAction>

Specified by:

deadline in interface RestAction<ThreadChannel>

Overrides:

deadline in class AuditableRestActionImpl<ThreadChannel>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: AbstractThreadCreateAction

The guild to create this GuildChannel for.

Specified by:

getGuild in interface AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>

Returns:

The guild

getType

@Nonnull
public ChannelType getType()

Description copied from interface: AbstractThreadCreateAction

The ChannelType for the resulting channel.

Specified by:

getType in interface AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>

Returns:

The channel type

setName

@Nonnull
@CheckReturnValue
public ThreadChannelActionImpl setName(@Nonnull
 String name)

Description copied from interface: AbstractThreadCreateAction

Sets the name for the new GuildChannel.

Specified by:

setName in interface AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>

Parameters:

name - The not-null name for the new GuildChannel (up to 100 characters)

Returns:

The current action, for chaining convenience

setAutoArchiveDuration

@Nonnull
public ThreadChannelAction setAutoArchiveDuration(@Nonnull
 ThreadChannel.AutoArchiveDuration autoArchiveDuration)

Description copied from interface: AbstractThreadCreateAction

Sets the ThreadChannel.AutoArchiveDuration for the new thread.
This is primarily used to hide threads after the provided time of inactivity. Threads are automatically archived after 7 days of inactivity regardless.

Specified by:

setAutoArchiveDuration in interface AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>

Parameters:

autoArchiveDuration - The new archive inactivity duration (which hides the thread)

Returns:

The current action, for chaining convenience

setSlowmode

@Nonnull
public ThreadChannelAction setSlowmode(int slowmode)

Description copied from interface: AbstractThreadCreateAction

Sets the slowmode for the new thread.

A channel slowmode must not be negative nor greater than ISlowmodeChannel.MAX_SLOWMODE!

Note: Bots are unaffected by this.
Having MESSAGE_MANAGE or MANAGE_CHANNEL permission also grants immunity to slowmode.

Specified by:

setSlowmode in interface AbstractThreadCreateAction<ThreadChannel,ThreadChannelAction>

Parameters:

slowmode - The new slowmode

Returns:

The current action, for chaining convenience

See Also:

• ISlowmodeChannel.getSlowmode()

setInvitable

@Nonnull
public ThreadChannelAction setInvitable(boolean invitable)

Description copied from interface: ThreadChannelAction

Sets whether this channel allows all members to add new members.
When set to false, only moderators and the thread owner can add new members.

Specified by:

setInvitable in interface ThreadChannelAction

Parameters:

invitable - True, if all members should be allowed to add new members

Returns:

The current ThreadChannelAction for chaining convenience