coarnotify.patterns.undo_offer
==============================

.. py:module:: coarnotify.patterns.undo_offer

.. autoapi-nested-parse::

   Pattern to represent the Undo Offer notification
   https://coar-notify.net/specification/1.0.0/undo-offer/



Classes
-------

.. autoapisummary::

   coarnotify.patterns.undo_offer.UndoOffer


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

.. py:class:: UndoOffer(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.NestedPatternObjectMixin`, :py:obj:`coarnotify.core.notify.NotifyPattern`, :py:obj:`coarnotify.core.notify.SummaryMixin`


   Class to represent the Undo Offer notification


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

      In addition to the base validation apply the following constraints:

      * The ``inReplyTo`` property is required
      * The ``inReplyTo`` value must match the ``object.id`` value

      :return:



   .. py:attribute:: TYPE

      Undo Offer type, the ActivityStreams Undo type