Class: AddonsHelper

AddonsHelper()

A helper type for resource addon-related API endpoints.

Constructor

new AddonsHelper()

Source:

Methods

(async) listAllLicenses(addonId, sort) → {Array.<AddonLicense>}

List all pages of licenses for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonLicense>

(async) listAllPurchases(addonId, sort) → {Array.<AddonPurchase>}

List all pages of purchases for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonPurchase>

(async) listLicenses(addonId, sort) → {Array.<AddonLicense>}

List a page of licenses for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonLicense>

(async) listLicensesByMember(addonId, memberId, sort) → {Array.<AddonLicense>}

List a page of licenses by member for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
memberId number The identifier of the member.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonLicense>

(async) listLicensesUntil(addonId, shouldContinue, sort) → {Array.<AddonLicense>}

List multiple pages of licenses for a given addon until a condition is no longer met.
Parameters:
Name Type Description
addonId number The identifier of the addon.
shouldContinue function A fn which determines if further pages are requested.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonLicense>

(async) listPurchases(addonId, sort) → {Array.<AddonPurchase>}

List a page of purchases for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonPurchase>

(async) listPurchasesByMember(addonId, memberId, sort) → {Array.<AddonPurchase>}

List a page of purchases by member for a given addon.
Parameters:
Name Type Description
addonId number The identifier of the addon.
memberId number The identifier of the member.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonPurchase>

(async) listPurchasesUntil(addonId, shouldContinue, sort) → {Array.<AddonPurchase>}

List multiple pages of purchases for a given addon until a condition is no longer met.
Parameters:
Name Type Description
addonId number The identifier of the addon.
shouldContinue function A fn which determines if further pages are requested.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<AddonPurchase>