Class Vpim::Icalendar::Vevent
In: lib/vpim/vevent.rb
Parent: Object

Methods

accept   create   create_yearly   dtend   duration   transparency  

Included Modules

Vpim::Icalendar::Property::Base Vpim::Icalendar::Property::Common Vpim::Icalendar::Property::Priority Vpim::Icalendar::Property::Location Vpim::Icalendar::Property::Resources Vpim::Icalendar::Property::Recurrence

Classes and Modules

Class Vpim::Icalendar::Vevent::Maker

Public Class methods

create(start = Time.now, fields=[])

Create a new Vevent object. All events must have a DTSTART field, specify it as either a Time or a Date in start, it defaults to "now"

If specified, fields must be either an array of Field objects to add, or a Hash of String names to values that will be used to build Field objects. The latter is a convenient short-cut allowing the Field objects to be created for you when called like: 

  Vevent.create(Date.today, 'SUMMARY' => "today's event")
create_yearly(date, summary)

Creates a yearly repeating event, such as for a birthday.

Public Instance methods

accept(invitee)

Accept an event invitation. The invitee is the Address that wishes to accept the event invitation as confirmed.

The event created is identical to this one, but

  • without the attendees
  • with the invitee added with a PARTSTAT of ACCEPTED
dtend()

The end time for this Event. If the DTEND field is not present, but the DURATION field is, the end will be calculated from DTSTART and DURATION.

duration()

The duration in seconds of an Event, or nil if unspecified. If the DURATION field is not present, but the DTEND field is, the duration is calculated from DTSTART and DTEND. Durations of zero seconds are possible.

transparency()

In iTIP, whether this event is OPAQUE or TRANSPARENT to scheduling. If transparency is not explicitly set, it defaults to OPAQUE.

[Validate]