| Package | lc.core |
| Interface | public interface IFavoritesManager |
| Implementors | FavoritesManager |
IFavoritesManager interface is implemented to manage favorite endpoints.
Endpoints are used to invoke a process (by using a form) in LiveCycle Workspace ES.
You implement the IFavoritesManager interface to retrieve, add, and remove the favorites.
See also
| Property | Defined By | ||
|---|---|---|---|
| favorites : ListCollectionView
The collection of favorites.
| IFavoritesManager | ||
| Method | Defined By | ||
|---|---|---|---|
|
Adds an endpoint to the Favorites collection.
| IFavoritesManager | ||
|
Returns whether the specified endpoints is a favorite.
| IFavoritesManager | ||
|
Removes an endpoint from the Favorites collection.
| IFavoritesManager | ||
| favorites | property |
favorites:ListCollectionView [read-write] The collection of favorites.
public function get favorites():ListCollectionView
public function set favorites(value:ListCollectionView):void
| addToFavorites | () | method |
public function addToFavorites(endpoint:Endpoint):Token
Adds an endpoint to the Favorites collection.
Parameters
endpoint:Endpoint |
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
Returns whether the specified endpoints 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):Token
Removes an endpoint from the Favorites collection.
Parameters
endpoint:Endpoint — Specifies the endpoint to remove from the favorites.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
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/IFavoritesManager.html