mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-08-21 18:09:04 +00:00
7a523961e2
* [ADF-2152] Added See Also sections to docs * [ADF-2152] Added doc script to package.json
23 lines
891 B
Markdown
23 lines
891 B
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.
|