ILetterService - Adobe ActionScript® 3 (AS3 Asset Composer) API-Referenz

Paket	com.adobe.icc.services.letter
Schnittstelle	public interface ILetterService extends IEventDispatcher

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Defines a service for Letter management.

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		activateLetter(letterID:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken Activates a letter template	ILetterService
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	IEventDispatcher
		copyLetter(oldLetterID:String, newLetter:Letter):com.adobe.icc.token:IAsyncToken Creates a copy of an existing letter.	ILetterService
		createLetter(letter:Letter):com.adobe.icc.token:IAsyncToken Allows creating a new Letter template entry.	ILetterService
		createTestLetter(letterID:String):com.adobe.icc.token:IAsyncToken Allows creating a test version of a letter template entry.	ILetterService
		deleteLetter(letterId:String):com.adobe.icc.token:IAsyncToken Allows deleting of a letter.	ILetterService
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	IEventDispatcher
		getAllLetters(query:Query = null):com.adobe.icc.token:IAsyncToken Method description: Returns a list of available letter templates.	ILetterService
		getLetter(letterId:String):com.adobe.icc.token:IAsyncToken Retrieves a letter given its unique identifier.	ILetterService
		getLetterByVersion(letterId:String, date:Date):com.adobe.icc.token:IAsyncToken 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
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	IEventDispatcher
		letterExists(name:String):com.adobe.icc.token:IAsyncToken Determines if the specified letter exists.	ILetterService
		markReadyToPublish(letterId:String):com.adobe.icc.token:IAsyncToken Mark as ready to publish the Letter identified by the given letterID.	ILetterService
		publishLetter(letterId:String):com.adobe.icc.token:IAsyncToken Publish the Letter identified by the given letterID.	ILetterService
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	IEventDispatcher
		revertToLastPublish(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken Reverts the letter to the last published version.	ILetterService
		updateLetter(letter:Letter):com.adobe.icc.token:IAsyncToken Allows modifying a letter template entry which has a state test.	ILetterService
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	IEventDispatcher

Methodendetails

activateLetter

()

Methode

public function activateLetter(letterID:String, updateDependencies:Boolean = false):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Activates a letter template

Parameter

	`letterID:String` — The ID (GUID) of the letter to activate

	`updateDependencies:Boolean` (default = `false`) — Whether to replace/use this new activated version in the dependencies

Rückgabewerte

com.adobe.icc.token:IAsyncToken — the updated Letter

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

copyLetter

()

Methode

public function copyLetter(oldLetterID:String, newLetter:Letter):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Creates a copy of an existing letter.

Parameter

	`oldLetterID:String` — Identifier if the letter to be copied

	`newLetter:Letter` — may optionally specify a new test data file

Rückgabewerte

com.adobe.icc.token:IAsyncToken — New letter object (the copy).

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

createLetter

()

Methode

public function createLetter(letter:Letter):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Allows creating a new Letter template entry.

Parameter

letter:Letter — Letter object to be created

Rückgabewerte

com.adobe.icc.token:IAsyncToken — The new Letter object on success

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

createTestLetter

()

Methode

public function createTestLetter(letterID:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Allows creating a test version of a letter template entry.

Parameter

letterID:String — The ID (GUID) of an existing Letter to duplicate as a test version

Rückgabewerte

com.adobe.icc.token:IAsyncToken — The new Letter object

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

deleteLetter

()

Methode

public function deleteLetter(letterId:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Allows deleting of a letter.

Parameter

letterId:String — The ID (GUID) of the letter to delete

Rückgabewerte

com.adobe.icc.token:IAsyncToken — Return without any value if delete was successful

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

getAllLetters

()

Methode

public function getAllLetters(query:Query = null):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Method description: Returns a list of available letter templates.

Parameter

query:Query (default = null) — Query specifying the statements for filtering search results.

Rückgabewerte

com.adobe.icc.token:IAsyncToken — ArrayCollection containing the letter records as Letter objects

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

getLetter

()

Methode

public function getLetter(letterId:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Retrieves a letter given its unique identifier.

Parameter

letterId:String — The unique identifier of the letter to retrieve (i.e. it's GUID).

Rückgabewerte

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.

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

getLetterByVersion

()

Methode

public function getLetterByVersion(letterId:String, date:Date):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Retrieves a letter given its unique identifier and date on which the letter was published.

Parameter

	`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

Rückgabewerte

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.

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

getUsedDataModules

()

Methode

 public function getUsedDataModules(letterId:String, fetchIndirectReferences:Boolean = false):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Retrieve the list of modules that is used by the Letter identified by the given letterId.

Parameter

	`letterId:String` — ID (GUID) of the Letter, for which the used modules are to be fetched.

	`fetchIndirectReferences:Boolean` (default = `false`) — True, if you wish to fetch the modules that are directly or indirectly used by this Letter. For example, if a Text T1 is used in a List L1, and List L1 is used in Letter L1, the List would contain (T1 and L1), for the Letter L1. If false, the List would contain only L1.

Rückgabewerte

com.adobe.icc.token:IAsyncToken — List of modules that is used by the given Letter.

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

letterExists

()

Methode

public function letterExists(name:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Determines if the specified letter exists.

Parameter

name:String — Version-independent name of the letter.

Rückgabewerte

com.adobe.icc.token:IAsyncToken — Boolean which is true if the letter exists; false if not.

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

markReadyToPublish

()

Methode

public function markReadyToPublish(letterId:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Mark as ready to publish the Letter identified by the given letterID.

Parameter

letterId:String — ID of the Letter

Rückgabewerte

com.adobe.icc.token:IAsyncToken — Letter object marked for publishing

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

publishLetter

()

Methode

public function publishLetter(letterId:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Publish the Letter identified by the given letterID.

Parameter

letterId:String — ID of the Letter

Rückgabewerte

com.adobe.icc.token:IAsyncToken — published Letter object

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

revertToLastPublish

()

Methode

public function revertToLastPublish(fragmentLayoutId:String):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Reverts the letter to the last published version. If letter is not published, it is removed from repository.

Parameter

fragmentLayoutId:String — ID of the Letter

Rückgabewerte

com.adobe.icc.token:IAsyncToken — Reverted letter object

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

updateLetter

()

Methode

public function updateLetter(letter:Letter):com.adobe.icc.token:IAsyncToken

Sprachversion:

ActionScript 3.0

Produktversion:

Baustein „Asset Composer“ 10

Laufzeitversionen:

AIR (unsupported), Flash Player 10.2

Allows modifying a letter template entry which has a state test.

Parameter

letter:Letter — Letter object to be updated

Rückgabewerte

com.adobe.icc.token:IAsyncToken — Updated letter object.

Auslöser

Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.

Rechtliche Hinweise | Onlinedatenschutzerklärung

ILetterService - AS3 Asset Composer

Klassen x

activateLetter

copyLetter

createLetter

createTestLetter

deleteLetter

getAllLetters

getLetter

getLetterByVersion

getUsedDataModules

letterExists

markReadyToPublish

publishLetter

revertToLastPublish

updateLetter