coarnotify.patterns.request_endorsement
=======================================

.. py:module:: coarnotify.patterns.request_endorsement

.. autoapi-nested-parse::

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



Classes
-------

.. autoapisummary::

   coarnotify.patterns.request_endorsement.RequestEndorsement
   coarnotify.patterns.request_endorsement.RequestEndorsementItem
   coarnotify.patterns.request_endorsement.RequestEndorsementObject


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

.. py:class:: RequestEndorsement(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 Endorsement notification


   .. py:attribute:: TYPE

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



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


      Custom getter to retrieve the object property as a RequestEndorsementObject

      :return:



.. py:class:: RequestEndorsementItem(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 item class for Request Endorsement to provide the custom validation


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

      Extend the base validation to include the following constraints:

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

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



.. py:class:: RequestEndorsementObject(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 object class for Request Endorsement to provide the custom item getter


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


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