KGAPI2::CalendarService
Typedefs | |
using | EventSerializeFlags = QFlags< EventSerializeFlag > |
Enumerations | |
enum | EventSerializeFlag { Default = 0, NoID = 1 << 0 } |
Detailed Description
Additional methods for implementing support for Google Calendar service.
You should never need to use these methods, unless implementing your own Job
Function Documentation
KGAPICALENDAR_EXPORT QString KGAPI2::CalendarService::APIVersion | ( | ) |
Supported API version.
Definition at line 271 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QByteArray KGAPI2::CalendarService::calendarToJSON | ( | const CalendarPtr & | calendar | ) |
Serializes calendar into JSON.
- Parameters
-
calendar
Definition at line 330 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::createCalendarUrl | ( | ) |
Returns URL for creating a new calendar.
Definition at line 98 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::createEventUrl | ( | const QString & | calendarID, |
SendUpdatesPolicy | updatesPolicy | ||
) |
Returns URL creating new events.
- Parameters
-
calendarID ID of calendar in which to create the event updatesPolicy Whether to send notification to participants
Definition at line 155 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QByteArray KGAPI2::CalendarService::eventToJSON | ( | const EventPtr & | event, |
EventSerializeFlags | flags = EventSerializeFlag::Default |
||
) |
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchCalendarsUrl | ( | ) |
Returns URL for fetching calendars list.
Definition at line 77 of file calendarservice.cpp.
Returns URL for fetching single calendar.
- Parameters
-
calendarID calendar ID
Definition at line 84 of file calendarservice.cpp.
Returns URL for fetching all events from a specific calendar.
- Parameters
-
calendarID ID of calendar from which to fetch events
Definition at line 112 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchEventUrl | ( | const QString & | calendarID, |
const QString & | eventID | ||
) |
Returns URL for fetching a single event from a specific calendar.
- Parameters
-
calendarID ID of calendar from which to fetch the event eventID ID of event to fetch
Definition at line 119 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::freeBusyQueryUrl | ( | ) |
Returns URL for freebusy queries.
Definition at line 182 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT CalendarPtr KGAPI2::CalendarService::JSONToCalendar | ( | const QByteArray & | jsonData | ) |
Parses calendar JSON data into Calendar object.
- Parameters
-
jsonData
Definition at line 276 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT EventPtr KGAPI2::CalendarService::JSONToEvent | ( | const QByteArray & | jsonData | ) |
Parses event JSON into Event object.
- Parameters
-
jsonData
Definition at line 377 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::moveEventUrl | ( | const QString & | sourceCalendar, |
const QString & | destCalendar, | ||
const QString & | eventID | ||
) |
Returns URL for moving event between calendars.
- Parameters
-
sourceCalendar ID of calendar from which to remove the event destCalendar ID of calendar to which to move the even eventID ID of event in the sourceCalendar
to move
Definition at line 172 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT ObjectsList KGAPI2::CalendarService::parseCalendarJSONFeed | ( | const QByteArray & | jsonFeed, |
FeedData & | feedData | ||
) |
Parses JSON feed into list of Calendars.
- Parameters
-
jsonFeed feedData The structure will be filled with additional information about the feed, including URL for next page (if any)
Definition at line 350 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT ObjectsList KGAPI2::CalendarService::parseEventJSONFeed | ( | const QByteArray & | jsonFeed, |
FeedData & | feedData | ||
) |
Parses JSON feed into list of Events.
- Parameters
-
jsonFeed feedData The structure will be filled with additional information about the feed, including URL for next page (if any)
Definition at line 775 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QNetworkRequest KGAPI2::CalendarService::prepareRequest | ( | const QUrl & | url | ) |
Preparse a QNetworkRequest for given URL.
- Parameters
-
url
Definition at line 67 of file calendarservice.cpp.
Returns URL for removing an existing calendar.
- Parameters
-
calendarID ID of calendar to remove
Definition at line 105 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::removeEventUrl | ( | const QString & | calendarID, |
const QString & | eventID | ||
) |
Returns URL for removing events.
- Parameters
-
calendarID ID of parent calendar eventID ID of event to remove.
Definition at line 165 of file calendarservice.cpp.
Returns URL for updating existing calendar.
- Parameters
-
calendarID ID of calendar to modify
Definition at line 91 of file calendarservice.cpp.
KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::updateEventUrl | ( | const QString & | calendarID, |
const QString & | eventID, | ||
SendUpdatesPolicy | updatesPolicy | ||
) |
Returns URL for updating a single event.
- Parameters
-
calendarID ID of calendar in which the event is eventID ID of event to update updatesPolicy Whether to send notification to participants
Definition at line 145 of file calendarservice.cpp.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Jan 20 2021 23:16:14 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.