/
NewsChannelManager.java
85 lines (81 loc) · 3.07 KB
/
NewsChannelManager.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
* 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}.
*
* <p><b>Example</b>
* <pre>{@code
* manager.setName("no-more-news")
* .setType(ChannelType.TEXT) // Changes channel type to TextChannel
* .queue();
* }</pre>
*/
public interface NewsChannelManager extends StandardGuildMessageChannelManager<NewsChannel, NewsChannelManager>
{
/**
* Converts the selected channel to a different {@link ChannelType}.
*
* <br><br>
* This can only be done in the follow situations:
* <table>
* <caption style="display: none">Javadoc is stupid, this is not a required tag</caption>
* <thead>
* <tr>
* <th>Current Channel Type</th>
* <th></th>
* <th>New Channel Type</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td>{@link ChannelType#NEWS}</td>
* <td> -> </td>
* <td>{@link ChannelType#TEXT}</td>
* </tr>
* <tr>
* <td>{@link ChannelType#TEXT}</td>
* <td> -> </td>
* <td>{@link ChannelType#NEWS}</td>
* </tr>
* </tbody>
* </table>
*
* @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);
}