ClientFlash

Class ClientFlash

WEB-INF.cftags.component
        coldbox.system.web.flash.AbstractFlashScope
            coldbox.system.web.flash.ClientFlash

Class Attributes:

output : false

A ColdBox client 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 cluster 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

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

public boolean flashExists()

Checks if the flash storage exists and IT HAS DATA to inflate.

public struct getFlash()

Get the flash storage structure to inflate it.

public string getFlashKey()

Get the flash key storage used in cluster scope.

public any removeFlash()

Remove the entire flash storage

public any saveFlash()

Save the flash storage in preparing to go to the next request