ColdBox Platform v3.8.0

coldbox.system.web.flash
Class SessionFlash

WEB-INF.cftags.component
        extended by coldbox.system.web.flash.AbstractFlashScope
            extended by coldbox.system.web.flash.SessionFlash

public class SessionFlash
extends AbstractFlashScope

A ColdBox session flash scope

Constructor Summary
init(any<Controller> controller, [any<struct> defaults='[runtime expression]'])
          Constructor
 
Method Summary
 boolean flashExists()
          Checks if the flash storage exists and IT HAS DATA to inflate
 struct getFlash()
          Get the flash storage structure to inflate it
 string getFlashKey()
          Get the flash key storage used in session scope
 any removeFlash()
          Remove the entire flash storage
 any saveFlash()
          Save the flash storage in preparing to go to the next request
 
Methods inherited from class coldbox.system.web.flash.AbstractFlashScope
clear, clearFlash, discard, exists, get, getController, getDefaults, getKeys, getProperties, getProperty, getScope, getUtil, inflateFlash, isEmpty, keep, persistRC, propertyExists, put, putAll, remove, setProperties, setProperty, size, statusMarks
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any<Controller> controller, [any<struct> defaults='[runtime expression]'])
Constructor

Parameters:
controller - The ColdBox Controller
defaults - Default flash data packet for the flash RAM object=[scope,properties,inflateToRC,inflateToPRC,autoPurge,autoSave]
Method Detail

flashExists

public boolean flashExists()
Checks if the flash storage exists and IT HAS DATA to inflate.

Overrides:
flashExists in class AbstractFlashScope

getFlash

public struct getFlash()
Get the flash storage structure to inflate it.

Overrides:
getFlash in class AbstractFlashScope

getFlashKey

public string getFlashKey()
Get the flash key storage used in session scope.


removeFlash

public any removeFlash()
Remove the entire flash storage

Overrides:
removeFlash in class AbstractFlashScope

saveFlash

public any saveFlash()
Save the flash storage in preparing to go to the next request

Overrides:
saveFlash in class AbstractFlashScope

ColdBox Platform v3.8.0