Documentation/detritus-client/Structures

Entitlementclass

Entitlement Structure

On this page

Overview
Constructor1
Properties11
Accessors10
Methods16

Entitlement Structure

import { Structures } from 'detritus-client';

Structures.Entitlement;

Hierarchy

StructureBaseStructureEntitlement

18 properties4 methods15 inheritedsrc/structures/entitlement.ts:36

Constructor

new Entitlement

src/structures/entitlement.ts:50

new Entitlement(client: ShardClient, data: BaseStructureData, isClone?: boolean)

Properties

applicationId

string

Default ''

client

ShardClient

readonly

Inherited from BaseStructure.client

consumed?

boolean

optional

deleted

boolean

Default false

endsAtUnix

number

Default 0

guildId?

string

optional

string

Default ''

skuId

string

Default ''

startsAtUnix

number

Default 0

type

number

Default EntitlementTypes.APPLICATION_SUBSCRIPTION

userId?

string

optional

Accessors

createdAt

Date | null

get

createdAtUnix

number | null

get

ended

boolean

get

endsAt

Date | undefined

get

guild

Guild | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

started

boolean

get

startsAt

Date | undefined

get

user

User | null

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

consume()

async src/structures/entitlement.ts:112

consume(): Promise<any>

delete()

async src/structures/entitlement.ts:116

delete(): Promise<any>

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/entitlement.ts:120

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON

toString()

src/structures/entitlement.ts:168

toString(): string

Returns a string representation of an object.