Base endpoints

1. /api/v1/likes/list/ - List API View to return all likes for authenticated user.

   You can set serializer for each model in LIKES_MODELS setting to use it for content object serialization, otherwise, you will get an id of content object.

   For example:

   LIKE_MODELS = {
       "article.Article": {
           'serializer': 'article.api.serializers.ArticleSerializer'
       },
   }

   Use GET parameter search to filter by a content type’s model: /api/v1/likes/list/?search=article

2. /api/v1/likes/count/ - API View to return count of likes for authenticated user.

3. /api/v1/likes/is/ - API View to check is given elements are liked by authenticated user. As result, you will get a list of ids.

   Possible payload:

   {
       "type": 'app_label.model',  # '.'.join(object_ct.natural_key())
       "ids": [1,2,3]
   }

   Possible result:

   {
       "ids": [1,3]
   }

4. /api/v1/likes/toggle/ - API View to like-unlike a given object by authenticated user.

   Possible payload:

   {
       "type": 'app_label.model',  # '.'.join(object_ct.natural_key())
       "id": 1
   }

   Possible result:

   {
       "is_liked": true
   }

likes_count

Returns a count of likes for a given object:

{{ object|likes_count }}

who_liked

Returns a queryset of users, who liked a given object:

{% who_liked object as fans %}

{% for user in fans %}
    <div class="like">{{ user.get_full_name }} likes {{ object }}</div>
{% endfor %}

likes

Returns a queryset of likes for a given user:

{% likes request.user as user_likes %}
{% for like in user_likes %}
    <div>{{ like }}</div>
{% endfor %}

is_liked

Returns a bool value, which says is a given object liked by a given user:

{% is_liked object request.user as liked %}

get_likes_count

The same as the likes_count filter.

Usage:

{{ get_likes_count(object) }}

get_who_liked

The same as the who_liked tag.

Usage:

{{ get_who_liked(object) }}

get_likes

The same as the likes tag.

Usage:

{{ get_likes(request.user) }}

get_is_liked

The same as the is_liked tag.

Usage:

{{ get_is_liked(object, request.user) }}

likes.signals.object_liked

A signal, which sents immediately after the object was liked and provides the single kwarg of created Like instance.

likes.signals.object_unliked

A signal, which sents immediately after the object was unliked and provides the single kwarg of an object.