mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2463] Moved doc files to subfolders (#3081)
This commit is contained in:
committed by
Eugenio Romano
parent
c27273cb7d
commit
e33cb06371
26
docs/core/favorites-api.service.md
Normal file
26
docs/core/favorites-api.service.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
---
|
||||
# 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.
|
Reference in New Issue
Block a user