inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +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

3
lib/content-services/social/services/rating.service.ts
View File

@@ -32,6 +32,7 @@ export class RatingService {
* Gets the current user's rating for a node.
* @param nodeId Node to get the rating from
* @param ratingType Type of rating (can be "likes" or "fiveStar")
* @returns The rating value
*/
getRating(nodeId: string, ratingType: any): any {
return Observable.fromPromise(this.apiService.getInstance().core.ratingsApi.getRating(nodeId, ratingType))
@@ -44,6 +45,7 @@ export class RatingService {
* @param nodeId Target node for the rating
* @param ratingType Type of rating (can be "likes" or "fiveStar")
* @param vote Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
* @returns Details about the rating, including the new value
*/
postRating(nodeId: string, ratingType: any, vote: any): any {
let ratingBody: RatingBody = {
@@ -59,6 +61,7 @@ export class RatingService {
* Removes the current user's rating for a node.
* @param nodeId Target node
* @param ratingType Type of rating to remove (can be "likes" or "fiveStar")
* @returns Null response indicating that the operation is complete
*/
deleteRating(nodeId: string, ratingType: any): any {
return Observable.fromPromise(this.apiService.getInstance().core.ratingsApi.removeRating(nodeId, ratingType))