Class: Node

Node(opts)

The Node class wraps node operations

Cannot directly be instantiated

Constructor

new Node(opts)

Creates a Node

Parameters:
Name Type Description
opts object

The configuration options.

Methods

degradeRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Degrade a node with record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

degradeRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Degrade a node with record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

evaluateDownloadZip(uuids) → {Promise.<(*|never)>}

Get the results of evaluating download nodes into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<(*|never)>

evaluateDownloadZip(uuids) → {Promise.<(*|never)>}

Get the results of evaluating download nodes into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<(*|never)>

evaluateElementsToLock(uuid) → {Promise.<(*|never)>}

Get the result of evaluating if there's some node locked by another user in the hierarchy

Parameters:
Name Type Description
uuid

The uuid of the node to evaluate

Returns:
Type
Promise.<(*|never)>

evaluateElementsToLock(uuid) → {Promise.<(*|never)>}

Get the result of evaluating if there's some node locked by another user in the hierarchy

Parameters:
Name Type Description
uuid

The uuid of the node to evaluate

Returns:
Type
Promise.<(*|never)>

exportZip(uuids) → {Promise.<any>|Promise.<(*|never)>}

Export data into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<any> | Promise.<(*|never)>

exportZip(uuids) → {Promise.<any>|Promise.<(*|never)>}

Export data into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<any> | Promise.<(*|never)>

generateDownloadToken(uuid, preview) → {Promise.<*>}

Generate a document token to download a node

Parameters:
Name Type Description
uuid

The uuid of the node

preview

When preview the download must be done in the next minute

Returns:
  • Return void
Type
Promise.<*>

generateDownloadToken(uuid, preview) → {Promise.<*>}

Generate a document token to download a node

Parameters:
Name Type Description
uuid

The uuid of the node

preview

When preview the download must be done in the next minute

Returns:
  • Return void
Type
Promise.<*>

getBreadcrumb(uuid) → {Promise.<*>}

Get and ordered list of parents nodes

Parameters:
Name Type Description
uuid

The uuid of a node ( usually folder and record )

Returns:
  • Return a list of type BreadcrumItem
Type
Promise.<*>

getBreadcrumb(uuid) → {Promise.<*>}

Get and ordered list of parents nodes

Parameters:
Name Type Description
uuid

The uuid of a node ( usually folder and record )

Returns:
  • Return a list of type BreadcrumItem
Type
Promise.<*>

getChildrenByCategoryPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList, pluginName) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

pluginName

The canonical name of the plugin

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenByCategoryPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList, pluginName) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

pluginName

The canonical name of the plugin

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getLockInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get the lockinfo

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

Return the lockinfo of a node

Type
Promise.<any> | Promise.<(*|never)>

getLockInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get the lockinfo

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

Return the lockinfo of a node

Type
Promise.<any> | Promise.<(*|never)>

