Constructor
new Repository(opts)
Creates a Repository
Parameters:
Name | Type | Description |
---|---|---|
opts |
object | The configuration options. |
Methods
getAppLicense() → {Promise.<any>|Promise.<*>}
Get information license info
Returns:
Return license info
- Type
- Promise.<any> | Promise.<*>
getAppLicense() → {Promise.<any>|Promise.<*>}
Get information license info
Returns:
Return license info
- Type
- Promise.<any> | Promise.<*>
getAppVersion() → {Promise.<any>|Promise.<*>}
Get information about the version of the application
Returns:
Return the application version information
- Type
- Promise.<any> | Promise.<*>
getAppVersion() → {Promise.<any>|Promise.<*>}
Get information about the version of the application
Returns:
Return the application version information
- Type
- Promise.<any> | Promise.<*>
getAvailableLocales(locale) → {Promise.<any>|Promise.<(*|never)>}
Return a list of available locales
Parameters:
Name | Type | Description |
---|---|---|
locale |
The locale id ( value should be ISO369-1 code ) |
Returns:
Return a list of AvailableLocale {code, name}
- Type
- Promise.<any> | Promise.<(*|never)>
getAvailableLocales(locale) → {Promise.<any>|Promise.<(*|never)>}
Return a list of available locales
Parameters:
Name | Type | Description |
---|---|---|
locale |
The locale id ( value should be ISO369-1 code ) |
Returns:
Return a list of AvailableLocale {code, name}
- Type
- Promise.<any> | Promise.<(*|never)>
getCategoriesFolder() → {Promise.<*>}
Get categories folder
Returns:
- Return the categories folder node
- Type
- Promise.<*>
getCategoriesFolder() → {Promise.<*>}
Get categories folder
Returns:
- Return the categories folder node
- Type
- Promise.<*>
getClusterUuid() → {Promise.<any>|Promise.<*>}
Get the cluster UUID
Returns:
Return the application cluster uuid
- Type
- Promise.<any> | Promise.<*>
getClusterUuid() → {Promise.<any>|Promise.<*>}
Get the cluster UUID
Returns:
Return the application cluster uuid
- Type
- Promise.<any> | Promise.<*>
getConfiguration(key) → {Promise.<*>}
Get configuration
Parameters:
Name | Type | Description |
---|---|---|
key |
The key of the configuration |
Returns:
- Return Return the configuration by key
- Type
- Promise.<*>
getConfiguration(key) → {Promise.<*>}
Get configuration
Parameters:
Name | Type | Description |
---|---|---|
key |
The key of the configuration |
Returns:
- Return Return the configuration by key
- Type
- Promise.<*>
getDecimalPattern() → {Promise.<any>|Promise.<*>}
Get the decimal pattern
Returns:
Return the application decimal pattern
- Type
- Promise.<any> | Promise.<*>
getDecimalPattern() → {Promise.<any>|Promise.<*>}
Get the decimal pattern
Returns:
Return the application decimal pattern
- Type
- Promise.<any> | Promise.<*>
getExtensionInfo(uuids) → {Promise.<any>|Promise.<*>}
Get information about registered extensions
Parameters:
Name | Type | Description |
---|---|---|
uuids |
The list of extension uuid |
Returns:
Return extension info
- Type
- Promise.<any> | Promise.<*>
getExtensionInfo(uuids) → {Promise.<any>|Promise.<*>}
Get information about registered extensions
Parameters:
Name | Type | Description |
---|---|---|
uuids |
The list of extension uuid |
Returns:
Return extension info
- Type
- Promise.<any> | Promise.<*>
getFilePlan() → {Promise.<any>|Promise.<*>}
Get file plan configuration
Returns:
Return true when file plan is enabled
- Type
- Promise.<any> | Promise.<*>
getFilePlan() → {Promise.<any>|Promise.<*>}
Get file plan configuration
Returns:
Return true when file plan is enabled
- Type
- Promise.<any> | Promise.<*>
getLanguages(module) → {Promise.<(*|never)>}
Get available languages by module
Parameters:
Name | Type | Description |
---|---|---|
module |
The module id |
Returns:
- Type
- Promise.<(*|never)>
getLanguages(module) → {Promise.<(*|never)>}
Get available languages by module
Parameters:
Name | Type | Description |
---|---|---|
module |
The module id |
Returns:
- Type
- Promise.<(*|never)>
getMailFolder() → {Promise.<*>}
Get mail folder
Returns:
- Return the mail folder node
- Type
- Promise.<*>
getMailFolder() → {Promise.<*>}
Get mail folder
Returns:
- Return the mail folder node
- Type
- Promise.<*>
getMailFolderBase() → {Promise.<*>}
Get mail folder base
Returns:
- Return the mail folder base node
- Type
- Promise.<*>
getMailFolderBase() → {Promise.<*>}
Get mail folder base
Returns:
- Return the mail folder base node
- Type
- Promise.<*>
getNodePath(uuid) → {Promise.<any>|Promise.<(*|never)>}
Return the path of a node
Parameters:
Name | Type | Description |
---|---|---|
uuid |
The uuid of the node |
Returns:
Return the path of the node
- Type
- Promise.<any> | Promise.<(*|never)>
getNodePath(uuid) → {Promise.<any>|Promise.<(*|never)>}
Return the path of a node
Parameters:
Name | Type | Description |
---|---|---|
uuid |
The uuid of the node |
Returns:
Return the path of the node
- Type
- Promise.<any> | Promise.<(*|never)>
getNodeUuid(nodePath) → {Promise.<any>|Promise.<*>}
Return the uuid of a node
Parameters:
Name | Type | Description |
---|---|---|
nodePath |
The path of the node |
Returns:
Return the uuid of the node
- Type
- Promise.<any> | Promise.<*>
getNodeUuid(nodePath) → {Promise.<any>|Promise.<*>}
Return the uuid of a node
Parameters:
Name | Type | Description |
---|---|---|
nodePath |
The path of the node |
Returns:
Return the uuid of the node
- Type
- Promise.<any> | Promise.<*>
getPersonalFolder() → {Promise.<*>}
Get personal folder
Returns:
- Return the personal folder node
- Type
- Promise.<*>
getPersonalFolder() → {Promise.<*>}
Get personal folder
Returns:
- Return the personal folder node
- Type
- Promise.<*>
getPersonalFolderBase() → {Promise.<*>}
Get personal folder base
Returns:
- Return the personal folder base node
- Type
- Promise.<*>
getPersonalFolderBase() → {Promise.<*>}
Get personal folder base
Returns:
- Return the personal folder base node
- Type
- Promise.<*>
getRootFolder() → {Promise.<*>}
Get root folder
Returns:
- Return the root folder node
- Type
- Promise.<*>
getRootFolder() → {Promise.<*>}
Get root folder
Returns:
- Return the root folder node
- Type
- Promise.<*>
getTemplatesFolder() → {Promise.<*>}
Get templates folder
Returns:
- Return the templates folder node
- Type
- Promise.<*>
getTemplatesFolder() → {Promise.<*>}
Get templates folder
Returns:
- Return the templates folder node
- Type
- Promise.<*>
getTranslations(lang, module) → {Promise.<(*|never)>}
Get available translations by language and module
Parameters:
Name | Type | Description |
---|---|---|
lang |
The language id |
|
module |
The module id |
Returns:
- Type
- Promise.<(*|never)>
getTranslations(lang, module) → {Promise.<(*|never)>}
Get available translations by language and module
Parameters:
Name | Type | Description |
---|---|---|
lang |
The language id |
|
module |
The module id |
Returns:
- Type
- Promise.<(*|never)>
getTrashFolder() → {Promise.<*>}
Get trash folder
Returns:
- Return the trash folder node
- Type
- Promise.<*>
getTrashFolder() → {Promise.<*>}
Get trash folder
Returns:
- Return the trash folder node
- Type
- Promise.<*>
getTrashFolderBase() → {Promise.<*>}
Get trash folder base
Returns:
- Return the trash folder base node
- Type
- Promise.<*>
getTrashFolderBase() → {Promise.<*>}
Get trash folder base
Returns:
- Return the trash folder base node
- Type
- Promise.<*>
hasNode(nodeId) → {Promise.<any>|Promise.<(*|never)>}
Check if a node exist
Parameters:
Name | Type | Description |
---|---|---|
nodeId |
The uuid or path of a node |
Returns:
Return true when node exist
- Type
- Promise.<any> | Promise.<(*|never)>
hasNode(nodeId) → {Promise.<any>|Promise.<(*|never)>}
Check if a node exist
Parameters:
Name | Type | Description |
---|---|---|
nodeId |
The uuid or path of a node |
Returns:
Return true when node exist
- Type
- Promise.<any> | Promise.<(*|never)>
purgeTrash() → {Promise.<*>}
Purge trash
Returns:
- Type
- Promise.<*>
purgeTrash() → {Promise.<*>}
Purge trash
Returns:
- 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 |