[ADF-2905] Updated JSDocs for core (#3271)

This commit is contained in:
Andy Stark
2018-05-04 19:03:13 +01:00
committed by Eugenio Romano
parent fe0ac0e474
commit c824e646de
18 changed files with 256 additions and 119 deletions

View File

@@ -1,7 +1,9 @@
---
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.
@@ -10,8 +12,11 @@ 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.
- `getFavorites(personId: string = null, options?: any = null): Observable<NodePaging>`<br/>
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