Shane Landrum > Net-ICal-0.15 > Net::ICal::ETJ

Download:
Net-ICal-0.15.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Source  

NAME ^

Net::ICal::ETJ - iCalendar event, todo and journal entry base class

SYNOPSIS ^

  use Net::ICal::ETJ;

  my $c = new Net::ICal::ETJ(%arguments);

DESCRIPTION ^

Net::ICal::ETJ represents iCalendar events, todo items and journal entries. It's a base class for N::I::Event, N::I::Todo, and N::I::Journal.

Casual users shouldn't ever need to actually make an ETJ object. The following documentation is for developers only.

DEVELOPER DOCUMENTATION ^

$self->validate

Performs basic validation on a Net::ICal event, todo or journal object. Returns 1 for success, undef for failure.

Required properties include:

my $args = { attendee => new Net::ICal::Attendee('mailto:foo@example.com');

ok( $c->validate($args) , "Validation of simple, correct ETJ"); ok( not($c->validate()) , "ETJ with no organizer should fail");

_create($foo, $class, %args)

Creates the ETJ object map using Class::MethodMapper

$self->occurrences($reqperiod)

Given a period of time, determines occurences of an Event/Todo/Journal within that period. Returns an arrayref of... what exactly?

SEE ALSO ^

Net::ICal::Event, Net::ICal::Todo, Net::ICal::Journal, and if you want to understand *how* this module works, read the source. You'll need to understand how Class::MethodMapper works also.

More documentation pointers can also be found in Net::ICal.

syntax highlighting: