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.download 

IDownloadService  - AS3 Asset Composer

Packagecom.adobe.icc.services.download
Interfacepublic interface IDownloadService 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 downloading data related to assets on the server.



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
  
Retrieves the raw XDP that represents the form.
IDownloadService
  
Retrieves the raw image bytes that represent the image module's contents.
IDownloadService
  
Retrieves the Expression SWF used by the letter.
IDownloadService
  
Retrieves the letter's test data as raw XML.
IDownloadService
  
Retrieves the raw (unresolved) XHTML that represents the text module's contents.
IDownloadService
 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
 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

getFormData

()method
public function getFormData(formId:String):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

Retrieves the raw XDP that represents the form.

Parameters

formId:String — The ID (GUID) of the form whose raw XDP contents is to be retrieved.

Returns
com.adobe.icc.token:IAsyncToken — A DataDownload object containing the data (raw XDP bytes from the form).

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

Related API Elements

getImageModuleData

()method 
public function getImageModuleData(imageModuleId:String):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

Retrieves the raw image bytes that represent the image module's contents.

Parameters

imageModuleId:String — The ID (GUID) of the image module whose raw byte contents is to be retrieved.

Returns
com.adobe.icc.token:IAsyncToken — A DataDownload object containing the data (raw image bytes).

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

Related API Elements

getLetterExpressionSwf

()method 
public function getLetterExpressionSwf(letterId:String):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

Retrieves the Expression SWF used by the letter.

Parameters

letterId:String — The ID (GUID) of the letter whose Expression SWF is to be retrieved.

Returns
com.adobe.icc.token:IAsyncToken — A DataDownload object containing the data (Expression SWF bytes).

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

Related API Elements

getLetterTestData

()method 
public function getLetterTestData(letterId:String):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

Retrieves the letter's test data as raw XML.

Parameters

letterId:String — The ID (GUID) of the letter whose test data is to be retrieved.

Returns
com.adobe.icc.token:IAsyncToken — A DataDownload object containing the test data (XML bytes). The response will be null if the letter doesn't have test data.

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

Related API Elements

getTextModuleData

()method 
public function getTextModuleData(textModuleId:String):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

Retrieves the raw (unresolved) XHTML that represents the text module's contents.

Parameters

textModuleId:String — The ID (GUID) of the text module whose raw XHTML contents is to be retrieved.

Returns
com.adobe.icc.token:IAsyncToken — A DataDownload object containing the data (raw XHTML bytes).

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

Related API Elements