Package net.dv8tion.jda.api.entities

Enum Entitlement.EntitlementType

java.lang.Object

java.lang.Enum<Entitlement.EntitlementType>

net.dv8tion.jda.api.entities.Entitlement.EntitlementType

All Implemented Interfaces:

Serializable, Comparable<Entitlement.EntitlementType>

Enclosing interface:

Entitlement

public static enum Entitlement.EntitlementType
extends Enum<Entitlement.EntitlementType>

Represents the type of this Entitlement

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPLICATION_SUBSCRIPTION	Entitlement was purchased as an app subscription
DEVELOPER_GIFT	Entitlement was gifted by developer
FREE_PURCHASE	Entitlement was granted when the SKU was free
PREMIUM_PURCHASE	Entitlement was claimed by user for free as a Nitro Subscriber
PREMIUM_SUBSCRIPTION	Entitlement for Discord Nitro subscription
PURCHASE	Entitlement was purchased by user
TEST_MODE_PURCHASE	Entitlement was purchased by a dev in application test mode
UNKNOWN	Placeholder for unsupported types.
USER_GIFT	Entitlement was gifted by another user

Method Summary

Modifier and Type	Method	Description
static Entitlement.EntitlementType	fromKey(int key)	Gets the EntitlementType related to the provided key.
int	getKey()	The Discord defined id key for this EntitlementType.
static Entitlement.EntitlementType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Entitlement.EntitlementType[]	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 Details

PURCHASE

public static final Entitlement.EntitlementType PURCHASE

Entitlement was purchased by user

PREMIUM_SUBSCRIPTION

public static final Entitlement.EntitlementType PREMIUM_SUBSCRIPTION

Entitlement for Discord Nitro subscription

DEVELOPER_GIFT

public static final Entitlement.EntitlementType DEVELOPER_GIFT

Entitlement was gifted by developer

TEST_MODE_PURCHASE

public static final Entitlement.EntitlementType TEST_MODE_PURCHASE

Entitlement was purchased by a dev in application test mode

FREE_PURCHASE

public static final Entitlement.EntitlementType FREE_PURCHASE

Entitlement was granted when the SKU was free

USER_GIFT

public static final Entitlement.EntitlementType USER_GIFT

Entitlement was gifted by another user

PREMIUM_PURCHASE

public static final Entitlement.EntitlementType PREMIUM_PURCHASE

Entitlement was claimed by user for free as a Nitro Subscriber

APPLICATION_SUBSCRIPTION

public static final Entitlement.EntitlementType APPLICATION_SUBSCRIPTION

Entitlement was purchased as an app subscription

UNKNOWN

public static final Entitlement.EntitlementType UNKNOWN

Placeholder for unsupported types.

Method Details

values

public static Entitlement.EntitlementType[] values()

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

Returns:

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

valueOf

public static Entitlement.EntitlementType 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 defined id key for this EntitlementType.

Returns:

the id key.

fromKey

@Nonnull
public static Entitlement.EntitlementType fromKey(int key)

Gets the EntitlementType related to the provided key.
If an unknown key is provided, this returns UNKNOWN

Parameters:

key - The Discord key referencing a EntitlementType.

Returns:

The EntitlementType that has the key provided, or UNKNOWN for unknown key.