Class: PropertyGroup

PropertyGroup(opts)

The PropertyGroup class wraps property group operations

Cannot directly be instantiated

Constructor

new PropertyGroup(opts)

Creates a PropertyGroup

Parameters:
Name Type Description
opts object

The configuration options.

Methods

addGroup(uuid, grpName, properties) → {Promise.<any>}

Add property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

addGroup(uuid, grpName, properties) → {Promise.<any>}

Add property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

getAllGroups() → {Promise.<(*|never)>}

Return a list with all property groups available to the user

Returns:

A list of property groups

Type
Promise.<(*|never)>

getAllGroups() → {Promise.<(*|never)>}

Return a list with all property groups available to the user

Returns:

A list of property groups

Type
Promise.<(*|never)>

getGroup(grpName) → {Promise.<any>|Promise.<*>}

Return the property group definition

Parameters:
Name Type Description
grpName

The group name

Returns:

Return the property group definition

Type
Promise.<any> | Promise.<*>

getGroup(grpName) → {Promise.<any>|Promise.<*>}

Return the property group definition

Parameters:
Name Type Description
grpName

The group name

Returns:

Return the property group definition

Type
Promise.<any> | Promise.<*>

getGroups(uuid) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of a node

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

A list of property group of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroups(uuid) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of a node

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

