Package net.dv8tion.jda.api.requests.restaction

Interface ThreadChannelAction

All Superinterfaces:

AuditableRestAction<ThreadChannel>, RestAction<ThreadChannel>

public interface ThreadChannelAction
extends AuditableRestAction<ThreadChannel>

Extension of RestAction specifically designed to create a ThreadChannel. This extension allows setting properties before executing the action.

See Also:

Message.createThreadChannel(String), IThreadContainer.createThreadChannel(String), IThreadContainer.createThreadChannel(String, boolean), IThreadContainer.createThreadChannel(String, long), IThreadContainer.createThreadChannel(String, String)

Method Summary

Modifier and Type	Method	Description
ThreadChannelAction	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 in
ChannelType	getType()	The ChannelType for the resulting channel
ThreadChannelAction	setAutoArchiveDuration(ThreadChannel.AutoArchiveDuration autoArchiveDuration)
ThreadChannelAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ThreadChannelAction	setInvitable(boolean isInvitable)
ThreadChannelAction	setName(String name)	Sets the name for the new GuildChannel
ThreadChannelAction	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

reason

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

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

Method Detail

setCheck

@Nonnull
ThreadChannelAction setCheck(@Nullable
                             BooleanSupplier checks)

Description copied from interface: AuditableRestAction

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 RestAction<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
ThreadChannelAction 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 RestAction<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
ThreadChannelAction deadline(long timestamp)

Description copied from interface: AuditableRestAction

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 RestAction<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
Guild getGuild()

The guild to create this GuildChannel in

Returns:

The guild

getType

@Nonnull
ChannelType getType()

The ChannelType for the resulting channel

Returns:

The channel type

setName

@Nonnull
@CheckReturnValue
ThreadChannelAction setName(@Nonnull
                            String name)

Sets the name for the new GuildChannel

Parameters:

name - The not-null name for the new GuildChannel (1-100 chars long)

Returns:

The current ChannelAction, for chaining convenience

Throws:

IllegalArgumentException - If the provided name is null or not between 1-100 chars long

setAutoArchiveDuration

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

setInvitable

@Nonnull
@CheckReturnValue
ThreadChannelAction setInvitable(boolean isInvitable)