Package discord4j.core.object.entity

Enum PartialMember.Flag

java.lang.Object

java.lang.Enum<PartialMember.Flag>

discord4j.core.object.entity.PartialMember.Flag

All Implemented Interfaces:

Serializable, Comparable<PartialMember.Flag>

Enclosing class:

PartialMember

public static enum PartialMember.Flag
extends Enum<PartialMember.Flag>

Describes the flags of a member in a guild.

See Also:

Discord Docs - Guild Member Flags

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYPASSES_VERIFICATION	Member has completed onboarding Note: this flag allows a member who does not meet verification requirements to participate in a server.
COMPLETED_ONBOARDING	Member has completed onboarding
DID_REJOIN	Member has left and rejoined the guild
STARTED_ONBOARDING	Member has started onboarding

Method Summary

Modifier and Type	Method	Description
int	getFlag()	Gets the flag value as represented by Discord.
int	getValue()	Gets the underlying value as represented by Discord.
static EnumSet<PartialMember.Flag>	of(long value)	Gets the flags of member.
static PartialMember.Flag	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PartialMember.Flag[]	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

DID_REJOIN

public static final PartialMember.Flag DID_REJOIN

Member has left and rejoined the guild

COMPLETED_ONBOARDING

public static final PartialMember.Flag COMPLETED_ONBOARDING

Member has completed onboarding

BYPASSES_VERIFICATION

public static final PartialMember.Flag BYPASSES_VERIFICATION

Member has completed onboarding
Note: this flag allows a member who does not meet verification requirements to participate in a server.

STARTED_ONBOARDING

public static final PartialMember.Flag STARTED_ONBOARDING

Member has started onboarding

Method Detail

values

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

Returns:

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

valueOf

public static PartialMember.Flag 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.

getFlag

public int getFlag()

Gets the flag value as represented by Discord.

Returns:

The flag value as represented by Discord.

of

public static EnumSet<PartialMember.Flag> of(long value)

Gets the flags of member. It is guaranteed that invoking getValue() from the returned enum will be equal (==) to the supplied value.

Parameters:

value - The flags value as represented by Discord.

Returns:

The EnumSet of flags.