Class: Tilia::VObject::ITip::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/tilia/v_object/i_tip/message.rb

Overview

This class represents an iTip message.

A message holds all the information relevant to the message, including the object itself.

It should for the most part be treated as immutable.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Message

Initialize instance variables



103
104
105
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 103

def initialize
  @significant_change = true
end

Instance Attribute Details

#component ⇒ String

The component type, such as VEVENT.

Returns:

  • (String) 


19
20
21
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 19

def component
  @component
end

#message ⇒ Component::VCalendar

The iCalendar / iTip body.

Returns:



72
73
74
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 72

def message
  @message
end

#method ⇒ String

Contains the ITip method, which is something like REQUEST, REPLY or CANCEL.

Returns:

  • (String) 


25
26
27
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 25

def method
  @method
end

#recipient ⇒ String

The recipient’s email address.

Returns:

  • (String) 


50
51
52
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 50

def recipient
  @recipient
end

#recipient_name ⇒ String?

The name of the recipient. This is usually populated with the CN parameter from the ATTENDEE or ORGANIZER property, if it’s available.

Returns:

  • (String, nil) 


56
57
58
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 56

def recipient_name
  @recipient_name
end

#schedule_status ⇒ String, false

Returns the schedule status as a string.

For example: 1.2

Returns:

  • (String, false) 


67
68
69
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 67

def schedule_status
  @schedule_status
end

#sender ⇒ String

The senders’ email address.

Note that this does not imply that this has to be used in a From: field if the message is sent by email. It may also be populated in Reply-To: or not at all.

Returns:

  • (String) 


39
40
41
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 39

def sender
  @sender
end

#sender_name ⇒ String?

The name of the sender. This is often populated from a CN parameter from either the ORGANIZER or ATTENDEE, depending on the message.

Returns:

  • (String, nil) 


45
46
47
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 45

def sender_name
  @sender_name
end

#sequence ⇒ Fixnum

The current sequence number for the event.

Returns:

  • (Fixnum) 


30
31
32
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 30

def sequence
  @sequence
end

#significant_change ⇒ Boolean

This will be set to true, if the iTip broker considers the change ‘significant’.

In practice, this means that we’ll only mark it true, if for instance DTSTART changed. This allows systems to only send iTip messages when significant changes happened. This is especially useful for iMip, as normally a ton of messages may be generated for normal calendar use.

To see the list of properties that are considered ‘significant’, check out SabreVObjectITipBroker::significant_change_properties.

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 86

def significant_change
  @significant_change
end

#uid ⇒ String

The object’s UID.

Returns:

  • (String) 


14
15
16
 
# File 'lib/tilia/v_object/i_tip/message.rb', line 14

def uid
  @uid
end