---

The class "calendars" implements the interface to the database structures.

Defined in packages/xotcl-core/tcl/01-debug-procs.tcl

Class Relations

• class: ::nx::Object

Methods (to be applied on the object)

• alwaysQueriedCalendars (scripted, public)

   caldav::calendars alwaysQueriedCalendars \
      [ -with_sync_calendar on|off ] user_id

  Switches:

  -with_sync_calendar (optional, boolean, defaults to "true")

  Parameters:

  user_id (required, integer)

  Returns:

  the calendar_ids, which should be always returned

  Testcases:

  No testcase defined.

• alwaysQueriedClause (scripted, public)

   caldav::calendars alwaysQueriedClause user_id

  Parameters:

  user_id (required, integer)

  Returns:

  SQL clause which is always queried

  Testcases:

  No testcase defined.

• calendar_clause (scripted, public)

   caldav::calendars calendar_clause [ -calendar_ids calendar_ids ] \
      [ -user_id user_id ] [ -attr attr ]

  When calendar_ids are empty, user_id has to be specified

  Switches:

  -calendar_ids (optional, integer)

  -user_id (optional, integer)

  -attr (optional, defaults to "c.on_which_calendar")

  Testcases:

  No testcase defined.

• communityCalendarClause (scripted, public)

   caldav::calendars communityCalendarClause user_id

  Get calendars from communities, when DotLRN is active.

  Parameters:

  user_id (required, integer)

  Testcases:

  No testcase defined.

• footer (scripted, public)

   caldav::calendars footer

  Return the footer of the ical file.

  Testcases:

  No testcase defined.

• format_recurrence (scripted, public)

   caldav::calendars format_recurrence [ -recurrence_id recurrence_id ]

  Return the recurrence specification in form of a formatted ical RRULE. @param recurrence_id is the unique id of the recurrence item.

  Switches:

  -recurrence_id (optional, integer, accept empty)

  Testcases:

  No testcase defined.

• get_cal_item_from_uid (scripted, public)

   caldav::calendars get_cal_item_from_uid [ -calendar_ids calendar_ids ] \
      uid

  Switches:

  -calendar_ids (optional, integer)

  Parameters:

  uid (required)

  unique id of an calendar item

  Returns:

  for a uid the cal_item_id(s?)

  Testcases:

  No testcase defined.

• get_calendar_and_cal_item_from_uid (scripted, public)

   caldav::calendars get_calendar_and_cal_item_from_uid \
      [ -calendar_ids calendar_ids ] uid

  Switches:

  -calendar_ids (optional, integer)

  Parameters:

  uid (required)

  unique id of an calendar item

  Returns:

  for a uid the cal_item_id(s?)

  Testcases:

  No testcase defined.

• get_calitems (scripted, public)

   caldav::calendars get_calitems [ -user_id user_id ] \
      [ -start_date start_date ] [ -end_date end_date ] \
      [ -calendar_ids calendar_ids ]

  Get feed of calendar items for a given user.

  Switches:

  -user_id (optional, integer)

  -start_date (optional)

  -end_date (optional)

  -calendar_ids (optional, integer)

  Returns:

  list set of calendar item objects

  Testcases:

  No testcase defined.

• header (scripted, public)

   caldav::calendars header [ -calendar_name calendar_name ]

  Return the header of the ical file. GN TODO: don't hardcode TIMEZONE "X-WR-TIMEZONE:Europe/Vienna"

  Switches:

  -calendar_name (optional)

  Testcases:

  No testcase defined.

• parse (scripted, public)

   caldav::calendars parse text

  Parse the ical file passed in as string and output a list of CalItem objects. The attributes specified in opaque_tags are passed as opaque values. Opaque attributes are not shown in OpenACS, but output when the calendar item is requested in ical format.

  Parameters:

  text (required)

  the text do be parsed TODO: this should go into ical-procs..... but first check dependencies - $item add_ical_var .... - ::caldav::calitem new

  Testcases:

  No testcase defined.

• timezone (scripted, public)

   caldav::calendars timezone

  Return the timezone

  Testcases:

  No testcase defined.

---