Class: SchemaOrg::EventSeries

Inherits:
Base
  • Object
show all
Includes:
Mixins::EventSeries, _EventSeries
Defined in:
lib/schema_org/types/event_series.rb,
sig/schema_org.rbs

Overview

https://schema.org/EventSeries

A series of [[Event]]s. Included events can relate with the series using the [[superEvent]] property.

An EventSeries is a collection of events that share some unifying characteristic. For example, "The Olympic Games" is a series, which is repeated regularly. The "2012 London Olympics" can be presented both as an [[Event]] in the series "Olympic Games", and as an [[EventSeries]] that included a number of sporting competitions as Events.

The nature of the association between the events in an [[EventSeries]] can vary, but typical examples could include a thematic event series (e.g. topical meetups or classes), or a series of regular events that share a location, attendee group and/or organizers.

EventSeries has been defined as a kind of Event to make it easy for publishers to use it in an Event context without worrying about which kinds of series are really event-like enough to call an Event. In general an EventSeries may seem more Event-like when the period of time is compact and when aspects such as location are fixed, but it may also sometimes prove useful to describe a longer-term series as an Event.

Constant Summary collapse

SCHEMA_NAME = 
"EventSeries"
SCHEMA_TYPES = 
[self, SchemaOrg::Event, SchemaOrg::Series, SchemaOrg::Thing, SchemaOrg::Intangible].freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Mixins::EventSeries

schema_property_definitions

Methods included from Mixins::Series

schema_property_definitions

Methods included from Mixins::Intangible

schema_property_definitions

Methods included from Mixins::Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, schema_property_definitions, #subject_of, #subject_of=, #url, #url=

Methods included from Mixins::Event

#about, #about=, #actor, #actor=, #aggregate_rating, #aggregate_rating=, #attendee, #attendee=, #attendees, #attendees=, #audience, #audience=, #composer, #composer=, #contributor, #contributor=, #director, #director=, #door_time, #door_time=, #duration, #duration=, #end_date, #end_date=, #event_attendance_mode, #event_attendance_mode=, #event_schedule, #event_schedule=, #event_status, #event_status=, #funder, #funder=, #funding, #funding=, #has_participation_offer, #has_participation_offer=, #has_sponsorship_offer, #has_sponsorship_offer=, #in_language, #in_language=, #is_accessible_for_free, #is_accessible_for_free=, #keywords, #keywords=, #location, #location=, #maximum_attendee_capacity, #maximum_attendee_capacity=, #maximum_physical_attendee_capacity, #maximum_physical_attendee_capacity=, #maximum_virtual_attendee_capacity, #maximum_virtual_attendee_capacity=, #offers, #offers=, #organizer, #organizer=, #performer, #performer=, #performers, #performers=, #previous_start_date, #previous_start_date=, #recorded_in, #recorded_in=, #remaining_attendee_capacity, #remaining_attendee_capacity=, #review, #review=, schema_property_definitions, #sponsor, #sponsor=, #start_date, #start_date=, #sub_event, #sub_event=, #sub_events, #sub_events=, #super_event, #super_event=, #translator, #translator=, #typical_age_range, #typical_age_range=, #work_featured, #work_featured=, #work_performed, #work_performed=

Methods included from _EventSeries

#about, #about=, #actor, #actor=, #additional_type, #additional_type=, #aggregate_rating, #aggregate_rating=, #alternate_name, #alternate_name=, #attendee, #attendee=, #attendees, #attendees=, #audience, #audience=, #composer, #composer=, #contributor, #contributor=, #description, #description=, #director, #director=, #disambiguating_description, #disambiguating_description=, #door_time, #door_time=, #duration, #duration=, #end_date, #end_date=, #event_attendance_mode, #event_attendance_mode=, #event_schedule, #event_schedule=, #event_status, #event_status=, #funder, #funder=, #funding, #funding=, #has_participation_offer, #has_participation_offer=, #has_sponsorship_offer, #has_sponsorship_offer=, #identifier, #identifier=, #image, #image=, #in_language, #in_language=, #is_accessible_for_free, #is_accessible_for_free=, #keywords, #keywords=, #location, #location=, #main_entity_of_page, #main_entity_of_page=, #maximum_attendee_capacity, #maximum_attendee_capacity=, #maximum_physical_attendee_capacity, #maximum_physical_attendee_capacity=, #maximum_virtual_attendee_capacity, #maximum_virtual_attendee_capacity=, #name, #name=, #offers, #offers=, #organizer, #organizer=, #owner, #owner=, #performer, #performer=, #performers, #performers=, #potential_action, #potential_action=, #previous_start_date, #previous_start_date=, #recorded_in, #recorded_in=, #remaining_attendee_capacity, #remaining_attendee_capacity=, #review, #review=, #same_as, #same_as=, #sponsor, #sponsor=, #start_date, #start_date=, #sub_event, #sub_event=, #sub_events, #sub_events=, #subject_of, #subject_of=, #super_event, #super_event=, #translator, #translator=, #typical_age_range, #typical_age_range=, #url, #url=, #work_featured, #work_featured=, #work_performed, #work_performed=

Class Method Details

.new(**properties) ⇒ EventSeries

Parameters:

Returns:



42
43
44
 
# File 'lib/schema_org/types/event_series.rb', line 42

def new(**properties)
  super
end

.schema_name ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/schema_org/types/event_series.rb', line 29

def schema_name
  SCHEMA_NAME
end

.schema_type?(other_type) ⇒ Boolean

Parameters:

  • (Object)

Returns:



37
38
39
40
 
# File 'lib/schema_org/types/event_series.rb', line 37

def schema_type?(other_type)
  Base.schema_type_argument!(other_type)
  SCHEMA_TYPES.include?(other_type)
end

.schema_types ⇒ ::Array[::Class]

Returns:

  • (::Array[::Class]) 


33
34
35
 
# File 'lib/schema_org/types/event_series.rb', line 33

def schema_types
  SCHEMA_TYPES
end

Instance Method Details

#schema_type? ⇒ Boolean

Parameters:

  • (Object)

Returns:



45084
 
# File 'sig/schema_org.rbs', line 45084

def schema_type?: (untyped) -> bool

#schema_types ⇒ ::Array[::Class]

Returns:

  • (::Array[::Class]) 


45083
 
# File 'sig/schema_org.rbs', line 45083

def schema_types: () -> ::Array[::Class]