Set session state
Syntax
$value.storeInSession(key: "my-prop-1", persistent: true)
Description
Saves a value in the user session. If persistent
is set to false
, the value is lost after the user logs out. With persistent: true
, the value is saved under the specified key in the user's personal settings and is still available after a new login.
Parameters
Parameter Name | Type | Type Description | Mandatory | Default |
---|---|---|---|---|
value | Number, character string, truth value, specialized object or list of these values | The value to be saved | Yes | - |
key | Character string | Key under which the value is saved in the session or the user's personal settings. | yes | - |
persistent | Truth value | Whether the value should be retained after a logout/login of the user. | no | false |
Return value
Type: Number, character string, truth value, specialized object or list of these values
The value that was previously saved under the specified key.