mx.rpc.AsyncToken - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.rpc
Class	public dynamic class AsyncToken
Inheritance	AsyncToken EventDispatcher Object
Subclasses	ItemReference

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

This class provides a place to set additional or token-level data for asynchronous RPC operations. It also allows an IResponder to be attached for an individual call. The AsyncToken can be referenced in ResultEvent and FaultEvent from the token property.

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
		message : IMessage [read-only] Provides access to the associated message.	AsyncToken
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		responders : Array [read-only] An array of IResponder handlers that will be called when the asynchronous request completes.	AsyncToken
		result : Object [read-only] The result that was returned by the associated RPC call.	AsyncToken

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		AsyncToken(message:IMessage = null) Constructs an instance of the token with the specified message.	AsyncToken
		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
		addResponder(responder:IResponder):void Adds a responder to an Array of responders.	AsyncToken
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hasResponder():Boolean Determines if this token has at least one mx.rpc.IResponder registered.	AsyncToken
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
propertyChange	Dispatched when a property of the channel set changes.	AsyncToken

Property Detail

message

property

message:IMessage [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Provides access to the associated message.

Implementation
public function get message():IMessage

responders

property

responders:Array [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An array of IResponder handlers that will be called when the asynchronous request completes. Eaxh responder assigned to the token will have its result or fault function called passing in the matching event before the operation or service dispatches the event itself. A developer can prevent the service from subsequently dispatching the event by calling event.preventDefault(). Note that this will not prevent the service or operation's result property from being assigned.

Implementation
public function get responders():Array

result

property

result:Object [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The result that was returned by the associated RPC call. Once the result property on the token has been assigned it will be strictly equal to the result property on the associated ResultEvent.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get result():Object

Constructor Detail

AsyncToken

()

Constructor

public function AsyncToken(message:IMessage = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructs an instance of the token with the specified message.

Parameters

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

Method Detail

addResponder

()

method

public function addResponder(responder:IResponder):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

hasResponder

()

method

public function hasResponder():Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Event Detail

propertyChange

Event

Event Object Type: mx.events.PropertyChangeEvent
property PropertyChangeEvent.type = mx.events.PropertyChangeEvent.PROPERTY_CHANGE

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Dispatched when a property of the channel set changes.

The PropertyChangeEvent.PROPERTY_CHANGE constant defines the value of the type property of the event object for a PropertyChange event.

The properties of the event object have the following values:

Property	Value
`bubbles`	Determined by the constructor; defaults to false.
`cancelable`	Determined by the constructor; defaults to false.
`kind`	The kind of change; PropertyChangeEventKind.UPDATE or PropertyChangeEventKind.DELETE.
`oldValue`	The original property value.
`newValue`	The new property value, if any.
`property`	The property that changed.
`source`	The object that contains the property that changed.
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.