diff --git a/chapters.ent b/chapters.ent index ab5073afed..d29aa54c76 100644 --- a/chapters.ent +++ b/chapters.ent @@ -51,6 +51,7 @@ + @@ -80,7 +81,7 @@ - + diff --git a/functions/icap.xml b/functions/icap.xml index 1e8b44dc1b..e4f6c1ae58 100644 --- a/functions/icap.xml +++ b/functions/icap.xml @@ -1,13 +1,14 @@ - ICAP functions + ICAP Functions ICAP To get these functions to work, you have to compile PHP with . That requires the - icap library to be installed. Grab the latest version from &url.icap; and - compile and install it. + icap library to be installed. Grab the latest version from &url.icap; and compile and install it. + @@ -32,12 +33,11 @@ icap_open opens up an ICAP connection to the specified calendar store. If the optional options is specified, passes the - options to that mailbox also. - + options to that mailbox also. + - icap_close @@ -74,56 +74,94 @@ icap_fetch_event fetches an event from the - calendar stream specified by id. + calendar stream specified by id. + Returns an event object consisting of: - - - int id - ID of that event. - - int public - TRUE if the event if public, FALSE if it is private. - - string category - Category string of the event. - - string title - Title string of the event. - - string description - Description string of the event. - + + + int id - ID of that event. + + + + + int public - TRUE if the event if public, FALSE if it is private. + + + + + string category - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + int alarm - number of minutes before the event to send an - alarm/reminder. - - object start - Object containing a datetime entry. - - object end - Object containing a datetime entry. + alarm/reminder. + + + + + object start - Object containing a datetime entry. + + + + + object end - Object containing a datetime entry. + + - All datetime entries consist of an object that contains: - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - - + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + - icap_list_events - - Return a list of events between two given - datetimes + + Return a list of events between two given datetimes @@ -138,33 +176,52 @@ Returns an array of event ID's that are between the two given - datetimes. + datetimes. + icap_list_events function takes in a beginning datetime and an end datetime for a calendar stream. An array of event id's that are between the given datetimes are - returned. + returned. + All datetime entries consist of an object that contains: - - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + - icap_store_event @@ -183,49 +240,85 @@ icap_store_event Stores an event into an ICAP calendar. an event object consists of: - - - int public - 1 if public, 0 if private; - - string caegory - Category string of the event. - - string title - Title string of the event. - - string description - Description string of the event. - - int alarm - Number of minutes before the event to sned out an alarm. - - datetime start - datetime object of the start of the event. - - datetime end - datetime object of the end of the event. - - + + + int public - 1 if public, 0 if private; + + + + + string caegory - Category string of the event. + + + + + string title - Title string of the event. + + + + + string description - Description string of the event. + + + + + int alarm - Number of minutes before the event to sned out an alarm. + + + + + datetime start - datetime object of the start of the event. + + + + + datetime end - datetime object of the end of the event. + + + + All datetime entries consist of an object that contains: - - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - - + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + - Returns true on success and false on error. - + Returns true on success and false on error. + - icap_delete_event @@ -241,9 +334,11 @@ icap_delete_event deletes the calendar event - specified by the uid. + specified by the uid. + - Returns true. + Returns true. + @@ -262,9 +357,11 @@ icap_snooze turns off an alarm for a - calendar event specified by the uid. + calendar event specified by the uid. + - Returns true. + Returns true. + @@ -287,27 +384,48 @@ Returns an array of event ID's that has an alarm going off at the - given datetime. + given datetime. + icap_list_alarms function takes in a datetime for a calendar stream. An array of event id's that has - an alarm should be going off at the datetime are returned. + an alarm should be going off at the datetime are returned. + All datetime entries consist of an object that contains: - - int year - year - - int month - month - - int mday - day of month - - int hour - hour - - int min - minutes - - int sec - seconds - + + + int year - year + + + + + int month - month + + + + + int mday - day of month + + + + + int hour - hour + + + + + int min - minutes + + + + + int sec - seconds + + + + @@ -323,7 +441,7 @@ sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" +sgml-default-dtd-file:"../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil