Constructor
new Document(opts)
Creates a Document
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
cancelCheckout(uuid, force) → {Promise.<*>}
Checkout a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
force |
Force to cancel the checkout ( only allowed to administrators ) |
Returns:
- Return void
- Type
- Promise.<*>
cancelCheckout(uuid, force) → {Promise.<*>}
Checkout a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
force |
Force to cancel the checkout ( only allowed to administrators ) |
Returns:
- Return void
- Type
- Promise.<*>
captureData(uuid, templateId) → {Promise.<any>|Promise.<*>}
Capture data from the document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
templateId |
The template id |
Returns:
- Type
- Promise.<any> | Promise.<*>
captureData(uuid, templateId) → {Promise.<any>|Promise.<*>}
Capture data from the document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
templateId |
The template id |
Returns:
- Type
- Promise.<any> | Promise.<*>
checkin(uuid) → {Promise.<*>}
Checkin a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
checkin(uuid) → {Promise.<*>}
Checkin a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
checkout(uuid) → {Promise.<*>}
Checkout a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
checkout(uuid) → {Promise.<*>}
Checkout a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the document |
Returns:
- Return void
- Type
- Promise.<*>
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the document |
Returns:
- Return void
- Type
- Promise.<*>
createDocument(uuid, file) → {Promise.<any>|Promise.<(*|never)>}
Creates a new Document Node
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent node |
|
file |
The file to create. More information about File object at https://developer.mozilla.org/en-US/docs/Web/API/File/File |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
createDocument(uuid, file) → {Promise.<any>|Promise.<(*|never)>}
Creates a new Document Node
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent node |
|
file |
The file to create. More information about File object at https://developer.mozilla.org/en-US/docs/Web/API/File/File |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
createFromTemplate(uuid, dstPath, categories, keywords, notes, properties) → {Promise.<any>|Promise.<T>}
Create document from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstPath |
The destination path of the new document |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
properties |
The metadata groups |
Returns:
- Type
- Promise.<any> | Promise.<T>
createFromTemplate(uuid, dstPath, categories, keywords, notes, properties) → {Promise.<any>|Promise.<T>}
Create document from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstPath |
The destination path of the new document |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
properties |
The metadata groups |
Returns:
- Type
- Promise.<any> | Promise.<T>
delete(uuid) → {Promise.<*>}
Delete a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
delete(uuid) → {Promise.<*>}
Delete a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
extendedCopy(uuid, dstId, newName, categories, keywords, notes, propertyGroups, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the folder or record destination node |
|
newName |
The newName of the new node |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
propertyGroups |
The metadata groups |
|
security |
When true copy security |
Returns:
Return the properties of a document
- Type
- Promise.<any> | Promise.<(*|never)>
extendedCopy(uuid, dstId, newName, categories, keywords, notes, propertyGroups, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the folder or record destination node |
|
newName |
The newName of the new node |
|
categories |
When true copy categories |
|
keywords |
When true copy keywords |
|
notes |
When true copy notes |
|
propertyGroups |
The metadata groups |
|
security |
When true copy security |
Returns:
Return the properties of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getChildren(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get children documents
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a parent folder or record |
Returns:
Return a list of documents
- Type
- Promise.<any> | Promise.<(*|never)>
getChildren(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get children documents
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a parent folder or record |
Returns:
Return a list of documents
- Type
- Promise.<any> | Promise.<(*|never)>
getContent(uuid, docName) → {Promise.<any>|Promise.<*>}
Download document content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
docName |
The name of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getContent(uuid, docName) → {Promise.<any>|Promise.<*>}
Download document content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
docName |
The name of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getContentByVersion(uuid, versionName, docName) → {Promise.<any>|Promise.<*>}
Download document content by version
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the ndoe |
|
versionName |
The name of the version |
|
docName |
The name of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getContentByVersion(uuid, versionName, docName) → {Promise.<any>|Promise.<*>}
Download document content by version
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the ndoe |
|
versionName |
The name of the version |
|
docName |
The name of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getExtractedText(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the Extracted text
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a document node |
Returns:
Return the text of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getExtractedText(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the Extracted text
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a document node |
Returns:
Return the text of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getLiveEditRestrictedMimeTypes() → {Promise.<any>|Promise.<(*|never)>}
Return allowed live edit mime types
Returns:
Return a list of the allowed live edit mime types
- Type
- Promise.<any> | Promise.<(*|never)>
getLiveEditRestrictedMimeTypes() → {Promise.<any>|Promise.<(*|never)>}
Return allowed live edit mime types
Returns:
Return a list of the allowed live edit mime types
- Type
- Promise.<any> | Promise.<(*|never)>
getNumberOfPages(uuid) → {Promise.<any>|Promise.<*>}
Get number of pages of a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
Document UUID |
Returns:
- Type
- Promise.<any> | Promise.<*>
getNumberOfPages(uuid) → {Promise.<any>|Promise.<*>}
Get number of pages of a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
Document UUID |
Returns:
- Type
- Promise.<any> | Promise.<*>
getPageAsImage(uuid, pageNumber, maxWidth, maxHeight) → {Promise.<any>|Promise.<*>}
Get page of a PDF as image
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
UUID |
|
pageNumber |
Page number |
|
maxWidth |
Max width |
|
maxHeight |
Min height |
Returns:
- Type
- Promise.<any> | Promise.<*>
getPageAsImage(uuid, pageNumber, maxWidth, maxHeight) → {Promise.<any>|Promise.<*>}
Get page of a PDF as image
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
UUID |
|
pageNumber |
Page number |
|
maxWidth |
Max width |
|
maxHeight |
Min height |
Returns:
- Type
- Promise.<any> | Promise.<*>
getPdf(uuid, filename) → {Promise.<any>|Promise.<*>}
Download document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
filename |
The name of the PDF document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getPdf(uuid, filename) → {Promise.<any>|Promise.<*>}
Download document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
filename |
The name of the PDF document |
Returns:
- Type
- Promise.<any> | Promise.<*>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the document properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a document node |
Returns:
Return the properties of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the document properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a document node |
Returns:
Return the properties of a document
- Type
- Promise.<any> | Promise.<(*|never)>
getTextContent(uuid) → {Promise.<*>}
Get the text content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
getTextContent(uuid) → {Promise.<*>}
Get the text content
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Return void
- Type
- Promise.<*>
getThumbnail(uuid, type, halfSize) → {Promise.<*>}
Get the thumbnail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
type |
Type of the thumnail |
|
halfSize |
Thumnail halfsize |
Returns:
- Return void
- Type
- Promise.<*>
getThumbnail(uuid, type, halfSize) → {Promise.<*>}
Get the thumbnail
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
type |
Type of the thumnail |
|
halfSize |
Thumnail halfsize |
Returns:
- Return void
- Type
- Promise.<*>
isAttachment(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is attachment
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a attachment otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isAttachment(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is attachment
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a attachment otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isConvertibleToPdf(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is convertible to pdf
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isConvertibleToPdf(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is convertible to pdf
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isOCRDataCaptureSupported(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is OCR Data Capture Supported
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isOCRDataCaptureSupported(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is OCR Data Capture Supported
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is convertible to pdf otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a document otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a document otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
liveEditCheckin(uuid, comment, increment) → {Promise.<any>|Promise.<*>}
Check in the edited documents with live editor feature
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
|
comment |
The comment |
|
increment |
The increment value is used to increase to a major version |
Returns:
- Type
- Promise.<any> | Promise.<*>
liveEditCheckin(uuid, comment, increment) → {Promise.<any>|Promise.<*>}
Check in the edited documents with live editor feature
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
|
comment |
The comment |
|
increment |
The increment value is used to increase to a major version |
Returns:
- Type
- Promise.<any> | Promise.<*>
mergePdf(destinationUuid, name, uuidList) → {Promise.<unknown>|Promise.<string>|Promise.<*>}
Merges as PDF document
Parameters:
| Name | Type | Description |
|---|---|---|
destinationUuid |
The uuid of the destination folder or record |
|
name |
The name of the document |
|
uuidList |
The list of uuid's nodes to merge |
Returns:
- Type
- Promise.<unknown> | Promise.<string> | Promise.<*>
mergePdf(destinationUuid, name, uuidList) → {Promise.<unknown>|Promise.<string>|Promise.<*>}
Merges as PDF document
Parameters:
| Name | Type | Description |
|---|---|---|
destinationUuid |
The uuid of the destination folder or record |
|
name |
The name of the document |
|
uuidList |
The list of uuid's nodes to merge |
Returns:
- Type
- Promise.<unknown> | Promise.<string> | Promise.<*>
move(uuid, dstId) → {Promise.<*>}
Move a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
move(uuid, dstId) → {Promise.<*>}
Move a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
recognize(uuid) → {Promise.<any>|Promise.<*>}
Recognise OCR template and when possible process the document to capture data
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
recognize(uuid) → {Promise.<any>|Promise.<*>}
Recognise OCR template and when possible process the document to capture data
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
Returns:
- Type
- Promise.<any> | Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the document |
Returns:
- Return void
- Type
- Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the document |
Returns:
- Return void
- Type
- Promise.<*>
savePdf(uuid, newName, propertyGroups, security) → {Promise.<any>|Promise.<*>}
Save document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
newName |
The newName of the document |
|
propertyGroups |
The metadata groups |
|
security |
When true copy security |
Returns:
- Type
- Promise.<any> | Promise.<*>
savePdf(uuid, newName, propertyGroups, security) → {Promise.<any>|Promise.<*>}
Save document as PDF
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
newName |
The newName of the document |
|
propertyGroups |
The metadata groups |
|
security |
When true copy security |
Returns:
- Type
- Promise.<any> | Promise.<*>
setDescription(uuid, description) → {Promise.<*>}
Set description
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
description |
The description of the document |
Returns:
- Return void
- Type
- Promise.<*>
setDescription(uuid, description) → {Promise.<*>}
Set description
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
description |
The description of the document |
Returns:
- Return void
- Type
- Promise.<*>
setIndexable(uuid, enabled) → {Promise.<*>}
Indexable a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
enabled |
The enabled |
Returns:
- Return void
- Type
- Promise.<*>
setIndexable(uuid, enabled) → {Promise.<*>}
Indexable a document
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
enabled |
The enabled |
Returns:
- Return void
- Type
- Promise.<*>
setLanguage(uuid, language) → {Promise.<*>}
Set language
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
language |
The language of the document |
Returns:
- Return void
- Type
- Promise.<*>
setLanguage(uuid, language) → {Promise.<*>}
Set language
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
language |
The language of the document |
Returns:
- Return void
- Type
- Promise.<*>
setNodeClass(uuid, ncId) → {Promise.<*>}
Set nodeClass
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
ncId |
The nodeClass id |
Returns:
- Return void
- Type
- Promise.<*>
setNodeClass(uuid, ncId) → {Promise.<*>}
Set nodeClass
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
ncId |
The nodeClass id |
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 |
setTitle(uuid, title) → {Promise.<*>}
Set title
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
title |
The title of the document |
Returns:
- Return void
- Type
- Promise.<*>
setTitle(uuid, title) → {Promise.<*>}
Set title
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the document |
|
title |
The title of the document |
Returns:
- Return void
- Type
- Promise.<*>
setToken(token)
Set the token in Document variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Document variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
updateFromTemplate(uuid, dstId, properties) → {Promise.<any>|Promise.<T>}
Update document from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstId |
The uuid of the node to update |
|
properties |
The metadata groups |
Returns:
- Type
- Promise.<any> | Promise.<T>
updateFromTemplate(uuid, dstId, properties) → {Promise.<any>|Promise.<T>}
Update document from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstId |
The uuid of the node to update |
|
properties |
The metadata groups |
Returns:
- Type
- Promise.<any> | Promise.<T>