getNodeByUuid(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get a node by uuid

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

Return a node object

Type
Promise.<any> | Promise.<(*|never)>

getNodeByUuid(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get a node by uuid

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

Return a node object

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorConfig(pluginName) → {Promise.<any>|Promise.<(*|never)>}

Get the paginator configuration of a plugin

Parameters:
Name Type Description
pluginName

The canonical name of a plugin

Returns:

Return the paginator configuration of a plugin

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorConfig(pluginName) → {Promise.<any>|Promise.<(*|never)>}

Get the paginator configuration of a plugin

Parameters:
Name Type Description
pluginName

The canonical name of a plugin

Returns:

Return the paginator configuration of a plugin

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorPlugins() → {Promise.<any>|Promise.<(*|never)>}

Get the paginator plugins

Returns:

Return a list of all the paginator plugins except default

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorPlugins() → {Promise.<any>|Promise.<(*|never)>}

Get the paginator plugins

Returns:

Return a list of all the paginator plugins except default

Type
Promise.<any> | Promise.<(*|never)>

getVersionHistory(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get versions of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

A Versions list of the node

Type
Promise.<any> | Promise.<(*|never)>

getVersionHistory(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get versions of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

A Versions list of the node

Type
Promise.<any> | Promise.<(*|never)>

isLocked(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get is locked

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

isLocked(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get is locked

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

lock(uuid, force) → {Promise.<*>}

Lock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

When true force the lock

Returns:
  • Return void
Type
Promise.<*>

lock(uuid, force) → {Promise.<*>}

Lock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

When true force the lock

Returns:
  • Return void
Type
Promise.<*>

mayBePromotedAsRecord(uuid, fullEvaluation) → {Promise.<any>|Promise.<(*|never)>}

Check if a node maybe promoted as a record

Parameters:
Name Type Description
uuid

The uuid of a node

fullEvaluation

Full evaluation

Returns:

Return the PromoteAsRecordEvaluationRest of a node

Type
Promise.<any> | Promise.<(*|never)>

mayBePromotedAsRecord(uuid, fullEvaluation) → {Promise.<any>|Promise.<(*|never)>}

Check if a node maybe promoted as a record

Parameters:
Name Type Description
uuid

The uuid of a node

fullEvaluation

Full evaluation

Returns:

Return the PromoteAsRecordEvaluationRest of a node

Type
Promise.<any> | Promise.<(*|never)>

promoteAsRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Promote a node to the record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

promoteAsRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Promote a node to the record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

purgeVersionHistory(uuid) → {Promise.<any>|Promise.<*>}

Purge version history of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<*>

purgeVersionHistory(uuid) → {Promise.<any>|Promise.<*>}

Purge version history of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<*>

renameHistoryVersion(uuid, versionName, newName) → {Promise.<*>}

Rename History Version

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

newName

The new name of the version

Returns:
  • Return void
Type
Promise.<*>

renameHistoryVersion(uuid, versionName, newName) → {Promise.<*>}

Rename History Version

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

newName

The new name of the version

Returns:
  • Return void
Type
Promise.<*>

restore(uuid) → {Promise.<any>|Promise.<*>}

Restore a node

Parameters:
Name Type Description
uuid

The uuid of the node

Returns:

Return the node restored

Type
Promise.<any> | Promise.<*>

restore(uuid) → {Promise.<any>|Promise.<*>}

Restore a node

Parameters:
Name Type Description
uuid

The uuid of the node

Returns:

Return the node restored

Type
Promise.<any> | Promise.<*>

restoreVersion(uuid, versionName) → {Promise.<any>|Promise.<*>}

Restore version of a node

Parameters:
Name Type Description
uuid

The UUID of the node

versionName

The name of a version of a node

Returns:
Type
Promise.<any> | Promise.<*>

restoreVersion(uuid, versionName) → {Promise.<any>|Promise.<*>}

Restore version of a node

Parameters:
Name Type Description
uuid

The UUID of the node

versionName

The name of a version of a node

Returns:
Type
Promise.<any> | Promise.<*>

setComment(uuid, versionName, comment) → {Promise.<*>}

Set comment

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

comment

The comment of the node

Returns:
  • Return void
Type
Promise.<*>

setComment(uuid, versionName, comment) → {Promise.<*>}

Set comment

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

comment

The comment of the node

Returns:
  • Return void
Type
Promise.<*>

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

subscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Subscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

subscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Subscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unlock(uuid, force) → {Promise.<*>}

Unlock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

Force to cancel the unlock ( only allowed to administrators )

Returns:
  • Return void
Type
Promise.<*>

unlock(uuid, force) → {Promise.<*>}

Unlock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

Force to cancel the unlock ( only allowed to administrators )

Returns:
  • Return void
Type
Promise.<*>

unsubscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Unsubscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unsubscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Unsubscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unzip(uuid, dstId) → {Promise.<any>|Promise.<(*|never)>}

unzip zip file

Parameters:
Name Type Description
uuid

The uuid of the document

dstId

The uuid of the destination folder or record

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unzip(uuid, dstId) → {Promise.<any>|Promise.<(*|never)>}

unzip zip file

Parameters:
Name Type Description
uuid

The uuid of the document

dstId

The uuid of the destination folder or record

Returns:
Type
Promise.<any> | Promise.<(*|never)>

Node(opts)

The Node class wraps node operations

Cannot directly be instantiated

Constructor

new Node(opts)

Creates a Node

Parameters:
Name Type Description
opts object

The configuration options.

Methods

degradeRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Degrade a node with record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

degradeRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Degrade a node with record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

evaluateDownloadZip(uuids) → {Promise.<(*|never)>}

Get the results of evaluating download nodes into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<(*|never)>

evaluateDownloadZip(uuids) → {Promise.<(*|never)>}

Get the results of evaluating download nodes into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<(*|never)>

evaluateElementsToLock(uuid) → {Promise.<(*|never)>}

Get the result of evaluating if there's some node locked by another user in the hierarchy

Parameters:
Name Type Description
uuid

The uuid of the node to evaluate

Returns:
Type
Promise.<(*|never)>

evaluateElementsToLock(uuid) → {Promise.<(*|never)>}

Get the result of evaluating if there's some node locked by another user in the hierarchy

Parameters:
Name Type Description
uuid

The uuid of the node to evaluate

Returns:
Type
Promise.<(*|never)>

exportZip(uuids) → {Promise.<any>|Promise.<(*|never)>}

Export data into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<any> | Promise.<(*|never)>

exportZip(uuids) → {Promise.<any>|Promise.<(*|never)>}

Export data into zip file

Parameters:
Name Type Description
uuids

The array of uuids nodes

Returns:
Type
Promise.<any> | Promise.<(*|never)>

generateDownloadToken(uuid, preview) → {Promise.<*>}

Generate a document token to download a node

Parameters:
Name Type Description
uuid

The uuid of the node

preview

When preview the download must be done in the next minute

Returns:
  • Return void
Type
Promise.<*>

generateDownloadToken(uuid, preview) → {Promise.<*>}

Generate a document token to download a node

Parameters:
Name Type Description
uuid

The uuid of the node

preview

When preview the download must be done in the next minute

Returns:
  • Return void
Type
Promise.<*>

getBreadcrumb(uuid) → {Promise.<*>}

Get and ordered list of parents nodes

Parameters:
Name Type Description
uuid

The uuid of a node ( usually folder and record )

Returns:
  • Return a list of type BreadcrumItem
Type
Promise.<*>

getBreadcrumb(uuid) → {Promise.<*>}

Get and ordered list of parents nodes

Parameters:
Name Type Description
uuid

The uuid of a node ( usually folder and record )

Returns:
  • Return a list of type BreadcrumItem
Type
Promise.<*>

getChildrenByCategoryPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList, pluginName) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

pluginName

The canonical name of the plugin

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenByCategoryPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList, pluginName) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

pluginName

The canonical name of the plugin

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getChildrenPaginated(uuid, offset, limit, filter, orderByField, orderAsc, filteredByNodeTypeList) → {Promise.<*>}

Get children nodes

Parameters:
Name Type Description
uuid

The id of the parent folder

offset

The offset of the node query

limit

The limit of the node query

filter

Filter the result using this parameter

orderByField

Field used to order the query

orderAsc

Field used to order ascendant

filteredByNodeTypeList

Field used to indicate node types
(1-> documents, 2-> folders, 3-> email 4-> records )

Returns:
  • Return a list of Nodes
Type
Promise.<*>

getLockInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get the lockinfo

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

Return the lockinfo of a node

Type
Promise.<any> | Promise.<(*|never)>

getLockInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get the lockinfo

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

Return the lockinfo of a node

Type
Promise.<any> | Promise.<(*|never)>

getNodeByUuid(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get a node by uuid

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

Return a node object

Type
Promise.<any> | Promise.<(*|never)>

getNodeByUuid(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get a node by uuid

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

Return a node object

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorConfig(pluginName) → {Promise.<any>|Promise.<(*|never)>}

Get the paginator configuration of a plugin

Parameters:
Name Type Description
pluginName

The canonical name of a plugin

Returns:

Return the paginator configuration of a plugin

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorConfig(pluginName) → {Promise.<any>|Promise.<(*|never)>}

Get the paginator configuration of a plugin

Parameters:
Name Type Description
pluginName

The canonical name of a plugin

Returns:

Return the paginator configuration of a plugin

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorPlugins() → {Promise.<any>|Promise.<(*|never)>}

Get the paginator plugins

Returns:

Return a list of all the paginator plugins except default

Type
Promise.<any> | Promise.<(*|never)>

getPaginatorPlugins() → {Promise.<any>|Promise.<(*|never)>}

Get the paginator plugins

Returns:

Return a list of all the paginator plugins except default

Type
Promise.<any> | Promise.<(*|never)>

getVersionHistory(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get versions of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

A Versions list of the node

Type
Promise.<any> | Promise.<(*|never)>

getVersionHistory(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get versions of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:

A Versions list of the node

Type
Promise.<any> | Promise.<(*|never)>

isLocked(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get is locked

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

isLocked(uuid) → {Promise.<any>|Promise.<(*|never)>}

Get is locked

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

lock(uuid, force) → {Promise.<*>}

Lock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

When true force the lock

Returns:
  • Return void
Type
Promise.<*>

lock(uuid, force) → {Promise.<*>}

Lock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

When true force the lock

Returns:
  • Return void
Type
Promise.<*>

mayBePromotedAsRecord(uuid, fullEvaluation) → {Promise.<any>|Promise.<(*|never)>}

Check if a node maybe promoted as a record

Parameters:
Name Type Description
uuid

The uuid of a node

fullEvaluation

Full evaluation

Returns:

Return the PromoteAsRecordEvaluationRest of a node

Type
Promise.<any> | Promise.<(*|never)>

mayBePromotedAsRecord(uuid, fullEvaluation) → {Promise.<any>|Promise.<(*|never)>}

Check if a node maybe promoted as a record

Parameters:
Name Type Description
uuid

The uuid of a node

fullEvaluation

Full evaluation

Returns:

Return the PromoteAsRecordEvaluationRest of a node

Type
Promise.<any> | Promise.<(*|never)>

promoteAsRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Promote a node to the record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

promoteAsRecord(uuid) → {Promise.<any>|Promise.<(*|never)>}

Promote a node to the record status

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

purgeVersionHistory(uuid) → {Promise.<any>|Promise.<*>}

Purge version history of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<*>

purgeVersionHistory(uuid) → {Promise.<any>|Promise.<*>}

Purge version history of a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<*>

renameHistoryVersion(uuid, versionName, newName) → {Promise.<*>}

Rename History Version

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

newName

The new name of the version

Returns:
  • Return void
Type
Promise.<*>

renameHistoryVersion(uuid, versionName, newName) → {Promise.<*>}

Rename History Version

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

newName

The new name of the version

Returns:
  • Return void
Type
Promise.<*>

restore(uuid) → {Promise.<any>|Promise.<*>}

Restore a node

Parameters:
Name Type Description
uuid

The uuid of the node

Returns:

Return the node restored

Type
Promise.<any> | Promise.<*>

restore(uuid) → {Promise.<any>|Promise.<*>}

Restore a node

Parameters:
Name Type Description
uuid

The uuid of the node

Returns:

Return the node restored

Type
Promise.<any> | Promise.<*>

restoreVersion(uuid, versionName) → {Promise.<any>|Promise.<*>}

Restore version of a node

Parameters:
Name Type Description
uuid

The UUID of the node

versionName

The name of a version of a node

Returns:
Type
Promise.<any> | Promise.<*>

restoreVersion(uuid, versionName) → {Promise.<any>|Promise.<*>}

Restore version of a node

Parameters:
Name Type Description
uuid

The UUID of the node

versionName

The name of a version of a node

Returns:
Type
Promise.<any> | Promise.<*>

setComment(uuid, versionName, comment) → {Promise.<*>}

Set comment

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

comment

The comment of the node

Returns:
  • Return void
Type
Promise.<*>

setComment(uuid, versionName, comment) → {Promise.<*>}

Set comment

Parameters:
Name Type Description
uuid

The uuid of the node

versionName

The name of the version

comment

The comment of the node

Returns:
  • Return void
Type
Promise.<*>

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setRestUrl(restUrl)

Set the rest url

Parameters:
Name Type Description
restUrl

The rest url

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

setToken(token)

Set the token in Node variables

Parameters:
Name Type Description
token

The authorization token value

subscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Subscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

subscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Subscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unlock(uuid, force) → {Promise.<*>}

Unlock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

Force to cancel the unlock ( only allowed to administrators )

Returns:
  • Return void
Type
Promise.<*>

unlock(uuid, force) → {Promise.<*>}

Unlock a node

Parameters:
Name Type Description
uuid

The uuid of the node

force

Force to cancel the unlock ( only allowed to administrators )

Returns:
  • Return void
Type
Promise.<*>

unsubscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Unsubscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unsubscribe(uuid) → {Promise.<any>|Promise.<(*|never)>}

Unsubscribe to a node

Parameters:
Name Type Description
uuid

The UUID of the node

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unzip(uuid, dstId) → {Promise.<any>|Promise.<(*|never)>}

unzip zip file

Parameters:
Name Type Description
uuid

The uuid of the document

dstId

The uuid of the destination folder or record

Returns:
Type
Promise.<any> | Promise.<(*|never)>

unzip(uuid, dstId) → {Promise.<any>|Promise.<(*|never)>}

unzip zip file

Parameters:
Name Type Description
uuid

The uuid of the document

dstId

The uuid of the destination folder or record

Returns:
Type
Promise.<any> | Promise.<(*|never)>