inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/core/favorites-api.service.md
Andy Stark c824e646de [ADF-2905] Updated JSDocs for core (#3271)
2018-05-04 19:03:13 +01:00

1.2 KiB
Raw Blame History

Added, Status, Last reviewed
Added Status Last reviewed
v2.0.0 Active 2018-05-04

Favorites Api service

Gets a list of items a user has marked as their favorites.

Class members

Methods

  • getFavorites(personId: string = null, options?: any = null): Observable<NodePaging>
    Gets the favorites for a user.
    • personId: string = null - ID of the user
    • options?: any = null - (Optional) Options supported by JSAPI
    • Returns Observable<NodePaging> - List of favorites

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 for getFavorites for more information.