Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
PersistenceManager

Package | spark.managers
Class | public class PersistenceManager
Inheritance | PersistenceManager Object
Implements | IPersistenceManager

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

The PersistenceManager class is a basic persistence manager that is backed by a local shared object named FxAppCache. When initialized, it loads a local shared object that matches its id. If a local shared object is not found, it is created.

When storing values using the manager, it is important that all values can be properly be written to a shared object. Complex objects that store classes or non-standard flash primitives must implement flash.net.IExternalizable interface to work properly. Saving incompatible objects does not cause an RTE, but creates undefined behavior when the data is read back.

See also

flash.utils.IExternalizable

Public Methods

| Method | Defined By
--- | --- | ---
|  | PersistenceManager() Constructor. | PersistenceManager
|  | clear():void Clears all the data that is being stored by the persistence manager. | PersistenceManager
|  | getProperty(key:String):Object Returns the value of a property stored in the persistence manager. | PersistenceManager
|  | load():Boolean Initializes the persistence manager. | PersistenceManager
|  | save():Boolean Flushes the data being managed by the persistence manager to disk, or to another external storage file. | PersistenceManager
|  | setProperty(key:String, value:Object):void Stores a value in the persistence manager. | PersistenceManager

Constructor Detail

PersistenceManager | () | Constructor

`public function PersistenceManager()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Constructor.

Method Detail

clear | () | method

`public function clear():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Clears all the data that is being stored by the persistence manager.

getProperty | () | method |

`public function getProperty(key:String):Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Returns the value of a property stored in the persistence manager. Properties are saved as key:value pairs.

Parameters

| `key:String` — The property key.

Returns

| `Object` — The value of a property stored in the persistence manager.

load | () | method |

`public function load():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Initializes the persistence manager.

Returns

| `Boolean` — `true` if the operation is successful.

save | () | method |

`public function save():Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Flushes the data being managed by the persistence manager to disk, or to another external storage file.

Returns

| `Boolean` — `true` if the operation is successful.

setProperty | () | method |

`public function setProperty(key:String, value:Object):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

Stores a value in the persistence manager. Properties are saved as key:value pairs.

Parameters

| `key:String` — The key to use to store the value.
| `value:Object` — The value object to store.

Sun Mar 5 2017, 03:42 PM +11:00