Item

Members

descendents :Array:.<Item:>

Description:

• All descendents of the current group Item (as returned by 'getAllMembers()'). Must be a group Item.

Source:

• items/items.js, line 245

Type:

• Array:.<Item:>

groupNames

Description:

• Gets the names of the groups this Item is member of.

Source:

• items/items.js, line 500

isUninitialized :boolean

Description:

• Whether this Item is uninitialized (true if it has not been initialized).

Source:

• items/items.js, line 253

Type:

• boolean

label :string

Description:

• Label attached to Item

Source:

• items/items.js, line 125

Type:

• string

lastStateChangeInstant :time.Instant|null

Description:

• The time the state was last changed as Instant or null if no timestamp is available.

Source:

• items/items.js, line 227

Type:

• time.Instant | null

lastStateChangeTimestamp :time.ZonedDateTime|null

Description:

• The time the state was last changed as ZonedDateTime or null if no timestamp is available.

Source:

• items/items.js, line 217

Type:

• time.ZonedDateTime | null

lastStateUpdateInstant :time.Instant|null

Description:

• The time the state was last updated as Instant or null if no timestamp is available.

Source:

• items/items.js, line 207

Type:

• time.Instant | null

lastStateUpdateTimestamp :time.ZonedDateTime|null

Description:

• The time the state was last updated as ZonedDateTime or null if no timestamp is available.

Source:

• items/items.js, line 197

Type:

• time.ZonedDateTime | null

members :Array:.<Item:>

Description:

• Members / children / direct descendents of the current group Item (as returned by 'getMembers()'). Must be a group Item.

Source:

• items/items.js, line 237

Type:

• Array:.<Item:>

name :string

Description:

• Name of Item

Source:

• items/items.js, line 117

Type:

• string

numericState :number|null

Description:

• Numeric representation of Item state, or null if state is not numeric

Source:

• items/items.js, line 141

Type:

• number | null

persistence :ItemPersistence

Description:

• Access historical states for this Item items.ItemPersistence

Source:

• items/items.js, line 96

Type:

• ItemPersistence

previousNumericState :number|null

Description:

• Numeric representation of Item previous state, or null if state is not numeric or not available.

Source:

• items/items.js, line 173

Type:

• number | null

previousQuantityState :Quantity|null

Description:

• Previous item state as Quantity or null if state is not Quantity-compatible, Quantity would be unit-less (without unit) or not available.

Source:

• items/items.js, line 181

Type:

• Quantity | null

previousRawState :HostState|null

Description:

• Previous raw state of Item, as a Java State object or null if previous state not available.

Source:

• items/items.js, line 189

Type:

• HostState | null

previousState :string|null

Description:

• String representation of the previous state of the Item or null if no previous state is available.

Source:

• items/items.js, line 165

Type:

• string | null

quantityState :Quantity|null

Description:

• Item state as Quantity or null if state is not Quantity-compatible or Quantity would be unit-less (without unit)

Source:

• items/items.js, line 149

Type:

• Quantity | null

rawItem :HostItem

Description:

• raw Java Item

Source:

• items/items.js, line 90

Type:

• HostItem

rawState :HostState

Description:

• Raw state of Item, as a Java State object

Source:

• items/items.js, line 157

Type:

• HostState

semantics :ItemSemantics

Description:

• Access Semantic information of this Item items.ItemSemantics

Source:

• items/items.js, line 102

Type:

• ItemSemantics

state :string

Description:

• String representation of the Item state.

Source:

• items/items.js, line 133

Type:

• string

tags :Array:.<string:>

Description:

• Gets the tags from this Item

Source:

• items/items.js, line 530

Type:

• Array:.<string:>

type :string

Description:

• Type of Item: the Simple (without package) name of the Java Item type, such as 'Switch'.

Source:

• items/items.js, line 109

Type:

• string

Methods

addGroups(…groupNamesOrItems)

Description:

• Adds groups to this Item

Source:

• items/items.js, line 508

Parameters:

addTags(…tagNames)

Description:

• Adds tags to this Item

Source:

• items/items.js, line 538

Parameters:

getMetadata(namespaceopt) → {Object|ItemMetadata|null}

Description:

• Gets metadata of a single namespace or of all namespaces from this Item.

Source:

• items/items.js, line 274

See:

• items.metadata.getMetadata

Example

// Get metadata of ALL namespaces
var meta = Item.getMetadata();
var namespaces = Object.keys(meta); // Get metadata namespaces
// Get metadata of a single namespace
meta = Item.getMetadata('expire');

Parameters:

Returns:

Type

Object | ItemMetadata | null

postToggleUpdate()

Description:

• Posts an update to flip the Item's state (e.g. if it is 'ON' an 'OFF' update is posted).

Source:

• items/items.js, line 481

Throws:

postUpdate(value)

Description:

• Posts an update to the Item.

Source:

• items/items.js, line 492

See:

• postToggleUpdate
• sendCommand

Parameters:

removeGroups(…groupNamesOrItems)

Description:

• Removes groups from this Item

Source:

• items/items.js, line 518

Parameters:

removeMetadata(namespaceopt) → {ItemMetadata|null}

Description:

• Removes metadata of a single namespace or of all namespaces from a given Item.

Source:

• items/items.js, line 300

See:

• items.metadata.removeMetadata

Parameters:

Returns:

Type

ItemMetadata | null

removeTags(…tagNames)

Description:

• Removes tags from this Item

Source:

• items/items.js, line 547

Parameters:

replaceMetadata(namespace, value, configurationopt) → {ItemMetadata|null}

Description:

• Updates or adds metadata of a single namespace to this Item.

  If metadata is not provided by this script or the ManagedMetadataProvider, it is not editable and a warning is logged.

Source:

• items/items.js, line 289

See:

• items.metadata.replaceMetadata

Parameters:

Returns:

Type

ItemMetadata | null

sendCommand(value, expireopt, onExpireopt)

Description:

• Sends a command to the Item.

Source:

• items/items.js, line 321

See:

• sendCommandIfDifferent
• postUpdate

Example

// Turn on the Hallway lights
items.getItem('HallwayLight').sendCommand('ON');
// Turn on the Hallway lights for at least 5 minutes, if they were on before, keep them on, otherwise turn them off
items.getItem('HallwayLight').sendCommand('ON', time.Duration.ofMinutes(5));
// Turn on the Hallway lights for 5 minutes, then turn them off
items.getItem('HallwayLight').sendCommand('ON', time.Duration.ofMinutes(5), 'OFF');

Parameters:

sendCommandIfDifferent(value) → {boolean}

Description:

• Sends a command to the Item, but only if the current state is not what is being sent.

Source:

• items/items.js, line 346

See:

• sendCommand

Parameters:

Returns:

Type

boolean

sendDecreaseCommand(value) → {boolean}

Description:

• Decreases the value of this Item to the given value by sending a command, but only if the current state is greater than that value.

Source:

• items/items.js, line 414

Parameters:

Returns:

Type

boolean

sendIncreaseCommand(value) → {boolean}

Description:

• Increase the value of this Item to the given value by sending a command, but only if the current state is less than that value.

Source:

• items/items.js, line 385

Parameters:

Returns:

Type

boolean

sendToggleCommand()

Description:

• Sends a command to flip the Item's state (e.g. if it is 'ON' an 'OFF' command is sent).

Source:

• items/items.js, line 469

Throws: