summaryrefslogtreecommitdiff
path: root/apidocs/index.html
blob: fd0e711e690e45679d45445280c4a72f6b338966 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: Libical — an implementation of iCalendar protocols and data formats</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Libical API Documentation<span id="projectnumber">&#160;3.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Libical — an implementation of iCalendar protocols and data formats </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md__home_allen_projects_libical_libical_README"></a> <a href="https://ci.appveyor.com/api/projects/status/github/libical/libical"><img src="https://ci.appveyor.com/api/projects/status/github/libical/libical?branch=master?svg=true" alt="Appveyor status" class="inline"/></a> <a href="https://repology.org/metapackage/libical"><img src="https://repology.org/badge/tiny-repos/libical.svg" alt="Packaging status" style="pointer-events: none;" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md2"></a>
About</h1>
<p >Libical — an implementation of iCalendar protocols and data formats</p>
<p >Most of the code in here was written by Eric Busboom at the end of the last millennium with help from dozens of contributors. It is currently maintained by Allen Winter and the libical team at <a href="https://github.com/libical/libical">https://github.com/libical/libical</a>.</p>
<p >Libical is an Open Source implementation of the iCalendar protocols and protocol data units. The iCalendar specification describes how calendar clients can communicate with calendar servers so users can store their calendar data and arrange meetings with other users.</p>
<h1><a class="anchor" id="rfcs"></a>
RFCs</h1>
<p >Libical implements <a href="https://tools.ietf.org/html/rfc5545">RFC5545</a>, <a href="https://tools.ietf.org/html/rfc5546">RFC5546</a>, <a href="https://tools.ietf.org/html/rfc7529">RFC7529</a>; the CalDav scheduling extensions in <a href="https://tools.ietf.org/html/rfc6638">RFC6638</a>; iCalendar extensions in <a href="https://tools.ietf.org/html/rfc7986">RFC7986</a>, <a href="https://tools.ietf.org/html/rfc9073">RFC9073</a>, <a href="https://tools.ietf.org/html/rfc9074">RFC9074</a>; plus the iCalendar iMIP protocol in <a href="https://tools.ietf.org/html/rfc6047">RFC6047</a>.</p>
<h1><a class="anchor" id="autotoc_md3"></a>
License</h1>
<p >The code and datafiles in this distribution are licensed under the Mozilla Public License (MPL) v2.0. See <a href="https://www.mozilla.org/MPL">https://www.mozilla.org/MPL</a> for a copy of this license.</p>
<p >Alternately, you may use libical under the terms of the GNU Lesser General Public License (LGPL) v2.1. See <a href="https://www.gnu.org/licenses/lgpl-2.1.txt">https://www.gnu.org/licenses/lgpl-2.1.txt</a> for a copy of this license.</p>
<p >This dual license ensures that the library can be incorporated into both proprietary code and GPL'd programs, and will benefit from improvements made by programmers in both realms. We (the libical developers) will only accept changes to this library if they are similarly dual-licensed.</p>
<h1><a class="anchor" id="autotoc_md4"></a>
Building</h1>
<p >See the top-level <a href="Install.txt">Install.txt</a> file.</p>
<h1><a class="anchor" id="autotoc_md5"></a>
Documentation</h1>
<p >Documentation is hosted at <a href="https://libical.github.io/libical/apidocs/">https://libical.github.io/libical/apidocs/</a>.</p>
<p >For a conceptual overview of the library, see <a class="el" href="md__home_allen_projects_libical_libical_doc_UsingLibical.html">Using Libical</a>. There is other rudimentary, unfinished documentation in the <code>doc/</code> directory of the source distribution, annotated examples in <code>examples/</code> and the test code in <code>src/test/</code>.</p>
<h1><a class="anchor" id="autotoc_md6"></a>
Acknowledgments</h1>
<p >Portions of this distribution are (C) Copyright 1996 Apple Computer,Inc., AT&amp;T Corp., International Business Machines Corporation and Siemens Rolm Communications Inc. See <a href="src/libicalvcal/README.txt">src/libicalvcal/README.TXT</a> for details.</p>
<h1><a class="anchor" id="autotoc_md7"></a>
Libical Users</h1>
<p >In no particular order:</p>
<ul>
<li><a href="https://www.cyrusimap.org">Cyrus Email/Calendars/Contacts Server</a></li>
<li><a href="https://syncevolution.org">syncEvolution</a></li>
<li><a href="https://flexibits.com/fantastical">Fantastical</a></li>
<li>GNOME's EDS (evolution-data-server) which serves data to:<ul>
<li><a href="https://wiki.gnome.org/Apps/Evolution">Evolution</a></li>
<li><a href="https://wiki.gnome.org/Apps/Calendar">GNOME Calendar</a></li>
<li><a href="https://wiki.gnome.org/Apps/Notes">GNOME Notes</a></li>
<li><a href="https://wiki.gnome.org/Apps/Todo">GNOME Todo</a></li>
<li>and more GNOME apps...</li>
</ul>
</li>
<li>KDE's <a href="https://kontact.kde.org">Kontact Suite</a> including:<ul>
<li><a href="https://kontact.kde.org/components/akonadi.html">Akonadi framework</a></li>
<li><a href="https://kontact.kde.org/components/korganizer.html">KOrganizer calendar and scheduling component</a></li>
<li>and more KDE apps...</li>
</ul>
</li>
</ul>
<h1><a class="anchor" id="autotoc_md8"></a>
Get Involved</h1>
<p >Subscribe to our mailing lists:</p>
<p >For developer discussions <a href="https://lists.infradead.org/mailman/listinfo/libical-devel">https://lists.infradead.org/mailman/listinfo/libical-devel</a></p>
<p >For general discussions about libical and related projects <a href="https://lists.infradead.org/mailman/listinfo/libical-interest">https://lists.infradead.org/mailman/listinfo/libical-interest</a></p>
<p >Report bugs to our issue tracker at <a href="https://github.com/libical/libical/issues">https://github.com/libical/libical/issues</a> </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>