coarnotify.patterns.request_review
==================================

.. py:module:: coarnotify.patterns.request_review

.. autoapi-nested-parse::

   Pattern to represent a Request Review notification
   https://coar-notify.net/specification/1.0.0/request-review/



Classes
-------

.. autoapisummary::

   coarnotify.patterns.request_review.RequestReview
   coarnotify.patterns.request_review.RequestReviewItem
   coarnotify.patterns.request_review.RequestReviewObject


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

.. py:class:: RequestReview(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 a Request Review notification


   .. py:attribute:: TYPE

      Request Review types, including an ActivityStreams offer and a COAR Notify Review Action



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


      Custom getter to retrieve the object property as a RequestReviewObject
      :return:



.. py:class:: RequestReviewItem(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 Request Review Item class to provide the custom validation


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

      Extend the base validation to include the following constraints:

      * The type property is required and must validate
      * the ``mediaType`` property is required

      :return: ``True`` if validation passes, else raise a ``ValidationError``



.. py:class:: RequestReviewObject(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 Request Review Object class to return the custom RequestReviewItem class


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


      Custom getter to retrieve the item property as a RequestReviewItem
      :return: