(Beta)
| Package | com.adobe.icc.services.render |
| Interface | public interface ILetterRenderService 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 | ||
|---|---|---|---|
 | 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 | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken
Determines the URL where the PDF was rendered on the server if the response result from a call to render a letter is successful. | ILetterRenderService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Renders a specified letter, given the letter's identifier, as an interactive PDF that is to be augmented with a user interface for use in a document composer application. | ILetterRenderService | ||
renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Renders a specified letter, given the full Letter object, as an interactive PDF that is to be augmented with a user interface for use in a document composer application. | ILetterRenderService | ||
renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Renders a specified letter, given the letter's identifier, based on the specified input parameters. | ILetterRenderService | ||
renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Renders a specified letter, given the letter’s identifier, based on the given input parameters. | ILetterRenderService | ||
renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Renders a specified letter using initial XML data, the letter's test data, or no data at all. | ILetterRenderService | ||
renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Renders a specified letter to a file on the disk, given the letter’s identifier, based on the specified input parameters. | ILetterRenderService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
getRenderedFileUrl | () | method |
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):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 the URL where the PDF was rendered on the server if the response result from a call to render a letter is successful. The PDF can then be downloaded to the client.
Parameters
response:com.adobe.icc.vo.render:PDFResponseType — The response returned from a call to render a letter. For example, via renderLetter().
|
com.adobe.icc.token:IAsyncToken — A string containing the URL of the rendered file.
|
Throws
Error — Invalid render response.
| |
Error — Render response indicates a failure to render the letter.
|
Related API Elements
renderInteractiveLetter | () | method |
public function renderInteractiveLetter(letterId:String, initialXmlData:String = 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 |
Renders a specified letter, given the letter's identifier, as an interactive PDF that is to be augmented with a user interface for use in a document composer application. The initial XML is the data to merge with the interactive PDF. The initial XML is also used as initializing data for the data dictionary. The PDF that is returned does not contain any data or modules, including mandatory and pre-selected ones. The client fills the letter.
Parameters
letterId:String — The identifier of the letter to render. The identifier is the GUID.
| |
initialXmlData:String (default = null) |
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file.
|
Throws
Error — Letter ID is invalid.
|
Related API Elements
renderInteractiveLetterFromObject | () | method |
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = 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 |
Renders a specified letter, given the full Letter object, as an interactive PDF that is to be augmented with a user interface for use in a document composer application.
The initial XML is the data to merge with the interactive PDF. The initial XML is also used as initializing data for the data dictionary.
The PDF that is returned
does not contain any data or any modules, including mandatory and pre-selected ones. The client fills the letter.
Parameters
letter:Letter — Fully populated letter object with layout and assignments.
| |
initialXmlData:String (default = null) |
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file.
|
Throws
Error — Letter ID is invalid.
|
Related API Elements
renderLetter | () | method |
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):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 |
Renders a specified letter, given the letter's identifier, based on the specified input parameters. This is used for a shell layout PDF that is augmented with a user interface and used within a document composer application.
Parameters
letterId:String — The identifier of the letter to render. The identifier is the GUID.
| |
mergeData:Boolean (default = false) | |
initialXmlData:String (default = null)Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true. | |
useTestData:Boolean (default = false)Ignored if initialXmlData is not null. | |
interactive:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — If mergeData is false, a PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file. If mergeData is true, the PDFResponseType object contains information about the rendered file only, not about the file
itself. To access the rendered PDF on the server, use the renderLetterToFile() method.
|
Throws
Error — The letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is false. That is, no data is supplied.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is true, but the letter does not have test data.
| |
Error — The data supplied could not be used to initialize the letter's data dictionary.
|
Related API Elements
renderLetterFromObject | () | method |
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):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 |
Renders a specified letter, given the letter’s identifier, based on the given input parameters. This is used for a shell layout PDF that is augmented with a user interface and used within a document composer application.
Parameters
letter:Letter — Fully populated Letter object with layout and assignments.
| |
mergeData:Boolean (default = false) | |
initialXmlData:String (default = null)Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true. | |
useTestData:Boolean (default = false)Ignored if initialXmlData is not null. | |
interactive:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — If mergeData is false, a PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file. If mergeData is true, the PDFResponseType object contains information about the rendered file only, not about the file
itself. To access the rendered PDF on the server, use the renderLetterObjectToFile() method.
|
Throws
Error — MergeData is true, initialXmlData is null, and useTestData is false. That is, no data is supplied.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is true, but the letter does not have test data.
| |
Error — The data supplied could not be used to initialize the letter's data dictionary.
|
Related API Elements
renderLetterObjectToFile | () | method |
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):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 |
Renders a specified letter using initial XML data, the letter's test data, or no data at all. This is used for a shell layout PDF that is augmented with a user interface and used within a document composer application.
Parameters
letter:Letter — Fully populated Letter object with layout and assignments.
| |
mergeData:Boolean (default = false) | |
initialXmlData:String (default = null)Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true. | |
useTestData:Boolean (default = false)Ignored if initialXmlData is not null. | |
interactive:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file.
|
Throws
Error — Letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is false. That is, no data is supplied.
| |
Error — MergeData is true, initialXmlData is null, useTestData is true, but the letter does not have test data.
| |
Error — The data supplied could not be used to initialize the letter's data dictionary.
|
Related API Elements
renderLetterToFile | () | method |
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):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 |
Renders a specified letter to a file on the disk, given the letter’s identifier, based on the specified input parameters. The name of the file saved on disk is available in the response. This is used for a shell layout PDF that is augmented with a user interface and used within a document composer application.
Parameters
letterId:String — The identifier of the letter to render. The identifier is the GUID.
| |
mergeData:Boolean (default = false) | |
initialXmlData:String (default = null)Can be null if mergeData is false or useTestData is true. If specified, this data takes precedence over any existing test data, even if useTestData is true. | |
useTestData:Boolean (default = false)Ignored if initialXmlData is not null. | |
interactive:Boolean (default = true) |
com.adobe.icc.token:IAsyncToken — A PDFResponseType object that contains the name of the PDF file rendered on the server. Use the getRenderedFileUrl()
method to get the full URL of the file.
|
Throws
Error — The letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is false. That is, no data is supplied.
| |
Error — MergeData is true, initialXmlData is null, and useTestData is true, but the letter does not have test data.
| |
Error — The data supplied could not be used to initialize the letter's data dictionary.
|
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00