net.dv8tion.jda

Enum Permission

java.lang.Object

java.lang.Enum<Permission>

net.dv8tion.jda.Permission

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Permission>

public enum Permission
extends java.lang.Enum<Permission>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAN_MEMBERS
CREATE_INSTANT_INVITE
KICK_MEMBERS
MANAGE_CHANNEL
MANAGE_PERMISSIONS
MANAGE_ROLES
MANAGE_SERVER
MESSAGE_ATTACH_FILES
MESSAGE_EMBED_LINKS
MESSAGE_HISTORY
MESSAGE_MANAGE
MESSAGE_MENTION_EVERYONE
MESSAGE_READ
MESSAGE_TTS
MESSAGE_WRITE
UNKNOWN
VOICE_CONNECT
VOICE_DEAF_OTHERS
VOICE_MOVE_OTHERS
VOICE_MUTE_OTHERS
VOICE_SPEAK
VOICE_USE_VAD

Method Summary

Modifier and Type	Method and Description
static Permission	getFromOffset(int offset) Gets the Permission relating to the provided offset. If there is no Permssions that matches the provided offset, Permission.UNKNOWN is returned.
int	getOffset() The binary offset of the permission. For more information about Discord's offset system refer to Discord Permission Numbers.
static java.util.List<Permission>	getPermissions(int permissions) A list of all Permissions that are specified by this raw int representation of permissions.
static Permission	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Permission[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATE_INSTANT_INVITE

public static final Permission CREATE_INSTANT_INVITE

KICK_MEMBERS

public static final Permission KICK_MEMBERS

BAN_MEMBERS

public static final Permission BAN_MEMBERS

MANAGE_ROLES

public static final Permission MANAGE_ROLES

MANAGE_PERMISSIONS

public static final Permission MANAGE_PERMISSIONS

MANAGE_CHANNEL

public static final Permission MANAGE_CHANNEL

MANAGE_SERVER

public static final Permission MANAGE_SERVER

MESSAGE_READ

public static final Permission MESSAGE_READ

MESSAGE_WRITE

public static final Permission MESSAGE_WRITE

MESSAGE_TTS

public static final Permission MESSAGE_TTS

MESSAGE_MANAGE

public static final Permission MESSAGE_MANAGE

MESSAGE_EMBED_LINKS

public static final Permission MESSAGE_EMBED_LINKS

MESSAGE_ATTACH_FILES

public static final Permission MESSAGE_ATTACH_FILES

MESSAGE_HISTORY

public static final Permission MESSAGE_HISTORY

MESSAGE_MENTION_EVERYONE

public static final Permission MESSAGE_MENTION_EVERYONE

VOICE_CONNECT

public static final Permission VOICE_CONNECT

VOICE_SPEAK

public static final Permission VOICE_SPEAK

VOICE_MUTE_OTHERS

public static final Permission VOICE_MUTE_OTHERS

VOICE_DEAF_OTHERS

public static final Permission VOICE_DEAF_OTHERS

VOICE_MOVE_OTHERS

public static final Permission VOICE_MOVE_OTHERS

VOICE_USE_VAD

public static final Permission VOICE_USE_VAD

UNKNOWN

public static final Permission UNKNOWN

Method Detail

values

public static Permission[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Permission c : Permission.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Permission valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getOffset

public int getOffset()

The binary offset of the permission.
For more information about Discord's offset system refer to Discord Permission Numbers.

Returns:

The offset that represents this Permission.

getFromOffset

public static Permission getFromOffset(int offset)

Gets the Permission relating to the provided offset.
If there is no Permssions that matches the provided offset, Permission.UNKNOWN is returned.

Parameters:

offset - The offset to match a Permission to.

Returns:

Permission relating to the provided offset.

getPermissions

public static java.util.List<Permission> getPermissions(int permissions)

A list of all Permissions that are specified by this raw int representation of permissions. The is best used with the getRaw methods in Role, PermissionOverride or PermissionUtil.

Examples:
PermissionUtil.getEffectivePermission(user, channel)
PermissionOverride.getAllowedRaw()
Role.getPermissionsRaw()

Parameters:

permissions - The raw int representation of permissions.

Returns:

Possibly-empty list of Permissions.