| Package | lc.core |
| Interface | public interface IEndpointManager |
IEndpointManager interface is implemented to manage endpoints.
Endpoints are used to invoke a process (by using a form) in LiveCycle Workspace ES.
You implement the IEndpointManager interface to get categories of endpoints,
invoke endpoints, retrieve endpoints, and get images associated with endpoints.
See also
| Method | Defined By | ||
|---|---|---|---|
|
Retrieves the users that match the specified substring and have invoke
permissions to the service.
| IEndpointManager | ||
|
Retrieves all categories of endpoints that are available to an authenticated user.
| IEndpointManager | ||
|
Retrieves the endpoint using the specified endpoint identifer.
| IEndpointManager | ||
|
Retrieves the location (as a URL) of the image for an endpoint.
| IEndpointManager | ||
|
Retrieves the endpoints for an array of endpoint identifiers.
| IEndpointManager | ||
|
Retrieves the endpoints in the specified category.
| IEndpointManager | ||
|
Invokes the specified endpoint by its unique identifier.
| IEndpointManager | ||
| findUsersWithPermission | () | method |
public function findUsersWithPermission(commonNamePattern:String, serviceName:String):CollectionToken
Retrieves the users that match the specified substring and have invoke permissions to the service. The matching is performed against the display name of the user. For example, "ohn" would match "John Doe". Matching is not case-sensitive.
Parameters
commonNamePattern:String — Specifies a substring to match.
|
|
serviceName:String — Service name assoc with the task.
|
CollectionToken — A token containing a collection of User objects
when the request completes. You can set result and fault handlers on
the token to be called when the invocation is complete and the
collection is fully populated.
|
| getCategories | () | method |
public function getCategories():CollectionToken
Retrieves all categories of endpoints that are available to an authenticated user.
ReturnsCollectionToken — A collection of tokens that contains a collection of Category objects
when the request completes. 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):ObjectToken
Retrieves the endpoint using the specified endpoint identifer.
Parameters
endpointId:String — Specifies the unique identifier of an endpoint.
|
ObjectToken — A token that will contain the Endpoint object when the request completes.
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
Retrieves the location (as a URL) of the image for an endpoint.
Parameters
endpointId:String — Specifies the endpoint identifier to retrieve the image for.
|
|
imageTicket:String — Specifies the location of the image for the endpoint.
|
String — The location (as a URL) from which the image can be retrieved.
|
| getEndpoints | () | method |
public function getEndpoints(endpointIds:Array):CollectionToken
Retrieves the endpoints for an array of endpoint identifiers.
Parameters
endpointIds:Array — Specifies endpoint identifiers as an array.
|
CollectionToken — A token containing a collection of Endpoint objects when the request completes.
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):CollectionToken
Retrieves the endpoints in the specified category.
Parameters
categoryName:String — Specifies the unique identifier of the category.
|
CollectionToken — A token containing a collection of Endpoint objects when the request completes.
You can set result and fault handlers on the token to be called when the invocation is
complete and the collection is fully populated.
|
| invokeEndpoint | () | method |
public function invokeEndpoint(endpointId:String):ObjectToken
Invokes the specified endpoint by its unique identifier. If the endpoint returns a
Document object on the server-side, a DocumentReference object
will be returned; if the endpoint returns task information, a Task object
will be returned. Invoked endpoints return either a DocumentReference or Task object.
Parameters
endpointId:String — Specifies the unique identifier that specifies the endpoint to invoke.
|
ObjectToken — A token that will contain the endpoint invocation result, a Task or a DocumentReference object,
when the request completes. You can set result and fault handlers on the token to be called when the invocation is
complete and the result is returned.
|
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/IEndpointManager.html