Available methods for Koledar (kronolith)

Application: kronolith
Prefix: calendar
Name: Koledar

Example:

// inside ObalaNET 1
$result = $registry->call("calendar/METHOD_NAME", array(PARAMETERS));

// inside ObalaNET 2
$result = $registry->callByPackage("kronolith", "METHOD_NAME", array(PARAMETERS));

// XML RPC (http://pear.php.net/package/XML_RPC)
require_once "XML/RPC.php";
$msg = new XML_RPC_Message("calendar.METHOD_NAME", PARAMETERS);
$cli = new XML_RPC_Client("/rpc.php", "http://HOSTNAME");
$resp = $cli->send($msg);
$val = $resp->value();
$result = XML_RPC_decode($val);

// XML RPC 2 (http://pear.php.net/package/XML_RPC2)
require_once "XML/RPC2/Client.php";
$client = XML_RPC2_Client::create("http://HOSTNAME/rpc.php", array("prefix" => "calendar"));
$result = $client->METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...);

// Python Example (http://wiki.horde.org/XmlRpcPythonHowTo)
import xmlrpclib
url = "http://HOSTNAME/rpc.php"
server = xmlrpclib.ServerProxy(url, verbose=0)
result = server.calendar.METHOD_NAME(PARAMETER_1, PARAMETER_2, PARAMETER_3 ...)

More detailed examples: http://www.drugapisarna.si/wicked/ZunanjaUporaba

perms - Kronolith external A...

Call: (mixed) perms()

Description :

Kronolith external API interface.
$Horde: kronolith/lib/api.php,v 1.209 2007/12/28 13:36:26 jan Exp $
This file defines Kronolith's external API interface. Other applications
can interact with Kronolith through this API.

removeUserData - ...

Call: (mixed) removeUserData((mixed) user)
Parameters:

Type	Name	Documentation
mixed	user

shareHelp - ...

Call: (mixed) shareHelp()

browse - Browse through Krono...

Call: (array) browse( [ (string) path, (array) properties ] )

Description :

Browse through Kronolith's object tree.
'icon', and 'browseable'.

Parameters:

Type	Name	Documentation
string	path	The level of the tree to browse.
array	properties	The item properties to return. Defaults to 'name',

put - Saves a file into th...

Call: (array) put((string) path, (string) content, (string) content_type)

Description :

Saves a file into the Kronolith tree.

Parameters:

Type	Name	Documentation
string	path	The path where to PUT the file.
string	content	The file content.
string	content_type	The file's content type.

path_delete - Deletes a file from ...

Call: (mixed) path_delete((string) path)

Description :

Deletes a file from the Kronolith tree.

Parameters:

Type	Name	Documentation
string	path	The path to the file.

getFreeBusy - Generates free/busy ...

Call: (Horde_iCalendar_vfreebusy) getFreeBusy( [ (integer) startstamp, (integer) endstamp, (string) calendar ] )

Description :

Generates free/busy information for a given time period.
Defaults to the user's default calendar.
specified time period.

Parameters:

Type	Name	Documentation
integer	startstamp	The start of the time period to retrieve.
integer	endstamp	The end of the time period to retrieve.
string	calendar	The calendar to view free/busy slots for.

listCalendars - ...

Call: (mixed) listCalendars( [ (mixed) owneronly, (mixed) permission ] )
Parameters:

Type	Name	Documentation
mixed	owneronly
mixed	permission

listEvents - Lists events for a g...

Call: (array) listEvents( [ (integer) startstamp, (integer) endstamp, (array) calendars, (boolean) showRecurrence, (boolean) alarmsOnly ] )

Description :

Lists events for a given time period.
Defaults to the user's default calendar.
If false, will only return recurring events
once inside the $startDate - $endDate range.
Defaults to false.

Parameters:

Type	Name	Documentation
integer	startstamp	The start of the time period to retrieve.
integer	endstamp	The end of the time period to retrieve.
array	calendars	rs The calendars to view events from.
boolean	showRecurrence	Return every instance of a recurring event?
boolean	alarmsOnly	Filter results for events with alarms.

listAlarms - Lists alarms for a g...

Call: (array) listAlarms((integer) time [ , (string) user ] )

Description :

Lists alarms for a given moment.

Parameters:

Type	Name	Documentation
integer	time	The time to retrieve alarms for.
string	user	The user to retrieve alarms for. All users if null.

list - ...

Call: (mixed) list( [ (mixed) calendar, (mixed) startstamp, (mixed) endstamp ] )
Parameters:

