Class: module:api/FoldersApi

module:api/FoldersApi(apiClient)

new module:api/FoldersApi(apiClient)

Constructs a new FoldersApi.

Parameters:
Name Type Description
apiClient module:ApiClient

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

Source:

Methods

getFoldersByID(id, opts) → {Promise}

To access a content folder, you construct a URL using the template shown below. This template requires you to specify a content folder id and a subfolder level. In response, the server returns a corresponding content folder document. Only content folder, which are marked as online are returned.

Parameters:
Name Type Description
id String

The id of the requested content folder.

opts Object

Optional parameters

Properties
Name Type Description
levels Number
locale String
Source:
Returns:

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

Type
Promise

getFoldersByIDs(ids, opts) → {Promise}

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

Optional parameters

Properties
Name Type Description
levels Number
locale String
Source:
Returns:
Type
Promise

getFoldersByIDsWithHttpInfo(ids, opts) → {Promise}

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

Optional parameters

Properties
Name Type Description
levels Number
locale String
Source:
Returns:

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

Type
Promise

getFoldersByIDWithHttpInfo(id, opts) → {Promise}

To access a content folder, you construct a URL using the template shown below. This template requires you to specify a content folder id and a subfolder level. In response, the server returns a corresponding content folder document. Only content folder, which are marked as online are returned.

Parameters:
Name Type Description
id String

The id of the requested content folder.

opts Object

Optional parameters

Properties
Name Type Description
levels Number
locale String
Source:
Returns:

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

Type
Promise