File: Calendar.rst

package info (click to toggle)
nc-py-api 0.19.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,320 kB
  • sloc: python: 12,415; makefile: 238; xml: 100; javascript: 56; sh: 14
file content (22 lines) | stat: -rw-r--r-- 803 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.. py:currentmodule:: nc_py_api.calendar_api

Calendar API
============

.. note:: To make this API work you should install **nc_py_api** with **calendar** extra dependency.

.. code-block:: python

    principal = nc.cal.principal()
    calendars = principal.calendars()  # get list of calendars

``nc.cal`` is usual ``caldav.DAVClient`` object with the same API.

Documentation for ``caldav`` can be found here: `CalDAV <"https://caldav.readthedocs.io/en/latest">`_

.. class:: _CalendarAPI

    Class that encapsulates ``caldav.DAVClient``. Avalaible as **cal** in the Nextcloud class.

    .. note:: You should not call ``close`` or ``request`` methods of CalendarAPI, they will be removed somewhere
        in the future when ``caldav.DAVClient`` will be rewritten(API compatability will remains).