Module: RiCal::Properties::Alarm

Included in:
Component::Alarm
Defined in:
lib/ri_cal/properties/alarm.rb

Overview

  • ©2009 Rick DeNatale

  • All rights reserved. Refer to the file README.txt for the license

Properties::Alarm provides property accessing methods for the Alarm class This source file is generated by the rical:gen_propmodules rake tasks, DO NOT EDIT

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(mod) ⇒ Object

:nodoc:


381
382
383
# File 'lib/ri_cal/properties/alarm.rb', line 381

def self.included(mod) #:nodoc:
  mod.extend ClassMethods
end

Instance Method Details

#==(o) ⇒ Object

:nodoc:


345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/ri_cal/properties/alarm.rb', line 345

def ==(o) #:nodoc:
  if o.class == self.class
  (duration_property == o.duration_property) &&
  (attendee_property == o.attendee_property) &&
  (trigger_property == o.trigger_property) &&
  (description_property == o.description_property) &&
  (summary_property == o.summary_property) &&
  (repeat_property == o.repeat_property) &&
  (attach_property == o.attach_property) &&
  (action_property == o.action_property)
  else
     super
  end
end

#actionObject

return the value of the ACTION property which will be an instance of String


34
35
36
# File 'lib/ri_cal/properties/alarm.rb', line 34

def action
  action_property ? action_property.ruby_value : nil
end

#action=(ruby_value) ⇒ Object

set the value of the ACTION property


28
29
30
# File 'lib/ri_cal/properties/alarm.rb', line 28

def action=(ruby_value)
  self.action_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#action_propertyObject

return the the ACTION property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property defines the action to be invoked when an alarm is triggered

see RFC 2445 4.8.6.1 p 126


17
18
19
# File 'lib/ri_cal/properties/alarm.rb', line 17

def action_property
  @action_property
end

#action_property=(property_value) ⇒ Object

set the ACTION property property value should be an instance of RiCal::PropertyValueText


23
24
25
# File 'lib/ri_cal/properties/alarm.rb', line 23

def action_property=(property_value)
  @action_property = property_value
end

#action_property_from_string(line) ⇒ Object

:nodoc:


38
39
40
# File 'lib/ri_cal/properties/alarm.rb', line 38

def action_property_from_string(line) # :nodoc:
  @action_property = RiCal::PropertyValue::Text.new(self, line)
end

#add_attach(ruby_value) ⇒ Object

add one value to the ATTACH property one instances of Uri may be passed to this method


308
309
310
# File 'lib/ri_cal/properties/alarm.rb', line 308

def  add_attach(ruby_value)
 self.attach_property << RiCal::PropertyValue::Uri.convert(self, ruby_value)
end

#add_attachments(*ruby_values) ⇒ Object

add one or more values to the ATTACH property one or more instances of Uri may be passed to this method


302
303
304
# File 'lib/ri_cal/properties/alarm.rb', line 302

def  add_attachments(*ruby_values)
 ruby_values.each {|val|  self.attach_property << RiCal::PropertyValue::Uri.convert(self, val)}
end

#add_attendee(ruby_value) ⇒ Object

add one value to the ATTENDEE property one instances of CalAddress may be passed to this method


245
246
247
# File 'lib/ri_cal/properties/alarm.rb', line 245

def  add_attendee(ruby_value)
 self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, ruby_value)
end

#add_attendees(*ruby_values) ⇒ Object

add one or more values to the ATTENDEE property one or more instances of CalAddress may be passed to this method


239
240
241
# File 'lib/ri_cal/properties/alarm.rb', line 239

def  add_attendees(*ruby_values)
 ruby_values.each {|val|  self.attendee_property << RiCal::PropertyValue::CalAddress.convert(self, val)}
end

#add_date_times_to(required_timezones) ⇒ Object

:nodoc:


372
373
# File 'lib/ri_cal/properties/alarm.rb', line 372

def add_date_times_to(required_timezones) #:nodoc:
end

#attachObject

return the value of the ATTACH property which will be an array of instances of Uri


326
327
328
# File 'lib/ri_cal/properties/alarm.rb', line 326

def attach
  attach_property.map {|prop| prop ? prop.ruby_value : prop}
end

#attach=(ruby_value) ⇒ Object

set the value of the ATTACH property to a single value one instance of Uri may be passed to this method


296
297
298
# File 'lib/ri_cal/properties/alarm.rb', line 296

