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

(Beta)

Package	lc.procmgmt.domain
Class	public class Endpoint
Inheritance	Endpoint DomainObject Object
Implements	IManaged

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 Endpoint class represents a TaskManager endpoint in LiveCycle ES2. An Endpoint object is used for the following purposes:

Retrieving the properties of the endpoint.

Starting a process instance and the corresponding tasks by invoking an endpoint. For the user's perspective, a process is started by using a form.

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 .

Related API Elements

lc.procmgmt.domain.ProcessInstance
lc.procmgmt.domain.Task

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		categoryId : String The identifier of the category that the TaskManager endpoint is part of.	Endpoint
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		description : String The description of the TaskManager endpoint.	Endpoint
		endpointId : String The endpoint identifier representing the TaskManager endpoint.	Endpoint
		name : String The name of the TaskManager endpoint or form used to start a process.	Endpoint
		service : String	Endpoint
		session : SessionMap [read-only] A SessionMap object that stores information relating to the server session.	DomainObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	Endpoint
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Endpoint
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Endpoint
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		invoke():lc.foundation.util:ObjectToken Invokes the specified TaskManager endpoint.	Endpoint
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Endpoint
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSession(session:SessionMap):void [override] Sets a SessionMap object that stores the information relating to the server session.	Endpoint
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	Endpoint

Property Detail

categoryId

property

categoryId: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

The identifier of the category that the TaskManager endpoint is part of.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get categoryId():String
public function set categoryId(value:String):void

Related API Elements

lc.procmgmt.domain.Category

description

property

description: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

The description of the TaskManager endpoint.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get description():String
public function set description(value:String):void

endpointId

property

endpointId: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

The endpoint identifier representing the TaskManager endpoint.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get endpointId():String
public function set endpointId(value:String):void

name

property

name: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

The name of the TaskManager endpoint or form used to start a process.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get name():String
public function set name(value:String):void

service

property

service: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

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get service():String
public function set service(value:String):void

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

invoke

()

method

public function invoke():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 TaskManager endpoint. If the TaskManager endpoint returns a document, a DocumentReference object is returned. WHen a TaskManager endpoint returns task information, a Task object is returned.

Returns

lc.foundation.util:ObjectToken — An object that contains the endpoint invocation result as a Task or DocumentReference object when the request completes.

Related API Elements

lc.procmgmt.IEndpointManager.invokeEndpoint()

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

setSession

()

method

override public function setSession(session:SessionMap):void

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

Sets a SessionMap object that stores the information relating to the server session.

Parameters

session:SessionMap — Specifies the information relating to the server session.

willTrigger

()

method

public function 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. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Endpoint - AS3 ADEP Document Services

Classes x

categoryId

description

endpointId

name

service

addEventListener

dispatchEvent

hasEventListener

invoke

removeEventListener

setSession

willTrigger