| Operation |
Details |
public
deletePersistedProperties():Boolean
|
Sequential
|
Notes:
|
Deletes all properties from the persisted object <br />@return true if the properties have successfully been deleted
|
|
public
deletePersistedProperty(
 propertyName: String,
| Default: |
|
| Kind: |
in |
| Stereotype: |
|
|
|
):Boolean
|
Sequential
|
Notes:
|
Deletes a specified property from the persisted object <br />@param the name of the property to delete
|
|
public
destroy():void
|
Sequential
|
Notes:
|
Destroys the current SharedObject from the clients local disk
|
|
public
getCurrentSessionId():Number
|
Sequential
|
Notes:
|
Returns the current session date of a persisted object <br />@return a date object for the current session
|
|
public
getCurrentSessionTimestamp():String
|
Sequential
|
Notes:
|
Retrieves the current session timestamp <br />@return the current session timestamp
|
|
public
getData():Object
|
Sequential
|
Notes:
|
Returns the data object of the persisted object. The data object is a property of SharedObject and is used to maintain persisted data either Locally or Remotely <br />@return An object which contains all properties / values
|
|
public
getIdentifier():String
|
Sequential
|
Notes:
|
Returns the name of the shared object. <br />@return The name of the shared object
|
|
public
getPersistedProperties():Array
|
Sequential
|
Notes:
|
Returns an array of all properties in the persisted object <br />@return an array of all persisted properties
|
|
public
getPersistedProperty(
propertyName: String,
| Default: |
|
| Kind: |
in |
| Stereotype: |
|
|
|
):var
|
Sequential
|
Notes:
|
Returns the value of a specified persisted property <br />@return the value of the property
|
|
public
getPreviousSessionId():Number
|
Sequential
|
Notes:
|
Returns the previous session date of a persisted object <br />@return a date object for the previous session
|
|
public
getPreviousSessionTimestamp():String
|
Sequential
|
Notes:
|
Retrieves the previous session timestamp <br />@return the current session timestamp
|
|
public
getSessions():Array
|
Sequential
|
Notes:
|
Retrieves all session unique identifier <br />@return an Array of all session identifiers
|
|
public
getSessionTimestamps():Array
|
Sequential
|
Notes:
|
Retrieves all session timestamps <br />@return an Array of all session identifiers
|
|
public
getSize():int
|
Sequential
|
Notes:
|
Returns the size object of the persisted object. <br />@return the size of the LSO in kilobytes
|
|
public
LocalPersistence(
identifier: String,
| Default: |
|
| Kind: |
in |
| Stereotype: |
|
|
|
minDiskSpace: int,
| Default: |
100 |
| Kind: |
in |
| Stereotype: |
|
|
|
):var
|
Sequential
|
Notes:
|
Creates a reference to the persisted SharedObject available from the clients local-disk. If the SharedObject does not currently exsist, Flash Player will attempt to created it <br /><p> If the identifier contains any invalid charachters, they will be substituted with underscores<br /></p> <br />@param the name of the local shared object<br />@param the minimum amount of disc space required by the shared object<br />@return true if the write operation was successful, false if not
|
|
public
objectEncoding(
version: int,
| Default: |
|
| Kind: |
in |
| Stereotype: |
|
|
|
):void
|
Sequential <<property set>>
|
Notes:
|
Sets the current ObjectEncoding version of the persisted object <br />@param an integer of either 0 or 3, representing AMF3 or AMF0
|
|
public
objectEncoding():int
|
Sequential <<property get>>
|
Notes:
|
Returns the current ObjectEncoding of the persisted object <br />@return an integet of either 0 or 3 (AMF0, AMF3)
|
|
public
setPersistedProperty(
propertyName: String,
| Default: |
|
| Kind: |
in |
| Stereotype: |
|
|
|
value: var,
| Default: |
null |
| Kind: |
in |
| Stereotype: |
|
|
|
):void
|
Sequential
|
Notes:
|
Sets the value of a specified persisted property <br />@param the name of the property to be persisted<br />@param the value of the property to be persisted
|
|
public
write(
minDiskSpace: int,
| Default: |
100 |
| Kind: |
in |
| Stereotype: |
|
|
|
):Boolean
|
Sequential
|
Notes:
|
Writes the persisted SharedObject to disk <br />@param the minimum amount of disc space required by the shared object<br />@return true if the write operation was successful, false if not
|
|