data.tags.javascript

Interface SignStixItem

SignStixItem

Javascript-to-Player interface for accessing the player's item database. This is a persistent database which maps from RFID tag data (IDs) to item names, as might be used in a Lift and Learn experience, for example.

In addition, this interface can trigger 'Item Mode' in which a special sign is displayed, guiding the end-user through the process of assigning tags IDs to item names. The user is invited to place the tagged item on an RFID pad when the correct item name is displayed on the screen. The list of item names to choose from is set by calling 'addItemName'. That list is not persistent but does survive until the next device re-boot.

Function Summary

Modifier and Type	Function and Description
void	addItemName(String itemName) Add the argument item name to the list that can be chosen from during 'Item Mode'.
void	clearItemNames() Clear the set of item names that can be chosen from during 'Item Mode'.
void	clearMapping() Clear all the mappings from tags to item names..
String	findItemName(String tagId) Find the item name in the database which corresponds to the argument tagId.
String	getItemNames() Generate a JSON-formatted string containing all the item names that will be available during 'Item Mode'.
String	getMapping() Generate a JSON-formatted string containing all the mappings from tags to item names.
void	setItemName(String tagId, String itemName) Set in the database the item name that corresponds to the argument tag ID.
void	startItemMode() Launch 'Item Mode'.

Function Detail

findItemName

String findItemName(String tagId)

Find the item name in the database which corresponds to the argument tagId.

Parameters:

tagId - the ID from the RFID tag e.g. "EA4B58FE".

Returns:

the corresponding item name, or null if there is no corresponding name.

Since:

Player 3.3.0

setItemName

void setItemName(String tagId,
                 String itemName)

Set in the database the item name that corresponds to the argument tag ID. If there is already an item name for this tag ID, it will be replaced. The resulting change will persist across re-boots.

Parameters:

tagId - the ID from the RFID tag e.g. "EA4B58FE".

itemName - the name of the item that this tag corresponds to e.g. "Blue Plate".

Since:

Player 3.3.0

getMapping

String getMapping()

Generate a JSON-formatted string containing all the mappings from tags to item names. Example JSON return:

         [
     {
             "tagId": "EA4B58FE",
             "itemName": "Blue Plate"
     },
     {
             "tagId": "DA4CCD31",
             "itemName": "Red Saucer"
     },
     ...
   ]
 

Returns:

a JSON-formatted string of all the tags.

Since:

Player 3.3.0

clearMapping

void clearMapping()

Clear all the mappings from tags to item names.. The resulting change will persist across re-boots.

Since:

Player 3.3.0

addItemName

void addItemName(String itemName)

Add the argument item name to the list that can be chosen from during 'Item Mode'. Note that the resulting change is temporary, lasting until the Player is re-booted.

Parameters:

itemName - the item name to make available.

Since:

Player 3.3.0

getItemNames

String getItemNames()

Generate a JSON-formatted string containing all the item names that will be available during 'Item Mode'. Example JSON return:

         [
     "Blue Plate",
     "Red Cup",
     ...
   ]
 

Returns:

a sorted list of item names.

Since:

Player 3.3.0

clearItemNames

void clearItemNames()

Clear the set of item names that can be chosen from during 'Item Mode'.

Since:

Player 3.3.0

startItemMode

void startItemMode()

Launch 'Item Mode'. A special sign will appear, guiding the user through the process of assigning tag IDs to item names. The item names should be set in advance using 'addItemName'. After a timeout, the Player will automatically revert to the content that was playing when the mode was launched.

Since:

Player 3.3.0