LikeService (Nuxeo ECM Projects 7.2-SNAPSHOT API)

All Known Implementing Classes:

LikeServiceImpl
```
public interface LikeService
```
Service handling likes / dislikes on documents, or any other activity object.

Since:

5.6

Author:

Thomas Roger

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancel(String username, DocumentModel doc)` Convenient method to cancel a like or dislike on a `DocumentModel`.
`void`	`cancel(String username, String activityObject)` Cancel a like or dislike for the given `username`.
`void`	`dislike(String username, DocumentModel doc)` Convenient method to dislike a `DocumentModel`.
`void`	`dislike(String username, String activityObject)` Dislike the given `activityObject` by the `username`.
`long`	`getDislikesCount(DocumentModel doc)` Convenient method to returns the dislikes count for a `DocumentModel`.
`long`	`getDislikesCount(String activityObject)` Returns the dislikes count for the given `activityObject`.
`long`	`getLikesCount(DocumentModel doc)` Convenient method to returns the likes count for a `DocumentModel`.
`long`	`getLikesCount(String activityObject)` Returns the likes count for the given `activityObject`.
`LikeStatus`	`getLikeStatus(DocumentModel doc)` Convenient method to return the `LikeStatus` for a `DocumentModel`.
`LikeStatus`	`getLikeStatus(String activityObject)` Returns the `LikeStatus` for the `activityObject`.
`LikeStatus`	`getLikeStatus(String username, DocumentModel doc)` Convenient method to return the `LikeStatus` for the `username` and a `DocumentModel`.
`LikeStatus`	`getLikeStatus(String username, String activityObject)` Returns the `LikeStatus` for the `username` and `activityObject`.
`ActivitiesList`	`getMostLikedActivities(CoreSession session, int limit, DocumentModel source)` An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context.
`ActivitiesList`	`getMostLikedActivities(CoreSession session, int limit, DocumentModel source, Date fromDt, Date toDt)` An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context the result will be between two dates
`boolean`	`hasUserDisliked(String username, DocumentModel doc)` Returns `true` if the given `username` already disliked the `doc`, `false` otherwise.
`boolean`	`hasUserDisliked(String username, String activityObject)` Returns `true` if the given `username` already disliked the `activityObject`, `false` otherwise.
`boolean`	`hasUserLiked(String username, DocumentModel doc)` Returns `true` if the given `username` already liked the `doc`, `false` otherwise.
`boolean`	`hasUserLiked(String username, String activityObject)` Returns `true` if the given `username` already liked the `activityObject`, `false` otherwise.
`void`	`like(String username, DocumentModel doc)` Convenient method to like a `DocumentModel`.
`void`	`like(String username, String activityObject)` Like the given `activityObject` by the `username`.

- Method Detail
  - like
```
void like(String username,
        String activityObject)
```
    Like the given activityObject by the username.
  - like
```
void like(String username,
        DocumentModel doc)
```
    Convenient method to like a DocumentModel.
    
    See Also:
    like(String, String)
  - hasUserLiked
```
boolean hasUserLiked(String username,
                   String activityObject)
```
    Returns true if the given username already liked the activityObject, false otherwise.
  - hasUserLiked
```
boolean hasUserLiked(String username,
                   DocumentModel doc)
```
    Returns true if the given username already liked the doc, false otherwise.
  - getLikesCount
```
long getLikesCount(String activityObject)
```
    Returns the likes count for the given activityObject.
  - getLikesCount
```
long getLikesCount(DocumentModel doc)
```
    Convenient method to returns the likes count for a DocumentModel.
    
    See Also:
    getLikesCount(String)
  - dislike
```
void dislike(String username,
           String activityObject)
```
    Dislike the given activityObject by the username.
  - dislike
```
void dislike(String username,
           DocumentModel doc)
```
    Convenient method to dislike a DocumentModel.
    
    See Also:
    dislike(String, String)
  - hasUserDisliked
```
boolean hasUserDisliked(String username,
                      String activityObject)
```
    Returns true if the given username already disliked the activityObject, false otherwise.
  - hasUserDisliked
```
boolean hasUserDisliked(String username,
                      DocumentModel doc)
```
    Returns true if the given username already disliked the doc, false otherwise.
  - getDislikesCount
```
long getDislikesCount(String activityObject)
```
    Returns the dislikes count for the given activityObject.
  - getDislikesCount
```
long getDislikesCount(DocumentModel doc)
```
    Convenient method to returns the dislikes count for a DocumentModel.
    
    See Also:
    getDislikesCount(String)
  - cancel
```
void cancel(String username,
          String activityObject)
```
    Cancel a like or dislike for the given username.
    
    Parameters:
    username - the username
    activityObject - the activity object on which to cancel the like or dislike.
  - cancel
```
void cancel(String username,
          DocumentModel doc)
```
    Convenient method to cancel a like or dislike on a DocumentModel.
    
    See Also:
    cancel(String, String)
  - getLikeStatus
```
LikeStatus getLikeStatus(String activityObject)
```
    Returns the LikeStatus for the activityObject.
  - getLikeStatus
```
LikeStatus getLikeStatus(DocumentModel doc)
```
    Convenient method to return the LikeStatus for a DocumentModel.
    
    See Also:
    getLikeStatus(String)
  - getLikeStatus
```
LikeStatus getLikeStatus(String username,
                       String activityObject)
```
    Returns the LikeStatus for the username and activityObject.
    The returned LikeStatus will have the information about the like / dislike status of the username.
  - getLikeStatus
```
LikeStatus getLikeStatus(String username,
                       DocumentModel doc)
```
    Convenient method to return the LikeStatus for the username and a DocumentModel.
    
    See Also:
    getLikeStatus(String, String)
  - getMostLikedActivities
```
ActivitiesList getMostLikedActivities(CoreSession session,
                                    int limit,
                                    DocumentModel source)
```
    An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context.
    
    Parameters:
    limit - maximum documents returned
    source - the parent document when child will be reached
  - getMostLikedActivities
```
ActivitiesList getMostLikedActivities(CoreSession session,
                                    int limit,
                                    DocumentModel source,
                                    Date fromDt,
                                    Date toDt)
```
    An actitivitesList containing a documentActivity or a minimessageActivity as target, the likes count as object, current user as actor and actor's likes in context the result will be between two dates
    
    Parameters:
    limit - maximum documents returned
    source - the parent document when child will be reached

Interface LikeService

Method Summary

Method Detail

like

like

hasUserLiked

hasUserLiked

getLikesCount

getLikesCount

dislike

dislike

hasUserDisliked

hasUserDisliked

getDislikesCount

getDislikesCount

cancel

cancel

getLikeStatus

getLikeStatus

getLikeStatus

getLikeStatus

getMostLikedActivities

getMostLikedActivities