Net::ICal::Freebusy(3pUser Contributed Perl DocumentatiNet::ICal::Freebusy(3p)



NAME
       Net::ICal::Freebusy -- Freebusy class

DESCRIPTION
       Net::ICal::Freebusy represents a list of time when someone's free or
       busy. Freebusy elements can be used in three ways:

       o   To request information about a user's open schedule slots

       o   To reply to a request for free/busy information

       o   To publish a user's list of free/busy information.

SYNOPSIS
         use Net::ICal::Freebusy;

         my $p = new Net::ICal::Period("19970101T120000","19970101T123000");
         my $q = new Net::ICal::Period("19970101T124500","19970101T130000");

         # syntax which works now
         my $f = new Net::ICal::Freebusy(freebusy => [$p],
                                         organizer => 'alice@wonderland.com');

         # FIXME, BUG 424144:
         #  you should be able to say this, but it doesn't work now
         my $f = new Net::ICal::Freebusy(freebusy => [$p, $q],
                                         organizer => 'alice@wonderland.com');

BASIC METHODS
   new (options_hash)
       Creates a new Freebusy element. Arguments should be specified as
       elements in a hash.

       When making a request for information about a user's free/busy time,
       arguments can be any of the following:

       o   contact - who to contact about this

       o   dtstart - beginning of the window of time we want info about

       o   dtend - end of the window of time we want info about.

       o   duration - how large a block of time we want to know about.

       o   dtstamp - when this request was created

       o   organizer - user who wants information about free/busy times

       o   uid - a unique identifier for this request.

       o   url - a URL with more information about this request

       o   attendee - which users' schedules we want info about; an array of
           Attendee objects

       o   comment - a comment about this request.

       o   freebusy - allowed but meaningless.

       o   request_status - allowed but not relevant.

       When responding to a request for free/busy information, the arguments
       mean different things:

       o   contact - who to contact about this list

       o   dtstart - allowed but irrelevant

       o   dtend - allowed but irrelevant

       o   duration - allowed but irrelevant

       o   dtstamp - when this response was created

       o   organizer - allowed but irrelevant

       o   uid - a unique identifier for this response.

       o   url - a URL with more information about this response.

       o   attendee - the user responding to the request

       o   comment - a comment about this response.

       o   freebusy - an array of Durations that are free. Right now, only one
           Duration is allowed, This will be fixed.

       o   request_status - a number representing the success or failure of
           the request. See RFC2445 4.8.8.2.

       When publishing information about busy time to other users, the
       parameters have the following meanings:

       o   contact - who to contact about this list

       o   dtstart - Beginning date of this range of published free/busy time

       o   dtend - End date of this range of published free/busy time

       o   duration - allowed but irrelevant (?)

       o   dtstamp - when this information was published

       o   organizer - The calendar user associated with this free/busy info

       o   uid - a unique identifier for this publication of free/busy info.

       o   url - a URL with more information about this published free/busy.

       o   attendee - allowed but irrelevant.

       o   comment - a comment about this publication.

       o   freebusy - an array of Durations that are free. Right now, only one
           Duration is allowed, This will be fixed.

       o   request_status - allowed but irrelevant.

   new_from_ical ($text)
       Takes iCalendar text as a parameter; returns a Net::ICal::Freebusy
       object.

SEE ALSO
       More documentation pointers can be found in Net::ICal.



perl v5.12.2                      2001-08-03           Net::ICal::Freebusy(3p)
