[[Dashboard | << Back to Dashboard ]] {| align="right" | __TOC__ |} = 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 === {| cellpadding="5", class="tablelisting" ! '''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 === {| cellpadding="5", class="tablelisting" ! '''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 === {| cellpadding="5", class="tablelisting" ! '''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 === {| cellpadding="5", class="tablelisting" ! '''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'' === Examples ===