ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
coldfusion.air 

SessionToken  - AS3 CF

Packagecoldfusion.air
Classpublic dynamic class SessionToken
InheritanceSessionToken Inheritance Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Token representing the call to a method on the Session class. It also allows an IResponder to be attached for an individual call. The SessionToken can be referenced in SessionResultEvent and SessionFaultEvent from the sessionToken property.



Public Properties
 PropertyDefined By
  autoGeneratedId : Object
The auto-generated key for inserts.
SessionToken
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  responders : Array
[read-only] An array of IResponder handlers that will be called when the asynchronous request completes.
SessionToken
  result : Object
The result that was returned by the associated call.
SessionToken
  session : Session
[read-only] The session object associated with the token.
SessionToken
  UID : String
[read-only] Returns the UID associated with the token.
SessionToken
Public Methods
 MethodDefined By
  
Creates an instance of the SessionToken class.
SessionToken
  
addResponder adds a responder to an Array of responders.
SessionToken
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Determines if this token has at least one mx.rpc.IResponder registered.
SessionToken
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

autoGeneratedId

property
public var autoGeneratedId:Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9.0.1
Runtime Versions: Flash Player 9, AIR 1.0

The auto-generated key for inserts. If not generated, the value is null.

responders

property 
responders:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

An array of IResponder handlers that will be called when the asynchronous request completes. Each responder assigned to the token will have its result or fault function called by passing in the matching event before the operation or service dispatches the event itself.



Implementation
    public function get responders():Array

result

property 
public var result:Object

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The result that was returned by the associated call.

scope

property 

session

property 
session:Session  [read-only]

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

The session object associated with the token.



Implementation
    public function get session():Session

UID

property 
UID:String  [read-only]

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Returns the UID associated with the token.



Implementation
    public function get UID():String
Constructor Detail

SessionToken

()Constructor
public function SessionToken(session:Session)

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Creates an instance of the SessionToken class.

Parameters
session:Session
Method Detail

addResponder

()method
public function addResponder(responder:IResponder):void

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

addResponder adds a responder to an Array of responders. The object assigned to the responder parameter must implement mx.rpc.IResponder.

Parameters

responder:IResponder — A handler which will be called when the asynchronous request completes.

Related API Elements

hasResponder

()method 
public function hasResponder():Boolean

Language Version: ActionScript 3.0
Product Version: ColdFusion 9
Runtime Versions: Flash Player 9, AIR 1.0

Determines if this token has at least one mx.rpc.IResponder registered.

Returns
Boolean — true if at least one responder has been added to this token.