inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-19 17:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/rating.service.md

1.2 KiB
Raw Blame History

Rating service

Manages ratings for items in Content Services.

Methods

getRating(nodeId: string, ratingType: any): any
Gets the current user's rating for a node.

postRating(nodeId: string, ratingType: any, vote: any): any
Adds the current user's rating for a node.

deleteRating(nodeId: string, ratingType: any): any
Removes the current user's rating for a node.

Details

The ratingType string currently has two possible options, "likes" and "fiveStar". When the "likes" scheme is used, the result of getRating and the vote parameter of postRating are boolean values. When "fiveStar" is used, the value is an integer representing the number of stars out of five.

See the Ratings API in the Alfresco JS API for more information about the returned data and the REST API that this service is based on.

See also