Package xyz.dynxsty.dih4jda.interactions.commands

Class CommandRequirements

java.lang.Object

xyz.dynxsty.dih4jda.interactions.commands.CommandRequirements

Direct Known Subclasses:

BaseCommandRequirements, SlashCommand.Subcommand

public abstract class CommandRequirements
extends Object

Allows to set requirements that must be met in order to execute the command. If a requirement isn't met, this will fire the corresponding event in DIH4JDAEventListener.

Since:

v1.5

Constructor Summary

Constructors

Constructor	Description
CommandRequirements()

Method Summary

Modifier and Type	Method	Description
final Set<net.dv8tion.jda.api.Permission>	getRequiredPermissions()
final Set<Long>	getRequiredRoles()
final Set<Long>	getRequiredUsers()
final void	requirePermissions(net.dv8tion.jda.api.Permission... permissions)	Allows to require a set of Permissions which are needed to execute the corresponding command.
final void	requireRoles(Long... roles)	Allows to require a set of Longs (role Ids) which are able to execute the corresponding command.
final void	requireUsers(Long... users)	Allows to require a set of Longs (user Ids) which are able to execute the corresponding command.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommandRequirements

public CommandRequirements()

Method Details

requirePermissions

public final void requirePermissions(net.dv8tion.jda.api.Permission... permissions)

Allows to require a set of Permissions which are needed to execute the corresponding command.

Parameters:

permissions - The set of Permissions.

requireUsers

public final void requireUsers(Long... users)

Allows to require a set of Longs (user Ids) which are able to execute the corresponding command.

Parameters:

users - The set of Longs (user Ids).

requireRoles

public final void requireRoles(Long... roles)

Allows to require a set of Longs (role Ids) which are able to execute the corresponding command.

Parameters:

roles - The set of Longs (role Ids).

getRequiredPermissions

public final Set<net.dv8tion.jda.api.Permission> getRequiredPermissions()

getRequiredUsers

public final Set<Long> getRequiredUsers()

getRequiredRoles

public final Set<Long> getRequiredRoles()