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

ISubmitService  - AS3 Asset Composer

Packagecom.adobe.icc.services.submit
Interfacepublic interface ISubmitService extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Defines a service for submitting filled letter data (ICC Data).



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
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
submitLetter(letter:Letter, letterData:String, interactive:Boolean = false):com.adobe.icc.token:IAsyncToken
Submits the data for the specified letter.
ISubmitService
  
submitLetterWithParams(letter:Letter, letterData:String, interactive:Boolean = false, useLatestAssets:Boolean = false, reload:Boolean = false, serviceName:String = null, params:Object = null):com.adobe.icc.token:IAsyncToken
Submits the data for the specified letter.
ISubmitService
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Method Detail

submitLetter

()method
public function submitLetter(letter:Letter, letterData:String, interactive:Boolean = false):com.adobe.icc.token:IAsyncToken

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Submits the data for the specified letter.

Parameters

letter:Letter — The letter being submitted.
 
letterData:String — The XML data for the letter (ICC Data). This string is expected to be non-encoded XML and cannot be null/empty.
 
interactive:Boolean (default = false) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.

Returns
com.adobe.icc.token:IAsyncTokenResultEvent.result is a dynamic Object containing the following properties:
  • redirect (String): The URL to which the user should be redirected or null if no redirect should take place. Note that it is the caller's responsibility to ensure this is a valid URL.

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

submitLetterWithParams

()method 
public function submitLetterWithParams(letter:Letter, letterData:String, interactive:Boolean = false, useLatestAssets:Boolean = false, reload:Boolean = false, serviceName:String = null, params:Object = null):com.adobe.icc.token:IAsyncToken

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Submits the data for the specified letter.

Parameters

letter:Letter — The letter to submit.
 
letterData:String — The XML data for the letter. That is, Correspondence Management data. This string is expected to be non-encoded XML and cannot be null or empty.
 
interactive:Boolean (default = false) — True if the rendered letter should be an interactive PDF, false if it should be a flattened PDF.
 
useLatestAssets:Boolean (default = false) — True if the rendered letter should use the latest assets when generating the final Letter.
 
reload:Boolean (default = false) — True if we are reloading a Letter.
 
serviceName:String (default = null) — Name of the custom service(PostProcess) To be invoked on the server.
 
params:Object (default = null) — additional arguments to be posted to the server.

Returns
com.adobe.icc.token:IAsyncTokenResultEvent.result is a dynamic Object that contains the following properties:
  • redirect (String): The URL the user is redirected to, or null if the user is not redirected. Note that it is the caller's responsibility to ensure that this is a valid URL.

Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.