ReferencesManager

Type: Class

How to get referencesManager?

JavaScript

import referencesManager from 'fontoxml-references/src/referencesManager.js'

The reference manager manages communication with the references CMS endpoints.

Methods

createPermanentIdForReference

Type: Function

Create a permanent ID for the given reference.

Creating a permanent ID requires specifying the referrer document. This can be specified as a local DocumentId referrerDocumentId.

For operations, use the createPermanentIdForReference transform.

Arguments

Returns

retrieve

Type: Function

Returns the details of references given a permanent identifiers to the references, which uses batching to make the actual requests.

This method uses batching based on a time window. After the first call to this method is made, a time window is started. All calls to this method made in the time window are bundled in one request to the connector. After this time window has expired, the actual request to the connector is made. The first call to this method after the time window has expired will create a new batch window.

Arguments

Returns

retrieveSingle

Type: Function

Convenience method to retrieve a single reference. Consider using ReferencesManager#retrieve if you need to retrieve multiple references.

For operations, use the retrieveReferenceFromPermanentId transform.

Arguments

Returns

updateMetadata

Type: Function

Update the metadata of an existing reference in the reference repository and returns the reference.

Arguments

Returns