inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2905] Updated JSDocs for content services (#3269)

Browse Source 
* [ADF-2905] Updated JSDocs for content services

* [ADF-2905] Added missing update to version manager MD file
This commit is contained in:
Andy Stark
2018-05-04 13:56:01 +01:00
committed by Eugenio Romano
parent b393708514
commit 563af3bbfa
15 changed files with 50 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content-services/rating.service.md
+4 -3
View File
@@ -1,6 +1,7 @@
---
Added: v2.0.0
Status: Active
Last reviewed: 2018-05-04
---
# Rating service
@@ -15,18 +16,18 @@ Manages ratings for items in Content Services.
Removes the current user's rating for a node.
- `nodeId: string = null` - Target node
- `ratingType: any = null` - Type of rating to remove (can be "likes" or "fiveStar")
- **Returns** `any` -
- **Returns** `any` - Null response indicating that the operation is complete
- `getRating(nodeId: string = null, ratingType: any = null): any`<br/>
Gets the current user's rating for a node.
- `nodeId: string = null` - Node to get the rating from
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar")
- **Returns** `any` -
- **Returns** `any` - The rating value
- `postRating(nodeId: string = null, ratingType: any = null, vote: any = null): any`<br/>
Adds the current user's rating for a node.
- `nodeId: string = null` - Target node for the rating
- `ratingType: any = null` - Type of rating (can be "likes" or "fiveStar")
- `vote: any = null` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- **Returns** `any` -
- **Returns** `any` - Details about the rating, including the new value
## Details