Class: OpenActive::Models::Event

Inherits:
Schema::Event show all
Defined in:
lib/openactive/models/event.rb

Overview

This type is derived from [Event](schema.org/Event), which means that any of this type’s properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.

Instance Attribute Summary collapse

Attributes inherited from Schema::Event

#about, #actor, #aggregate_rating, #attendee, #attendees, #audience, #composer, #director, #door_time, #funder, #in_language, #performer, #performers, #previous_start_date, #recorded_in, #review, #sponsor, #sub_events, #translator, #typical_age_range, #work_featured, #work_performed

Attributes inherited from Schema::Thing

#additional_type, #alternate_name, #disambiguating_description, #main_entity_of_page, #same_as, #subject_of

Attributes inherited from JsonLdModel

#context, #id

Method Summary

Methods inherited from BaseModel

#assign_attributes, define_property, deserialize, #deserialize, deserialize_class, #initialize, #serialize, serialize, #set_property, #to_json

Methods included from Concerns::TypeChecker

#check_types, included

Methods included from Concerns::JsonLdSerializable

included, #to_h, #values

Constructor Details

This class inherits a constructor from OpenActive::BaseModel

Instance Attribute Details

#accessibility_informationString

Returns:

  • (String)


31
32
33
# File 'lib/openactive/models/event.rb', line 31

def accessibility_information
  @accessibility_information
end

#accessibility_supportArray<OpenActive::Models::Concept>

Returns:



36
37
38
# File 'lib/openactive/models/event.rb', line 36

def accessibility_support
  @accessibility_support
end

#activityArray<OpenActive::Models::Concept>

Returns:



41
42
43
# File 'lib/openactive/models/event.rb', line 41

def activity
  @activity
end

#age_rangeOpenActive::Models::QuantitativeValue



46
47
48
# File 'lib/openactive/models/event.rb', line 46

def age_range
  @age_range
end

#attendee_countint?

Returns:

  • (int, nil)


255
256
257
# File 'lib/openactive/models/event.rb', line 255

def attendee_count
  @attendee_count
end

#attendee_instructionsString

Returns:

  • (String)


51
52
53
# File 'lib/openactive/models/event.rb', line 51

def attendee_instructions
  @attendee_instructions
end

#availabilityString

Returns:

  • (String)


238
239
240
# File 'lib/openactive/models/event.rb', line 238

def availability
  @availability
end

#categoryArray<String>, Array<OpenActive::Models::Concept>

Returns:



56
57
58
# File 'lib/openactive/models/event.rb', line 56

def category
  @category
end

#contributorArray<OpenActive::Models::Person>

Returns:



62
63
64
# File 'lib/openactive/models/event.rb', line 62

def contributor
  @contributor
end

#descriptionString

Returns:

  • (String)


26
27
28
# File 'lib/openactive/models/event.rb', line 26

def description
  @description
end

#distanceOpenActive::Models::QuantitativeValue



195
196
197
# File 'lib/openactive/models/event.rb', line 195

def distance
  @distance
end

#durationActiveSupport::Duration?

Returns:

  • (ActiveSupport::Duration, nil)


67
68
69
# File 'lib/openactive/models/event.rb', line 67

def duration
  @duration
end

#end_dateDate, ...

Returns:

  • (Date, DateTime, nil)


173
174
175
# File 'lib/openactive/models/event.rb', line 173

def end_date
  @end_date
end

#estimated_durationOpenActive::Models::QuantitativeValue



200
201
202
# File 'lib/openactive/models/event.rb', line 200

def estimated_duration
  @estimated_duration
end

#event_scheduleArray<OpenActive::Models::Schedule>

Returns:



73
74
75
# File 'lib/openactive/models/event.rb', line 73

def event_schedule
  @event_schedule
end

#event_statusOpenActive::Enums::Schema::EventStatusType?



78
79
80
# File 'lib/openactive/models/event.rb', line 78

def event_status
  @event_status
end

#facility_settingOpenActive::Enums::FacilitySettingType?



216
217
218
# File 'lib/openactive/models/event.rb', line 216

def facility_setting
  @facility_setting
end

#formatted_descriptionString

Returns:

  • (String)


211
212
213
# File 'lib/openactive/models/event.rb', line 211

def formatted_description
  @formatted_description
end

#gender_restrictionOpenActive::Enums::GenderRestrictionType?



84
85
86
# File 'lib/openactive/models/event.rb', line 84

def gender_restriction
  @gender_restriction
end

#identifierint, ...



12
13
14
# File 'lib/openactive/models/event.rb', line 12

