Docs
- Home
-
Quick Index
- Introduction
- ColdBox Overview
- Directory Layout & Conventions
- Request Life Cycles
- Application Bootstrapper
- Configuring
- Application Configuration
- Using configuration settings
- Fun Logging with LogBox
- Models
- ColdBox Models
- Dependency Injection via WireBox
- Active Entity
- Built-in ORM Services
- Hibernate Criteria Builder
- ORM Event Handling
- Views
- Layouts and Rendering in ColdBox
- Controllers
- Event Handlers
- ColdBox SES URL Mappings
- Object and Form Validation
- Request Context
- Request Context
- Extending the Request Context
- Tumble Down The Rabbit Hole...
- Flash RAM & Webflows
- Ajax Integration
- Powering Flex/Air/SOAP/REST Apps
- Caching with CacheBox
- Localization & i18n
- ColdBox Security
- Aspect Oriented Programming
- ColdBox Recipes
- Extending ColdBox
- ColdBox Modules & Architecture
- ColdBox Plugins
- Core Plugins Browser
- ColdBox Interceptors
- Core Interceptors Browser
- Testing
- Testing ColdBox Applications
- Mocking-Stubbing with MockBox
- Tools, IDE Extras
- ColdBox Platform Utilities
- IDE Syntax Dictionaries
- Standalone Projects
- ColdBox Cheatsheet
- API Docs
- Directory
SideBar
User Login 
Plugins:SessionStorage
last edited by
lmajano
on 11-Apr-2010
lmajano
on 11-Apr-2010
|
Exploring the SessionStorage Plugin
Overview
Session Storage plugin. It provides the user with a mechanism for permanent data storage using the session scope.
setVar
Set a new permanent variable.
Returns
- This function returns void
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | --- | The name of the variable. |
| value | any | Yes | --- | The value to set in the variable. |
Examples
getVar
Get a new permanent variable. If the variable does not exist. The method returns blank.
Returns
- This function returns any
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | --- | The variable name to retrieve. |
| default | any | No | The default value to set. If not used, a blank is returned. |
Examples
removeStorage
remove the entire storage scope
Returns
- This function returns void
Examples
exists
Checks wether the permanent variable exists.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | --- | The variable name to retrieve. |
Examples
clearAll
Clear the entire coldbox session storage
Returns
- This function returns void
Examples
deleteVar
Tries to delete a permanent session var.
Returns
- This function returns boolean
Arguments
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | --- | The variable name to retrieve. |
Examples
getStorage
Get the entire storage scope
Returns
- This function returns any
Comments (