KGAPI2::CalendarService

KGAPI2::CalendarService Namespace Reference

Typedefs

using EventSerializeFlags = QFlags<EventSerializeFlag>
 

Enumerations

enum class  EventSerializeFlag { Default = 0 , NoID = 1 << 0 }
 

Functions

QString APIVersion ()
 
QByteArray calendarToJSON (const CalendarPtr &calendar)
 
QUrl createCalendarUrl ()
 
QUrl createEventUrl (const QString &calendarID, SendUpdatesPolicy updatesPolicy)
 
QByteArray eventToJSON (const EventPtr &event, EventSerializeFlags flags=EventSerializeFlag::Default)
 
Event::EventType eventTypeFromString (const QString &eventType)
 
QString eventTypeToString (Event::EventType eventType)
 
QUrl fetchCalendarsUrl ()
 
QUrl fetchCalendarUrl (const QString &calendarID)
 
QUrl fetchEventsUrl (const QString &calendarID)
 
QUrl fetchEventUrl (const QString &calendarID, const QString &eventID)
 
QUrl freeBusyQueryUrl ()
 
QUrl importEventUrl (const QString &calendarID, SendUpdatesPolicy updatesPolicy)
 
CalendarPtr JSONToCalendar (const QByteArray &jsonData)
 
EventPtr JSONToEvent (const QByteArray &jsonData)
 
QUrl moveEventUrl (const QString &sourceCalendar, const QString &destCalendar, const QString &eventID)
 
ObjectsList parseCalendarJSONFeed (const QByteArray &jsonFeed, FeedData &feedData)
 
ObjectsList parseEventJSONFeed (const QByteArray &jsonFeed, FeedData &feedData)
 
QNetworkRequest prepareRequest (const QUrl &url)
 
QUrl removeCalendarUrl (const QString &calendarID)
 
QUrl removeEventUrl (const QString &calendarID, const QString &eventID)
 
QUrl updateCalendarUrl (const QString &calendarID)
 
QUrl updateEventUrl (const QString &calendarID, const QString &eventID, SendUpdatesPolicy updatesPolicy)
 

Detailed Description

Additional methods for implementing support for Google Calendar service.

You should never need to use these methods, unless implementing your own Job

Typedef Documentation

◆ EventSerializeFlags

Definition at line 34 of file calendarservice.h.

Enumeration Type Documentation

◆ EventSerializeFlag

enum class KGAPI2::CalendarService::EventSerializeFlag
strong

Definition at line 30 of file calendarservice.h.

Function Documentation

◆ APIVersion()

KGAPICALENDAR_EXPORT QString KGAPI2::CalendarService::APIVersion ( )

Supported API version.

Definition at line 286 of file calendarservice.cpp.

◆ calendarToJSON()

KGAPICALENDAR_EXPORT QByteArray KGAPI2::CalendarService::calendarToJSON ( const CalendarPtr & calendar)

Serializes calendar into JSON.

Parameters
calendar

Definition at line 344 of file calendarservice.cpp.

◆ createCalendarUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::createCalendarUrl ( )

Returns URL for creating a new calendar.

Definition at line 98 of file calendarservice.cpp.

◆ createEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::createEventUrl ( const QString & calendarID,
SendUpdatesPolicy updatesPolicy )

Returns URL creating new events.

Parameters
calendarIDID of calendar in which to create the event
updatesPolicyWhether to send notification to participants

Definition at line 156 of file calendarservice.cpp.

◆ eventToJSON()

KGAPICALENDAR_EXPORT QByteArray KGAPI2::CalendarService::eventToJSON ( const EventPtr & event,
EventSerializeFlags flags = EventSerializeFlag::Default )

Serializes Event into JSON.

Parameters
event

Definition at line 639 of file calendarservice.cpp.

◆ eventTypeFromString()

KGAPICALENDAR_EXPORT Event::EventType KGAPI2::CalendarService::eventTypeFromString ( const QString & eventType)

Converts event type string to enum value.

Definition at line 848 of file calendarservice.cpp.

◆ eventTypeToString()

KGAPICALENDAR_EXPORT QString KGAPI2::CalendarService::eventTypeToString ( Event::EventType eventType)

Converts event type enum value to string.

Definition at line 831 of file calendarservice.cpp.

◆ fetchCalendarsUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchCalendarsUrl ( )

