IExportService

Package	com.adobe.icc.services.export
Interface	public interface IExportService 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 exporting data related to assets.

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
		exportAllAssets():com.adobe.icc.token:IAsyncToken Exports all assets(published/mark-for-published assets) and data dictionary (non-system)	IExportService
		exportAssetDefinition(assetType:int, assetId:String):com.adobe.icc.token:IAsyncToken Export the definition of an asset in a readable XML format.	IExportService
		exportAssetDefinitionCompressed(assetType:int, assetId:String):com.adobe.icc.token:IAsyncToken Export the definition of an asset in a 'compressed' readable XML format.	IExportService
		exportAssetDependencies(assetType:int, assetId:String):com.adobe.icc.token:IAsyncToken Retrieves the asset depedencies in xml format	IExportService
		exportPackage(assetIdList:IList, packageName:String):com.adobe.icc.token:IAsyncToken Exports the list of selected assets.	IExportService
		fetchPackageDependencies(assetIdList:IList):com.adobe.icc.token:IAsyncToken Fetches all the dependent assets of the selected assets from the server .	IExportService
		getAllExportedAssetsInfo():com.adobe.icc.token:IAsyncToken Information about all assets being exported	IExportService
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		importAsset(dataDownload:DataDownload):com.adobe.icc.token:IAsyncToken Imports all the assets from the zip file.	IExportService
		importAssetDefinition(assetType:int, bytes:ByteArray, isCompressed:Boolean):com.adobe.icc.token:IAsyncToken Reads the given XML data bytes (serialized asset bytes) and creates the corresponding asset object.	IExportService
		importPackage(dataDownload:DataDownload):com.adobe.icc.token:IAsyncToken Fetches all the assets to be imported from the (.zip) file .	IExportService
		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

exportAllAssets

()

method

public function exportAllAssets():com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Exports all assets(published/mark-for-published assets) and data dictionary (non-system)

Returns

com.adobe.icc.token:IAsyncToken — Downloadable object having zip File content for all assets

exportAssetDefinition

()

method

public function exportAssetDefinition(assetType:int, assetId: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

Export the definition of an asset in a readable XML format.

Parameters

	`assetType:int` — The asset type.

	`assetId:String` — The asset identifier (GUID).

Returns

com.adobe.icc.token:IAsyncToken — A DataDownload object containing the asset definition data. That is xml as bytes.

Throws

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

exportAssetDefinitionCompressed

()

method

public function exportAssetDefinitionCompressed(assetType:int, assetId: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

Export the definition of an asset in a 'compressed' readable XML format.

Parameters

	`assetType:int` — The asset type.

	`assetId:String` — The asset identifier (GUID).

Returns

com.adobe.icc.token:IAsyncToken — A DataDownload object containing the asset definition data. That is xml as 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

exportAssetDependencies

()

method

public function exportAssetDependencies(assetType:int, assetId: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 asset depedencies in xml format

Parameters

	`assetType:int` — The asset type.

	`assetId:String` — The asset identifier (GUID).

Returns

com.adobe.icc.token:IAsyncToken — A DataDownload object containing the asset dependencies. That is xml as bytes.

Throws

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

exportPackage

()

method

public function exportPackage(assetIdList:IList, packageName:String):com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Exports the list of selected assets.

Parameters

	`assetIdList:IList` — The IList type.

	`packageName:String` — The String type.

Returns

com.adobe.icc.token:IAsyncToken — The list of selected assets to be exported.

Throws

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

fetchPackageDependencies

()

method

public function fetchPackageDependencies(assetIdList:IList):com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Fetches all the dependent assets of the selected assets from the server .

Parameters

assetIdList:IList — The IList type.

Returns

com.adobe.icc.token:IAsyncToken — all the dependent assets of the selected assets from the server

Throws

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

getAllExportedAssetsInfo

()

method

public function getAllExportedAssetsInfo():com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Information about all assets being exported

Returns

com.adobe.icc.token:IAsyncToken — List of Assets and Data Dictinary to be exported. List may contains (TextModule, ListDataModule, ConditionalDataModule, ImageModule, Form, FragmentLayout, Letter) and data dictionary (DataDictionary)

Throws

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

importAsset

()

method

public function importAsset(dataDownload:DataDownload):com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Imports all the assets from the zip file.

Parameters

dataDownload:DataDownload — Downloadable object having zip file content

Returns

com.adobe.icc.token:IAsyncToken —

Throws

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

importAssetDefinition

()

method

 public function importAssetDefinition(assetType:int, bytes:ByteArray, isCompressed:Boolean):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

Reads the given XML data bytes (serialized asset bytes) and creates the corresponding asset object.

Parameters

	`assetType:int` — The asset type.

	`bytes:ByteArray` — The asset definition bytes, that may have been generated using `exportAssetDefinition`.

	`isCompressed:Boolean` — True, if the bytes are compressed. False otherwise.

Returns

com.adobe.icc.token:IAsyncToken — A DataDownload object containing the letter definition data. That is xml as bytes.

Throws

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

importPackage

()

method

public function importPackage(dataDownload:DataDownload):com.adobe.icc.token:IAsyncToken

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Fetches all the assets to be imported from the (.zip) file .

Parameters

dataDownload:DataDownload — Downloadable object having zip file content

Returns

com.adobe.icc.token:IAsyncToken — list of assetID being imported.

Throws

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

Legal Notices | Online Privacy Policy

IExportService - AS3 Asset Composer

Classes x

exportAllAssets

exportAssetDefinition

exportAssetDefinitionCompressed

exportAssetDependencies

exportPackage

fetchPackageDependencies

getAllExportedAssetsInfo

importAsset

importAssetDefinition

importPackage