Package com.alfresco.content.apis

Interface RatingsApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract RatingEntry createRating(@Path(value = "nodeId") String nodeId, @Body() RatingBody ratingBodyCreate, @Query(value = "fields") List<String> fields) Create a rating Create a rating for the node with identifier nodeId The endpoint is owned by defaultname service owner
      abstract Unit deleteRating(@Path(value = "nodeId") String nodeId, @Path(value = "ratingId") String ratingId) Delete a rating Deletes rating ratingId from node nodeId.
      abstract RatingEntry getRating(@Path(value = "nodeId") String nodeId, @Path(value = "ratingId") String ratingId, @Query(value = "fields") List<String> fields) Get a rating Get the specific rating ratingId on node nodeId.
      abstract RatingPaging listRatings(@Path(value = "nodeId") String nodeId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields) List ratings Gets a list of ratings for node nodeId.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • createRating

        @Headers(value = {"Content-Type: application/json"})@POST(value = "alfresco/versions/1/nodes/{nodeId}/ratings") abstract RatingEntry createRating(@Path(value = "nodeId") String nodeId, @Body() RatingBody ratingBodyCreate, @Query(value = "fields") List<String> fields)

        Create a rating Create a rating for the node with identifier nodeId The endpoint is owned by defaultname service owner

        Parameters:
        nodeId - The identifier of a node.
        ratingBodyCreate - For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.
        fields - A list of field names.

      • deleteRating

        @Headers(value = {"Content-Type: application/json"})@DELETE(value = "alfresco/versions/1/nodes/{nodeId}/ratings/{ratingId}") abstract Unit deleteRating(@Path(value = "nodeId") String nodeId, @Path(value = "ratingId") String ratingId)

        Delete a rating Deletes rating ratingId from node nodeId. The endpoint is owned by defaultname service owner

        Parameters:
        nodeId - The identifier of a node.
        ratingId - The identifier of a rating.

      • getRating

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/ratings/{ratingId}") abstract RatingEntry getRating(@Path(value = "nodeId") String nodeId, @Path(value = "ratingId") String ratingId, @Query(value = "fields") List<String> fields)

        Get a rating Get the specific rating ratingId on node nodeId. The endpoint is owned by defaultname service owner

        Parameters:
        nodeId - The identifier of a node.
        ratingId - The identifier of a rating.
        fields - A list of field names.

      • listRatings

        @Headers(value = {"Content-Type: application/json"})@GET(value = "alfresco/versions/1/nodes/{nodeId}/ratings") abstract RatingPaging listRatings(@Path(value = "nodeId") String nodeId, @Query(value = "skipCount") Integer skipCount, @Query(value = "maxItems") Integer maxItems, @Query(value = "fields") List<String> fields)

        List ratings Gets a list of ratings for node nodeId. The endpoint is owned by defaultname service owner

        Parameters:
        nodeId - The identifier of a node.
        skipCount - The number of entities that exist in the collection before those included in this list.
        maxItems - The maximum number of items to return in the list.
        fields - A list of field names.