inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
ce14d68ea7
alfresco-ng2-components/docs/content-services/rating.service.md

1.5 KiB
Raw Blame History

Added, Status
Added Status
v2.0.0 Active

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.
    • 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")

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