Files
alfresco-ng2-components/docs/favorites-api.service.md
Andy Stark 7a523961e2 [ADF-2152] Added See Also sections and updated doc tools (#2835)
* [ADF-2152] Added See Also sections to docs

* [ADF-2152] Added doc script to package.json
2018-01-16 17:43:10 +00:00

891 B

Favorites Api service

Gets a list of items a user has marked as their favorites.

Methods

getFavorites(personId: string, options?: any): Observable<NodePaging>
Gets the favorites for a user.

Details

Process Services allows users to mark items as "favorites". These are typically items that are important or frequently used.

Use getFavorites to find a user's favorite items. You could use this, for example, to create a menu for the user to access their favorites quickly rather than by navigating or searching. Using "-me-" for the personId indicates that the target person is the currently logged-in user.

You can specify a number of options to modify the search further. See the Alfresco JS API page for getFavorites for more information.