coarnotify.patterns.announce_service_result

Pattern to represent the Announce Service Result notification https://coar-notify.net/specification/1.0.0/announce-resource/

Classes

AnnounceServiceResult	Class to represent the Announce Service Result Pattern
AnnounceServiceResultContext	Custom object class for Announce Service Result to provide the custom item getter
AnnounceServiceResultItem	Custom item class for Announce Service Result to apply the custom validation
AnnounceServiceResultObject	Custom object class for Announce Service Result to apply the custom validation

Module Contents

class coarnotify.patterns.announce_service_result.AnnounceServiceResult(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 the Announce Service Result Pattern

validate() → bool

Extends the base validation to make context required

Returns:

True if valid, otherwise raises coarnotify.exceptions.ValidationError

TYPE

Announce Service Result type, the ActivityStreams Announce type

property context: AnnounceServiceResultContext | None

Custom getter to retrieve the context property as an AnnounceServiceResultContext

Returns:

AnnounceSericeResultCOntext

property object: AnnounceServiceResultObject | None

Custom getter to retrieve the object property as an AnnounceServiceResultObject

Returns:

AnnounceServiceResultObject

class coarnotify.patterns.announce_service_result.AnnounceServiceResultContext(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 Announce Service Result to provide the custom item getter

property item: AnnounceServiceResultItem | None

Custom getter to retrieve the item property as an AnnounceServiceResultItem :return:

class coarnotify.patterns.announce_service_result.AnnounceServiceResultItem(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 Announce Service Result to apply the custom validation

validate() → bool

Beyond the base validation, apply the following:

• Make type required and avlid

• Make the mediaType required

Returns:

True if validation passes, else raise a ValidationError

class coarnotify.patterns.announce_service_result.AnnounceServiceResultObject(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 Announce Service Result to apply the custom validation

validate() → bool

Extend the base validation to include the following constraints:

• The object type is required and must validate

Returns:

True if validation passes, else raise a ValidationError