def attach=(ruby_value)
  @attach_property = [RiCal::PropertyValue::Uri.convert(self, ruby_value)]
end

#attach_propertyObject

return the the ATTACH property which will be an array of instances of RiCal::PropertyValueUri

purpose (from RFC 2445)

The property provides the capability to associate a document object with a calendar component.

see RFC 2445 4.8.1.1 pp 77-78


278
279
280
# File 'lib/ri_cal/properties/alarm.rb', line 278

def attach_property
  @attach_property ||= []
end

#attach_property=(*property_values) ⇒ Object

set the the ATTACH property one or more instances of RiCal::PropertyValueUri may be passed to this method


284
285
286
# File 'lib/ri_cal/properties/alarm.rb', line 284

def attach_property=(*property_values)
  @attach_property= property_values
end

#attach_property_from_string(line) ⇒ Object

:nodoc:


330
331
332
# File 'lib/ri_cal/properties/alarm.rb', line 330

def attach_property_from_string(line) # :nodoc:
  attach_property << RiCal::PropertyValue::Uri.new(self, line)
end

#attachments=(ruby_values) ⇒ Object

set the value of the ATTACH property to multiple values one or more instances of Uri may be passed to this method


290
291
292
# File 'lib/ri_cal/properties/alarm.rb', line 290

def attachments=(ruby_values)
  @attach_property = ruby_values.map {|val| RiCal::PropertyValue::Uri.convert(self, val)}
end

#attendeeObject

return the value of the ATTENDEE property which will be an array of instances of CalAddress


263
264
265
# File 'lib/ri_cal/properties/alarm.rb', line 263

def attendee
  attendee_property.map {|prop| prop ? prop.ruby_value : prop}
end

#attendee=(ruby_value) ⇒ Object

set the value of the ATTENDEE property to a single value one instance of CalAddress may be passed to this method


233
234
235
# File 'lib/ri_cal/properties/alarm.rb', line 233

def attendee=(ruby_value)
  @attendee_property = [RiCal::PropertyValue::CalAddress.convert(self, ruby_value)]
end

#attendee_propertyObject

return the the ATTENDEE property which will be an array of instances of RiCal::PropertyValueCalAddress

purpose (from RFC 2445)

The property defines an 'Attendee' within a calendar component.

see RFC 2445 4.8.4.1 pp 102-104


215
216
217
# File 'lib/ri_cal/properties/alarm.rb', line 215

def attendee_property
  @attendee_property ||= []
end

#attendee_property=(*property_values) ⇒ Object

set the the ATTENDEE property one or more instances of RiCal::PropertyValueCalAddress may be passed to this method


221
222
223
# File 'lib/ri_cal/properties/alarm.rb', line 221

def attendee_property=(*property_values)
  @attendee_property= property_values
end

#attendee_property_from_string(line) ⇒ Object

:nodoc:


267
268
269
# File 'lib/ri_cal/properties/alarm.rb', line 267

def attendee_property_from_string(line) # :nodoc:
  attendee_property << RiCal::PropertyValue::CalAddress.new(self, line)
end

#attendees=(ruby_values) ⇒ Object

set the value of the ATTENDEE property to multiple values one or more instances of CalAddress may be passed to this method


227
228
229
# File 'lib/ri_cal/properties/alarm.rb', line 227

def attendees=(ruby_values)
  @attendee_property = ruby_values.map {|val| RiCal::PropertyValue::CalAddress.convert(self, val)}
end

#descriptionObject

return the value of the DESCRIPTION property which will be an instance of String


67
68
69
# File 'lib/ri_cal/properties/alarm.rb', line 67

def description
  description_property ? description_property.ruby_value : nil
end

#description=(ruby_value) ⇒ Object

set the value of the DESCRIPTION property


61
62
63
# File 'lib/ri_cal/properties/alarm.rb', line 61

def description=(ruby_value)
  self.description_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#description_propertyObject

return the the DESCRIPTION property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property provides a more complete description of the calendar component, than that provided by the “SUMMARY” property.

see RFC 2445 4.8.1.5 pp 81-82


50
51
52
# File 'lib/ri_cal/properties/alarm.rb', line 50

def description_property
  @description_property
end

#description_property=(property_value) ⇒ Object

set the DESCRIPTION property property value should be an instance of RiCal::PropertyValueText


56
57
58
# File 'lib/ri_cal/properties/alarm.rb', line 56

def description_property=(property_value)
  @description_property = property_value
end

