Entitlement

Implementation of the Discord Entitlement class in Luau

Properties

Entitlement.type :: apiTypes.EntitlementType

The type of entitlement this object represents. Maps to Discord’s entitlement types.

Entitlement.id :: apiTypes.Snowflake

The unique identifier for this entitlement.

Entitlement.skuId :: apiTypes.Snowflake

The ID of the SKU (Stock Keeping Unit) that this entitlement grants access to.

Entitlement.applicationId :: apiTypes.Snowflake

The ID of the application this entitlement is for.

Entitlement.userId :: apiTypes.Snowflake?

The ID of the user this entitlement belongs to. May be null for some entitlement types.

Entitlement.deleted :: boolean

Whether this entitlement has been deleted.

Entitlement.startsAt :: stdPolyfills.DateTime?

The date and time when this entitlement becomes active. May be null for permanent entitlements.

Entitlement.endsAt :: stdPolyfills.DateTime?

The date and time when this entitlement expires. May be null for permanent entitlements.

Entitlement.guildId :: apiTypes.Snowflake?

The ID of the guild this entitlement is for. May be null for user-specific entitlements.

Entitlement.consumed :: boolean?

Whether this entitlement has been consumed. Only applicable to consumable entitlements.

The Entitlement instance has no set methods!

Entitlement . sync (

self: Entitlement
entitlementData: apiTypes.EntitlementObject
) -> ()

Responsible for syncing data to this entitlement object. This is typically called by the API when this object is created or updated.

Entitlement . new (

entitlementData: apiTypes.EntitlementObject
) -> ()

Responsible for constructing this class.