Component instantiation

Each category of component can be manipulated using the JS API through a specific object. The following constructors can be used to instantiate a component:

var newDocument = new Document();
var newTask = new Task();
var newFolder = new Folder();
var newVFolder = new VirtualFolder();

Each of these objects has its own functions:

• common to all components
• specific to a component category

Access to internal information

Several pieces of information are maintained by the FlowerDocs platform for internal purposes. Depending on the information, the following functions are available to access or modify it (when modification is authorised):

Tags management

The tags of a component can be manipulated via the JS API using several functions. The getTags() function can be used to determine the tags already present on a component by returning an array containing the names of each of the component’s tags.

Adding or modifying a tag

To add a tag to a component, use the addTag(name, value, readonly) function. The second parameter value can be a character string or an array of strings to define multiple values.

Using this function for a tag already present on the component overwrites existing values. It can be used to modify tag values.

The third parameter readonly is a Boolean indicating whether the tag should be displayed as read-only or not.

Tag recovery

To access the values of a tag present on a component, the functions getTagValue(name) and getTagValues(name) are exposed on the component object. The first returns the first value of a tag (character string), while the second returns an array containing all the values of a tag.

var task = new Task();
task.addTag("Amount", "1234", false);
if(task.getTags().includes("Amount")){
    console.info('The amount is ' + task.getTagValue("Amount"));
}