Skip to main content
Version: 1.21.3

SimpleStorage

SimpleStorage is an object storage. Just like the Map object in JavaScript, it collects the key-value pairs, where the keys can be of any type.

Use the methods of this class, for example, to manage the data that can be useful for client-side scripts of the widgets or forms in the future. See the code example below:

Example:

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.

Parameter(s):

NameTypeMandatoryDefault value
keyStringYN

Return:

TypeDescription
StringThis method returns a value of the specified key.

Example:

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

hasItem(key)


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

Parameter(s):

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.

Parameter(s):

NameTypeMandatoryDefault 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 key-value.

Return:

TypeDescription
ArrayThis method returns an array of arrays containing the keys names and their values; or 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 that contains values, or an empty array.

Example:

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

getSize()


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

Return:

TypeDescription
IntegerThis method returns the quantity of values in the storage.

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();