metadata

metadata

Source:

Items' metadata namespace. This namespace provides access to metadata on items.

Methods

Source:

Adds (inserts) or updates an Item channel link.

Parameters:
Name Type Attributes Description
itemName string

the name of the Item

channel string

channelUID as string

conf Map.<String, String> <optional>

Map of channel configuration

Returns:

true if the channel link was added, false if it was updated

Source:

Removes an ItemChannelLink from the provider. Therefore, the channel link is removed from the Item.

Parameters:
Name Type Description
itemName string

the name of the Item

channel string

channelUID as string

Returns:

the removed ItemChannelLink

Type
ItemChannelLink

(static) getValue(itemName, namespace) → {String|null}

Source:

This function will return the Metadata object associated with the specified Item.

Parameters:
Name Type Description
itemName string

name of the Item

namespace string

name of the namespace

Returns:

the metadata as a string, or null

Type
String | null

(static) upsertValue(itemName, namespace, value, configopt) → {boolean}

Source:

Adds (inserts) or updates a metadata value.

Parameters:
Name Type Attributes Description
itemName string

the name of the Item

namespace string

the name of the namespace

value string

the value to insert or update

config Map.<String, String> <optional>

configuration of namespace

Returns:

true if the value was added, false if it was updated

Type
boolean