api.rst

The API

After you've got your VotableManager added to your model you can start playing around with the API.

param verbose_name:	The verbose_name for this field.
param through:	The through model
param field_name:	The field name added to the query
param extra_field:	The field on your model. It will be updated when up or down

.. method:: up(user)

    This adds a vote to an object by the ``user``. ``IntegrityError`` will be raised if the user has voted before::

        >>> comments.votes.up(user)

.. method:: down(user)

    Removes the vote from an object. No exception is raised if the user
    doesn't have voted the object.

.. method:: exists(user)

    Check if user has voted the instance before.

.. method:: all(user)

    Get all instances voted by the specify user.

.. method:: count()

    The count of  all votes for an object.

.. method:: annotate(queryset=None, user=None)

    Add annotation data to the ``queyset``

Aggregation

Django does not support aggregation with GenericRelation currently but you still can use annotate:

>>> Comment.objects.filter(article__id=article_id).annotate(num_votes=Count('votes__user'))