alfresco-ng2-components/docs/favorites-api.service.md
2017-11-09 13:20:56 +00:00

27 lines
1.0 KiB
Markdown

# Favorites Api service
Gets a list of items a user has marked as their favorites.
## Methods
`getFavorites(personId: string, options?: any): Observable<NodePaging>`<br/>
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](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/FavoritesApi.md#getfavorites)
for `getFavorites` for more information.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
<!-- seealso end -->