Class BaseEntitlement

Represents a base entitlement. See TestEntitlement and Entitlement.

Hierarchy (view full)

Base
- BaseEntitlement
  - Entitlement
  - TestEntitlement

Index

Constructors

Properties

applicationID client consumed deleted giftCodeFlags guildID id promotionID skuID type userID

Accessors

Methods

consume toJSON toString generateID getCreatedAt getDiscordEpoch

Constructors

constructor

new BaseEntitlement(data, client): BaseEntitlement
Parameters
- data: RawBaseEntitlement
- client: Client<ClientEvents>
Returns BaseEntitlement
Overrides Base.constructor
- Defined in lib/structures/BaseEntitlement.ts:18

Properties

applicationID

applicationID: string

client

client: Client<ClientEvents>

consumed

consumed: boolean

deleted

deleted: boolean

giftCodeFlags

giftCodeFlags: number

guildID

guildID: null | string

id

id: string

promotionID

promotionID: null | string

skuID

skuID: string

type

type: EntitlementTypes

userID

userID: null | string

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in lib/structures/Base.ts:39

Methods

consume

consume(): Promise<void>
Mark this entitlement as consumed.

Returns Promise<void>
- Defined in lib/structures/BaseEntitlement.ts:32

toJSON

toJSON(): JSONBaseEntitlement
Returns JSONBaseEntitlement
Overrides Base.toJSON
- Defined in lib/structures/BaseEntitlement.ts:36

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in lib/structures/Base.ts:64

`Static` generateID

generateID(timestamp?): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from Base.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in lib/structures/Base.ts:32