net.dv8tion.jda.api.entities.channel.attribute.ISlowmodeChannel Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* 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.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.managers.channel.ChannelManager;
import net.dv8tion.jda.api.managers.channel.attribute.ISlowmodeChannelManager;
import javax.annotation.CheckReturnValue;
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.
*
If slowmode is set, this returns an {@code int} between 1 and {@value #MAX_SLOWMODE}.
*
Otherwise, if no slowmode is set, this returns {@code 0}.
*
* Note bots are unaffected by this.
*
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.
*
*
Special case
* {@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}.
*
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
@CheckReturnValue
ISlowmodeChannelManager getManager();
}