Class: Coarnotify::Core::Notify::NotifyService

Inherits:
NotifyPatternPart show all
Defined in:
lib/coarnotify/core/notify.rb

Overview

Default class to represent a service in the COAR Notify pattern.

Services are used to represent origin and target properties in the notification patterns

Specific patterns may need to extend this class to provide their specific behaviours and validation

Instance Attribute Summary

Attributes inherited from NotifyBase

#properties_by_reference, #validate_properties, #validate_stream_on_construct, #validators

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NotifyPatternPart

allowed_types, #allowed_types, #initialize, #type=

Methods inherited from NotifyBase

#doc, #get_property, #id, #id=, #initialize, #optional_and_validate, #register_property_validation_error, #required, #required_and_validate, #set_property, #to_jsonld, #type, #type=, #validate, #validate_property

Constructor Details

This class inherits a constructor from Coarnotify::Core::Notify::NotifyPatternPart

Class Method Details

.default_type ⇒ Object

The default type for a service is Service, but the type can be set to any value



604
605
606
 
# File 'lib/coarnotify/core/notify.rb', line 604

def self.default_type
  ActivityStreams2::ActivityStreamsTypes::SERVICE
end

Instance Method Details

#inbox ⇒ String

Get the inbox property of the service

Returns:

  • (String) —

    the inbox URL



611
612
613
 
# File 'lib/coarnotify/core/notify.rb', line 611

def inbox
  get_property(NotifyProperties::INBOX)
end

#inbox=(value) ⇒ Object

Set the inbox property of the service

Parameters:

  • value (String) —

    the inbox URL to set



618
619
620
 
# File 'lib/coarnotify/core/notify.rb', line 618

def inbox=(value)
  set_property(NotifyProperties::INBOX, value)
end