WebService::30Boxes::API::Event - Object returned by WebService::30Boxes::API::call("events.Get*
#$api_key and $auth_token are defined before
my $boxes = WebService::30Boxes::API->new(api_key => $api_key);
my $events = $boxes->call('events.Get', {authorizedUserToken => $auth_token});
if($events->{'success'}){
print "List start: " . $events->get_listStart . "\n";
print "List end: " . $events->get_listEnd . "\n";
print "User Id: " . $events->get_userId . "\n\n\n";
#while ($events->nextEventId){ - if you use this, you don't need to specify
#$_ as an argument
#foreach (@{$events->get_ref_eventIds}){
foreach ($events->get_eventIds){
print "Event id: $_\n";
print "Title: " . $events->get_title($_) . "\n";
print "Repeat end date: " . $events->get_repeatEndDate($_) . "\n";
print "Repeat skip dates: ";
foreach ($events->get_repeatSkipDates($_)){print "$_\n";}
print "Repeat type: " . $events->get_repeatType($_) . "\n";
print "Repeat interval: " . $events->get_repeatInterval($_) . "\n";
print "Reminder: " . $events->get_reminder($_) . "\n";
print "Tags: ";
foreach ($events->get_tags($_)){print "$_\n";}
print "Start date: " . $events->get_startDate($_) . "\n";
print "Start time: " . $events->get_startTime($_) . "\n";
print "End date: " . $events->get_endDate($_) . "\n";
print "End time: " . $events->get_endTime($_) . "\n";
print "Is all day event: " . $events->isAllDayEvent($_) . "\n";
print "Notes: ";
foreach ($events->get_notes($_)){print "$_\n";}
print "Privacy: " . $events->get_privacy($_) . "\n\n";
print "External UID: " . $events->get_externalUID($_) . "\n\n";
}
}
else{
print "An error occured (" . $events->{'error_code'} . ": " .
$events->{'error_msg'} . ")\n";
}
An object of this type is returned by the WebService::30Boxes::API::call("events.Get*") function
The following methods can be used
Create a new WebService::30Boxes::API::Event object.
(Mandatory) Result must be the the hash function returned by the XML parser. Results are undefined if some other hash is passed in.
(Mandatory) If the API call was successful or not.
(Optional) If success is false, this must be supplied
(Optional) If success is false, this must be supplied
Returns an array of event ids.
You can then use this to call any of the following functions.
Returns a reference to an array of event ids.
You can then use this to call any of the following functions.
Returns the end date of the list of events - yyyy-mm-dd.
Returns the start date of the list of events - yyyy-mm-dd.
Returns the current user id.
Advances the event index and returns the new eventID (for convenience)
Returns the date when the recurring event stops repeating - yyyy-mm-dd. Returns 0000-00-00 if none. If an event spans over multiple days but it is not recurring, the final date will be returned.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns a list of the days that are skipped.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the repeat type for the event. Returns 'no' if none.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the repeat interval for the event. This together with get_repeatType tell you all you need to know about how the event repeats.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the number of minutes before the event when the reminder will be sent. Returns -1 if no reminder.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns a list of tags.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the start date for the event - yyyy-mm-dd.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the start time for the event - hh:mm:ss.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the end date for the event - yyyy-mm-dd.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the end time for the event - hh:mm:ss.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns 1 if it is an all day event, 0 otherwise.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the title for the event.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Return the notes for the event in the form of a string. If the notes span over multiple lines, the order in which they are returned is undefined.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns whether the event is shared or private. Return value is a string.
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Returns the user defined ID for this event The return value is a string
Arguments:
(Optional) The eventId of the event for which you want to retreive the information. If not present, the next eventId will be used as an index. The next eventId is set by calling nextEventId.
Add more error checking. Compact the code and make it more efficient. Please email me for feature requests.
Please notify chitoiup@umich.edu of any bugs.
http://30boxes.com/, http://30boxes.com/api/
WebService::30Boxes::API::Todo
Robert Chitoiu, <chitoiup@umich.edu>
Copyright (C) 2007 by Robert Chitoiu
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