Returns URL for fetching calendars list.

Definition at line 77 of file calendarservice.cpp.

◆ fetchCalendarUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchCalendarUrl ( const QString & calendarID)

Returns URL for fetching single calendar.

Parameters
calendarIDcalendar ID

Definition at line 84 of file calendarservice.cpp.

◆ fetchEventsUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchEventsUrl ( const QString & calendarID)

Returns URL for fetching all events from a specific calendar.

Parameters
calendarIDID of calendar from which to fetch events

Definition at line 112 of file calendarservice.cpp.

◆ fetchEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::fetchEventUrl ( const QString & calendarID,
const QString & eventID )

Returns URL for fetching a single event from a specific calendar.

Parameters
calendarIDID of calendar from which to fetch the event
eventIDID of event to fetch

Definition at line 119 of file calendarservice.cpp.

◆ freeBusyQueryUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::freeBusyQueryUrl ( )

Returns URL for freebusy queries.

Definition at line 193 of file calendarservice.cpp.

◆ importEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::importEventUrl ( const QString & calendarID,
SendUpdatesPolicy updatesPolicy )

Returns URL importing private copies of existing events.

Parameters
calendarIDID of calendar in which to create the event
updatesPolicyWhether to send notification to participants

Definition at line 166 of file calendarservice.cpp.

◆ JSONToCalendar()

KGAPICALENDAR_EXPORT CalendarPtr KGAPI2::CalendarService::JSONToCalendar ( const QByteArray & jsonData)

Parses calendar JSON data into Calendar object.

Parameters
jsonData

Definition at line 291 of file calendarservice.cpp.

◆ JSONToEvent()

KGAPICALENDAR_EXPORT EventPtr KGAPI2::CalendarService::JSONToEvent ( const QByteArray & jsonData)

Parses event JSON into Event object.

Parameters
jsonData

Definition at line 390 of file calendarservice.cpp.

◆ moveEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::moveEventUrl ( const QString & sourceCalendar,
const QString & destCalendar,
const QString & eventID )

Returns URL for moving event between calendars.

Parameters
sourceCalendarID of calendar from which to remove the event
destCalendarID of calendar to which to move the even
eventIDID of event in the sourceCalendar to move

Definition at line 183 of file calendarservice.cpp.

◆ parseCalendarJSONFeed()

KGAPICALENDAR_EXPORT ObjectsList KGAPI2::CalendarService::parseCalendarJSONFeed ( const QByteArray & jsonFeed,
FeedData & feedData )

Parses JSON feed into list of Calendars.

Parameters
jsonFeed
feedDataThe structure will be filled with additional information about the feed, including URL for next page (if any)

Definition at line 363 of file calendarservice.cpp.

◆ parseEventJSONFeed()

KGAPICALENDAR_EXPORT ObjectsList KGAPI2::CalendarService::parseEventJSONFeed ( const QByteArray & jsonFeed,
FeedData & feedData )

Parses JSON feed into list of Events.

Parameters
jsonFeed
feedDataThe structure will be filled with additional information about the feed, including URL for next page (if any)

Definition at line 793 of file calendarservice.cpp.

◆ prepareRequest()

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.

◆ removeCalendarUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::removeCalendarUrl ( const QString & calendarID)

Returns URL for removing an existing calendar.

Parameters
calendarIDID of calendar to remove

Definition at line 105 of file calendarservice.cpp.

◆ removeEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::removeEventUrl ( const QString & calendarID,
const QString & eventID )

Returns URL for removing events.

Parameters
calendarIDID of parent calendar
eventIDID of event to remove.

Definition at line 176 of file calendarservice.cpp.

◆ updateCalendarUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::updateCalendarUrl ( const QString & calendarID)

Returns URL for updating existing calendar.

Parameters
calendarIDID of calendar to modify

Definition at line 91 of file calendarservice.cpp.

◆ updateEventUrl()

KGAPICALENDAR_EXPORT QUrl KGAPI2::CalendarService::updateEventUrl ( const QString & calendarID,
const QString & eventID,
SendUpdatesPolicy updatesPolicy )

Returns URL for updating a single event.

Parameters
calendarIDID of calendar in which the event is
eventIDID of event to update
updatesPolicyWhether to send notification to participants

Definition at line 146 of file calendarservice.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 7 2024 12:02:03 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.