net.dv8tion.jda.api.managers.AutoModRuleManager 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;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.automod.AutoModResponse;
import net.dv8tion.jda.api.entities.automod.AutoModRule;
import net.dv8tion.jda.api.entities.automod.build.TriggerConfig;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.Arrays;
import java.util.Collection;
/**
* Manager providing functionality to update one or more fields for an {@link AutoModRule}.
*
* Example
*
{@code
* manager.setName("Discord Invites")
* .setEnables(false)
* .queue();
* manager.reset(AutoModRuleManager.NAME | AutoModRuleManager.ENABLED)
* .setName("Invites")
* .setEnabled(true)
* .queue();
* }
*
* @see Guild#modifyAutoModRuleById(long)
* @see Guild#modifyAutoModRuleById(String)
* @see AutoModRule#getManager()
*/
public interface AutoModRuleManager extends Manager
{
/** Used to reset the name field. */
long NAME = 1;
/** Used to reset the enabled field. */
long ENABLED = 1 << 1;
/** Used to reset the response field. */
long RESPONSE = 1 << 2;
/** Used to reset the exempt roles field. */
long EXEMPT_ROLES = 1 << 3;
/** Used to reset the exempt channels field. */
long EXEMPT_CHANNELS = 1 << 4;
/** Used to reset the trigger metadata field. */
long TRIGGER_METADATA = 1 << 5;
/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
*
Example: {@code manager.reset(AutoModRuleManager.NAME | AutoModRuleManager.RESPONSE);}
*
* Flag Constants:
*
* - {@link #NAME}
* - {@link #ENABLED}
* - {@link #RESPONSE}
* - {@link #EXEMPT_ROLES}
* - {@link #EXEMPT_CHANNELS}
* - {@link #TRIGGER_METADATA}
*
*
* @param fields
* Integer value containing the flags to reset.
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@Override
AutoModRuleManager reset(long fields);
/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
*
Example: {@code manager.reset(AutoModRuleManager.NAME, AutoModRuleManager.RESPONSE);}
*
* Flag Constants:
*
* - {@link #NAME}
* - {@link #ENABLED}
* - {@link #RESPONSE}
* - {@link #EXEMPT_ROLES}
* - {@link #EXEMPT_CHANNELS}
* - {@link #TRIGGER_METADATA}
*
*
* @param fields
* Integer value containing the flags to reset.
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@Override
AutoModRuleManager reset(long... fields);
/**
* Sets the name of the selected {@link AutoModRule}.
*
* A rule name must be between 1-{@value AutoModRule#MAX_RULE_NAME_LENGTH} characters long!
*
* @param name
* The new name for the selected {@link AutoModRule}
*
* @throws IllegalArgumentException
* If the provided name is {@code null} or not between 1-{@value AutoModRule#MAX_RULE_NAME_LENGTH} characters long
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setName(@Nonnull String name);
/**
* Sets the enabled state of the selected {@link AutoModRule}.
*
*
When a rule is disabled, it will not be applied to any messages.
*
* @param enabled
* True, if the selected {@link AutoModRule} should be enabled
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setEnabled(boolean enabled);
// @Nonnull
// @CheckReturnValue
// AutoModRuleManager setEventType(@Nonnull AutoModEventType type);
/**
* Sets what the rule should do upon triggering.
*
*
Note that each response type can only be used once.
* If multiple responses of the same type are provided, the last one is used.
*
* @param responses
* The responses to configure
*
* @throws IllegalArgumentException
*
* - If {@code null} or {@link AutoModResponse.Type#UNKNOWN} is provided
* - If the collection is empty
*
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setResponses(@Nonnull Collection responses);
/**
* Sets what the rule should do upon triggering.
*
* Note that each response type can only be used once.
* If multiple responses of the same type are provided, the last one is used.
*
* @param responses
* The responses to configure
*
* @throws IllegalArgumentException
*
* - If {@code null} or {@link AutoModResponse.Type#UNKNOWN} is provided
* - If the collection is empty
*
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
default AutoModRuleManager setResponses(@Nonnull AutoModResponse... responses)
{
Checks.noneNull(responses, "Responses");
return setResponses(Arrays.asList(responses));
}
/**
* Set which roles can bypass this rule.
*
* Roles added to the exemptions will allow all of its members to bypass this rule.
*
* @param roles
* The roles to exempt (up to {@value AutoModRule#MAX_EXEMPT_ROLES} roles)
*
* @throws IllegalArgumentException
* If null is provided or the number of roles exceeds {@value AutoModRule#MAX_EXEMPT_ROLES}
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setExemptRoles(@Nonnull Collection roles);
/**
* Set which roles can bypass this rule.
*
* Roles added to the exemptions will allow all of its members to bypass this rule.
*
* @param roles
* The roles to exempt (up to {@value AutoModRule#MAX_EXEMPT_ROLES} roles)
*
* @throws IllegalArgumentException
* If null is provided or the number of roles exceeds {@value AutoModRule#MAX_EXEMPT_ROLES}
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
default AutoModRuleManager setExemptRoles(@Nonnull Role... roles)
{
Checks.noneNull(roles, "Roles");
return setExemptRoles(Arrays.asList(roles));
}
/**
* Set which channels can bypass this rule.
*
*
No messages sent in this channel will trigger the rule.
*
* @param channels
* The channels to add (up to {@value AutoModRule#MAX_EXEMPT_CHANNELS} channels)
*
* @throws IllegalArgumentException
* If null is provided or the number of channels exceeds {@value AutoModRule#MAX_EXEMPT_CHANNELS}
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setExemptChannels(@Nonnull Collection channels);
/**
* Set which channels can bypass this rule.
*
*
No messages sent in this channel will trigger the rule.
*
* @param channels
* The channels to add (up to {@value AutoModRule#MAX_EXEMPT_CHANNELS} channels)
*
* @throws IllegalArgumentException
* If null is provided or the number of channels exceeds {@value AutoModRule#MAX_EXEMPT_CHANNELS}
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
default AutoModRuleManager setExemptChannels(@Nonnull GuildChannel... channels)
{
Checks.noneNull(channels, "Channels");
return setExemptChannels(Arrays.asList(channels));
}
/**
* Change the {@link TriggerConfig} for this rule.
*
* @param config
* The new config
*
* @throws IllegalArgumentException
* If null is provided
*
* @return AutoModRuleManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
AutoModRuleManager setTriggerConfig(@Nonnull TriggerConfig config);
}