####
ICal
####


****
NAME
****


Kernel::System::Calendar::Import::ICal - \ ``iCalendar``\  import lib


***********
DESCRIPTION
***********


Import functions for \ ``iCalendar``\  format.


****************
PUBLIC INTERFACE
****************


new()
=====


create an object. Do not use it directly, instead use:


.. code-block:: perl

     use Kernel::System::ObjectManager;
     local $Kernel::OM = Kernel::System::ObjectManager->new();
     my $ImportObject = $Kernel::OM->Get('Kernel::System::Calendar::Export::ICal');



Import()
========


Import calendar in \ ``iCalendar``\  format.


.. code-block:: perl

     my $Success = $ImportObject->Import(
         CalendarID     => 123,
         ICal           =>                         # (required) iCal string
             '
                 BEGIN:VCALENDAR
                 PRODID:Zimbra-Calendar-Provider
                 VERSION:2.0
                 METHOD:REQUEST
                 # ...
             ',
         UserID         => 1,                      # (required) UserID
         UpdateExisting => 0,                      # (optional) Delete existing Appointments within same Calendar if UniqueID matches
         UntilLimit     => '2017-01-01 00:00:00',  # (optional) If provided, system will use this value for limiting recurring Appointments without defined end date
                                                   # instead of AppointmentCalendar::Import::RecurringMonthsLimit to do the calculation
                                                   # NOTE: PLEASE USE THIS PARAMETER FOR UNIT TESTS ONLY
     );


Returns number of imported appointments if successful, otherwise 0.