IEndpointManager - BETA ActionScript® 3 (AS3 ADEP Document Services) Reference for the Adobe® Flash® Platform API Reference

(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

The 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

lc.procmgmt.domain.Endpoint
lc.procmgmt.domain.Category

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		faultHandler : Function The default fault handler function.	IManager

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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		getCategories():lc.foundation.util:CollectionToken Retrieves all categories of endpoints that are available to an authenticated user.	IEndpointManager
		getEndpoint(endpointId:String):lc.foundation.util:ObjectToken Retrieves the endpoint by using the specified endpoint identifer.	IEndpointManager
		getEndpointImageUrl(endpointId:String, imageTicket:String):String Deprecated Since LiveCycle ES Update 1 (8.2): Please use getImageUrlForEndpoint().	IEndpointManager
		getEndpoints(endpointIds:Array):lc.foundation.util:CollectionToken Retrieves the endpoints for an array of endpoint identifiers.	IEndpointManager
		getEndpointsForCategory(categoryName:String):lc.foundation.util:CollectionToken Retrieves the endpoints in the specified category.	IEndpointManager
		getImageUrlForEndpoint(endpoint:Endpoint):String Retrieves the location of the image for an endpoint.	IEndpointManager
		handleEvent(token:lc.foundation.util:Token, event:LiveCycleEvent):void Determines whether the default operation is prevented.	IManager
		handleFault(token:lc.foundation.util:Token, event:LiveCycleFaultEvent):void Determines whether the default operation is prevented.	IManager
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		invokeEndpoint(endpointId:String):lc.foundation.util:ObjectToken Invokes the specified endpoint by its unique identifier.	IEndpointManager
		invokeEndpointFromStartTask(taskId:String):lc.foundation.util:ObjectToken Invokes an endpoint with the data from the task that the task ID identified as the initial data.	IEndpointManager
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	IEventDispatcher

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

IEndpointManager - AS3 ADEP Document Services

Packagesx

Language Elements

Appendixes

Package lc.procmgmt

getCategories

getEndpoint

getEndpointImageUrl

getEndpoints

getEndpointsForCategory

getImageUrlForEndpoint

invokeEndpoint

invokeEndpointFromStartTask

	`endpointId:String` — Specifies the identifier of the endpoint to retrieve the image for.

	`imageTicket:String` — Specifies the location of the image for the endpoint.