All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.dv8tion.jda.api.requests.restaction.ForumPostAction Maven / Gradle / Ivy

Go to download

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0
Show newest version
/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.requests.restaction;

import net.dv8tion.jda.api.entities.channel.attribute.IPostContainer;
import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
import net.dv8tion.jda.api.entities.channel.forums.ForumPost;
import net.dv8tion.jda.api.entities.channel.forums.ForumTagSnowflake;
import net.dv8tion.jda.api.requests.FluentRestAction;
import net.dv8tion.jda.api.utils.messages.MessageCreateData;
import net.dv8tion.jda.api.utils.messages.MessageCreateRequest;
import net.dv8tion.jda.internal.utils.Checks;

import javax.annotation.Nonnull;
import java.util.Arrays;
import java.util.Collection;

/**
 * Extension of {@link net.dv8tion.jda.api.requests.RestAction RestAction} specifically
 * designed to create new Forum Post Threads.
 *
 * 

On success, this provides a {@link ForumPost} object with the {@link ForumPost#getMessage() starter message} * and the {@link ForumPost#getThreadChannel() thread channel} of the post. * * @see IPostContainer#createForumPost(String, MessageCreateData) */ public interface ForumPostAction extends AbstractThreadCreateAction, MessageCreateRequest, FluentRestAction { /** * The {@link IPostContainer} to create the post in * * @return The {@link IPostContainer} */ @Nonnull IPostContainer getChannel(); /** * Configures that tags which should be applied to the new post. *
Some forums require setting at least one tag. * * @param tags * Up to {@value ForumChannel#MAX_POST_TAGS} tags to apply * * @throws IllegalArgumentException * If null is provided or more than {@value ForumChannel#MAX_POST_TAGS} tags are provided, * or if at least one is {@link ForumChannel#isTagRequired() required} and none were provided. * * @return The current ForumPostAction for chaining convenience * * @see ForumTagSnowflake#fromId(long) */ @Nonnull ForumPostAction setTags(@Nonnull Collection tags); /** * Configures that tags which should be applied to the new post. *
Some forums require setting at least one tag. * * @param tags * Up to {@value ForumChannel#MAX_POST_TAGS} tags to apply * * @throws IllegalArgumentException * If null is provided or more than {@value ForumChannel#MAX_POST_TAGS} tags are provided, * or if at least one is {@link ForumChannel#isTagRequired() required} and none were provided. * * @return The current ForumPostAction for chaining convenience * * @see ForumTagSnowflake#fromId(long) */ @Nonnull default ForumPostAction setTags(@Nonnull ForumTagSnowflake... tags) { Checks.noneNull(tags, "Tags"); return setTags(Arrays.asList(tags)); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy