Plugins:ClientStorage

<< Back to Dashboard

Exploring the ClientStorage Plugin

Overview

Client Storage plugin. It provides the user with a mechanism for permanent data storage using the client scope and WDDX.

clearAll

Clear the entire coldbox client storage

Returns

• This function returns void

Examples

// Clear the entire client storage
getPlugin("ClientStorage").clearAll();

exists

Checks wether the permanent variable exists.

Returns

• This function returns boolean

Arguments

Examples

if ( getPlugin("ClientStorage").exists("userData") ){
  // use the data
}

getVar

Get a new permanent variable. If the variable does not exist. The method returns blank.

Returns

• This function returns any

Arguments

Examples

// No default
var userData = getPlugin("ClientStorage").getVar("userData");

// With Default
var data= getPlugin("ClientStorage").getVar("userData", structNew() );

setVar

Set a new permanent variable.

Returns

• This function returns void

Arguments

Examples

// Prepare data, can be simple or complex
userData = {
  name = "Luis Majano",
  created = now(),
  nicknames = ["Captain Awesome", "Pio"],
  awesomeLevel = "high"
};
getPlugin("ClientStorage").setVar("userData", userData);

getStorage

Get the entire storage scope structure

Returns

• This function returns struct

Examples

var clientStorage = getPlugin("ClientStorage").getStorage();

deleteVar

Tries to delete a permanent client var.

Returns

• This function returns boolean

Arguments

Examples

getPlugin("ClientStorage").deleteVar("userData");