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

Package | spark.managers
Interface | public interface IPersistenceManager
Implementors | PersistenceManager

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | AIR 2.5

IPersistenceManager defines the interface that all persistence managers must implement. These objects are responsible for persisting data between application sessions.

See also

spark.managers.PersistenceManager

Public Methods

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

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