Class: TimedTagUpdater

plugins/interval-updater~TimedTagUpdater()

new TimedTagUpdater()

Creates the updater instance.

Source:

Methods

addTags(tags) → {module:plugins/interval-updater~TimedTagUpdater}

Adds the given tags to the ones to be updated by this updater. If the update loop is already running (because startUpdateLoop() was called), the tag will start auto-updating.

Adding the same (determined by identity) object again has no effect. However, an object that represents the same tag as one already added (i.e., has the same uuid property value) will be registered for updates, too.

Parameters:
Name Type Description
tags WirelessTag | Array.<WirelessTag>

the tags (or the tag) to be updated

Source:
Returns:
Type
module:plugins/interval-updater~TimedTagUpdater

removeTags(tags) → {module:plugins/interval-updater~TimedTagUpdater}

Removes the given tag object(s) from the ones to be updated by this updater. If the update loop is already running (because startUpdateLoop() was called) and a tag object was previously registered, it will stop auto-updating.

Note that only the given object(s) will be removed. Specifically, other tag objects with the same uuid property value, if previously added, remain registered.

Parameters:
Name Type Description
tags WirelessTag | Array.<WirelessTag>

the tag object(s) to be removed from updating

Source:
Returns:
Type
module:plugins/interval-updater~TimedTagUpdater

startUpdateLoop()

Starts the continuous update loop. Registered tags will get updated until they are removed, or stopUpdateLoop() is called.

Has no effect if a continuous update loop is already running.

Source:

stopUpdateLoop()

Stops the continuous update loop. Has no effect if an update loop is not currently active.

Source: