Package com.atlassian.confluence.like

Interface LikeEntityDao

  • All Known Implementing Classes:
    HibernateLikeEntityDao
    @ParametersAreNonnullByDefault
public interface LikeEntityDao
    Persists and retrieves likes. Should only be accessed via a LikeManager.

    This interface replaces the deprecated LikeDao

    • Method Detail

      • addLike

        @NonNull LikeEntity addLike​(ContentEntityObject contentEntity,
                            com.atlassian.user.User user)
        Add a like on the content entity for the given user.
        Parameters:
        contentEntity - the content entity to add a like to
        user - User liking the content
        Returns:
        the created Like

      • removeLike

        void removeLike​(ContentEntityObject contentEntity,
                com.atlassian.user.User user)
        Remove like from content entity for the given user.
        Parameters:
        contentEntity - content entity to remove like from
        user - User removing their Like

      • removeAllLikesOn

        void removeAllLikesOn​(ContentEntityObject contentEntity)
        Removes all likes (for any user) from the specified content entity.
        Parameters:
        contentEntity - content entity

      • removeAllLikesFor

        @Deprecated
void removeAllLikesFor​(String username)
        Deprecated.
        since 6.13. use removeAllLikesFor(UserKey) instead
        Removes all likes (for any user) from the specified content entity.
        Parameters:
        username - the name of the user to remove all likes for

      • removeAllLikesFor

        void removeAllLikesFor​(@NonNull com.atlassian.sal.api.user.UserKey key)
        Remove all likes for the given userKey
        Parameters:
        key -

      • hasLike

        boolean hasLike​(ContentEntityObject contentEntity,
                com.atlassian.user.User user)
        Returns true if the given user likes this content entity.
        Parameters:
        contentEntity - the content entity
        user - the User the Like is being checked for
        Returns:
        true if the user likes this content entity.

      • countLikes

        int countLikes​(Searchable contentEntity)