Type	Name	Documentation
mixed	calendar
mixed	startstamp
mixed	endstamp

listBy - Returns an array of ...

Call: (array) listBy((string) action, (integer) timestamp [ , (string) calendar ] )

Description :

Returns an array of UIDs for events that have had $action happen since
$timestamp.

Parameters:

Type	Name	Documentation
string	action	n The action to check for - add, modify, or delete.
integer	timestamp	The time to start the search.
string	calendar	r The calendar to search in.

getActionTimestamp - Returns the timestam...

Call: (integer) getActionTimestamp((string) uid, (string) action [ , (string) calendar ] )

Description :

Returns the timestamp of an operation for a given uid an action

Parameters:

Type	Name	Documentation
string	uid	The uid to look for.
string	action	The action to check for - add, modify, or delete.
string	calendar	The calendar to search in.

import - Imports an event rep...

Call: (mixed) import((string) content, (string) contentType [ , (string) calendar ] )

Description :

Imports an event represented in the specified content type.

text/calendar
text/x-icalendar
text/x-vcalendar
text/x-vevent

Parameters:

Type	Name	Documentation
string	content	The content of the event.
string	contentType	What format is the data in? Currently supports:
string	calendar	What calendar should the event be added to?

export - Exports an event, id...

Call: (string) export((string) uid, (string) contentType)

Description :

Exports an event, identified by UID, in the requested content type.
A string with one of:

text/calendar (VCALENDAR 2.0. Recommended as
this is specified in rfc2445)
text/x-vtodo    Seems to be used by horde only.
Do we need this?
text/x-vcalendar (old VCALENDAR 1.0 format.
Still in wide use)
text/x-icalendar

Parameters:

Type	Name	Documentation
string	uid	Identify the event to export.
string	contentType	What format should the data be in?

exportCalendar - Exports a calendar i...

Call: (string) exportCalendar((string) calendar, (string) contentType)

Description :

Exports a calendar in the requested content type.
A string with one of:

text/calendar (VCALENDAR 2.0. Recommended as
this is specified in rfc2445)
text/x-vtodo    Seems to be used by horde only.
Do we need this?
text/x-vcalendar (old VCALENDAR 1.0 format.
Still in wide use)
text/x-icalendar

Parameters:

Type	Name	Documentation
string	calendar	The calendar to export.
string	contentType	What format should the data be in?

delete - Deletes an event ide...

Call: (boolean) delete((array) uid)

Description :

Deletes an event identified by UID.
to delete.

Parameters:

Type	Name	Documentation
array	uid	A single UID or an array identifying the event(s)

replace - Replaces the event i...

Call: (mixed) replace((string) uid, (mixed) content, (string) contentType)

Description :

Replaces the event identified by UID with the content represented in the
specified contentType.
Horde_iCalendar_vevent
text/calendar
text/x-icalendar
text/x-vcalendar
text/x-vevent
(Ignored if content is Horde_iCalendar_vevent)

Parameters:

Type	Name	Documentation
string	uid	Idenfity the event to replace.
mixed	content	t The content of the event. String or
string	contentType	What format is the data in? Currently supports:

eventFromUID - Retrieves a Kronolit...

Call: (Kronolith_Event) eventFromUID((string) uid)

Description :

Retrieves a Kronolith_Event object, given an event UID.
on failure.

Parameters:

Type	Name	Documentation
string	uid	The event's UID.

updateAttendee - Updates an attendee'...

Call: (mixed) updateAttendee((mixed) response)

Description :

Updates an attendee's response status for a specified event.
with a valid UID attribute that
points to an existing event.
This is typically the vEvent
portion of an iTip meeting-request
response, with the attendee's
response in an ATTENDEE parameter.

Parameters:

Type	Name	Documentation
mixed	response	A Horde_iCalender_vevent object,

subscribe - Subscribe to a calen...

Call: (mixed) subscribe((array) calendar)

Description :

Subscribe to a calendar.
parameter. Currently supports 'http' and 'webcal'
for remote calendars.

Parameters:

Type	Name	Documentation
array	calendar	Calendar description hash, with required 'type'

unsubscribe - Unsubscribe from a c...

Call: (mixed) unsubscribe((array) calendar)

Description :

Unsubscribe from a calendar.
parameter. Currently supports 'http' and 'webcal'
for remote calendars.

Parameters:

Type	Name	Documentation
array	calendar	Calendar description array, with required 'type'