mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Moved core library docs into subfolders * [ADF-4152] Manual fixes to core doc file links * [ADF-4152] Further automatic + manual link tidying
This commit is contained in:
committed by
Eugenio Romano
parent
285e56e9fb
commit
5fc05da7aa
48
docs/core/services/favorites-api.service.md
Normal file
48
docs/core/services/favorites-api.service.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
Title: Favorites Api service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-05-04
|
||||
---
|
||||
|
||||
# [Favorites Api service](../../../lib/core/services/favorites-api.service.ts "Defined in favorites-api.service.ts")
|
||||
|
||||
Gets a list of items a user has marked as their favorites.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getFavorites**(personId: `string`, options?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
|
||||
Gets the favorites for a user.
|
||||
- _personId:_ `string` - ID of the user
|
||||
- _options:_ `any` - (Optional) Options supported by JS-API
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorites
|
||||
- **remapFavoriteEntries**(entries: `any[]`): `any[]`<br/>
|
||||
|
||||
- _entries:_ `any[]` -
|
||||
- **Returns** `any[]` -
|
||||
|
||||
- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)<br/>
|
||||
|
||||
- _data:_ `any` -
|
||||
- **Returns** [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) -
|
||||
|
||||
- **remapEntry**(\_\_namedParameters: `Function`): `any`<br/>
|
||||
|
||||
- _\_\_namedParameters:_ `Function` -
|
||||
- **Returns** `any` -
|
||||
|
||||
## 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