#description_property_from_string(line) ⇒ Object

:nodoc:


71
72
73
# File 'lib/ri_cal/properties/alarm.rb', line 71

def description_property_from_string(line) # :nodoc:
  @description_property = RiCal::PropertyValue::Text.new(self, line)
end

#durationObject

return the value of the DURATION property which will be an instance of Duration


133
134
135
# File 'lib/ri_cal/properties/alarm.rb', line 133

def duration
  duration_property ? duration_property.ruby_value : nil
end

#duration=(ruby_value) ⇒ Object

set the value of the DURATION property


127
128
129
# File 'lib/ri_cal/properties/alarm.rb', line 127

def duration=(ruby_value)
  self.duration_property= RiCal::PropertyValue::Duration.convert(self, ruby_value)
end

#duration_propertyObject

return the the DURATION property which will be an instances of RiCal::PropertyValueDuration

purpose (from RFC 2445)

This property specifies a positive duration of time.

see RFC 2445 4.8.2.5 pp 94-95


116
117
118
# File 'lib/ri_cal/properties/alarm.rb', line 116

def duration_property
  @duration_property
end

#duration_property=(property_value) ⇒ Object

set the DURATION property property value should be an instance of RiCal::PropertyValueDuration


122
123
124
# File 'lib/ri_cal/properties/alarm.rb', line 122

def duration_property=(property_value)
  @duration_property = property_value
end

#duration_property_from_string(line) ⇒ Object

:nodoc:


137
138
139
# File 'lib/ri_cal/properties/alarm.rb', line 137

def duration_property_from_string(line) # :nodoc:
  @duration_property = RiCal::PropertyValue::Duration.new(self, line)
end

#export_properties_to(export_stream) ⇒ Object

:nodoc:


334
335
336
337
338
339
340
341
342
343
# File 'lib/ri_cal/properties/alarm.rb', line 334

def export_properties_to(export_stream) #:nodoc:
  export_prop_to(export_stream, "DURATION", @duration_property)
  export_prop_to(export_stream, "ATTENDEE", @attendee_property)
  export_prop_to(export_stream, "TRIGGER", @trigger_property)
  export_prop_to(export_stream, "DESCRIPTION", @description_property)
  export_prop_to(export_stream, "SUMMARY", @summary_property)
  export_prop_to(export_stream, "REPEAT", @repeat_property)
  export_prop_to(export_stream, "ATTACH", @attach_property)
  export_prop_to(export_stream, "ACTION", @action_property)
end

#initialize_copy(o) ⇒ Object

:nodoc:


360
361
362
363
364
365
366
367
368
369
370
# File 'lib/ri_cal/properties/alarm.rb', line 360

def initialize_copy(o) #:nodoc:
  super
  duration_property = duration_property && duration_property.dup
  attendee_property = attendee_property && attendee_property.dup
  trigger_property = trigger_property && trigger_property.dup
  description_property = description_property && description_property.dup
  summary_property = summary_property && summary_property.dup
  repeat_property = repeat_property && repeat_property.dup
  attach_property = attach_property && attach_property.dup
  action_property = action_property && action_property.dup
end

#mutual_exclusion_violationObject

:nodoc:


385
386
387
# File 'lib/ri_cal/properties/alarm.rb', line 385

def mutual_exclusion_violation #:nodoc:
  false
end

#remove_attach(ruby_value) ⇒ Object

remove one value from the ATTACH property one instances of Uri may be passed to this method


320
321
322
# File 'lib/ri_cal/properties/alarm.rb', line 320

def  remove_attach(ruby_value)
 self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, ruby_value))
end

#remove_attachments(*ruby_values) ⇒ Object

remove one or more values from the ATTACH property one or more instances of Uri may be passed to this method


314
315
316
# File 'lib/ri_cal/properties/alarm.rb', line 314

def  remove_attachments(*ruby_values)
 ruby_values.each {|val|  self.attach_property.delete(RiCal::PropertyValue::Uri.convert(self, val))}
end

#remove_attendee(ruby_value) ⇒ Object

remove one value from the ATTENDEE property one instances of CalAddress may be passed to this method


257
258
259
# File 'lib/ri_cal/properties/alarm.rb', line 257

def  remove_attendee(ruby_value)
 self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, ruby_value))
end

#remove_attendees(*ruby_values) ⇒ Object

remove one or more values from the ATTENDEE property one or more instances of CalAddress may be passed to this method


