| Package | coldfusion.air |
| Class | public class Session |
| Inheritance | Session  Object |
| Implements | IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Hide Inherited Public Properties
Show Inherited Public Properties| Method | Defined By | ||
|---|---|---|---|
Session(dbfile:File, syncManager:SyncManager, id:uint, cacheDirectory:File, encryptionKey:ByteArray)
Creates an instance of the Session class. | Session | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with the Session object so that the
listener receives notification of an event. | Session | ||
Begins a transaction on the session. | Session | ||
Closes the session by clearing the internal cache and closing the SqlConnection. | Session | ||
Commits the changes that have happened to the local database since the last fetch. | Session | ||
Commits the changes in the transaction. | Session | ||
Dispatches an event into the event flow. | Session | ||
Returns the SQLConnection being used by the session. | Session | ||
Returns the database file the session is operating on. | Session | ||
Checks whether the EventDispatcher object has any listeners registered for a
specific type of event. | Session | ||
 |
Indicates whether an object has a specified property defined. | Object | |
Determines whether a commit must be called on the session to commit any pending operations
to the server. | Session | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Retains the object in the local database and ignores the server object for each element in
the ArrayCollection of conflict instances. | Session | ||
Replaces the object in the local database with the corresponding server object for each element in
the ArrayCollection of conflict instances. | Session | ||
Retains the client object instance with the server object instance even if they are in conflict. | Session | ||
Replaces the client object instance with the server object instance if they are in conflict. | Session | ||
Loads the object with the specified lazy field name. | Session | ||
Takes objects of key-value pairs as criteria and returns an arraycollection
matching the specified criteria. | Session | ||
Loads all the instances of a particular Class from the database. | Session | ||
Loads a specific instance specified by the primary key-value pairs
passed in the second parameter. | Session | ||
loadByQuery(cls:Class, sqlCondition:String, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken
Loads instances of the type cls by taking the SQL condition for the WHERE clause to filter the instances. | Session | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes the object instance passed to the fucntion from the database. | Session | ||
Removes a listener from the EventDispatcher object. | Session | ||
Resets all the changes tracked in the offline AIR application. | Session | ||
Rolls the changes in the transaction back to the state before the transaction. | Session | ||
Saves an instance of the object in the local database. | Session | ||
Saves in the local database an ArrayCollection of data instances returned by the server CFC fetch method. | Session | ||
Saves a single object instance in the local database. | Session | ||
Checks if the object specified in the parameter exists in the database. | Session | ||
Saves or updates in the local database tan ArrayCollection of data instances returned by the server CFC fetch method. | Session | ||
Saves or updates in the local database a data instance returned by the server CFC fetch
method. | Session | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Updates the instance passed to it in the database. | Session | ||
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors
for the specified event type. | Session | ||
Session | () | Constructor |
public function Session(dbfile:File, syncManager:SyncManager, id:uint, cacheDirectory:File, encryptionKey:ByteArray)| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Creates an instance of the Session class.
Parametersdbfile:File — File handler for the offline sqlite database file.
| |
syncManager:SyncManager — Instance of the SyncManager class.
| |
id:uint — Integer ID to create a unique session for the offline sqlite database.
Use this ID to ensure that the correct sqlite database is used for each
client-side transaction.
| |
cacheDirectory:File | |
encryptionKey:ByteArray |
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Registers an event listener object with the Session object so that the listener receives notification of an event.
Parameters
type:String — String that specifies the type of the event.
| |
listener:Function — The listener function that processes the event.
| |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false) |
beginTransaction | () | method |
public function beginTransaction(option:String = null):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Begins a transaction on the session.
Parameters
option:String (default = null) |
coldfusion.air:SessionToken — The session token associated with the call
|
close | () | method |
public function close():coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Closes the session by clearing the internal cache and closing the SqlConnection. Match each openSession call on the syncManager with a corresponding close call on the session.
Returnscoldfusion.air:SessionToken — The session token associated with the call.
|
commit | () | method |
public function commit(ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Commits the changes that have happened to the local database since the last fetch.
Parameters
ignoreLazyLoad:Boolean (default = false) |
coldfusion.air:SessionToken — The session token associated with the call.
|
commitTransaction | () | method |
public function commitTransaction():coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Commits the changes in the transaction.
Returnscoldfusion.air:SessionToken — The session token associated with the call.
|
dispatchEvent | () | method |
public function dispatchEvent(evt:Event):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Dispatches an event into the event flow.
The event target is the EventDispatcher object upon which the
dispatchEvent() method is called.
Parameters
evt:Event — The Event object that is dispatched into the event flow.
If the event is being redispatched, a clone of the event is created automatically.
After an event is dispatched, its target property cannot be changed, so you must
create a new copy of the event for redispatching to work.
|
Boolean — A value of true if the event was successfully dispatched.
A value of false indicates failure or that preventDefault()
was called on the event.
|
dispatchSessionResultEvent | () | method |
cfair_internal function dispatchSessionResultEvent(result:Object, token:coldfusion.air:SessionToken, autoGeneratedId:Object = null):voidParameters
result:Object | |
token:coldfusion.air:SessionToken | |
autoGeneratedId:Object (default = null) |
executeStatement | () | method |
cfair_internal function executeStatement(stmt:SQLStatement, responder:Responder, doLog:Boolean = true):voidParameters
stmt:SQLStatement | |
responder:Responder | |
doLog:Boolean (default = true) |
getConnection | () | method |
public function getConnection():SQLConnection| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Returns the SQLConnection being used by the session.
ReturnsSQLConnection |
getDatabaseFile | () | method |
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Checks whether the EventDispatcher object has any listeners registered for a
specific type of event.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered;
false otherwise.
|
isCommitRequired | () | method |
public function isCommitRequired():coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Determines whether a commit must be called on the session to commit any pending operations to the server. The result received by a SessionResultEvent event is a Boolean value specifying if the commit is needed.
Returnscoldfusion.air:SessionToken — The session token associated with the call.
|
keepAllClientObjects | () | method |
public function keepAllClientObjects(coll:ArrayCollection):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Retains the object in the local database and ignores the server object for each element in the ArrayCollection of conflict instances.
Parameters
coll:ArrayCollection — ArrayCollection of conflict objects returned by the ColdFusion server.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
keepAllServerObjects | () | method |
public function keepAllServerObjects(coll:ArrayCollection):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Replaces the object in the local database with the corresponding server object for each element in the ArrayCollection of conflict instances.
Parameters
coll:ArrayCollection — Array collection of Conflict objects returned by the ColdFusion server.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
keepClientObject | () | method |
public function keepClientObject(conflict:Conflict):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9.0.1 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Retains the client object instance with the server object instance even if they are in conflict.
Parameters
conflict:Conflict — Conflict object returned by the ColdFusion server.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
keepServerObject | () | method |
public function keepServerObject(conflict:Conflict):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Replaces the client object instance with the server object instance if they are in conflict.
Parameters
conflict:Conflict — Conflict object returned by the ColdFusion server.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
lazyLoad | () | method |
public function lazyLoad(obj:Object, lazyFieldName:String):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Loads the object with the specified lazy field name.
Parameters
obj:Object — The object to be loaded.
| |
lazyFieldName:String — Property name of the nested object that needs to be loaded.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
load | () | method |
public function load(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Takes objects of key-value pairs as criteria and returns an arraycollection matching the specified criteria.
Parameters
cls:Class — Class object of the ActionScript type.
| |
obj:Object — Specifies the key-value pairs for which to find matching instances.
| |
ignoreLazyLoad:Boolean (default = false) |
coldfusion.air:SessionToken — The session token associated with the call.
|
loadAll | () | method |
public function loadAll(cls:Class, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Loads all the instances of a particular Class from the database.
Parameters
cls:Class — Class object of the ActionScript type.
| |
ignoreLazyLoad:Boolean (default = false) |
coldfusion.air:SessionToken — The session token associated with the call.
|
loadByPK | () | method |
public function loadByPK(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Loads a specific instance specified by the primary key-value pairs passed in the second parameter.
Parameters
cls:Class — Class object of the ActionScript type.
| |
obj:Object — Map of id fields and its values
| |
ignoreLazyLoad:Boolean (default = false) |
coldfusion.air:SessionToken — The session token associated with the call.
|
loadByQuery | () | method |
public function loadByQuery(cls:Class, sqlCondition:String, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Loads instances of the type cls by taking the SQL condition for the WHERE clause to filter the instances.
Parameters
cls:Class — Class object of the ActionScript type.
| |
sqlCondition:String — The SQL condition to match.
| |
ignoreLazyLoad:Boolean (default = false) |
coldfusion.air:SessionToken — The session token associated with the call.
|
remove | () | method |
public function remove(obj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Removes the object instance passed to the fucntion from the database. Corresponds to a SQL DELETE operation.
Parameters
obj:Object — The object to delete in the local database.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove
both, one call with useCapture() set to true, and another call with useCapture()
set to false.
|
resetTrackingChanges | () | method |
public function resetTrackingChanges(className:String = null):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Resets all the changes tracked in the offline AIR application.
Parameters
className:String (default = null)resetTrackingChanges function resets all the changes tracked
for all instances of the class name being passed.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
rollbackTransaction | () | method |
public function rollbackTransaction():coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Rolls the changes in the transaction back to the state before the transaction.
Returnscoldfusion.air:SessionToken — The session token associated with the call.
|
save | () | method |
public function save(saveObj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Saves an instance of the object in the local database. Corresponds to a SQL INSERT operation.
Parameters
saveObj:Object — The object to save in the local database.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
saveCache | () | method |
public function saveCache(coll:ArrayCollection):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Saves in the local database an ArrayCollection of data instances returned by the server CFC fetch method.
Parameters
coll:ArrayCollection — Array collection of the server objects.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
saveCacheObject | () | method |
public function saveCacheObject(obj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Saves a single object instance in the local database. This is an alternative to saveCache function that you can use if the fetch method returns a single result. This function differs from Save function. The Save function inserts a new record, whereas this method copies the object from server to the local database.
Parameters
obj:Object |
coldfusion.air:SessionToken — The session token associated with the call.
|
saveCacheObjectCallCache | () | method |
cfair_internal function saveCacheObjectCallCache(obj:Object, callCache:CallCache):coldfusion.air:SessionTokenParameters
obj:Object | |
callCache:CallCache |
coldfusion.air:SessionToken |
saveUpdate | () | method |
public function saveUpdate(saveObj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Checks if the object specified in the parameter exists in the database. If it does exists, updates the object; otherwise, it inserts the object in the database.
Parameters
saveObj:Object — The object to save or update in the local database.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
saveUpdateCache | () | method |
public function saveUpdateCache(coll:ArrayCollection):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Saves or updates in the local database tan ArrayCollection of data instances returned by the server CFC fetch method.
Parameters
coll:ArrayCollection — Array collection of the server objects.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
saveUpdateCacheObject | () | method |
public function saveUpdateCacheObject(obj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Saves or updates in the local database a data instance returned by the server CFC fetch method. This is an alternative to SaveUpdateCache function that you can use if the fetch method returns a single result. This function differs from SaveUpdate function. The SaveUpdate function inserts a new record or updates an existing one, whereas this method copies the object from server to the local database.
Parameters
obj:Object — Object that is passed to the function.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
update | () | method |
public function update(obj:Object):coldfusion.air:SessionToken| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Updates the instance passed to it in the database. Corresponds to a SQL UPDATE operation.
Parameters
obj:Object — The object to update in the local database.
|
coldfusion.air:SessionToken — The session token associated with the call.
|
willTrigger | () | method |
public function willTrigger(type:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | ColdFusion 9 |
| Runtime Versions: | Flash Player 9, AIR 1.0 |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered;
false otherwise.
|
Mon Nov 28 2011, 06:48 AM -08:00