signactivity.panels.javascript

Interface SignStixStore

SignStixStore

Javascript-to-Player interface for storing data persistently over the lifetime of the player instance. This makes the data potentially accessible by multiple web views across different signs.

A Javascript application should first ask the store to create a dictionary. The JS app can then set/get values within this dictionary. Optionally the dictionary can be explicitly destroyed when the app is finished with it. This is good practice, both for security and memory reasons.

Support for multiple dictionaries allows different web applications to operate on different data sets without interfering with each other.

Function Summary

Modifier and Type	Function and Description
boolean	createDictionary(String dictionaryName) Attempt to create a dictionary with the argument name.
boolean	destroyDictionary(String dictionaryName) Attempt to destroy the dictionary with the argument name.
String	getString(String dictionaryName, String key) Attempt to extract (from the argument dictionary) the string value associated with the argument key.
boolean	isDictionaryPresent(String dictionaryName) Find out if a dictionary with the argument name has been created.
boolean	setString(String dictionaryName, String key, String value) Attempt to set (in the argument dictionary) the string value associated with the argument key.

Function Detail

createDictionary

boolean createDictionary(String dictionaryName)

Attempt to create a dictionary with the argument name.

Parameters:

dictionaryName - name for the new dictionary.

Returns:

true if a dictionary was created. Return false if there was already a dictionary with this name.

Since:

Player 2.10.2

destroyDictionary

boolean destroyDictionary(String dictionaryName)

Attempt to destroy the dictionary with the argument name.

Parameters:

dictionaryName - name of the dictionary (already created).

Returns:

true if a matching dictionary was found and destroyed. Return false if no such dictionary was found.

Since:

Player 2.10.2

isDictionaryPresent

boolean isDictionaryPresent(String dictionaryName)

Find out if a dictionary with the argument name has been created.

Parameters:

dictionaryName - name of the dictionary (which may or may not exist).

Returns:

true if the argument dictionary exists, false otherwise.

Since:

Player 2.10.2

setString

boolean setString(String dictionaryName,
                  String key,
                  String value)

Attempt to set (in the argument dictionary) the string value associated with the argument key.

Parameters:

dictionaryName - name of the dictionary (already created).

key - e.g. 'country'.

value - e.g. 'France'.

Returns:

true if the value was set, or false if the dictionary did not exist.

Since:

Player 2.10.2

getString

String getString(String dictionaryName,
                 String key)

Attempt to extract (from the argument dictionary) the string value associated with the argument key.

Parameters:

dictionaryName - name of the dictionary (already created).

key - e.g. 'country'.

Returns:

the value if it exists, or null if the value does not exist, or the dictionary does not exist.

Since:

Player 2.10.2