A list of property group of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroupsByVersion(uuid, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of an specific version of the node

Parameters:
Name Type Description
uuid

The uuid of a node

versionName

The version name

Returns:

A list of property group of an specific version of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroupsByVersion(uuid, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of an specific version of the node

Parameters:
Name Type Description
uuid

The uuid of a node

versionName

The version name

Returns:

A list of property group of an specific version of the node

Type
Promise.<any> | Promise.<(*|never)>

getProperties(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group values of the node

Type
Promise.<any> | Promise.<(*|never)>

getProperties(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertiesByVersionForm(uuid, grpName, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of an specific version of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

versionName

The version name of a node

Returns:

A list of property group formElment values of a specific version of a node

Type
Promise.<any> | Promise.<(*|never)>

getPropertiesByVersionForm(uuid, grpName, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of an specific version of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

versionName

The version name of a node

Returns:

A list of property group formElment values of a specific version of a node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupForm(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group formElment values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupForm(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group formElment values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupFormDefinition(grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement definition

Parameters:
Name Type Description
grpName

The name of the group

Returns:

A list of property group formElement definition

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupFormDefinition(grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement definition

Parameters:
Name Type Description
grpName

The name of the group

Returns:

A list of property group formElement definition

Type
Promise.<any> | Promise.<(*|never)>

getSuggestBoxKeyValue(grpName, propertyName, key) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

key

The key value

Returns:

Return the KeyValue of the key

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValue(grpName, propertyName, key) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

key

The key value

Returns:

Return the KeyValue of the key

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValuesFiltered(grpName, propertyName, filter) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

filter

The filter value

Returns:

Return a list of KeyValues filtered

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValuesFiltered(grpName, propertyName, filter) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

filter

The filter value

Returns:

Return a list of KeyValues filtered

Type
Promise.<any> | Promise.<*>

hasGroup(uuid, grpName) → {Promise.<any>|Promise.<*>}

Check if the node has the metadata group

Parameters:
Name Type Description
uuid

The uuid of the node

grpName

The group id

Returns:

Return true when the node has the metadata group

Type
Promise.<any> | Promise.<*>

hasGroup(uuid, grpName) → {Promise.<any>|Promise.<*>}

Check if the node has the metadata group

Parameters:
Name Type Description
uuid

The uuid of the node

grpName

The group id

Returns:

Return true when the node has the metadata group

Type
Promise.<any> | Promise.<*>

removeGroup(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Remove property group

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

Returns:
Type
Promise.<any> | Promise.<(*|never)>

removeGroup(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Remove property group

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

Returns:
Type
Promise.<any> | Promise.<(*|never)>

setProperties(uuid, grpName, properties) → {Promise.<any>}

Update property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

setProperties(uuid, grpName, properties) → {Promise.<any>}

Update property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

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

PropertyGroup(opts)

The PropertyGroup class wraps property group operations

Cannot directly be instantiated

Constructor

new PropertyGroup(opts)

Creates a PropertyGroup

Parameters:
Name Type Description
opts object

The configuration options.

Methods

addGroup(uuid, grpName, properties) → {Promise.<any>}

Add property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

addGroup(uuid, grpName, properties) → {Promise.<any>}

Add property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

getAllGroups() → {Promise.<(*|never)>}

Return a list with all property groups available to the user

Returns:

A list of property groups

Type
Promise.<(*|never)>

getAllGroups() → {Promise.<(*|never)>}

Return a list with all property groups available to the user

Returns:

A list of property groups

Type
Promise.<(*|never)>

getGroup(grpName) → {Promise.<any>|Promise.<*>}

Return the property group definition

Parameters:
Name Type Description
grpName

The group name

Returns:

Return the property group definition

Type
Promise.<any> | Promise.<*>

getGroup(grpName) → {Promise.<any>|Promise.<*>}

Return the property group definition

Parameters:
Name Type Description
grpName

The group name

Returns:

Return the property group definition

Type
Promise.<any> | Promise.<*>

getGroups(uuid) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of a node

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

A list of property group of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroups(uuid) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of a node

Parameters:
Name Type Description
uuid

The uuid of a node

Returns:

A list of property group of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroupsByVersion(uuid, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of an specific version of the node

Parameters:
Name Type Description
uuid

The uuid of a node

versionName

The version name

Returns:

A list of property group of an specific version of the node

Type
Promise.<any> | Promise.<(*|never)>

getGroupsByVersion(uuid, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group of an specific version of the node

Parameters:
Name Type Description
uuid

The uuid of a node

versionName

The version name

Returns:

A list of property group of an specific version of the node

Type
Promise.<any> | Promise.<(*|never)>

getProperties(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group values of the node

Type
Promise.<any> | Promise.<(*|never)>

getProperties(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertiesByVersionForm(uuid, grpName, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of an specific version of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

versionName

The version name of a node

Returns:

A list of property group formElment values of a specific version of a node

Type
Promise.<any> | Promise.<(*|never)>

getPropertiesByVersionForm(uuid, grpName, versionName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of an specific version of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

versionName

The version name of a node

Returns:

A list of property group formElment values of a specific version of a node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupForm(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group formElment values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupForm(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement values of a node

Parameters:
Name Type Description
uuid

The uuid of a node

grpName

The name of the group

Returns:

A list of property group formElment values of the node

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupFormDefinition(grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement definition

Parameters:
Name Type Description
grpName

The name of the group

Returns:

A list of property group formElement definition

Type
Promise.<any> | Promise.<(*|never)>

getPropertyGroupFormDefinition(grpName) → {Promise.<any>|Promise.<(*|never)>}

Return a list with the property group formElement definition

Parameters:
Name Type Description
grpName

The name of the group

Returns:

A list of property group formElement definition

Type
Promise.<any> | Promise.<(*|never)>

getSuggestBoxKeyValue(grpName, propertyName, key) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

key

The key value

Returns:

Return the KeyValue of the key

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValue(grpName, propertyName, key) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

key

The key value

Returns:

Return the KeyValue of the key

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValuesFiltered(grpName, propertyName, filter) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

filter

The filter value

Returns:

Return a list of KeyValues filtered

Type
Promise.<any> | Promise.<*>

getSuggestBoxKeyValuesFiltered(grpName, propertyName, filter) → {Promise.<any>|Promise.<*>}

Get the KeyValue of a suggestbox

Parameters:
Name Type Description
grpName

The group id

propertyName

The property id

filter

The filter value

Returns:

Return a list of KeyValues filtered

Type
Promise.<any> | Promise.<*>

hasGroup(uuid, grpName) → {Promise.<any>|Promise.<*>}

Check if the node has the metadata group

Parameters:
Name Type Description
uuid

The uuid of the node

grpName

The group id

Returns:

Return true when the node has the metadata group

Type
Promise.<any> | Promise.<*>

hasGroup(uuid, grpName) → {Promise.<any>|Promise.<*>}

Check if the node has the metadata group

Parameters:
Name Type Description
uuid

The uuid of the node

grpName

The group id

Returns:

Return true when the node has the metadata group

Type
Promise.<any> | Promise.<*>

removeGroup(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Remove property group

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

Returns:
Type
Promise.<any> | Promise.<(*|never)>

removeGroup(uuid, grpName) → {Promise.<any>|Promise.<(*|never)>}

Remove property group

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

Returns:
Type
Promise.<any> | Promise.<(*|never)>

setProperties(uuid, grpName, properties) → {Promise.<any>}

Update property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

setProperties(uuid, grpName, properties) → {Promise.<any>}

Update property group properties

Parameters:
Name Type Description
uuid

The UUID of the node

grpName

The name of the group

properties
Returns:
Type
Promise.<any>

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