Module: RiCal::Properties::Alarm

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

Overview

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:



378
379
380
 
# File 'lib/ri_cal/properties/alarm.rb', line 378

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

Instance Method Details

#==(o) ⇒ Object

:nodoc:



342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/ri_cal/properties/alarm.rb', line 342

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

#action ⇒ Object

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



31
32
33
 
# File 'lib/ri_cal/properties/alarm.rb', line 31

def action
  action_property ? action_property.ruby_value : nil
end

#action=(ruby_value) ⇒ Object

set the value of the ACTION property



25
26
27
 
# File 'lib/ri_cal/properties/alarm.rb', line 25

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

#action_property ⇒ Object

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



14
15
16
 
# File 'lib/ri_cal/properties/alarm.rb', line 14

def action_property
  @action_property
end

#action_property=(property_value) ⇒ Object

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



20
21
22
 
# File 'lib/ri_cal/properties/alarm.rb', line 20

def action_property=(property_value)
  @action_property = property_value
end

#action_property_from_string(line) ⇒ Object

:nodoc:



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

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



305
306
307
 
# File 'lib/ri_cal/properties/alarm.rb', line 305

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



299
300
301
 
# File 'lib/ri_cal/properties/alarm.rb', line 299

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



242
243
244
 
# File 'lib/ri_cal/properties/alarm.rb', line 242

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



236
237
238
 
# File 'lib/ri_cal/properties/alarm.rb', line 236

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:



369
370
 
# File 'lib/ri_cal/properties/alarm.rb', line 369

def add_date_times_to(required_timezones) #:nodoc:
end

#attach ⇒ Object

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



323
324
325
 
# File 'lib/ri_cal/properties/alarm.rb', line 323

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



293
294
295
 
# File 'lib/ri_cal/properties/alarm.rb', line 293

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

#attach_property ⇒ Object

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



275
276
277
 
# File 'lib/ri_cal/properties/alarm.rb', line 275

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



281
282
283
 
# File 'lib/ri_cal/properties/alarm.rb', line 281

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

#attach_property_from_string(line) ⇒ Object

:nodoc:



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

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



287
288
289
 
# File 'lib/ri_cal/properties/alarm.rb', line 287

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

#attendee ⇒ Object

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



260
261
262
 
# File 'lib/ri_cal/properties/alarm.rb', line 260

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



230
231
232
 
# File 'lib/ri_cal/properties/alarm.rb', line 230

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

#attendee_property ⇒ Object

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



212
213
214
 
# File 'lib/ri_cal/properties/alarm.rb', line 212

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



218
219
220
 
# File 'lib/ri_cal/properties/alarm.rb', line 218

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

#attendee_property_from_string(line) ⇒ Object

:nodoc:



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

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



224
225
226
 
# File 'lib/ri_cal/properties/alarm.rb', line 224

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

#description ⇒ Object

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



64
65
66
 
# File 'lib/ri_cal/properties/alarm.rb', line 64

def description
  description_property ? description_property.ruby_value : nil
end

#description=(ruby_value) ⇒ Object

set the value of the DESCRIPTION property



58
59
60
 
# File 'lib/ri_cal/properties/alarm.rb', line 58

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

#description_property ⇒ Object

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



47
48
49
 
# File 'lib/ri_cal/properties/alarm.rb', line 47

def description_property
  @description_property
end

#description_property=(property_value) ⇒ Object

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



53
54
55
 
# File 'lib/ri_cal/properties/alarm.rb', line 53

def description_property=(property_value)
  @description_property = property_value
end

#description_property_from_string(line) ⇒ Object

:nodoc:



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

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

#duration ⇒ Object

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



130
131
132
 
# File 'lib/ri_cal/properties/alarm.rb', line 130

def duration
  duration_property ? duration_property.ruby_value : nil
end

#duration=(ruby_value) ⇒ Object

set the value of the DURATION property



124
125
126
 
# File 'lib/ri_cal/properties/alarm.rb', line 124

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

#duration_property ⇒ Object

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



113
114
115
 
# File 'lib/ri_cal/properties/alarm.rb', line 113

def duration_property
  @duration_property
end

#duration_property=(property_value) ⇒ Object

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



119
120
121
 
# File 'lib/ri_cal/properties/alarm.rb', line 119

def duration_property=(property_value)
  @duration_property = property_value
end

#duration_property_from_string(line) ⇒ Object

:nodoc:



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

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

#export_properties_to(export_stream) ⇒ Object

:nodoc:



331
332
333
334
335
336
337
338
339
340
 
# File 'lib/ri_cal/properties/alarm.rb', line 331

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:



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/ri_cal/properties/alarm.rb', line 357

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_violation ⇒ Object

:nodoc:



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

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



317
318
319
 
# File 'lib/ri_cal/properties/alarm.rb', line 317

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



311
312
313
 
# File 'lib/ri_cal/properties/alarm.rb', line 311

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



254
255
256
 
# File 'lib/ri_cal/properties/alarm.rb', line 254

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



248
249
250
 
# File 'lib/ri_cal/properties/alarm.rb', line 248

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

#repeat ⇒ Object

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



163
164
165
 
# File 'lib/ri_cal/properties/alarm.rb', line 163

def repeat
  repeat_property ? repeat_property.ruby_value : nil
end

#repeat=(ruby_value) ⇒ Object

set the value of the REPEAT property



157
158
159
 
# File 'lib/ri_cal/properties/alarm.rb', line 157

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

#repeat_property ⇒ Object

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



146
147
148
 
# File 'lib/ri_cal/properties/alarm.rb', line 146

def repeat_property
  @repeat_property
end

#repeat_property=(property_value) ⇒ Object

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



152
153
154
 
# File 'lib/ri_cal/properties/alarm.rb', line 152

def repeat_property=(property_value)
  @repeat_property = property_value
end

#repeat_property_from_string(line) ⇒ Object

:nodoc:



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

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

#summary ⇒ Object

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



196
197
198
 
# File 'lib/ri_cal/properties/alarm.rb', line 196

def summary
  summary_property ? summary_property.ruby_value : nil
end

#summary=(ruby_value) ⇒ Object

set the value of the SUMMARY property



190
191
192
 
# File 'lib/ri_cal/properties/alarm.rb', line 190

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

#summary_property ⇒ Object

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



179
180
181
 
# File 'lib/ri_cal/properties/alarm.rb', line 179

def summary_property
  @summary_property
end

#summary_property=(property_value) ⇒ Object

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



185
186
187
 
# File 'lib/ri_cal/properties/alarm.rb', line 185

def summary_property=(property_value)
  @summary_property = property_value
end

#summary_property_from_string(line) ⇒ Object

:nodoc:



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

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

#trigger ⇒ Object

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



97
98
99
 
# File 'lib/ri_cal/properties/alarm.rb', line 97

def trigger
  trigger_property ? trigger_property.ruby_value : nil
end

#trigger=(ruby_value) ⇒ Object

set the value of the TRIGGER property



91
92
93
 
# File 'lib/ri_cal/properties/alarm.rb', line 91

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

#trigger_property ⇒ Object

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



80
81
82
 
# File 'lib/ri_cal/properties/alarm.rb', line 80

def trigger_property
  @trigger_property
end

#trigger_property=(property_value) ⇒ Object

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



86
87
88
 
# File 'lib/ri_cal/properties/alarm.rb', line 86

def trigger_property=(property_value)
  @trigger_property = property_value
end

#trigger_property_from_string(line) ⇒ Object

:nodoc:



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

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