net.dv8tion.jda.api.managers.channel.concrete.NewsChannelManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

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

There is a newer version: 5.1.0

/*
 * 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.managers.channel.concrete;

import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.channel.ChannelType;
import net.dv8tion.jda.api.entities.channel.concrete.NewsChannel;
import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
import net.dv8tion.jda.api.managers.channel.middleman.StandardGuildMessageChannelManager;

import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;

/**
 * Manager providing methods to modify a {@link NewsChannel}.
 *
 * Example
 * 
{@code
 * manager.setName("no-more-news")
 *        .setType(ChannelType.TEXT) // Changes channel type to TextChannel
 *        .queue();
 * }
 */
public interface NewsChannelManager extends StandardGuildMessageChannelManager
{
    /**
     * Converts the selected channel to a different {@link ChannelType}.
     *
     * 


     * This can only be done in the follow situations:
     * 
     *     
     *     
     *         
     *             
     *             
     *             
     *         
     *     
     *     
     *         
     *             
     *             
     *             
     *         
     *         
     *             
     *             
     *             
     *         
     *     
     * Javadoc is stupid, this is not a required tagCurrent Channel Type New Channel Type
{@link ChannelType#NEWS}  -> {@link ChannelType#TEXT}
{@link ChannelType#TEXT}  -> {@link ChannelType#NEWS}
     *
     * @param  type
     *         The new not-null {@link ChannelType} of the channel
     *
     * @throws IllegalArgumentException
     *         If {@code channelType} is not {@link ChannelType#TEXT} or {@link ChannelType#NEWS}
     * @throws UnsupportedOperationException
     *         If this ChannelAction is not for a {@link TextChannel} or {@link NewsChannel}
     * @throws IllegalStateException
     *         If {@code channelType} is {@link ChannelType#NEWS} and the guild doesn't have the {@code NEWS} feature in {@link Guild#getFeatures()}.
     *
     * @return ChannelManager for chaining convenience
     *
     * @see    Guild#getFeatures()
     */
    @Nonnull
    @CheckReturnValue
    NewsChannelManager setType(@Nonnull ChannelType type);
}

Current Channel Type		New Channel Type
{@link ChannelType#NEWS}	->	{@link ChannelType#TEXT}
{@link ChannelType#TEXT}	->	{@link ChannelType#NEWS}