/
StandardGuildMessageChannelManager.java
62 lines (58 loc) · 2.26 KB
/
StandardGuildMessageChannelManager.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
/*
* 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.middleman;
import net.dv8tion.jda.api.entities.StandardGuildMessageChannel;
import net.dv8tion.jda.api.managers.channel.attribute.IAgeRestrictedChannelManager;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Manager providing functionality common for all {@link net.dv8tion.jda.api.entities.StandardGuildMessageChannel StandardGuildMessageChannels}.
*
* <p><b>Example</b>
* <pre>{@code
* manager.setName("help")
* .setTopic("Java is to Javascript as ham is to hamster")
* .queue();
* manager.reset(ChannelManager.PARENT | ChannelManager.NAME)
* .setTopic("nsfw-commits")
* .setNSFW(true)
* .queue();
* }</pre>
*
* @see StandardGuildMessageChannel#getManager()
*/
public interface StandardGuildMessageChannelManager<T extends StandardGuildMessageChannel, M extends StandardGuildMessageChannelManager<T, M>>
extends StandardGuildChannelManager<T, M>, IAgeRestrictedChannelManager<T, M>
{
/**
* Sets the <b><u>topic</u></b> of the selected {@link StandardGuildMessageChannel channel}.
*
* <p>A channel topic <b>must not</b> be more than {@code 1024} characters long!
*
* @param topic
* The new topic for the selected channel,
* {@code null} or empty String to reset
*
* @throws IllegalArgumentException
* If the provided topic is greater than {@code 1024} in length
*
* @return ChannelManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
M setTopic(@Nullable String topic);
}