Overview

Packages

  • awl
    • caldav-client-v2
    • RRule
  • davical
    • authentication
      • drivers
    • caldav
    • DAViCalSession
    • DAVTicket
    • external-bind
    • feed
    • HTTPAuthSession
    • iSchedule
    • iSchedule-POST
    • logging
    • metrics
    • Principal
    • propfind
    • PublicSession
    • Request
    • Resource
    • tzservice
  • None

Functions

  • add_failure
  • check_for_expansion
  • component_to_xml
  • controlRequestContainer
  • delete_collection
  • deliverItipCancel
  • display_status
  • do_scheduling_for_delete
  • do_scheduling_reply
  • do_scheduling_requests
  • doImipMessage
  • doItipAttendeeReply
  • doItipOrganizerCancel
  • export_iCalendar
  • GetItip
  • GetTZID
  • handle_cancel_request
  • handle_freebusy_request
  • handle_schedule_reply
  • handle_schedule_request
  • import_addressbook_collection
  • import_calendar_collection
  • import_collection
  • late_catch_fatal_error
  • logRequestHeaders
  • obfuscated_event
  • process_ace
  • processItipCancel
  • property_response
  • public_events_only
  • rollback
  • rollback_on_error
  • send_dav_header
  • simple_write_resource
  • write_alarms
  • write_attendees
  • write_resource
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Package davical\caldav

Functions summary
add_failure Small utility function to add propstat for one failure
check_for_expansion check if we need to do expansion of recurring events
component_to_xml Return XML for a single component from the DB
controlRequestContainer

Work out the location we are doing the PUT to, and check that we have the rights to do the needful.

delete_collection
deliverItipCancel Delivers the iTIP CANCEL message to an ATTENDEE's Scheduling Inbox Collection.
display_status
do_scheduling_for_delete

Entry point for scheduling on DELETE, for which there are thee outcomes: - We don't do scheduling (disabled, no organizer, ...) - We are an ATTENDEE declining the meeting. - We are the ORGANIZER canceling the meeting.

do_scheduling_reply Do the scheduling adjustments for a REPLY when an ATTENDEE updates their status.
do_scheduling_requests

Create/Update the scheduling requests for this resource. This includes updating the scheduled user's default calendar.

doImipMessage Send an iMIP message since they look like a non-local user.
doItipAttendeeReply
doItipOrganizerCancel Handles sending the iTIP CANCEL messages to each ATTENDEE by the ORGANIZER.
export_iCalendar
GetItip
GetTZID Get a TZID string from this VEVENT/VTODO/... component if we can
handle_cancel_request
handle_freebusy_request
handle_schedule_reply Deliver scheduling replies to organizer and other attendees
handle_schedule_request Deliver scheduling requests to attendees
import_addressbook_collection This function will import a whole addressbook
import_calendar_collection This function will import a whole calendar
import_collection This function will import a whole collection
late_catch_fatal_error
logRequestHeaders
obfuscated_event
process_ace
processItipCancel

Does the actual processing of the iTIP CANCEL message on behalf of an ATTENDEE, which generally means writing it into the ATTENDEE's default calendar.

property_response Wrap an individual property name as needed
public_events_only Check if this collection should force all events to be PUBLIC.
rollback
rollback_on_error This function launches an error
send_dav_header
simple_write_resource

A slightly simpler version of write_resource which will make more sense for calling from an external program. This makes assumptions that the collection and user do exist and bypasses all checks for whether it is reasonable to write this here.

write_alarms

Given a dav_id and an original vCalendar, pull out each of the VALARMs and write the values into the calendar_alarm table.

write_attendees

Parse out the attendee property and write a row to the calendar_attendee table for each one.

write_resource

Actually write the resource to the database. All checking of whether this is reasonable should be done before this is called.

DAViCal API documentation generated by ApiGen