Class: ResourcesHelper

ResourcesHelper()

A helper type for resource-related API endpoints.

Constructor

new ResourcesHelper()

Source:

Methods

(async) batchModify(resourceIds, changes) → {number}

Batch edit resource fields for resources you own.
Parameters:
Name Type Description
resourceIds Array.<number> The identifiers of the resources.
changes Array.<BatchChange> A list of changes to make.
Source:
Returns:
A batch edit identifier.
Type
number

(async) batchStatus(batchId) → {BatchEdit}

Fetch the status of a batch edit.
Parameters:
Name Type Description
batchId number The identifier of the batch edit.
Source:
Returns:
A raw data object.
Type
BatchEdit

downloads() → {DownloadsHelper}

Access download-related helper functions.
Source:
Returns:
A newly-constructed download helper instance.
Type
DownloadsHelper

(async) fetch(resourceId) → {Resource}

Fetch detailed information about a resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
Source:
Returns:
A raw data object.
Type
Resource

licenses() → {LicensesHelper}

Access license-related helper functions.
Source:
Returns:
A newly-constructed license helper instance.
Type
LicensesHelper

(async) list(sort) → {Array.<BasicResource>}

List a page of public resources.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listByAuthor(authorId, sort) → {Array.<BasicResource>}

List a page of resources by an author.
Parameters:
Name Type Description
authorId number The identifier of the resource author.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listByAuthorAll(authorId, sort) → {Array.<BasicResource>}

List all pages of resources by an author.
Parameters:
Name Type Description
authorId number The identifier of the resource author.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listByAuthorUntil(authorId, shouldContinue, sort) → {Array.<BasicResource>}

List multiple pages of resources by an author until a condition is no longer met.
Parameters:
Name Type Description
authorId number The identifier of the resource author.
shouldContinue function A function 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.<BasicResource>

(async) listCollaborated(sort) → {Array.<BasicResource>}

List a page of collaborated resources.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listCollaboratedAll(sort) → {Array.<BasicResource>}

List all pages of collaborated resources.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listCollaboratedUntil(shouldContinue, sort) → {Array.<BasicResource>}

List multiple pages of collaborated resources until a condition is no longer met.
Parameters:
Name Type Description
shouldContinue function A function 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.<BasicResource>

(async) listOwned(sort) → {Array.<BasicResource>}

List a page of owned resources.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listOwnedAll(sort) → {Array.<BasicResource>}

List all pages of owned resources.
Parameters:
Name Type Description
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<BasicResource>

(async) listOwnedUntil(shouldContinue, sort) → {Array.<BasicResource>}

List multiple pages of owned resources until a condition is no longer met.
Parameters:
Name Type Description
shouldContinue function A function 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.<BasicResource>

(async) modify(resourceId, title, description, tagLine)

Edit resource fields for a resource you own or collaborate on.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
title string The updated content of the title, or undefined.
description string The updated content of the description, or undefined.
tagLine string The updated content of the tag line, or undefined.
Source:

purchases() → {PurchasesHelper}

Access purchase-related helper functions.
Source:
Returns:
A newly-constructed purchase helper instance.
Type
PurchasesHelper

reviews() → {ReviewsHelper}

Access review-related helper functions.
Source:
Returns:
A newly-constructed review helper instance.
Type
ReviewsHelper

updates() → {UpdatesHelper}

Access update-related helper functions.
Source:
Returns:
A newly-constructed update helper instance.
Type
UpdatesHelper

versions() → {VersionsHelper}

Access version-related helper functions.
Source:
Returns:
A newly-constructed version helper instance.
Type
VersionsHelper