You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

SimpleStorage is an object storage. Just like the Map object in JavaScript, it is a collection of keys (or values), where the keys can be of any type.

Use the methods of this class, for example, in the widget client scripts to operate the objects. See the code example below:

Storage usage
if (SimpleStorage.hasItem('portalLogo')) {
  s_widget.setFieldValue("HasLogo", true);
  s_widget.setFieldValue("logo", SimpleStorage.getItem("portalLogo"));
} else {
  await s_widget.serverUpdate();
  SimpleStorage.setItem('portalLogo', s_widget.getFieldValue("logo"));
}


getItem(key)


Use this method to get a value based on the key.

NameTypeMandatoryDefault Value
keyStringYN


Return:

TypeDescription
StringThis method returns an item specified by a key.


Example:

getItem
SimpleStorage.getItem('name'); // "Adam"

hasItem(key)


Use this method to check if there is a key in the storage.

Parameter:

NameTypeMandatoryDefault value
keyAnyYN


Return:

TypeDescription
BooleanThis method returns 'true' if the key specified in the key parameter was found; otherwise, it returns 'false'.


Example:

hasItem
SimpleStorage.hasItem('name'); //  true

setItem(key, value)


Use this method to set a value based on a key.

Parameters:

Name

TypeMandatoryDefault Value
keyStringYN
valueAnyYN


Return:

TypeDescription
VoidThis method does not return a value.


Example:

setItem
SimpleStorage.setItem('name', 'Adam')


getEntries()


Use this method to get an array of pairs (value, key).

TypeDescription
ArrayThis method returns an array containing value pairs; otherwise, it returns an empty array.

Example:

getEntries
SimpleStorage.getEntries(); //  [["name", "Adam"],[ ["secondName", "Smith"]]]

getKeys()


Use this method to get an array of keys.

Return:

TypeDescription
ArrayThis method returns an array containing values; otherwise, it returns an empty array.

Example:

getKeys
SimpleStorage.getKeys(); //  ["name", "secondName"]

getSize()


Use this method to get the amount of the values stored.

Example:

getSize
SimpleStorage.getSize(); //  2

reset()


Use this method to empty the storage.

Return:

TypeDescription
VoidThis method does not return a value.

Example:

reset
SimpleStorage.reset();

  • No labels