Constructor
new Folder(opts)
Creates a Folder
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
object | The configuration options. |
Methods
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the folder |
Returns:
- Return void
- Type
- Promise.<*>
copy(uuid, dstId, newName) → {Promise.<*>}
Copy a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the destination folder or record |
|
newName |
The newName of the folder |
Returns:
- Return void
- Type
- Promise.<*>
create(uuid, name) → {Promise.<*>}
Create a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
name |
The name of the new folder |
Returns:
- Return the folder object
- Type
- Promise.<*>
create(uuid, name) → {Promise.<*>}
Create a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
name |
The name of the new folder |
Returns:
- Return the folder object
- Type
- Promise.<*>
createFromTemplate(uuid, dstPath, categories, keywords, notes, properties) → {Promise.<any>|Promise.<T>}
Create folder from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstPath |
The destination path of the new folder |
|
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 folder from template
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the template |
|
dstPath |
The destination path of the new folder |
|
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 folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
Returns:
- Return void
- Type
- Promise.<*>
delete(uuid) → {Promise.<*>}
Delete a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
Returns:
- Return void
- Type
- Promise.<*>
extendedCopy(uuid, dstId, newName, categories, keywords, propertyGroups, notes, wiki, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a folder
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 the current categories of the node |
|
keywords |
When true copy the current keywords of the node |
|
propertyGroups |
When true copy the current property groups |
|
notes |
When true copy the current notes |
|
wiki |
When true copy the current wiki |
|
security |
When true copy the current security |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
extendedCopy(uuid, dstId, newName, categories, keywords, propertyGroups, notes, wiki, security) → {Promise.<any>|Promise.<(*|never)>}
Extended copy of a folder
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 the current categories of the node |
|
keywords |
When true copy the current keywords of the node |
|
propertyGroups |
When true copy the current property groups |
|
notes |
When true copy the current notes |
|
wiki |
When true copy the current wiki |
|
security |
When true copy the current security |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
getChildren(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get children folders
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a parent folder or record |
Returns:
Return a list of folders
- Type
- Promise.<any> | Promise.<(*|never)>
getChildren(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get children folders
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a parent folder or record |
Returns:
Return a list of folders
- Type
- Promise.<any> | Promise.<(*|never)>
getContentInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the folder contentInfo
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a folder node |
Returns:
Return the contentInfo of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
getContentInfo(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the folder contentInfo
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a folder node |
Returns:
Return the contentInfo of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the folder properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a folder node |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
getProperties(uuid) → {Promise.<any>|Promise.<(*|never)>}
Get the folder properties
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of a folder node |
Returns:
Return the properties of a folder
- Type
- Promise.<any> | Promise.<(*|never)>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a folder otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
isValid(uuid) → {Promise.<any>|Promise.<(*|never)>}
Is valid folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the node |
Returns:
Return true when node is a folder otherwise false
- Type
- Promise.<any> | Promise.<(*|never)>
move(uuid, dstId) → {Promise.<*>}
Move a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
move(uuid, dstId) → {Promise.<*>}
Move a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
|
dstId |
The uuid of the destination folder or record |
Returns:
- Return void
- Type
- Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
Returns:
- Type
- Promise.<any> | Promise.<*>
purge(uuid) → {Promise.<any>|Promise.<*>}
Purge folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the folder |
Returns:
- Type
- Promise.<any> | Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the folder |
Returns:
- Return void
- Type
- Promise.<*>
rename(uuid, newName) → {Promise.<*>}
Rename a folder
Parameters:
| Name | Type | Description |
|---|---|---|
uuid |
The uuid of the parent |
|
newName |
The name of the folder |
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.<*>
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.<*>
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 Folder variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |
setToken(token)
Set the token in Folder variables
Parameters:
| Name | Type | Description |
|---|---|---|
token |
The authorization token value |