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

AutomationMethodDescriptor  - AS3 Flex
Packagemx.automation
Classpublic class AutomationMethodDescriptor
InheritanceAutomationMethodDescriptor Inheritance Object
Implements IAutomationMethodDescriptor

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Basic method descriptor class. Generates descriptor from event parameters, if necessary

Learn more

Understanding the automation framework

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  name : String
[read-only] The name of the method.
AutomationMethodDescriptor
  returnType : String
[read-only]
AutomationMethodDescriptor
Public Methods
 MethodDefined By
  
AutomationMethodDescriptor(name:String, asMethodName:String, returnType:String, args:Array)
AutomationMethodDescriptor
  
getArgDescriptors(obj:IAutomationObject):Array
Returns an Array of argument descriptors for this method.
AutomationMethodDescriptor
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
record(target:IAutomationObject, event:Event):Array
Encodes an automation event arguments into an Array.
AutomationMethodDescriptor
  
replay(target:IAutomationObject, args:Array):Object
Decodes an argument array and invokes a method.
AutomationMethodDescriptor
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

name

property
name:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The name of the method.



Implementation
    public function get name():String

returnType

property 
returnType:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1



Implementation
    public function get returnType():String
Constructor Detail

AutomationMethodDescriptor

()Constructor
public function AutomationMethodDescriptor(name:String, asMethodName:String, returnType:String, args:Array)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Parameters
name:String
 
asMethodName:String
 
returnType:String
 
args:Array
Method Detail

getArgDescriptors

()method
public function getArgDescriptors(obj:IAutomationObject):Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an Array of argument descriptors for this method.

Parameters

obj:IAutomationObject — Instance of the IAutomationObject that supports this method.

Returns
Array — Array of argument descriptors for this method.

record

()method 
public function record(target:IAutomationObject, event:Event):Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Encodes an automation event arguments into an Array. Not all method descriptors support recording.

Parameters

target:IAutomationObject — Automation event that is being recorded.
 
event:Event

Returns
Array — Array of argument descriptors.

replay

()method 
public function replay(target:IAutomationObject, args:Array):Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Decodes an argument array and invokes a method.

Parameters

target:IAutomationObject — Automation object to replay the method on.
 
args:Array — Array of argument values and descriptors to be used to invoke the method.

Returns
Object — Whatever the method invoked returns.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy