applicationStorage
Summary
Application storage is a global storage for core and plugins, to be able to share information between both core and plugins.
Information stored in the application storage must be limited.
Item Index
Methods
getAnonymousUserId
Syntax
Summary
Gets the id of the anonymous user.
Returns:
The super administrator id
Example:
var api = require('@openveo/api');
api.applicationStorage.getAnonymousUserId();getDatabase
Syntax
Summary
Gets the current database instance.
Returns:
A Database object
Example:
var api = require('@openveo/api');
api.applicationStorage.getDatabase();getEntities
Syntax
Summary
Gets the list of entities defined by both core and loaded plugins.
Returns:
entities
Example:
var api = require('@openveo/api');
api.applicationStorage.getEntities();getMenu
Syntax
Summary
Gets the computed back office menu with all links.
Returns:
The list of back office links
Example:
var api = require('@openveo/api');
api.applicationStorage.getMenu();getPermissions
Syntax
Summary
Gets the list of permissions defined by core and plugins.
Returns:
permissions
Example:
var api = require('@openveo/api');
api.applicationStorage.getPermissions();getPlugins
Syntax
Summary
Gets the list of loaded openveo plugins.
Returns:
The list of loaded plugins
Example:
var api = require('@openveo/api');
api.applicationStorage.getPlugins();getSuperAdminId
Syntax
Summary
Gets the id of the super administrator.
Returns:
The super administrator id
Example:
var api = require('@openveo/api');
api.applicationStorage.getSuperAdminId();getWebServiceScopes
Syntax
Summary
Gets the list of web service scopes defined by core and plugins.
Returns:
scopes
Example:
var api = require('@openveo/api');
api.applicationStorage.getWebServiceScopes();setAnonymousUserId
Syntax
setAnonymousUserId
-
id
Summary
Sets the id of the anonymous user.
It can be set only once.
Parameters:
-
idStringThe id of the anonymous user
setDatabase
Syntax
setDatabase
-
newDatabase
Summary
Sets a new database instance as the current database.
Parameters:
-
newDatabaseDatabaseThe new database of the application
setEntities
Syntax
setEntities
-
newEntities
Summary
Sets the list of entities.
Parameters:
-
newEntitiesObjectThe list of entities
setMenu
Syntax
setMenu
-
newMenu
Summary
Sets the back office menu list of links.
Parameters:
-
newMenuArrayThe list of back office menu links
setPermissions
Syntax
setPermissions
-
permissions
Summary
Sets the list of permissions.
Parameters:
-
permissionsObjectThe new list of permissions
setPlugins
Syntax
setPlugins
-
subPlugins
Summary
Sets the list of openveo plugins.
Parameters:
-
subPluginsArrayThe list of plugins
setSuperAdminId
Syntax
setSuperAdminId
-
id
Summary
Sets the id of the super administrator.
It can be set only once.
Parameters:
-
idStringThe id of the super administrator
setWebServiceScopes
Syntax
setWebServiceScopes
-
newScopes
Summary
Sets the web service list of scopes.
Parameters:
-
newScopesObjectThe new list of scopes of the web service