ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.rca.services.impl 

CacheToken  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.services.impl
Classpublic class CacheToken
InheritanceCacheToken Inheritance AsyncToken Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This class extends async token and instead of making remote call to fetch the result, fetches the result from a local cache.



Public Properties
 PropertyDefined By
  cache : Object
An instance of Cache in which the value is looked for.
CacheToken
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  key : String
Key that is looked up in the cache.
CacheToken
 Inheritedmessage : IMessage
[read-only] Provides access to the associated message.
AsyncToken
 Inheritedresponders : Array
[read-only] An array of IResponder handlers that will be called when the asynchronous request completes.
AsyncToken
 Inheritedresult : Object
[read-only] The result that was returned by the associated RPC call.
AsyncToken
Public Methods
 MethodDefined By
  
CacheToken(message:IMessage = null)
The constructor for CacheToken class.
CacheToken
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Adds a responder to an Array of responders.
AsyncToken
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines if this token has at least one mx.rpc.IResponder registered.
AsyncToken
 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
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a property of the channel set changes.AsyncToken
Public Constants
 ConstantDefined By
  ERROR_STATE : String = "ERROR_STATE"
[static] This property denotes that the token is in an error state.
CacheToken
  WAIT_STATE : String = "WAIT_STATE"
[static] This property denotes that the token is currently waiting for a remote object to return the response.
CacheToken
Property Detail

cache

property
cache:Object

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

An instance of Cache in which the value is looked for.



Implementation
    public function get cache():Object
    public function set cache(value:Object):void

key

property 
key:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Key that is looked up in the cache.



Implementation
    public function get key():String
    public function set key(value:String):void
Constructor Detail

CacheToken

()Constructor
public function CacheToken(message:IMessage = null)

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The constructor for CacheToken class.

Parameters
message:IMessage (default = null) — The message with which the token is associated.
Constant Detail

ERROR_STATE

Constant
public static const ERROR_STATE:String = "ERROR_STATE"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This property denotes that the token is in an error state.

WAIT_STATE

Constant 
public static const WAIT_STATE:String = "WAIT_STATE"

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This property denotes that the token is currently waiting for a remote object to return the response.