coarnotify.patterns.request_endorsement

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

Classes

RequestEndorsement

Class to represent a Request Endorsement notification

RequestEndorsementItem

Custom item class for Request Endorsement to provide the custom validation

RequestEndorsementObject

Custom object class for Request Endorsement to provide the custom item getter

Module Contents

class coarnotify.patterns.request_endorsement.RequestEndorsement(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyPattern

Class to represent a Request Endorsement notification

TYPE

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

property object: RequestEndorsementObject | None

Custom getter to retrieve the object property as a RequestEndorsementObject

Returns:

class coarnotify.patterns.request_endorsement.RequestEndorsementItem(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyItem

Custom item class for Request Endorsement to provide the custom validation

validate() → bool

Extend the base validation to include the following constraints:

  • The item type is required and must validate

  • The mediaType property is required

Returns:

True if validation passes, otherwise raise a ValidationError

class coarnotify.patterns.request_endorsement.RequestEndorsementObject(stream: coarnotify.core.activitystreams2.ActivityStream | dict = None, validate_stream_on_construct=True, validate_properties=True, validators=None, validation_context=None, properties_by_reference=True)

Bases: coarnotify.core.notify.NotifyObject

Custom object class for Request Endorsement to provide the custom item getter

property item: RequestEndorsementItem | None

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