Skip to content

MonetizationManager

Defined in: packages/managers/src/advanced.ts:260

SKUs, entitlements and subscriptions for one application. Entitlements are cached by ID and kept current by the client’s ENTITLEMENT_* events.

new MonetizationManager(rest, applicationId): MonetizationManager

Defined in: packages/managers/src/advanced.ts:264

REST

string

MonetizationManager

Manager.constructor

readonly applicationId: string

Defined in: packages/managers/src/advanced.ts:262


readonly cache: Collection<string, APIEntitlement>

Defined in: packages/managers/src/base.ts:27

Authoritative resource state. Entries never expire: see Manager.set.

Manager.cache

get size(): number

Defined in: packages/managers/src/base.ts:105

Gets cache size.

number

Number of cached values.

Manager.size

[iterator](): IterableIterator<[string, APIEntitlement]>

Defined in: packages/managers/src/base.ts:121

Iterates cached entries.

IterableIterator<[string, APIEntitlement]>

Cache iterator.

Manager.[iterator]


clear(): void

Defined in: packages/managers/src/base.ts:101

Clears the cache.

void

Nothing.

Manager.clear


consume(entitlementId): Promise<void>

Defined in: packages/managers/src/advanced.ts:315

Marks a one-time-purchase entitlement as consumed.

string

Promise<void>


createTestEntitlement(options): Promise<APIEntitlement>

Defined in: packages/managers/src/advanced.ts:324

Creates a test entitlement for a user or guild (owner type 1 = guild, 2 = user).

string

1 | 2

string

Promise<APIEntitlement>


delete(id): boolean

Defined in: packages/managers/src/base.ts:96

Deletes a cached value.

string

Cache key.

boolean

True when deleted.

Manager.delete


deleteTestEntitlement(entitlementId): Promise<void>

Defined in: packages/managers/src/advanced.ts:342

Deletes a test entitlement.

string

Promise<void>


fetch(entitlementId): Promise<APIEntitlement>

Defined in: packages/managers/src/advanced.ts:306

Fetches one entitlement.

string

Promise<APIEntitlement>


fetchEntitlements(query?): Promise<APIEntitlement[]>

Defined in: packages/managers/src/advanced.ts:278

Fetches entitlements matching the filters and caches them.

EntitlementQuery = {}

Promise<APIEntitlement[]>


fetchSkus(): Promise<APISKU[]>

Defined in: packages/managers/src/advanced.ts:271

Fetches the application’s SKUs.

Promise<APISKU[]>


fetchSubscription(skuId, subscriptionId): Promise<APISubscription>

Defined in: packages/managers/src/advanced.ts:370

Fetches one subscription.

string

string

Promise<APISubscription>


fetchSubscriptions(skuId, query?): Promise<APISubscription[]>

Defined in: packages/managers/src/advanced.ts:350

Fetches a SKU’s subscriptions for a user, or one subscription.

string

string

string

number

string

Promise<APISubscription[]>


find(predicate): APIEntitlement | undefined

Defined in: packages/managers/src/base.ts:117

Finds a cached value.

(value, key) => boolean

Predicate.

APIEntitlement | undefined

Matching value.

Manager.find


first(): APIEntitlement | undefined

Defined in: packages/managers/src/base.ts:109

Gets the first cached value.

APIEntitlement | undefined

First value.

Manager.first


get(id): APIEntitlement | undefined

Defined in: packages/managers/src/base.ts:36

Gets a cached value.

string

Cache key.

APIEntitlement | undefined

Cached value.

Manager.get


has(id): boolean

Defined in: packages/managers/src/base.ts:40

Checks whether a value is cached.

string

Cache key.

boolean

True when cached.

Manager.has


set(id, value): this

Defined in: packages/managers/src/base.ts:88

Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.

string

Cache key.

APIEntitlement

Value.

this

This manager.

Manager.set


values(): APIEntitlement[]

Defined in: packages/managers/src/base.ts:113

Returns cached values.

APIEntitlement[]

Array of values.

Manager.values