calendar/api/legacy/calendar.php

125 lines
2.7 KiB
PHP

<?php
class OC_Calendar_Calendar{
/**
* @brief Returns the list of calendars for a specific user.
* @param string $uid User ID
* @param boolean $active Only return calendars with this $active state, default(=false) is don't care
* @return array
*/
public static function allCalendars($uid, $active=false) {
}
/**
* @brief Gets the data of one calendar
* @param integer $id
* @return associative array
*/
public static function find($id) {
}
/**
* @brief Creates a new calendar
* @param string $userid
* @param string $name
* @param string $components Default: "VEVENT,VTODO,VJOURNAL"
* @param string $timezone Default: null
* @param integer $order Default: 1
* @param string $color Default: null, format: '#RRGGBB(AA)'
* @return insertid
*/
public static function addCalendar($userid,$name,$components='VEVENT,VTODO,VJOURNAL',$timezone=null,$order=0,$color=null) {
}
/**
* @brief Creates default calendars
* @param string $userid
* @return boolean
*/
public static function addDefaultCalendars($userid = null) {
}
/**
* @brief Edits a calendar
* @param integer $id
* @param string $name Default: null
* @param string $components Default: null
* @param string $timezone Default: null
* @param integer $order Default: null
* @param string $color Default: null, format: '#RRGGBB(AA)'
* @return boolean
*
* Values not null will be set
*/
public static function editCalendar($id,$name=null,$components=null,$timezone=null,$order=null,$color=null) {
}
/**
* @brief Sets a calendar (in)active
* @param integer $id
* @param boolean $active
* @return boolean
*/
public static function setCalendarActive($id,$active) {
}
/**
* @brief Updates ctag for calendar
* @param integer $id
* @return boolean
*/
public static function touchCalendar($id) {
}
/**
* @brief removes a calendar
* @param integer $id
* @return boolean
*/
public static function deleteCalendar($id) {
}
/**
* @brief Creates a URI for Calendar
* @param string $name name of the calendar
* @param array $existing existing calendar URIs
* @return string uri
*/
public static function createURI($name,$existing) {
}
/**
* @brief gets the userid from a principal path
* @return string
*/
public static function extractUserID($principaluri) {
}
/**
* @brief generates the Event Source Info for our JS
* @param array $calendar calendar data
* @return array
*/
public static function getEventSourceInfo($calendar) {
}
/*
* @brief checks if a calendar name is available for a user
* @param string $calendarname
* @param string $userid
* @return boolean
*/
public static function isCalendarNameavailable($calendarname, $userid) {
}
}