Package discord4j.core.object.entity

Enum Guild.MfaLevel

java.lang.Object

java.lang.Enum<Guild.MfaLevel>

discord4j.core.object.entity.Guild.MfaLevel

All Implemented Interfaces:

Serializable, Comparable<Guild.MfaLevel>

Enclosing class:

Guild

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

Prevent potentially dangerous administrative actions for users without two-factor authentication enabled. This setting can only be changed by the server owner if they have 2FA enabled on their account.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ELEVATED	Enabled 2FA requirement.
NONE	Disabled 2FA requirement.
UNKNOWN	Unknown MFA level.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the underlying value as represented by Discord.
static Guild.MfaLevel	of(int value)	Gets the multi-factor authentication level of the guild.
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

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

UNKNOWN

public static final Guild.MfaLevel UNKNOWN

Unknown MFA level.

NONE

public static final Guild.MfaLevel NONE

Disabled 2FA requirement.

ELEVATED

public static final Guild.MfaLevel ELEVATED

Enabled 2FA requirement.

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

getValue

public int getValue()

Gets the underlying value as represented by Discord.

Returns:

The underlying value as represented by Discord.

of

public static Guild.MfaLevel of(int value)

Gets the multi-factor authentication level of the guild. It is guaranteed that invoking getValue() from the returned enum will equal (==) the supplied value.

Parameters:

value - The underlying value as represented by Discord.

Returns:

The multi-factor authentication level of the guild.