com.adobe.gravity.utility.async.Token - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	com.adobe.gravity.utility.async
Class	public class Token
Inheritance	Token Object
Implements	IToken

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Token objects are returned from functions that initiate asynchronous operations. You are guaranteed that either the fault handlers or the success handlers will be invoked, depending on whether the operation succeeded or failed. Return values should always be of type IToken, the caller should not need to be aware what sort of IToken was used.

Success handlers take an arbitrary number of parameters. The number and type of the parameters depend on the API that returns the token; the API documentation will generally indicate what to expect. Fault handlers must take a single parameter of type Error.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Token() Constructor.	Token
		addFaultHandler(handler:Function, weakReference:Boolean = false):void Add a handler to be called if the operation fails.	Token
		addSuccessHandler(handler:Function, weakReference:Boolean = false):void Add a handler to be called if the operation succeeds.	Token
		callFaultHandlers(error:Error):void Call all the fault handlers with the provided error object.	Token
		callFaultHandlersViaErrorEvent(errorEvent:ErrorEvent):void Call all the fault handlers with an Error created from the provided ErrorEvent object.	Token
		callSuccessHandlers(... params):void Call all the success handlers with the provided parameters.	Token
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeFaultHandler(handler:Function):void Remove a fault handler.	Token
		removeSuccessHandler(handler:Function):void Remove a success handler.	Token
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Constructor Detail

Token

()

Constructor

public function Token()

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Constructor.

Method Detail

addFaultHandler

()

method

public function addFaultHandler(handler:Function, weakReference:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Add a handler to be called if the operation fails.

Parameters

	`handler:Function` — A function to be called if the operation fails.

	`weakReference:Boolean` (default = `false`) — Use a weak reference to hold onto the handler.

addSuccessHandler

()

method

public function addSuccessHandler(handler:Function, weakReference:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Add a handler to be called if the operation succeeds.

Parameters

	`handler:Function` — A function to be called if the operation succeeds.

	`weakReference:Boolean` (default = `false`) — Use a weak reference to hold onto the handler.

callFaultHandlers

()

method

public function callFaultHandlers(error:Error):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Call all the fault handlers with the provided error object.

Parameters

error:Error — The error object.

callFaultHandlersViaErrorEvent

()

method

public function callFaultHandlersViaErrorEvent(errorEvent:ErrorEvent):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Call all the fault handlers with an Error created from the provided ErrorEvent object. This is equivalent to

         callFaultHandlers(new Error(errorEvent.text));

Parameters

errorEvent:ErrorEvent — The error event.

callSuccessHandlers

()

method

public function callSuccessHandlers(... params):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Call all the success handlers with the provided parameters.

Parameters

... params — Zero or more parameters to be passed verbatim to any success handlers that have been added.

removeFaultHandler

()

method

public function removeFaultHandler(handler:Function):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Remove a fault handler.

Parameters

handler:Function — The handler to be removed.

removeSuccessHandler

()

method

public function removeSuccessHandler(handler:Function):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10

Runtime Versions:

AIR 1.1, Flash Player 9

Remove a success handler.

Parameters

handler:Function — The handler to remove.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

Token

addFaultHandler

addSuccessHandler

callFaultHandlers

callFaultHandlersViaErrorEvent

callSuccessHandlers

removeFaultHandler

removeSuccessHandler