OpenAB  1.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CalDAV Storage Plugin

Provides OpenAB::PIMCalendarItem items using CalDAV protocol (tested with Google Contacts, iCloud). More...

Collaboration diagram for CalDAV Storage Plugin:

Provides OpenAB::PIMCalendarItem items using CalDAV protocol (tested with Google Contacts, iCloud).

Plugin Name: "CardDAV"

Parameters:

Type Name Description Mandatory
String "server_url" CalDAV server address No, if calendar_url is provided
String "calendar_url" CalDAV calendar address No, if server_url is provided
String "calendar_name" CalDAV calendar name No
Integer "item_type" Type of items - OpenAB::eEvent or OpenAB::eTask (set to integer equal to OpenAB::PIMItemType enum values) Yes
String "login" User login Yes
String "password" User password Yes
String "client_id" Id of client application (registered in Google) Yes
String "client_secret" Secret of client application (registered in Google) Yes
String "refresh_token" OAuth2 user refresh token Yes

CalDAV can support multiple calendars for single account, when only "server_url" is provided, first found calendar will be used. Alternatively "calendar_name" can be provided to select first matching calendar of given name (some services e.g. Google allows to create multiple calendars with the same name). Last option is to provide direct address of calendar to use using "calendar_url" (in that case "serverl_url" parameter is not mandatory).

Note
"login" and "password" pair or triple "client_id", "client_secret" and "refresh_token" are mandatory to provide, depending on authorization method used by CardDAV server. When using OAuth2 refresh token it has to have required scope (for Google calendar this is https://www.googleapis.com/auth/calendar).