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.exm.authoring.domain.method 

IFunctionProvider  - AS3 Expression Manager
Packagecom.adobe.solutions.exm.authoring.domain.method
Interfacepublic interface IFunctionProvider extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The IFunctionProvider interface serves as the entry point for function-specific operations during expression authoring.


Public Methods
 MethodDefined By
 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.
IEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
listFunctionFamilies():void
Fires an asynchronous operation for retrieving the list of all available function-families.
IFunctionProvider
  
listLocalFunctions(familyId:String):String
Fires an asynchronous operation for retrieving the list of all local functions belonging to the given family.
IFunctionProvider
  
listServices(familyId:String):String
Fires an asynchronous operation for retrieving the list of all remote functions (services) belonging to the given family.
IFunctionProvider
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
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.
IEventDispatcher
Events
Click for more information on events
 Event Summary Defined By
  
functionFamilyProviderError
Dispatched when the provider encounters an error retrieving the list of function families.IFunctionProvider
  
functionFamilyProviderEvent
Dispatched when the provider successfully retrieves the list of available function families.IFunctionProvider
  
functionProviderError
Dispatched when the provider encounters an error retrieving a list of functions.IFunctionProvider
  
functionProviderEvent
Dispatched when the provider successfully retrieves a list of functions.IFunctionProvider
Method Detail

listFunctionFamilies

()method
public function listFunctionFamilies():void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of all available function-families. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfuly, an event with name "functionFamilyProviderEvent" of type FunctionFamilyProviderEvent. The 'families' property of the event will be a reference to the list of available function families (IFunctionFamily instances).
  • If the operation errors out, an event with name "functionFamilyProviderError" of type ErrorEvent. The 'error' property of the event will contain the actual error thrown by the operation.

listLocalFunctions

()method 
public function listLocalFunctions(familyId:String):String

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of all local functions belonging to the given family. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfuly, an event with name "functionProviderEvent" of type FunctionProviderEvent. The 'functions' property of the event will be a reference to the list of local functions (IFunction instances) belonging to the given family. The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
  • If the operation errors out, an event with name "functionProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Parameters

familyId:String — The ID of the family for which local functions are being listed. Can be null, in which case all local functions will be returned.

Returns
String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.

listServices

()method 
public function listServices(familyId:String):String

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of all remote functions (services) belonging to the given family. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfuly, an event with name "functionProviderEvent" of type FunctionProviderEvent. The 'functions' property of the event will be a reference to the list of remote functions (IFunction instances) belonging to the given family. The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
  • If the operation errors out, an event with name "functionProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Parameters

familyId:String — The ID of the family for which remote functions are being listed. Can be null, in which case all remote functions will be returned.

Returns
String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.
Event Detail

functionFamilyProviderError

 Event
Event Object Type: com.adobe.solutions.exm.authoring.domain.ErrorEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider encounters an error retrieving the list of function families.

functionFamilyProviderEvent

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.method.FunctionFamilyProviderEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider successfully retrieves the list of available function families.

functionProviderError

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.RequestAwareErrorEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider encounters an error retrieving a list of functions.

functionProviderEvent

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.method.FunctionProviderEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider successfully retrieves a list of functions.




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

 

Legal Notices | Online Privacy Policy