def identifier
  @identifier
end

#imageArray<OpenActive::Models::ImageObject>



90
91
92
# File 'lib/openactive/models/event.rb', line 90

def image
  @image
end

#is_accessible_for_freeBoolean?

Returns:

  • (Boolean, nil)


95
96
97
# File 'lib/openactive/models/event.rb', line 95

def is_accessible_for_free
  @is_accessible_for_free
end

#is_coachedBoolean?

Returns:

  • (Boolean, nil)


101
102
103
# File 'lib/openactive/models/event.rb', line 101

def is_coached
  @is_coached
end

#is_virtually_coachedBoolean?

Returns:

  • (Boolean, nil)


205
206
207
# File 'lib/openactive/models/event.rb', line 205

def is_virtually_coached
  @is_virtually_coached
end

#is_wheelchair_accessibleBoolean?

Returns:

  • (Boolean, nil)


243
244
245
# File 'lib/openactive/models/event.rb', line 243

def is_wheelchair_accessible
  @is_wheelchair_accessible
end

#leaderArray<OpenActive::Models::Person>

Returns:



107
108
109
# File 'lib/openactive/models/event.rb', line 107

def leader
  @leader
end

#levelArray<String>, Array<OpenActive::Models::Concept>

Returns:



112
113
114
# File 'lib/openactive/models/event.rb', line 112

def level
  @level
end

#locationOpenActive::Models::Place



118
119
120
# File 'lib/openactive/models/event.rb', line 118

def location
  @location
end

#maximum_attendee_capacityint?

Returns:

  • (int, nil)


123
124
125
# File 'lib/openactive/models/event.rb', line 123

def maximum_attendee_capacity
  @maximum_attendee_capacity
end

#meeting_pointString

Returns:

  • (String)


129
130
131
# File 'lib/openactive/models/event.rb', line 129

def meeting_point
  @meeting_point
end

#nameString

Returns:

  • (String)


21
22
23
# File 'lib/openactive/models/event.rb', line 21

def name
  @name
end

#offer_validity_periodActiveSupport::Duration?

Returns:

  • (ActiveSupport::Duration, nil)


222
223
224
# File 'lib/openactive/models/event.rb', line 222

def offer_validity_period
  @offer_validity_period
end

#offersArray<OpenActive::Models::Offer>

Returns:



134
135
136
# File 'lib/openactive/models/event.rb', line 134

def offers
  @offers
end

#organizerOpenActive::Models::Person, OpenActive::Models::Organization



139
140
141
# File 'lib/openactive/models/event.rb', line 139

def organizer
  @organizer
end

#potential_actionArray<OpenActive::Models::Action>

Returns:



145
146
147
# File 'lib/openactive/models/event.rb', line 145

def potential_action
  @potential_action
end

#programmeOpenActive::Models::Brand



150
151
152
# File 'lib/openactive/models/event.rb', line 150

def programme
  @programme
end

#registration_countint?

Returns:

  • (int, nil)


249
250
251
# File 'lib/openactive/models/event.rb', line 249

def registration_count
  @registration_count
end

#remaining_attendee_capacityint?

Returns:

  • (int, nil)


155
156
157
# File 'lib/openactive/models/event.rb', line 155

def remaining_attendee_capacity
  @remaining_attendee_capacity
end

#scheduling_noteString

Returns:

  • (String)


161
162
163
# File 'lib/openactive/models/event.rb', line 161

def scheduling_note
  @scheduling_note
end

#sports_activity_locationArray<OpenActive::Models::SportsActivityLocation>



228
229
230
# File 'lib/openactive/models/event.rb', line 228

def sports_activity_location
  @sports_activity_location
end

#start_dateDate, ...

Returns:

  • (Date, DateTime, nil)


166
167
168
# File 'lib/openactive/models/event.rb', line 166

def start_date
  @start_date
end

#sub_eventArray<OpenActive::Models::Event>

Returns:



180
181
182
# File 'lib/openactive/models/event.rb', line 180

def sub_event
  @sub_event
end

#super_eventOpenActive::Models::Event



185
186
187
# File 'lib/openactive/models/event.rb', line 185

def super_event
  @super_event
end

#typeString

Returns:

  • (String)


7
8
9
# File 'lib/openactive/models/event.rb', line 7

def type
  "Event"
end

#urlURI

Returns:

  • (URI)


190
191
192
# File 'lib/openactive/models/event.rb', line 190

def url
  @url
end

#videoArray<OpenActive::Models::Schema::VideoObject>



233
234
235
# File 'lib/openactive/models/event.rb', line 233

def video
  @video
end