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-2847] Added Class members headings and rebuilt prop/method tables for docs (#3240)

Browse Source 
* [ADF-2847] Added class members heading to content services docs

* [ADF-2847] Updated all prop/method tables in content services
This commit is contained in:
Andy Stark
2018-04-26 14:54:25 +01:00
committed by Eugenio Romano
parent 616036f9e7
commit 2c0e7aa035
40 changed files with 541 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/content-services/rating.service.md
View File

@@ -2,25 +2,31 @@
Added: v2.0.0
Status: Active
---
# Rating service
Manages ratings for items in Content Services.
## Methods
## Class members
- `getRating(nodeId: string, ratingType: any): any`
Gets the current user's rating for a node.
- `nodeId` - Node to get the rating from
- `ratingType` - Type of rating (can be "likes" or "fiveStar")
- `postRating(nodeId: string, ratingType: any, vote: any): any`
Adds the current user's rating for a node.
- `nodeId` - Target node for the rating
- `ratingType` - Type of rating (can be "likes" or "fiveStar")
- `vote` - Rating value (boolean for "likes", numeric 0..5 for "fiveStar")
- `deleteRating(nodeId: string, ratingType: any): any`
Removes the current user's rating for a node.
- `nodeId` - Target node
- `ratingType` - Type of rating to remove (can be "likes" or "fiveStar")
### Methods
- `deleteRating(nodeId: string = null, ratingType: any = null): any`<br/>
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` -
- `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` -
- `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` -
## Details