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.
Extends
Section titled “Extends”Manager<string,APIEntitlement>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MonetizationManager(
rest,applicationId):MonetizationManager
Defined in: packages/managers/src/advanced.ts:264
Parameters
Section titled “Parameters”applicationId
Section titled “applicationId”string
Returns
Section titled “Returns”MonetizationManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”applicationId
Section titled “applicationId”
readonlyapplicationId:string
Defined in: packages/managers/src/advanced.ts:262
readonlycache:Collection<string,APIEntitlement>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,APIEntitlement]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, APIEntitlement]>
Cache iterator.
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”consume()
Section titled “consume()”consume(
entitlementId):Promise<void>
Defined in: packages/managers/src/advanced.ts:315
Marks a one-time-purchase entitlement as consumed.
Parameters
Section titled “Parameters”entitlementId
Section titled “entitlementId”string
Returns
Section titled “Returns”Promise<void>
createTestEntitlement()
Section titled “createTestEntitlement()”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).
Parameters
Section titled “Parameters”options
Section titled “options”ownerId
Section titled “ownerId”string
ownerType
Section titled “ownerType”1 | 2
string
Returns
Section titled “Returns”Promise<APIEntitlement>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”deleteTestEntitlement()
Section titled “deleteTestEntitlement()”deleteTestEntitlement(
entitlementId):Promise<void>
Defined in: packages/managers/src/advanced.ts:342
Deletes a test entitlement.
Parameters
Section titled “Parameters”entitlementId
Section titled “entitlementId”string
Returns
Section titled “Returns”Promise<void>
fetch()
Section titled “fetch()”fetch(
entitlementId):Promise<APIEntitlement>
Defined in: packages/managers/src/advanced.ts:306
Fetches one entitlement.
Parameters
Section titled “Parameters”entitlementId
Section titled “entitlementId”string
Returns
Section titled “Returns”Promise<APIEntitlement>
fetchEntitlements()
Section titled “fetchEntitlements()”fetchEntitlements(
query?):Promise<APIEntitlement[]>
Defined in: packages/managers/src/advanced.ts:278
Fetches entitlements matching the filters and caches them.
Parameters
Section titled “Parameters”query?
Section titled “query?”EntitlementQuery = {}
Returns
Section titled “Returns”Promise<APIEntitlement[]>
fetchSkus()
Section titled “fetchSkus()”fetchSkus():
Promise<APISKU[]>
Defined in: packages/managers/src/advanced.ts:271
Fetches the application’s SKUs.
Returns
Section titled “Returns”Promise<APISKU[]>
fetchSubscription()
Section titled “fetchSubscription()”fetchSubscription(
skuId,subscriptionId):Promise<APISubscription>
Defined in: packages/managers/src/advanced.ts:370
Fetches one subscription.
Parameters
Section titled “Parameters”string
subscriptionId
Section titled “subscriptionId”string
Returns
Section titled “Returns”Promise<APISubscription>
fetchSubscriptions()
Section titled “fetchSubscriptions()”fetchSubscriptions(
skuId,query?):Promise<APISubscription[]>
Defined in: packages/managers/src/advanced.ts:350
Fetches a SKU’s subscriptions for a user, or one subscription.
Parameters
Section titled “Parameters”string
query?
Section titled “query?”after?
Section titled “after?”string
before?
Section titled “before?”string
limit?
Section titled “limit?”number
userId?
Section titled “userId?”string
Returns
Section titled “Returns”Promise<APISubscription[]>
find()
Section titled “find()”find(
predicate):APIEntitlement|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”APIEntitlement | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
APIEntitlement|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”APIEntitlement | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):APIEntitlement|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”APIEntitlement | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”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.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
APIEntitlement[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Array of values.