| Package | com.adobe.icc.services.render |
| Interface | public interface ILetterRenderService extends IEventDispatcher |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Méthodes publiques
Masquer les méthodes publiques héritées
Afficher les méthodes publiques héritées| Méthode | Défini par | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | IEventDispatcher | |
|
Distribue un événement dans le flux d’événements. | 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 | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | IEventDispatcher | |
|
Supprime un écouteur de l’objet EventDispatcher. | 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 | ||
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | IEventDispatcher | |
Détails de la méthode
getRenderedFileUrl | () | méthode |
public function getRenderedFileUrl(response:com.adobe.icc.vo.render:PDFResponseType):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Valeur émise
Error — Invalid render response.
| |
Error — Render response indicates a failure to render the letter.
|
Eléments de l’API associés
renderInteractiveLetter | () | méthode |
public function renderInteractiveLetter(letterId:String, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Valeur émise
Error — Letter ID is invalid.
|
Eléments de l’API associés
renderInteractiveLetterFromObject | () | méthode |
public function renderInteractiveLetterFromObject(letter:Letter, initialXmlData:String = null):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Valeur émise
Error — Letter ID is invalid.
|
Eléments de l’API associés
renderLetter | () | méthode |
public function renderLetter(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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).
Paramètres
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.
|
Valeur émise
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.
|
Eléments de l’API associés
renderLetterFromObject | () | méthode |
public function renderLetterFromObject(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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).
Paramètres
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.
|
Valeur émise
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.
|
Eléments de l’API associés
renderLetterObjectToFile | () | méthode |
public function renderLetterObjectToFile(letter:Letter, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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).
Paramètres
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.
|
Valeur émise
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.
|
Eléments de l’API associés
renderLetterToFile | () | méthode |
public function renderLetterToFile(letterId:String, mergeData:Boolean = false, initialXmlData:String = null, useTestData:Boolean = false, interactive:Boolean = true):com.adobe.icc.token:IAsyncToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Bloc de création Asset Composer 9.5 |
| Versions du moteur d’exécution: | 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).
Paramètres
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.
|
Valeur émise
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.
|
Eléments de l’API associés
Tue Jun 12 2018, 09:30 AM Z