Package net.dv8tion.jda.internal.entities

Class EntitlementImpl

java.lang.Object

net.dv8tion.jda.internal.entities.EntitlementImpl

All Implemented Interfaces:

Entitlement, ISnowflake

public class EntitlementImpl
extends Object
implements Entitlement

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Entitlement

Entitlement.EntitlementType

Constructor Summary

Constructors

Constructor	Description
EntitlementImpl(JDA api, long id, long skuId, long applicationId, long userId, long guildId, Entitlement.EntitlementType type, boolean deleted, OffsetDateTime startsAt, OffsetDateTime endsAt, boolean consumed)

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	consume()	Consumes the Entitlement if it has not already been consumed.
long	getApplicationIdLong()	The id of the parent application of this Entitlement
long	getGuildIdLong()	The guild id that is granted access to the Entitlements SKU
long	getIdLong()	The Snowflake id of this entity.
long	getSkuIdLong()	The id of the SKU related to this Entitlement
OffsetDateTime	getTimeEnding()	Date at which the Entitlement is no longer valid.
OffsetDateTime	getTimeStarting()	The start date at which the Entitlement is valid.
Entitlement.EntitlementType	getType()	The type of the Entitlement
long	getUserIdLong()	The id of the user that purchased the Entitlement
boolean	isConsumed()	Whether the Entitlement was consumed or not.
boolean	isDeleted()	Whether the Entitlement has been deleted or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.Entitlement

getApplicationId, getGuildId, getSkuId, getUserId

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Constructor Details

EntitlementImpl

public EntitlementImpl(JDA api,
 long id,
 long skuId,
 long applicationId,
 long userId,
 long guildId,
 Entitlement.EntitlementType type,
 boolean deleted,
 @Nullable
 OffsetDateTime startsAt,
 @Nullable
 OffsetDateTime endsAt,
 boolean consumed)

Method Details

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getSkuIdLong

public long getSkuIdLong()

Description copied from interface: Entitlement

The id of the SKU related to this Entitlement

Specified by:

getSkuIdLong in interface Entitlement

Returns:

The id of the SKU related to this Entitlement

getApplicationIdLong

public long getApplicationIdLong()

Description copied from interface: Entitlement

The id of the parent application of this Entitlement

Specified by:

getApplicationIdLong in interface Entitlement

Returns:

The id of the parent application of this Entitlement

getUserIdLong

public long getUserIdLong()

Description copied from interface: Entitlement

The id of the user that purchased the Entitlement

Specified by:

getUserIdLong in interface Entitlement

Returns:

The id of the user that purchased the Entitlement

getGuildIdLong

public long getGuildIdLong()

Description copied from interface: Entitlement

The guild id that is granted access to the Entitlements SKU

Specified by:

getGuildIdLong in interface Entitlement

Returns:

The id of the guild that purchased the Entitlement or 0 if this is not a guild subscription

getType

@Nonnull
public Entitlement.EntitlementType getType()

Description copied from interface: Entitlement

The type of the Entitlement

Specified by:

getType in interface Entitlement

Returns:

the Entitlement type

isDeleted

public boolean isDeleted()

Description copied from interface: Entitlement

Whether the Entitlement has been deleted or not.

Specified by:

isDeleted in interface Entitlement

Returns:

True if the Entitlement was deleted, False otherwise

See Also:

• EntitlementDeleteEvent

getTimeStarting

@Nullable
public OffsetDateTime getTimeStarting()

Description copied from interface: Entitlement

The start date at which the Entitlement is valid.

Specified by:

getTimeStarting in interface Entitlement

Returns:

Start date at which the Entitlement is valid. Not present when using test entitlements.

getTimeEnding

@Nullable
public OffsetDateTime getTimeEnding()

Description copied from interface: Entitlement

Date at which the Entitlement is no longer valid.

Specified by:

getTimeEnding in interface Entitlement

Returns:

Date at which the Entitlement is no longer valid. Not present when using test entitlements.

isConsumed

public boolean isConsumed()

Description copied from interface: Entitlement

Whether the Entitlement was consumed or not.

Specified by:

isConsumed in interface Entitlement

Returns:

True if the Entitlement was consumed, False otherwise

consume

@Nonnull
public RestAction<Void> consume()

Description copied from interface: Entitlement

Consumes the Entitlement if it has not already been consumed.
Only One-Time Purchase consumable Entitlements can be consumed.
After the Entitlement has been consumed, it will be marked as consumed.

Specified by:

consume in interface Entitlement

Returns:

A RestAction that will consume the Entitlement