net.dv8tion.jda.api.managers.channel.attribute.ISlowmodeChannelManager 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.managers.channel.attribute;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.channel.attribute.ISlowmodeChannel;
import net.dv8tion.jda.api.managers.channel.ChannelManager;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
/**
* Manager which supports setting slowmode of a channel.
*
* @param
* The concrete {@link ISlowmodeChannel} type
* @param
* The concrete manager type
*/
public interface ISlowmodeChannelManager>
extends ChannelManager
{
/**
* Sets the slowmode of the selected channel.
*
Provide {@code 0} to disable slowmode.
*
* A channel slowmode must not be negative nor greater than {@link ISlowmodeChannel#MAX_SLOWMODE}!
*
*
Note: Bots are unaffected by this.
*
Having {@link Permission#MESSAGE_MANAGE MESSAGE_MANAGE} or
* {@link 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.
*
* @param slowmode
* The new slowmode
*
* @throws IllegalArgumentException
* If the provided slowmode is negative or greater than {@value ISlowmodeChannel#MAX_SLOWMODE}
*
* @return ChannelManager for chaining convenience
*
* @see net.dv8tion.jda.api.entities.channel.attribute.ISlowmodeChannel#getSlowmode()
*/
@Nonnull
@CheckReturnValue
M setSlowmode(int slowmode);
}