net.dv8tion.jda.utils

Class PermissionUtil

java.lang.Object

net.dv8tion.jda.utils.PermissionUtil

public class PermissionUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PermissionUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	checkPermission(User user, Permission perm, Channel channel) Checks to see if the User has the specified Permission in the specified Channel.
static boolean	checkPermission(User user, Permission perm, Guild guild) Checks to see if the User has the specified Permission in the specified Guild.
static int	getEffectivePermission(User user, Channel channel) Gets the int representation of the effective permissions allowed for this User in this Channel.
static PermissionOverride	getFullPermOverride()

Methods inherited from class java.lang.Object

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

Constructor Detail

PermissionUtil

public PermissionUtil()

Method Detail

getFullPermOverride

public static PermissionOverride getFullPermOverride()

checkPermission

public static boolean checkPermission(User user,
                                      Permission perm,
                                      Channel channel)

Checks to see if the User has the specified Permission in the specified Channel. This method properly deals with PermissionOverrides and Owner status.

Note: this is based on effective permissions, not literal permissions. If a user has permissions that would enable them to do something without the literal permission to do it, this will still return true.
Example: If a user has the Permission.MANAGE_ROLES permission, they will be able to Permission.MESSAGE_WRITE in every channel.

Parameters:

user - The User whose permissions are being checked.

perm - The Permission being checked for.

channel - The Channel being checked.

Returns:

True - if the User effectively has the specified Permission.

checkPermission

public static boolean checkPermission(User user,
                                      Permission perm,
                                      Guild guild)

Checks to see if the User has the specified Permission in the specified Guild. This method properly deals with Owner status.

Note: this is based on effective permissions, not literal permissions. If a user has permissions that would enable them to do something without the literal permission to do it, this will still return true.
Example: If a user has the Permission.MANAGE_ROLES permission, they will be able to Permission.MANAGE_SERVER as well, even without the literal permission.

Parameters:

user - The User whose permissions are being checked.

perm - The Permission being checked for.

guild - The Guild being checked.

Returns:

True - if the User effectively has the specified Permission.

getEffectivePermission

public static int getEffectivePermission(User user,
                                         Channel channel)

Gets the int representation of the effective permissions allowed for this User in this Channel. This can be used in conjunction with Permission.getPermissions(int) to easily get a list of all Permissions that this user can use in this Channel.
This functions very similarly to how Role.getPermissionsRaw().

Parameters:

user - The User whose permissions are being checked.

channel - The Channel being checked.

Returns:

The int representation of the literal permissions that this User has in this Channel.