eSpace Name
ClientStorage_Lib
Description
The library allows interaction with the browser's WebStorage API ( known as localstorage and sessionstorage) through the use of client actions.
Structure to handle the rows inside partition.
Attribute:
Static entities for the storage mode
Values:
Static entity for the storage scope
Note on “ExpireInSeconds”, the clients actions delegated for add/insert operation has a optional parameter that allow to set an expire date for the storage item. If the parameter has default value ( 0 ) the item expire after one year.
Init js object to handle session storage
Input parameters
Name
DataType
Mandatory
Scope
The data separation scope.
KVClientStorageScope Identifier
Yes
Output parameters
StorageObject
The client object that handle session storage operations.
Object
Clear all session storage item based on js object scope configuration.
Add item session storage item based on js object scope configuration.
WARNING : This method insert new item only if the key not exist in the storage. If you need to insert always a value use SessionItemInsertOrUpdate
Key
The key of item in session storage
Text
Payload
The data to save
ExpireInSeconds
The lifespan of item in seconds
Integer
NO
Check if an item with given key exists in storage, based on js object scope configuration.
Exist
Check if item exist
Boolean
Insert a new item or update existing one in session storage based on scope configuration.
Retrieve item with given key in session storage based on scope configuration.
The content of item in session storage
Remove the item with given key in session storage based on scope configuration.
Init js object to handle local storage
The client object that handle local storage operations.
Clear all local storage item based on js object scope configuration.
Add item local storage item based on js object scope configuration.
WARNING : This method insert new item only if the key not exist in the storage. If you need to insert always a value use LocalItemInsertOrUpdate
The key of item in local storage
Insert a new item or update existing one in local storage based on scope configuration.
Retrieve item with given key in local storage based on scope configuration.
The content of item in local storage
Remove the item with given key in local storage based on scope configuration.
Init js object to handle keyvalue storage
Mode
The target storage
KVClientStorageMode Identifier
The data separation scope
The client object that handle partitions and rows.
StorageObject The client object that handle partitions and rows. Object
Clear the values inside a partition
PartitionKey
The key/name of partition
Clear a specific partition
Retrieve all partiations names
PartitionKeysList
The list of partitions
Text List
Remove All Partitions
Add a row inside a partition
The key of partition
RowKey
The key of the row
The lifespan of row in seconds
No
Delete a row inside a partition
Check if the row with given key exist
Check if the the row exist
Insert a new row or update an existing one in a specific partition.
Read a row in a partition.
The data to retrieve
Read all rows inside a partition.
Rows
The rows inside the partition
KVStoragePartitionRows List