Class: module:api/ContentApi

module:api/ContentApi(apiClient)

new module:api/ContentApi(apiClient)

Constructs a new ContentApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Source:

Methods

getContentByID(id, opts) → {Promise}

To access a content asset, you construct a URL using the template shown below. This template requires you to specify a content asset id. In response, the server returns a corresponding content asset document. Only content assets, which are marked as online are returned. An assignment to a folder is not necessary.

Parameters:
Name Type Description
id String

The id of the requested content asset.

opts Object

Optional parameters

Properties
Name Type Description
locale String
Source:
Returns:

a Promise, with data of type module:models/Content

Type
Promise

getContentByIDs(ids, opts) → {Promise}

Parameters:
Name Type Description
ids Array.<String>
opts Object

Optional parameters

Properties
Name Type Description
locale String
Source:
Returns:

a Promise, with data of type module:models/ContentResult

Type
Promise

getContentByIDsWithHttpInfo(ids, opts) → {Promise}

Parameters:
Name Type Description
ids Array.<String>
opts Object

Optional parameters

Properties
Name Type Description
locale String
Source:
Returns:

a Promise, with an object containing data of type module:models/ContentResult and HTTP response

Type
Promise

getContentByIDWithHttpInfo(id, opts) → {Promise}

To access a content asset, you construct a URL using the template shown below. This template requires you to specify a content asset id. In response, the server returns a corresponding content asset document. Only content assets, which are marked as online are returned. An assignment to a folder is not necessary.

Parameters:
Name Type Description
id String

The id of the requested content asset.

opts Object

Optional parameters

Properties
Name Type Description
locale String
Source:
Returns:

a Promise, with an object containing data of type module:models/Content and HTTP response

Type
Promise