Module: siteKiosk.siteRemote.blackboard

A module, which provides access to the SiteRemote blackboard. The blackboard is a key-value store, which synchronizes with the SiteRemote server.

Example

//store the string
siteKiosk.siteRemote.blackboard.set('foo','bar','string');

//load the strings
var entries = siteKiosk.siteRemote.blackboard.getAll('foo');

//do something with the entries

Methods

<static> getAll(keyPrefix) → {Array.<siteKiosk.siteRemote.blackboard~entry>}

Gets all entries with a specified key prefix.
Parameters:
Name Type Description
keyPrefix string The key prefix
Returns:
A set of blackboard entries
Type
Array.<siteKiosk.siteRemote.blackboard~entry>

<static> remove(key)

Removes the specified key and its value from the blackboard.
Parameters:
Name Type Description
key string The key to remove

<static> set(key, value, valueType)

Stores the provided value under the specified key.
Parameters:
Name Type Description
key string The blackboard key under which the value is stored
value * The value of the new entry
valueType string The native type this value will be converted to and stored as

Type Definitions

entry

Represents a blackboard entry.
Properties:
Name Type Description
Key string The blackboard key under which the value is stored
Value * The value of this entry