(Beta)
| Package | com.adobe.icc.services.letter |
| Interface | public interface ILetterService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
Activates a letter template
| ILetterService | ||
 | 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 | |
Creates a copy of an existing letter. | ILetterService | ||
Creates a new Letter template entry. | ILetterService | ||
Creates a test version of a letter template entry. | ILetterService | ||
Deletes a letter. | ILetterService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Returns a list of available letter templates. | ILetterService | ||
Fetch the latest version of the Letter identified by the given letterName. | ILetterService | ||
Retrieves a letter using its unique identifier. | ILetterService | ||
Retrieves a letter given its unique identifier, with the latest versions of assets used
in the letter. | ILetterService | ||
getUsedDataModules(letterId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken
Retrieve the list of modules that is used by the Letter identified by the given letterId. | ILetterService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Determines if the specified letter exists. | ILetterService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Modifies a letter template entry that has the state test. | ILetterService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
activateLetter | () | method |
public function activateLetter(letterID:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Activates a letter template
Parameters
letterID:String — The identifier of the letter to activate. The identifier is the GUID.
| |
updateDependencies:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — The updated Letter.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
copyLetter | () | method |
public function copyLetter(oldLetterID:String, newLetter:Letter):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a copy of an existing letter.
Parameters
oldLetterID:String — identifier of the letter to be copied.
| |
newLetter:Letter — Can optionally specify a new test data file.
|
com.adobe.icc.token:IAsyncToken — The new letter object. That is, the copy.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createLetter | () | method |
public function createLetter(letter:Letter):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a new Letter template entry.
Parameters
letter:Letter — Letter Object to be created
|
com.adobe.icc.token:IAsyncToken — The new Letter object, on success.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
createTestLetter | () | method |
public function createTestLetter(letterID:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Creates a test version of a letter template entry.
Parameters
letterID:String — The identifier of an existing Letter to duplicate as a test version. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — The new Letter object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
deleteLetter | () | method |
public function deleteLetter(letterId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Deletes a letter.
Parameters
letterId:String — The identifier of the letter to delete. The identifier is the GUID.
|
com.adobe.icc.token:IAsyncToken — Returns successfully in case of letter has been deleted successfully on 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.
|
getAllLetters | () | method |
public function getAllLetters(query:Query = null):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns a list of available letter templates.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection containing the letter records as Letter objects.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getLatestLetter | () | method |
public function getLatestLetter(letterName:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Fetch the latest version of the Letter identified by the given letterName.
Ignores any Inactive versions.
Parameters
letterName:String — Name of the Letter whose latest version is to be fetched.
|
com.adobe.icc.token:IAsyncToken — The result event's result data is the latest version of the Letter object for the specified letterName, if the name is valid.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getLetter | () | method |
public function getLetter(letterId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a letter using its unique identifier.
Parameters
letterId:String — The unique identifier of the letter to retrieve. That is, the GUID.
|
com.adobe.icc.token:IAsyncToken — The result event's result data is a Letter object for the specified letter, if the ID is valid.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getLetterWithLatestAssets | () | method |
public function getLetterWithLatestAssets(letterId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves a letter given its unique identifier, with the latest versions of assets used in the letter. The actual versions of assets used in the Letter would be replaced by the latest available assets. Note: If an Inactive version of an asset exists, then that is considered as the atestversion of that asset.
Parameters
letterId:String — The unique identifier of the letter to retrieve (i.e. it's GUID).
|
com.adobe.icc.token:IAsyncToken — The result event's result data will be a Letter object for the specified letter, if the ID was valid.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getUsedDataModules | () | method |
public function getUsedDataModules(letterId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieve the list of modules that is used by the Letter identified by the given letterId.
Parameters
letterId:String — ID (GUID) of the Letter, for which the used modules are to be fetched.
| |
fetchIndirectReferences:Boolean (default = false) |
com.adobe.icc.token:IAsyncToken — List of modules that is used by the given Letter.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
letterExists | () | method |
public function letterExists(name:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Determines if the specified letter exists.
Parameters
name:String — The name of the letter. The name is not associated with a specific version.
|
com.adobe.icc.token:IAsyncToken — A Boolean that is true if the letter exists. If the letter does not exist, it is false.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
updateLetter | () | method |
public function updateLetter(letter:Letter):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Modifies a letter template entry that has the state test.
Parameters
letter:Letter — Letter to be updated
|
com.adobe.icc.token:IAsyncToken — The updated letter object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Wed Nov 21 2018, 06:34 AM -08:00