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

Class ForumPostActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.ForumPostActionImpl

All Implemented Interfaces:

FluentRestAction<ForumPost,ForumPostAction>, RestAction<ForumPost>, AbstractThreadCreateAction<ForumPost,ForumPostAction>, ForumPostAction, MessageCreateRequest<ForumPostAction>, MessageData, MessageRequest<ForumPostAction>, AbstractMessageBuilderMixin<ForumPostAction,MessageCreateBuilder>, MessageCreateBuilderMixin<ForumPostAction>

public class ForumPostActionImpl
extends RestActionImpl<ForumPost>
implements ForumPostAction, MessageCreateBuilderMixin<ForumPostAction>

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
ForumPostActionImpl(IPostContainer channel, String name, MessageCreateBuilder builder)

Method Summary

Modifier and Type	Method	Description
ForumPostAction	addCheck(BooleanSupplier checks)	Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).
ForumPostAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
MessageCreateBuilder	getBuilder()
IPostContainer	getChannel()	The IPostContainer to create the post in
Guild	getGuild()	The guild to create this GuildChannel for.
ChannelType	getType()	The ChannelType for the resulting channel.
ForumPostAction	setAutoArchiveDuration(ThreadChannel.AutoArchiveDuration autoArchiveDuration)	Sets the ThreadChannel.AutoArchiveDuration for the new thread.
ForumPostAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ForumPostAction	setName(String name)	Sets the name for the new GuildChannel.
ForumPostAction	setSlowmode(int slowmode)	Sets the slowmode for the new thread.
ForumPostAction	setTags(Collection<? extends ForumTagSnowflake> tags)	Configures that tags which should be applied to the new post.

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.internal.utils.message.AbstractMessageBuilderMixin

getAllowedMentions, getComponents, getContent, getEmbeds, getMentionedRoles, getMentionedUsers, isMentionRepliedUser, isSuppressEmbeds, isUsingComponentsV2, mention, mentionRepliedUser, mentionRoles, mentionUsers, setAllowedMentions, setComponents, setContent, setEmbeds, setSuppressEmbeds, useComponentsV2

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

timeout

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

setTags

Methods inherited from interface net.dv8tion.jda.internal.utils.message.MessageCreateBuilderMixin

addComponents, addContent, addEmbeds, addFiles, getAttachments, getPoll, setFiles, setPoll, setSuppressedNotifications, setTTS, setVoiceMessage

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageCreateRequest

addComponents, addComponents, addEmbeds, addFiles, applyData, applyEditData, applyMessage, getAttachments

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageData

getComponentTree

Methods inherited from interface net.dv8tion.jda.api.utils.messages.MessageRequest

mention, mentionRoles, mentionRoles, mentionUsers, mentionUsers, setComponents, setComponents, setEmbeds, setFiles, useComponentsV2

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

ForumPostActionImpl

public ForumPostActionImpl(IPostContainer channel,
 String name,
 MessageCreateBuilder builder)

Method Details

setCheck

@Nonnull
public ForumPostAction 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 FluentRestAction<ForumPost,ForumPostAction>

Specified by:

setCheck in interface RestAction<ForumPost>

Overrides:

setCheck in class RestActionImpl<ForumPost>

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)

addCheck

@Nonnull
public ForumPostAction addCheck(@Nonnull
 BooleanSupplier checks)

Description copied from interface: RestAction

Shortcut for setCheck(() -> getCheck().getAsBoolean() && checks.getAsBoolean()).

Specified by:

addCheck in interface FluentRestAction<ForumPost,ForumPostAction>

Specified by:

addCheck in interface RestAction<ForumPost>

Parameters:

checks - Other checks to run

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.setCheck(BooleanSupplier)

deadline

@Nonnull
public ForumPostAction 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 FluentRestAction<ForumPost,ForumPostAction>

Specified by:

deadline in interface RestAction<ForumPost>

Overrides:

deadline in class RestActionImpl<ForumPost>

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<ForumPost,ForumPostAction>

Returns:

The guild

getChannel

@Nonnull
public IPostContainer getChannel()

Description copied from interface: ForumPostAction

The IPostContainer to create the post in

Specified by:

getChannel in interface ForumPostAction

Returns:

The IPostContainer

setTags

@Nonnull
public ForumPostAction setTags(@Nonnull
 Collection<? extends ForumTagSnowflake> tags)

Description copied from interface: ForumPostAction

Configures that tags which should be applied to the new post.
Some forums require setting at least one tag.

Specified by:

setTags in interface ForumPostAction

Parameters:

tags - Up to 5 tags to apply

Returns:

The current ForumPostAction for chaining convenience

See Also:

• ForumTagSnowflake.fromId(long)

getType

@Nonnull
public ChannelType getType()

Description copied from interface: AbstractThreadCreateAction

The ChannelType for the resulting channel.

Specified by:

getType in interface AbstractThreadCreateAction<ForumPost,ForumPostAction>

Returns:

The channel type

setName

@Nonnull
public ForumPostAction setName(@Nonnull
 String name)

Description copied from interface: AbstractThreadCreateAction

Sets the name for the new GuildChannel.

Specified by:

setName in interface AbstractThreadCreateAction<ForumPost,ForumPostAction>

Parameters:

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

Returns:

The current action, for chaining convenience

setAutoArchiveDuration

@Nonnull
public ForumPostAction 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<ForumPost,ForumPostAction>

Parameters:

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

Returns:

The current action, for chaining convenience

setSlowmode

@Nonnull
public ForumPostAction 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<ForumPost,ForumPostAction>

Parameters:

slowmode - The new slowmode

Returns:

The current action, for chaining convenience

See Also:

• ISlowmodeChannel.getSlowmode()

getBuilder

public MessageCreateBuilder getBuilder()

Specified by:

getBuilder in interface AbstractMessageBuilderMixin<ForumPostAction,MessageCreateBuilder>