| Package | com.adobe.icc.services.letter |
| Interface | public interface ILetterService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
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 | ||
Allows creating a new Letter template entry. | ILetterService | ||
Allows creating a test version of a letter template entry. | ILetterService | ||
Allows deleting of a letter. | ILetterService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Method description: Returns a list of available letter templates. | ILetterService | ||
Retrieves a letter given its unique identifier. | ILetterService | ||
Retrieves a letter given its unique identifier and date on which the letter was published. | 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 | ||
Mark as ready to publish the Letter identified by the given letterID. | ILetterService | ||
Publish the Letter identified by the given letterID. | ILetterService | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Reverts the letter to the last published version. | ILetterService | ||
Allows modifying a letter template entry which has a 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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Activates a letter template
Parameters
letterID:String — The ID (GUID) of the letter to activate
| |
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Creates a copy of an existing letter.
Parameters
oldLetterID:String — Identifier if the letter to be copied
| |
newLetter:Letter — may optionally specify a new test data file
|
com.adobe.icc.token:IAsyncToken — New letter object (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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Allows creating 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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Allows creating a test version of a letter template entry.
Parameters
letterID:String — The ID (GUID) of an existing Letter to duplicate as a test version
|
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Allows deleting of a letter.
Parameters
letterId:String — The ID (GUID) of the letter to delete
|
com.adobe.icc.token:IAsyncToken — Return without any value if delete was successful
|
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Method description: Returns a list of available letter templates.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — 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.
|
getLetter | () | method |
public function getLetter(letterId: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 |
Retrieves a letter given its unique identifier.
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.
|
getLetterByVersion | () | method |
public function getLetterByVersion(letterId:String, date:Date):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 |
Retrieves a letter given its unique identifier and date on which the letter was published.
Parameters
letterId:String — The unique identifier of the letter to retrieve (i.e. it's GUID).
| |
date:Date — The date on which the letter was published
|
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
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 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Determines if the specified letter exists.
Parameters
name:String — Version-independent name of the letter.
|
com.adobe.icc.token:IAsyncToken — Boolean which is true if the letter exists; false if not.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
markReadyToPublish | () | method |
public function markReadyToPublish(letterId: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 |
Mark as ready to publish the Letter identified by the given letterID.
Parameters
letterId:String — ID of the Letter
|
com.adobe.icc.token:IAsyncToken — Letter object marked for publishing
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
publishLetter | () | method |
public function publishLetter(letterId: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 |
Publish the Letter identified by the given letterID.
Parameters
letterId:String — ID of the Letter
|
com.adobe.icc.token:IAsyncToken — published 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.
|
revertToLastPublish | () | method |
public function revertToLastPublish(fragmentLayoutId: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 |
Reverts the letter to the last published version. If letter is not published, it is removed from repository.
Parameters
fragmentLayoutId:String — ID of the Letter
|
com.adobe.icc.token:IAsyncToken — Reverted 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.
|
updateLetter | () | method |
public function updateLetter(letter:Letter):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 |
Allows modifying a letter template entry which has a state test.
Parameters
letter:Letter — Letter object to be updated
|
com.adobe.icc.token:IAsyncToken — 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.
|
Mon Apr 10 2017, 12:28 PM -07:00