coarnotify.patterns.announce_review
===================================

.. py:module:: coarnotify.patterns.announce_review

.. autoapi-nested-parse::

   Pattern to represent the Announce Review notification
   https://coar-notify.net/specification/1.0.0/announce-review/



Classes
-------

.. autoapisummary::

   coarnotify.patterns.announce_review.AnnounceReview
   coarnotify.patterns.announce_review.AnnounceReviewContext
   coarnotify.patterns.announce_review.AnnounceReviewItem
   coarnotify.patterns.announce_review.AnnounceReviewObject


Module Contents
---------------

.. py:class:: AnnounceReview(stream: Union[coarnotify.core.activitystreams2.ActivityStream, dict] = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

   Bases: :py:obj:`coarnotify.core.notify.NotifyPattern`


   Class to represent Announce Review pattern


   .. py:method:: validate() -> bool

      Extends the base validation to make `context` required

      :return: ``True`` if valid, otherwise raises :py:class:`coarnotify.exceptions.ValidationError`



   .. py:attribute:: TYPE

      Announce Review type, including Acitivity Streams Announce and Notify Review Action 



   .. py:property:: context
      :type: Union[AnnounceReviewContext, None]


      Custom getter to retrieve AnnounceReview Context

      :return: AnnounceReviewContext



   .. py:property:: object
      :type: Union[AnnounceReviewObject, None]


      Custom getter to retrieve Announce Review object

      :return: Announce Review Object



.. py:class:: AnnounceReviewContext(stream: Union[coarnotify.core.activitystreams2.ActivityStream, dict] = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

   Bases: :py:obj:`coarnotify.core.notify.NotifyObject`


   Custom Context for Announce Review, specifically to return custom
   Announce Review Item


   .. py:property:: item
      :type: Union[AnnounceReviewItem, None]


      Custom getter to retrieve AnnounceReviewItem

      :return: AnnounceReviewItem



.. py:class:: AnnounceReviewItem(stream: Union[coarnotify.core.activitystreams2.ActivityStream, dict] = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

   Bases: :py:obj:`coarnotify.core.notify.NotifyItem`


   Custom AnnounceReviewItem which provides additional validation over the basic NotifyItem


   .. py:method:: validate() -> bool

      In addition to the base validator, this:

      * Reintroduces type validation
      * make ``mediaType`` a required field

      :return: ``True`` if valid, else raises a ValidationError



.. py:class:: AnnounceReviewObject(stream: Union[coarnotify.core.activitystreams2.ActivityStream, dict] = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

   Bases: :py:obj:`coarnotify.core.notify.NotifyObject`


   Custom Announce Review Object to apply custom validation for this pattern


   .. py:method:: validate() -> bool

      In addition to the base validator this:

      * Makes type required

      :return: ``True`` if valid, else raises ValidationError