com.freya02.botcommands.api.commands.application.context.annotations.JDAUserCommand Maven / Gradle / Ivy
package com.freya02.botcommands.api.commands.application.context.annotations;
import com.freya02.botcommands.api.commands.annotations.BotPermissions;
import com.freya02.botcommands.api.commands.annotations.Command;
import com.freya02.botcommands.api.commands.annotations.Cooldown;
import com.freya02.botcommands.api.commands.annotations.UserPermissions;
import com.freya02.botcommands.api.commands.application.CommandScope;
import com.freya02.botcommands.api.commands.application.builder.ApplicationCommandBuilder;
import com.freya02.botcommands.api.commands.application.context.user.GlobalUserEvent;
import com.freya02.botcommands.api.commands.application.context.user.GuildUserEvent;
import net.dv8tion.jda.api.entities.Member;
import net.dv8tion.jda.api.entities.User;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Required annotation for user commands
*
*
* The targeted method must have a {@link GlobalUserEvent} or a {@link GuildUserEvent} and the only other arguments possible are a {@link Member} or a {@link User}, which will be the targeted entity
*
*
Requirement: The declaring class must be annotated with {@link Command}.
*
* @see GlobalUserEvent#getTarget()
* @see GlobalUserEvent#getTargetMember()
* @see Discord docs
* @see Command
* @see UserPermissions @UserPermissions
* @see BotPermissions @BotPermissions
* @see Cooldown @Cooldown
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface JDAUserCommand {
/**
* Specified the application command scope for this command
*
* @return Scope of the command
*
* @see CommandScope
*/
CommandScope scope() default CommandScope.GLOBAL_NO_DM;
/**
* Specifies whether the application command is disabled by default, so that administrators can further configure the command
*
If this is used in coordination with {@link UserPermissions} then they will be cleared if this is default locked,
* as to allow discord to lock the command for everyone, until an admin configures it.
*
This does NOT affect administrators.
*
* @return true if the command should be disabled by default
*/
boolean defaultLocked() default ApplicationCommandBuilder.DEFAULT_DEFAULT_LOCKED;
/**
* Specifies whether the application command is usable in NSFW channels.
*
Note: NSFW commands need to be enabled by the user in order to appear in DMs
*
* @return {@code true} if the command should only be usable in NSFW channels
*
* @see Age-Restricted Commands FAQ
*/
boolean nsfw() default false;
/**
* Primary name of the command, must not contain any spaces and no upper cases
*
* @return Name of the command
*/
String name();
}