[[Dashboard | << Back to Dashboard ]]

{| align="right"
| __TOC__
|}

= Exploring the ApplicationStorage Plugin =


== Overview ==
Application Storage plugin. It provides the user with a mechanism for permanent data storage using the application 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 ===

<source lang="coldfusion">
getPlugin("ApplicationStorage").setVar("service", myService);
</source>


== getVar ==
Get a new permanent variable. If the variable does not exist. The method returns blank unless using the default return argument.

=== 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 ===

<source lang="coldfusion">
// No default
var service = getPlugin("ApplicationStorage").getVar("service");

// With Default
var onlineBit = getPlugin("ApplicationStorage").getVar("onlineBit", false);

</source>


== removeStorage ==
remove the entire storage from scope

=== Returns ===
* This function returns ''void''


=== Examples ===

<source lang="coldfusion">
getPlugin("ApplicationStorage").removeStorage();
</source>

== 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 ===

<source lang="coldfusion">
if ( getPlugin("ApplicationStorage").exists("onlineBit") ){

}
</source>

== clearAll ==
Clear the entire coldbox application storage

=== Returns ===
* This function returns ''void''


=== Examples ===


<source lang="coldfusion">
getPlugin("ApplicationStorage").clearAll();
</source>


== deleteVar ==
Tries to delete a permanent application variable. Returns True if deleted.

=== Returns ===
* This function returns ''boolean''


=== Arguments ===

{| cellpadding="5", class="tablelisting"
! '''Key''' !! '''Type'''  !! '''Required''' !! '''Default''' !! '''Description''' 
|-
| name || string || Yes || --- || The variable name to retrieve.
|}

=== Examples ===

<source lang="coldfusion">
getPlugin("ApplicationStorage").deleteVar("onlineBit");
</source>

== getStorage ==
Get the entire storage scope structure

=== Returns ===
* This function returns ''struct''


=== Examples ===

<source lang="coldfusion">
var appStorage = getPlugin("ApplicationStorage").getStorage();
</source>