(Beta)
| Package | lc.procmgmt |
| Interface | public interface IEndpointManager extends IManager , IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
IEndpointManager interface is implemented to manage TaskManager endpoints.
Workspace start points that are added to a process diagram create TaskManager endpoints. TaskManager
endpoints are invoked to start the process by using LiveCycle Workspace ES2. When using Workspace ES2 to
start a process, a form is always used. A PDF form or form data is passed as input to the process. For more information about creating processes for Workspace ES2,
see "Designing human-centric processes" in
LiveCycle Workbench ES2 Help
.
Implement the IEndpointManager interface to get categories of endpoints,
invoke endpoints, retrieve endpoints, and get images associated with endpoints.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public PropertiesPublic 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 | |
Retrieves all categories of endpoints that are available to an authenticated user. | IEndpointManager | ||
Retrieves the endpoint by using the specified endpoint identifer. | IEndpointManager | ||
Deprecated Since LiveCycle ES Update 1 (8.2): Please use getImageUrlForEndpoint(). | IEndpointManager | ||
Retrieves the endpoints for an array of endpoint identifiers. | IEndpointManager | ||
Retrieves the endpoints in the specified category. | IEndpointManager | ||
Retrieves the location of the image for an endpoint. | IEndpointManager | ||
|
Determines whether the default operation is prevented. | IManager | |
|
Determines whether the default operation is prevented. | IManager | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Invokes the specified endpoint by its unique identifier. | IEndpointManager | ||
Invokes an endpoint with the data from the task that the task ID identified as the initial data. | IEndpointManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
getCategories | () | method |
public function getCategories():lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves all categories of endpoints that are available to an authenticated user.
Returnslc.foundation.util:CollectionToken — A collection of tokens that contains Category objects
when the request is complete. You can set the result and fault handlers on each Token object
to be called when the invocation is complete and the collection is fully populated.
|
getEndpoint | () | method |
public function getEndpoint(endpointId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves the endpoint by using the specified endpoint identifer.
Parameters
endpointId:String — Specifies the unique identifier of an endpoint.
|
lc.foundation.util:ObjectToken — A token that will contain the Endpoint object when the request is complete.
You can set result and fault handlers on the token to be called when the invocation
is complete and the result is returned.
|
getEndpointImageUrl | () | method |
public function getEndpointImageUrl(endpointId:String, imageTicket:String):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Deprecated Since LiveCycle ES Update 1 (8.2): Please use getImageUrlForEndpoint().
Retrieves the location of the image for an endpoint.
Parameters
endpointId:String — Specifies the identifier of the endpoint to retrieve the image for.
| |
imageTicket:String — Specifies the location of the image for the endpoint.
|
String — A URL that represents the location of the image.
|
Related API Elements
getEndpoints | () | method |
public function getEndpoints(endpointIds:Array):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves the endpoints for an array of endpoint identifiers.
Parameters
endpointIds:Array — Specifies endpoint identifiers as an array.
|
lc.foundation.util:CollectionToken — A token that contains a collection of Endpoint objects when the request is complete.
You can set result and fault handlers on the token to be called when the invocation is
complete and the collection is fully populated.
|
getEndpointsForCategory | () | method |
public function getEndpointsForCategory(categoryName:String):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves the endpoints in the specified category.
Parameters
categoryName:String — Specifies the unique identifier of the category.
|
lc.foundation.util:CollectionToken — A token that contains a collection of Endpoint objects when the request is complete.
You can set result and fault handlers on the token to be called when the invocation is
complete and the collection is fully populated.
|
getImageUrlForEndpoint | () | method |
public function getImageUrlForEndpoint(endpoint:Endpoint):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves the location of the image for an endpoint.
Parameters
endpoint:Endpoint — Specifies the the endpoint to locate an image for.
|
String — A URL that represents the location of the image.
|
invokeEndpoint | () | method |
public function invokeEndpoint(endpointId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Invokes the specified endpoint by its unique identifier. If the endpoint returns a
Document object on the server-side, a DocumentReference object
is returned; if the endpoint returns task information, a Task object
is returned. Invoked endpoints return either a DocumentReference or Task object.
Parameters
endpointId:String — Specifies the unique identifier of the endpoint to invoke.
|
lc.foundation.util:ObjectToken — A token that will contain the endpoint invocation result, a Task, or a DocumentReference object
when the request is complete. You can set result and fault handlers on the token to be called when the invocation is
complete and the result is returned.
|
invokeEndpointFromStartTask | () | method |
public function invokeEndpointFromStartTask(taskId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Invokes an endpoint with the data from the task that the task ID identified as the initial data.
The invoked endpoint returns a DocumentReference object when a Document object is
returned on the server-side. A Task object is returned when an endpoint returns task
information.
Parameters
taskId:String — Specifies the unique identifier of the Task object to create a new task.
|
lc.foundation.util:ObjectToken — An ObjectToken object that contains the endpoint invocation result.
A Task or a DocumentReference object is provided.
You can set result and fault handlers on the ObjectToken object that
are called when the invocation is complete and the result is returned.
|
Mon Nov 18 2013, 11:47 AM -08:00