(Beta)
| Package | lc.procmgmt |
| Interface | public interface IFavoritesManager |
| Implementors | FavoritesManager |
| 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 |
IFavoritesManager interface is implemented to manage favorite TaskManager endpoints.
Workspace start points that are added to a process diagram create TaskManager endpoints. TaskManager
endpoints are used to invoke a process in LiveCycle Workspace ES2. When you use Workspace ES2 to invoke a
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 IFavoritesManager interface to retrieve, add, and remove the favorites.
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| favorites : ListCollectionView
The ListCollectionView object that contains a list of favorites. | IFavoritesManager | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Adds an endpoint to the Favorites collection. | IFavoritesManager | ||
Returns whether the specified endpoint is a favorite. | IFavoritesManager | ||
Removes an endpoint from the Favorites collection. | IFavoritesManager | ||
Property Detail
favorites | property |
favorites:ListCollectionView| 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 ListCollectionView object that contains a list of favorites.
Implementation
public function get favorites():ListCollectionView public function set favorites(value:ListCollectionView):voidMethod Detail
addToFavorites | () | method |
public function addToFavorites(endpoint:Endpoint):lc.foundation.util:Token| 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 |
Adds an endpoint to the Favorites collection.
Parameters
endpoint:Endpoint — Specifies the endpoint to add to the favorites.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation has completed.
|
isFavorite | () | method |
public function isFavorite(endpoint:Endpoint):Boolean| 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 |
Returns whether the specified endpoint is a favorite.
Parameters
endpoint:Endpoint — Specifies the endpoint to add as a favorite.
|
Boolean — A flag that indicates whether an endpoint is a favorite. A value of
true specifies that it is a favorite.
|
removeFromFavorites | () | method |
public function removeFromFavorites(endpoint:Endpoint):lc.foundation.util:Token| 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 |
Removes an endpoint from the Favorites collection.
Parameters
endpoint:Endpoint — Specifies the endpoint to remove from the favorites.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is completed.
|
Wed Nov 21 2018, 06:34 AM -08:00