| Paket | com.adobe.icc.services.render |
| Gränssnitt | public interface ILetterRenderService extends IEventDispatcher |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Publika metoder
Dölj ärvda publika metoder
Visa ärvda publika metoder| Metod | Definieras med | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser. | IEventDispatcher | |
|
Skickar en händelse till händelseflödet. | IEventDispatcher | |
getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken
Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client. | ILetterRenderService | ||
|
Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse. | IEventDispatcher | |
|
Tar bort en avlyssnare från EventDispatcher-objektet. | IEventDispatcher | |
renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. | ILetterRenderService | ||
renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. | ILetterRenderService | ||
renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer). | ILetterRenderService | ||
renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all
(for a UI-augmented shell Layout PDF for interactive use in Doc Composer). | ILetterRenderService | ||
renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer). | ILetterRenderService | ||
renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer). | ILetterRenderService | ||
|
Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen. | IEventDispatcher | |
Metoddetaljer
getRenderedFileUrl | () | metod |
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Given the successful response result from a call to render a letter, determine the URL where the PDF was rendered on the server so that it can be downloaded to the client.
Parametrar
response:com.adobe.icc.vo.render:PDFResponseType — The response returned from a call to render a letter (via renderLetter(), for example).
|
com.adobe.icc.token:IAsyncToken — A string containing the URL to the rendered file.
|
Utlöser
Error — Invalid render response.
| |
Error — Render response indicates a failure to render the letter.
|
Relaterade API-element
renderInteractiveLetter | () | metod |
public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. The PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter.
Parametrar
letterId:String — ID (GUID) of the letter to render.
| |
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 to the file.
|
Utlöser
Error — Letter ID is invalid.
|
Relaterade API-element
renderInteractiveLetterFromObject | () | metod |
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter as an augmented shell PDF for interactive use in Doc Composer. The PDF returned will be augmented with UI facilities for interactive use in Doc Composer but will not contain any data nor any modules, even mandatory and pre-selected ones. It is up to the client to fill the letter.
Parametrar
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 to the file.
|
Utlöser
Error — Letter ID is invalid.
|
Relaterade API-element
renderLetter | () | metod |
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
Parametrar
letterId:String — ID (GUID) of the letter to render.
| |
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 to the file. If mergeData is true, the PDFResponseType object only contains information about the rendered file but not the file
itself. To always get access the rendered PDF on the server, use the renderLetterToFile() method.
|
Utlöser
Error — Letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
| |
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
| |
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.
|
Relaterade API-element
renderLetterFromObject | () | metod |
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
Parametrar
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 to the file. If mergeData is true, the PDFResponseType object only contains information about the rendered file but not the file
itself. To always get access the rendered PDF on the server, use the renderLetterObjectToFile() method.
|
Utlöser
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
| |
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
| |
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.
|
Relaterade API-element
renderLetterObjectToFile | () | metod |
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
Parametrar
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 to the file.
|
Utlöser
Error — Letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
| |
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
| |
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.
|
Relaterade API-element
renderLetterToFile | () | metod |
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Asset Composer Building Block 9.5 |
| Körningsmiljöversioner: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Render a given Letter against the given Initial XML Data, the Letter's test data or no data at all (for a UI-augmented shell Layout PDF for interactive use in Doc Composer).
Parametrar
letterId:String — ID (GUID) of the letter to render.
| |
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 to the file.
|
Utlöser
Error — Letter ID is invalid.
| |
Error — MergeData is true, initialXmlData is null and useTestData is false (no data supplied).
| |
Error — MergeData is true, initialXmlData is null, useTestData is true but the Letter doesn't have test data.
| |
Error — The data supplied couldn't be used to initialize the Letter's Data Dictionary.
|
Relaterade API-element
Tue Jun 12 2018, 01:40 PM Z