Package net.dv8tion.jda.api.entities

Enum Guild.MFALevel

java.lang.Object

java.lang.Enum<Guild.MFALevel>

net.dv8tion.jda.api.entities.Guild.MFALevel

All Implemented Interfaces:

Serializable, Comparable<Guild.MFALevel>

Enclosing interface:

Guild

public static enum Guild.MFALevel
extends Enum<Guild.MFALevel>

Represents the Multifactor Authentication level required by the Guild.
The MFA Level restricts administrator functions to account with MFA Level equal to or higher than that set by the guild.

None -> There is no MFA level restriction on administrator functions in this guild.
Two_Factor_Auth -> Users must have 2FA enabled on their account to perform administrator functions.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE
TWO_FACTOR_AUTH
UNKNOWN

Method Summary

Modifier and Type	Method	Description
static Guild.MFALevel	fromKey(int key)	Used to retrieve a MFALevel based on the Discord id key.
int	getKey()	The Discord id key used to represent this MFALevel.
static Guild.MFALevel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Guild.MFALevel[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Guild.MFALevel NONE

TWO_FACTOR_AUTH

public static final Guild.MFALevel TWO_FACTOR_AUTH

UNKNOWN

public static final Guild.MFALevel UNKNOWN

Method Detail

values

public static Guild.MFALevel[] 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 (Guild.MFALevel c : Guild.MFALevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static Guild.MFALevel valueOf(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:

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

NullPointerException - if the argument is null

getKey

public int getKey()

The Discord id key used to represent this MFALevel.

Returns:

Integer id for this MFALevel.

fromKey

@Nonnull
public static Guild.MFALevel fromKey(int key)

Used to retrieve a MFALevel based on the Discord id key.

Parameters:

key - The Discord id key representing the requested MFALevel.

Returns:

The MFALevel related to the provided key, or MFALevel.UNKNOWN if the key is not recognized.