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

Interface ForumPostAction

All Superinterfaces:

AbstractThreadCreateAction<ForumPost,ForumPostAction>, FluentRestAction<ForumPost,ForumPostAction>, MessageCreateRequest<ForumPostAction>, MessageData, MessageRequest<ForumPostAction>, RestAction<ForumPost>

public interface ForumPostAction
extends AbstractThreadCreateAction<ForumPost,ForumPostAction>, MessageCreateRequest<ForumPostAction>, FluentRestAction<ForumPost,ForumPostAction>

Extension of RestAction specifically designed to create new Forum Post Threads.

On success, this provides a ForumPost object with the starter message and the thread channel of the post.

See Also:

• IPostContainer.createForumPost(String, MessageCreateData)

Method Summary

Modifier and Type	Method	Description
IPostContainer	getChannel()	The IPostContainer to create the post in
ForumPostAction	setTags(Collection<? extends ForumTagSnowflake> tags)	Configures that tags which should be applied to the new post.
default ForumPostAction	setTags(ForumTagSnowflake... tags)	Configures that tags which should be applied to the new post.

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

getGuild, getType, setAutoArchiveDuration, setName

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

addCheck, deadline, setCheck, timeout

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

addActionRow, addActionRow, addComponents, addComponents, addContent, addEmbeds, addEmbeds, addFiles, addFiles, applyData, applyEditData, applyMessage, getAttachments, getPoll, setPoll, setSuppressedNotifications, setTTS

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

getAllowedMentions, getComponents, getContent, getEmbeds, getMentionedRoles, getMentionedUsers, isMentionRepliedUser, isSuppressEmbeds

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

mention, mention, mentionRepliedUser, mentionRoles, mentionRoles, mentionRoles, mentionUsers, mentionUsers, mentionUsers, setActionRow, setActionRow, setAllowedMentions, setComponents, setComponents, setContent, setEmbeds, setEmbeds, setFiles, setFiles, setSuppressEmbeds

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

Method Details

getChannel

@Nonnull
IPostContainer getChannel()

The IPostContainer to create the post in

Returns:

The IPostContainer

setTags

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

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

Parameters:

tags - Up to 5 tags to apply

Returns:

The current ForumPostAction for chaining convenience

Throws:

IllegalArgumentException - If null is provided or more than 5 tags are provided, or if at least one is required and none were provided.

See Also:

• ForumTagSnowflake.fromId(long)

setTags

@Nonnull
default ForumPostAction setTags(@Nonnull
 ForumTagSnowflake... tags)

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

Parameters:

tags - Up to 5 tags to apply

Returns:

The current ForumPostAction for chaining convenience

Throws:

IllegalArgumentException - If null is provided or more than 5 tags are provided, or if at least one is required and none were provided.

See Also:

• ForumTagSnowflake.fromId(long)