com.adobe.icc.services.download

# IDownloadService - AS3 Asset Composer

Package | com.adobe.icc.services.download
Interface | public 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | getFormData(formId:String):com.adobe.icc.token:IAsyncToken Retrieves the raw XDP that represents the form. | IDownloadService
|  | getImageModuleData(imageModuleId:String):com.adobe.icc.token:IAsyncToken Retrieves the raw image bytes that represent the image module's contents. | IDownloadService
|  | getLetterExpressionSwf(letterId:String):com.adobe.icc.token:IAsyncToken Retrieves the Expression SWF used by the letter. | IDownloadService
|  | getLetterTestData(letterId:String):com.adobe.icc.token:IAsyncToken Retrieves the letter's test data as raw XML. | IDownloadService
|  | getTextModuleData(textModuleId:String):com.adobe.icc.token:IAsyncToken Retrieves the raw (unresolved) XHTML that represents the text module's contents. | IDownloadService
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | 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

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

com.adobe.icc.vo.DataDownload

### 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

com.adobe.icc.vo.DataDownload

### 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

com.adobe.icc.vo.DataDownload

### 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

com.adobe.icc.vo.DataDownload

### 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

com.adobe.icc.vo.DataDownload

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00