251
252
253
# File 'lib/ri_cal/properties/alarm.rb', line 251

def  remove_attendees(*ruby_values)
 ruby_values.each {|val|  self.attendee_property.delete(RiCal::PropertyValue::CalAddress.convert(self, val))}
end

#repeatObject

return the value of the REPEAT property which will be an instance of Integer


166
167
168
# File 'lib/ri_cal/properties/alarm.rb', line 166

def repeat
  repeat_property ? repeat_property.ruby_value : nil
end

#repeat=(ruby_value) ⇒ Object

set the value of the REPEAT property


160
161
162
# File 'lib/ri_cal/properties/alarm.rb', line 160

def repeat=(ruby_value)
  self.repeat_property= RiCal::PropertyValue::Integer.convert(self, ruby_value)
end

#repeat_propertyObject

return the the REPEAT property which will be an instances of RiCal::PropertyValueInteger

purpose (from RFC 2445)

This property defines the number of times the alarm should be repeated, after the initial trigger.

see RFC 2445 4.8.6.2 p 126-127


149
150
151
# File 'lib/ri_cal/properties/alarm.rb', line 149

def repeat_property
  @repeat_property
end

#repeat_property=(property_value) ⇒ Object

set the REPEAT property property value should be an instance of RiCal::PropertyValueInteger


155
156
157
# File 'lib/ri_cal/properties/alarm.rb', line 155

def repeat_property=(property_value)
  @repeat_property = property_value
end

#repeat_property_from_string(line) ⇒ Object

:nodoc:


170
171
172
# File 'lib/ri_cal/properties/alarm.rb', line 170

def repeat_property_from_string(line) # :nodoc:
  @repeat_property = RiCal::PropertyValue::Integer.new(self, line)
end

#summaryObject

return the value of the SUMMARY property which will be an instance of String


199
200
201
# File 'lib/ri_cal/properties/alarm.rb', line 199

def summary
  summary_property ? summary_property.ruby_value : nil
end

#summary=(ruby_value) ⇒ Object

set the value of the SUMMARY property


193
194
195
# File 'lib/ri_cal/properties/alarm.rb', line 193

def summary=(ruby_value)
  self.summary_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#summary_propertyObject

return the the SUMMARY property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property defines a short summary or subject for the calendar component.

see RFC 2445 4.8.1.12 pp 89-90


182
183
184
# File 'lib/ri_cal/properties/alarm.rb', line 182

def summary_property
  @summary_property
end

#summary_property=(property_value) ⇒ Object

set the SUMMARY property property value should be an instance of RiCal::PropertyValueText


188
189
190
# File 'lib/ri_cal/properties/alarm.rb', line 188

def summary_property=(property_value)
  @summary_property = property_value
end

#summary_property_from_string(line) ⇒ Object

:nodoc:


203
204
205
# File 'lib/ri_cal/properties/alarm.rb', line 203

def summary_property_from_string(line) # :nodoc:
  @summary_property = RiCal::PropertyValue::Text.new(self, line)
end

#triggerObject

return the value of the TRIGGER property which will be an instance of Duration


100
101
102
# File 'lib/ri_cal/properties/alarm.rb', line 100

def trigger
  trigger_property ? trigger_property.ruby_value : nil
end

#trigger=(ruby_value) ⇒ Object

set the value of the TRIGGER property


94
95
96
# File 'lib/ri_cal/properties/alarm.rb', line 94

def trigger=(ruby_value)
  self.trigger_property= RiCal::PropertyValue::Duration.convert(self, ruby_value)
end

#trigger_propertyObject

return the the TRIGGER property which will be an instances of RiCal::PropertyValueDuration

purpose (from RFC 2445)

This property specifies when an alarm will trigger.

see RFC 2445 4.8.6.3 p 127-129


83
84
85
# File 'lib/ri_cal/properties/alarm.rb', line 83

def trigger_property
  @trigger_property
end

#trigger_property=(property_value) ⇒ Object

set the TRIGGER property property value should be an instance of RiCal::PropertyValueDuration


89
90
91
# File 'lib/ri_cal/properties/alarm.rb', line 89

def trigger_property=(property_value)
  @trigger_property = property_value
end

#trigger_property_from_string(line) ⇒ Object

:nodoc:


104
105
106
# File 'lib/ri_cal/properties/alarm.rb', line 104

def trigger_property_from_string(line) # :nodoc:
  @trigger_property = RiCal::PropertyValue::Duration.new(self, line)
end