mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
e03f3a1a6b
* [ADF-3323] Fixed URL path to Typescript source files * [ADF-3323] Fixed and checked broken links caused by previous bug
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-05-04
|
|
---
|
|
|
|
# Favorites Api service
|
|
|
|
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`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
|
|
Gets the favorites for a user.
|
|
- _personId:_ `string` - ID of the user
|
|
- _options:_ `any` - (Optional) Options supported by JSAPI
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - List of favorites
|
|
- **remapFavoriteEntries**(entries: `any[]`): `any[]`<br/>
|
|
|
|
- _entries:_ `any[]` -
|
|
- **Returns** `any[]` -
|
|
|
|
- **remapFavoritesData**(data: `any` = `{}`): [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
|
|
|
|
- _data:_ `any` -
|
|
- **Returns** [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) -
|
|
|
|
- **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.
|