contentbox.modules.contentbox-deps.modules.cbstorages.models

Class ClientStorage

lucee.Component
    extended by contentbox.modules.contentbox-deps.modules.cbstorages.models.ClientStorage

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

Class Attributes:
  • singleton
  •  
  • output : false
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Constructor Summary
    init()
          Constructor.
    Method Summary
    void clearAll()
         Clear the entire coldbox client storage.
    boolean deleteVar(string name)
         Tries to delete a permanent client var.
    boolean exists(string name)
         Checks wether the permanent variable exists.
    struct getStorage()
         Get the entire storage scope structure.
    any getVar(string name, [any default=''])
         Get a new permanent variable.
    void setVar(string name, any value)
         Set a new permanent variable.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor.


    Method Detail

    clearAll

    public void clearAll()

    Clear the entire coldbox client storage


    deleteVar

    public boolean deleteVar(string name)

    Tries to delete a permanent client var.

    Parameters:
    name - The variable name to retrieve.

    exists

    public boolean exists(string name)

    Checks wether the permanent variable exists.

    Parameters:
    name - The variable name to retrieve.

    getStorage

    public struct getStorage()

    Get the entire storage scope structure


    getVar

    public any getVar(string name, [any default=''])

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

    Parameters:
    name - The variable name to retrieve.
    default - The default value to set. If not used, a blank is returned.

    setVar

    public void setVar(string name, any value)

    Set a new permanent variable.

    Parameters:
    name - The name of the variable.
    value - The value to set in the variable.