/
ISlowmodeChannel.java
71 lines (65 loc) · 3.04 KB
/
ISlowmodeChannel.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
/*
* 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.entities.channel.attribute;
import net.dv8tion.jda.api.entities.channel.ChannelField;
import net.dv8tion.jda.api.managers.channel.ChannelManager;
import net.dv8tion.jda.api.managers.channel.attribute.ISlowmodeChannelManager;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import javax.annotation.Nonnull;
/**
* Channels which support slowmode.
*/
public interface ISlowmodeChannel extends GuildChannel
{
/**
* The maximum duration of slowmode in seconds
*/
int MAX_SLOWMODE = 21600;
/**
* The slowmode set for this channel.
* <br>If slowmode is set, this returns an {@code int} between 1 and {@value #MAX_SLOWMODE}.
* <br>Otherwise, if no slowmode is set, this returns {@code 0}.
*
* <p>Note bots are unaffected by this.
* <br>Having {@link net.dv8tion.jda.api.Permission#MESSAGE_MANAGE MESSAGE_MANAGE} or
* {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL} permission also
* grants immunity to slowmode.
*
* <p><b>Special case</b><br>
* {@link net.dv8tion.jda.api.entities.channel.concrete.ForumChannel ForumChannels} use this to limit how many posts a user can create.
* The client refers to this as the post slowmode.
*
* @return The slowmode for this channel, between 1 and {@value #MAX_SLOWMODE}, or {@code 0} if no slowmode is set.
*/
int getSlowmode();
/**
* Returns the {@link ISlowmodeChannelManager} for this {@link ISlowmodeChannel slow mode channel}.
* <br>With the provided ChannelManager, you can additionally modify the {@link ChannelField#SLOWMODE}
* compared to a guild channel's {@link ChannelManager}.
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL Permission.MANAGE_CHANNEL}
*
* @return The {@link ISlowmodeChannelManager} of this {@link ISlowmodeChannel}
*
* @see ChannelManager ChannelManager, for modifying fields each guild channel provides
* @see ChannelField ChannelField, for all possible channel fields
*/
@Nonnull
@Override
ISlowmodeChannelManager<?, ?> getManager();
}