kord-core/dev.kord.core.entity.monetization/Entitlement

Entitlement

class Entitlement(val data: EntitlementData, val kord: Kord) : KordEntity(source)

An instance of an Entitlement.

Entitlements represent that a User or Guild has access to a premium offering in your Application.

Constructors

Entitlement

constructor(data: EntitlementData, kord: Kord)

Properties

applicationId

val applicationId: Snowflake

The ID of the Application this entitlement is for.

data

val data: EntitlementData

endsAt

val endsAt: Instant?

The date at which this entitlement is no longer valid.

guild

val guild: GuildBehavior?

The behavior of the Guild that is granted access to this entitlement's Sku.

guildId

val guildId: Snowflake?

The ID of the Guild that is granted access to this entitlement's Sku.

open override val id: Snowflake

The unique identifier of this entity.

isConsumed

val isConsumed: Boolean?

For consumable items, whether this entitlement has been consumed.

isDeleted

val isDeleted: Boolean

Whether this entitlement has been deleted.

kord

open override val kord: Kord

The kord instance that created this object.

skuId

val skuId: Snowflake

The ID of the Sku this entitlement is for.

startsAt

val startsAt: Instant?

The start date at which this entitlement is valid.

type

val type: EntitlementType

The type of this entitlement.

user

val user: UserBehavior?

The behavior of the User that is granted access to this entitlement's Sku.

userId

val userId: Snowflake?

The ID of the User that is granted access to this entitlement's Sku.

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

consume

suspend fun consume()

For One-Time Purchase consumable Skus, marks this entitlement for the user as consumed.

delete

suspend fun delete()

Requests to delete this currently active test entitlement.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String