discord4j.core.object

Enum Invite.Type

java.lang.Object

java.lang.Enum<Invite.Type>

discord4j.core.object.Invite.Type

All Implemented Interfaces:

Serializable, Comparable<Invite.Type>

Enclosing class:

Invite

public static enum Invite.Type
extends Enum<Invite.Type>

Represents the various types of target user for an invite.

Enum Constant Summary

Enum Constants

Enum Constant and Description
STREAM Stream.
UNKNOWN Unknown type.

Method Summary

Modifier and Type	Method and Description
int	getValue() Gets the underlying value as represented by Discord.
static Invite.Type	of(int value) Gets the type of target user.
static Invite.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Invite.Type[]	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 Invite.Type UNKNOWN

Unknown type.

STREAM

public static final Invite.Type STREAM

Stream.

Method Detail

values

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

Returns:

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

valueOf

public static Invite.Type 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 Invite.Type of(int value)

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

Parameters:

value - The underlying value as represented by Discord.

Returns:

The type of target user.