Class Icalendar::Event
In: lib/icalendar/component/event.rb
Parent: Component

A Event calendar component is a grouping of component properties, and possibly including Alarm calendar components, that represents a scheduled amount of time on a calendar. For example, it can be an activity; such as a one-hour long, department meeting from 8:00 AM to 9:00 AM, tomorrow. Generally, an event will take up time on an individual calendar.

Methods

alarm   new   occurrences_starting  

Attributes

alarms   
attach    Associates a URI or binary blob with this item
attachment    Associates a URI or binary blob with this item
attachments    Associates a URI or binary blob with this item
categories    Defines the categories for a calendar component (school, work…)
categories    Defines the categories for a calendar component (school, work…)
category    Defines the categories for a calendar component (school, work…)
comment    Simple comment for the calendar user.
comment    Simple comment for the calendar user.
comments    Simple comment for the calendar user.
contact    Contact information associated with this item.
contact    Contact information associated with this item.
contacts    Contact information associated with this item.
created    Date & time of creation
description    Complete description of the calendar component
dtend    Specifies a date and time that this item ends
dtstamp    Indicate date & time when this item was created
dtstart    Specifies date-time when calendar component begins
duration    Specifies a positive duration time
end    Specifies a date and time that this item ends
exception_date   
exception_dates   
exception_rule   
exception_rules   
exdate   
exrule   
geo    Latitude & longitude for specified activity
geo_location    Latitude & longitude for specified activity
ip_class    Access classification (PUBLIC, PRIVATE, CONFIDENTIAL…)
klass    Access classification (PUBLIC, PRIVATE, CONFIDENTIAL…)
last_modified    Date & time this item was last modified
location    Specifies the intended venue for this activity
organizer    Defines organizer of this item
priority    Defines relative priority for this item (1-9… 1 = best)
rdate    Used with the UID & SEQUENCE to identify a specific instance of a recurring calendar item.
recurid   
recurrence_date    Used with the UID & SEQUENCE to identify a specific instance of a recurring calendar item.
recurrence_dates    Used with the UID & SEQUENCE to identify a specific instance of a recurring calendar item.
recurrence_id   
recurrence_rule   
recurrence_rules   
related_to    Used to represent a relationship between two calendar items
related_to    Used to represent a relationship between two calendar items
related_tos    Used to represent a relationship between two calendar items
request_status   
request_statuses   
resource   
resources   
resources   
rrule   
rstatus   
seq    Revision sequence number for this item
sequence    Revision sequence number for this item
start    Specifies date-time when calendar component begins
status    Defines overall status or confirmation of this item
summary   
timestamp    Indicate date & time when this item was created
transp   
transparency   
tzid  [RW]  Specifies the timezone for the event
uid    Defines a persistent, globally unique id for this item
unique_id    Defines a persistent, globally unique id for this item
url    Defines a URL associated with this item

Public Class methods

new()

[Source]

# File lib/icalendar/component/event.rb, line 106
    def initialize()
      super("VEVENT")

      # Now doing some basic initialization
      sequence 0
      timestamp DateTime.now
      uid new_uid
    end

Public Instance methods

alarm(&block)

[Source]

# File lib/icalendar/component/event.rb, line 115
    def alarm(&block)
      a = Alarm.new
      self.add a

      a.instance_eval &block if block

      a
    end
occurrences_starting(time)

[Source]

# File lib/icalendar/component/event.rb, line 124
    def occurrences_starting(time)
      recurrence_rules.first.occurrences_of_event_starting(self, time)
    end

[Validate]