GDataCalendarService

GDataCalendarService — GData Calendar service object

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/services/calendar/gdata-calendar-service.h>

                    GDataCalendarService;
                    GDataCalendarServiceClass;
GDataCalendarService * gdata_calendar_service_new       (const gchar *client_id);
GDataFeed *         gdata_calendar_service_query_all_calendars
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);
void                gdata_calendar_service_query_all_calendars_async
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
GDataFeed *         gdata_calendar_service_query_own_calendars
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);
void                gdata_calendar_service_query_own_calendars_async
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
GDataFeed *         gdata_calendar_service_query_events (GDataCalendarService *self,
                                                         GDataCalendarCalendar *calendar,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);
GDataCalendarEvent * gdata_calendar_service_insert_event
                                                        (GDataCalendarService *self,
                                                         GDataCalendarEvent *event,
                                                         GCancellable *cancellable,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GDataService
         +----GDataCalendarService

Description

GDataCalendarService is a subclass of GDataService for communicating with the GData API of Google Calendar. It supports querying for, inserting, editing and deleting events from calendars, as well as operations on the calendars themselves.

For more details of Google Calendar's GData API, see the online documentation.

Details

GDataCalendarService

typedef struct _GDataCalendarService GDataCalendarService;

All the fields in the GDataCalendarService structure are private and should never be accessed directly.


GDataCalendarServiceClass

typedef struct {
} GDataCalendarServiceClass;

All the fields in the GDataCalendarServiceClass structure are private and should never be accessed directly.


gdata_calendar_service_new ()

GDataCalendarService * gdata_calendar_service_new       (const gchar *client_id);

Creates a new GDataCalendarService. The client_id must be unique for your application, and as registered with Google.

client_id :

your application's client ID

Returns :

a new GDataCalendarService, or NULL

gdata_calendar_service_query_all_calendars ()

GDataFeed *         gdata_calendar_service_query_all_calendars
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);

Queries the service to return a list of all calendars from the authenticated account which match the given query. It will return all calendars the user has read access to, including primary, secondary and imported calendars.

For more details, see gdata_service_query().

self :

a GDataCalendarService

query :

a GDataQuery with the query parameters, or NULL

cancellable :

optional GCancellable object, or NULL

progress_callback :

a GDataQueryProgressCallback to call when an entry is loaded, or NULL

progress_user_data :

data to pass to the progress_callback function

error :

a GError, or NULL

Returns :

a GDataFeed of query results; unref with g_object_unref()

gdata_calendar_service_query_all_calendars_async ()

void                gdata_calendar_service_query_all_calendars_async
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Queries the service to return a list of all calendars from the authenticated account which match the given query. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see gdata_calendar_service_query_all_calendars(), which is the synchronous version of this function, and gdata_service_query_async(), which is the base asynchronous query function.

self :

a GDataCalendarService

query :

a GDataQuery with the query parameters, or NULL

cancellable :

optional GCancellable object, or NULL

progress_callback :

a GDataQueryProgressCallback to call when an entry is loaded, or NULL

progress_user_data :

data to pass to the progress_callback function

callback :

a GAsyncReadyCallback to call when authentication is finished

user_data :

data to pass to the callback function

gdata_calendar_service_query_own_calendars ()

GDataFeed *         gdata_calendar_service_query_own_calendars
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);

Queries the service to return a list of calendars from the authenticated account which match the given query, and the authenticated user owns. (i.e. They have full read/write access to the calendar, as well as the ability to set permissions on the calendar.)

For more details, see gdata_service_query().

self :

a GDataCalendarService

query :

a GDataQuery with the query parameters, or NULL

cancellable :

optional GCancellable object, or NULL

progress_callback :

a GDataQueryProgressCallback to call when an entry is loaded, or NULL

progress_user_data :

data to pass to the progress_callback function

error :

a GError, or NULL

Returns :

a GDataFeed of query results; unref with g_object_unref()

gdata_calendar_service_query_own_calendars_async ()

void                gdata_calendar_service_query_own_calendars_async
                                                        (GDataCalendarService *self,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Queries the service to return a list of calendars from the authenticated account which match the given query, and the authenticated user owns. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see gdata_calendar_service_query_own_calendars(), which is the synchronous version of this function, and gdata_service_query_async(), which is the base asynchronous query function.

self :

a GDataCalendarService

query :

a GDataQuery with the query parameters, or NULL

cancellable :

optional GCancellable object, or NULL

progress_callback :

a GDataQueryProgressCallback to call when an entry is loaded, or NULL

progress_user_data :

data to pass to the progress_callback function

callback :

a GAsyncReadyCallback to call when authentication is finished

user_data :

data to pass to the callback function

gdata_calendar_service_query_events ()

GDataFeed *         gdata_calendar_service_query_events (GDataCalendarService *self,
                                                         GDataCalendarCalendar *calendar,
                                                         GDataQuery *query,
                                                         GCancellable *cancellable,
                                                         GDataQueryProgressCallback progress_callback,
                                                         gpointer progress_user_data,
                                                         GError **error);

Queries the service to return a list of events in the given calendar, which match query.

For more details, see gdata_service_query().

self :

a GDataCalendarService

calendar :

a GDataCalendarCalendar

query :

a GDataQuery with the query parameters, or NULL

cancellable :

optional GCancellable object, or NULL

progress_callback :

a GDataQueryProgressCallback to call when an entry is loaded, or NULL

progress_user_data :

data to pass to the progress_callback function

error :

a GError, or NULL

Returns :

a GDataFeed of query results; unref with g_object_unref()

gdata_calendar_service_insert_event ()

GDataCalendarEvent * gdata_calendar_service_insert_event
                                                        (GDataCalendarService *self,
                                                         GDataCalendarEvent *event,
                                                         GCancellable *cancellable,
                                                         GError **error);

Inserts event by uploading it to the online calendar service.

For more details, see gdata_service_insert_entry().

self :

a GDataCalendarService

event :

the GDataCalendarEvent to insert

cancellable :

optional GCancellable object, or NULL

error :

a GError, or NULL

Returns :

an updated GDataCalendarEvent, or NULL

Since 0.2.0