/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */ /* * GData Client * Copyright (C) Philip Withnall 2008, 2009, 2010, 2014 * * GData Client is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * GData Client is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with GData Client. If not, see . */ #ifndef GDATA_SERVICE_H #define GDATA_SERVICE_H #include #include #include #include #include #include G_BEGIN_DECLS /** * GDataOperationType: * @GDATA_OPERATION_QUERY: a query * @GDATA_OPERATION_INSERTION: an insertion of a #GDataEntry * @GDATA_OPERATION_UPDATE: an update of a #GDataEntry * @GDATA_OPERATION_DELETION: a deletion of a #GDataEntry * @GDATA_OPERATION_DOWNLOAD: a download of a file * @GDATA_OPERATION_UPLOAD: an upload of a file * @GDATA_OPERATION_AUTHENTICATION: authentication with the service * @GDATA_OPERATION_BATCH: a batch operation with #GDataBatchOperation * * Representations of the different operations performed by the library. * * Since: 0.6.0 */ typedef enum { GDATA_OPERATION_QUERY = 1, GDATA_OPERATION_INSERTION, GDATA_OPERATION_UPDATE, GDATA_OPERATION_DELETION, GDATA_OPERATION_DOWNLOAD, GDATA_OPERATION_UPLOAD, GDATA_OPERATION_AUTHENTICATION, GDATA_OPERATION_BATCH } GDataOperationType; /** * GDataServiceError: * @GDATA_SERVICE_ERROR_UNAVAILABLE: The service is unavailable due to maintainence or other reasons (e.g. network errors at the server end) * @GDATA_SERVICE_ERROR_PROTOCOL_ERROR: The client or server unexpectedly strayed from the protocol (fatal error) * @GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED: An entry has already been inserted, and cannot be re-inserted * @GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED: The user attempted to do something which required authentication, and they weren't authenticated or * didn't have authorization for the operation * @GDATA_SERVICE_ERROR_NOT_FOUND: A requested resource (feed or entry) was not found on the server * @GDATA_SERVICE_ERROR_CONFLICT: There was a conflict when updating an entry on the server; the server-side copy was modified inbetween downloading * and uploading the modified entry * @GDATA_SERVICE_ERROR_FORBIDDEN: Generic error for a forbidden action (not due to having insufficient permissions) * @GDATA_SERVICE_ERROR_BAD_QUERY_PARAMETER: A given query parameter was invalid for the query type * @GDATA_SERVICE_ERROR_NETWORK_ERROR: The service is unavailable due to local network errors (e.g. no Internet connection) * @GDATA_SERVICE_ERROR_PROXY_ERROR: The service is unavailable due to proxy network errors (e.g. proxy unreachable) * @GDATA_SERVICE_ERROR_WITH_BATCH_OPERATION: Generic error when running a batch operation and the whole operation fails * @GDATA_SERVICE_ERROR_API_QUOTA_EXCEEDED: The API request quota for this * developer account has been exceeded for the current time period (e.g. day). * Try again later. (Since: 0.16.0.) * * Error codes for #GDataService operations. */ typedef enum { GDATA_SERVICE_ERROR_UNAVAILABLE = 1, GDATA_SERVICE_ERROR_PROTOCOL_ERROR, GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED, GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED, GDATA_SERVICE_ERROR_NOT_FOUND, GDATA_SERVICE_ERROR_CONFLICT, GDATA_SERVICE_ERROR_FORBIDDEN, GDATA_SERVICE_ERROR_BAD_QUERY_PARAMETER, GDATA_SERVICE_ERROR_NETWORK_ERROR, GDATA_SERVICE_ERROR_PROXY_ERROR, GDATA_SERVICE_ERROR_WITH_BATCH_OPERATION, GDATA_SERVICE_ERROR_API_QUOTA_EXCEEDED, } GDataServiceError; /** * GDataQueryProgressCallback: * @entry: a new #GDataEntry * @entry_key: the key of the entry (zero-based index of its position in the feed) * @entry_count: the total number of entries in the feed * @user_data: user data passed to the callback * * Callback function called for each #GDataEntry parsed in a #GDataFeed when loading the results of a query. * * It is called in the main thread, so there is no guarantee on the order in which the callbacks are executed, * or whether they will be called in a timely manner. It is, however, guaranteed that they will all be called before * the #GAsyncReadyCallback which signals the completion of the query is called. */ typedef void (*GDataQueryProgressCallback) (GDataEntry *entry, guint entry_key, guint entry_count, gpointer user_data); #define GDATA_TYPE_SERVICE (gdata_service_get_type ()) #define GDATA_SERVICE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_SERVICE, GDataService)) #define GDATA_SERVICE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_SERVICE, GDataServiceClass)) #define GDATA_IS_SERVICE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_SERVICE)) #define GDATA_IS_SERVICE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_SERVICE)) #define GDATA_SERVICE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_SERVICE, GDataServiceClass)) #define GDATA_SERVICE_ERROR gdata_service_error_quark () typedef struct _GDataServicePrivate GDataServicePrivate; /** * GDataService: * * All the fields in the #GDataService structure are private and should never be accessed directly. */ typedef struct { GObject parent; GDataServicePrivate *priv; } GDataService; /** * GDataServiceClass: * @parent: the parent class * @api_version: the version of the GData API used by the service (typically 2) * @feed_type: the #GType of the feed class (subclass of #GDataFeed) to use for query results from this service * @append_query_headers: a function to allow subclasses to append their own headers to queries before they are submitted to the online service, * using the given authorization domain; new in version 0.9.0 * @parse_error_response: a function to parse error responses to queries from the online service. It should set the error * from the status, reason phrase and response body it is passed. * @get_authorization_domains: a function to return a newly-allocated list of all the #GDataAuthorizationDomains the service makes use of; * while the list should be newly-allocated, the individual domains should not be; not implementing this function is equivalent to returning an * empty list; new in version 0.9.0 * @parse_feed: a function to parse feed responses to queries from the online * service; new in version 0.17.0 * * The class structure for the #GDataService type. * * Since: 0.9.0 */ typedef struct { GObjectClass parent; const gchar *api_version; GType feed_type; void (*append_query_headers) (GDataService *self, GDataAuthorizationDomain *domain, SoupMessage *message); void (*parse_error_response) (GDataService *self, GDataOperationType operation_type, guint status, const gchar *reason_phrase, const gchar *response_body, gint length, GError **error); GList *(*get_authorization_domains) (void); GDataFeed *(*parse_feed) (GDataService *self, GDataAuthorizationDomain *domain, GDataQuery *query, GType entry_type, SoupMessage *message, GCancellable *cancellable, GDataQueryProgressCallback progress_callback, gpointer progress_user_data, GError **error); /*< private >*/ /* Padding for future expansion */ void (*_g_reserved1) (void); void (*_g_reserved2) (void); void (*_g_reserved3) (void); void (*_g_reserved4) (void); void (*_g_reserved5) (void); void (*_g_reserved6) (void); void (*_g_reserved7) (void); } GDataServiceClass; G_DEFINE_AUTOPTR_CLEANUP_FUNC (GDataService, g_object_unref) GType gdata_service_get_type (void) G_GNUC_CONST; GQuark gdata_service_error_quark (void) G_GNUC_CONST; GList *gdata_service_get_authorization_domains (GType service_type) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; gboolean gdata_service_is_authorized (GDataService *self); GDataAuthorizer *gdata_service_get_authorizer (GDataService *self) G_GNUC_PURE; void gdata_service_set_authorizer (GDataService *self, GDataAuthorizer *authorizer); #include GDataFeed *gdata_service_query (GDataService *self, GDataAuthorizationDomain *domain, const gchar *feed_uri, GDataQuery *query, GType entry_type, GCancellable *cancellable, GDataQueryProgressCallback progress_callback, gpointer progress_user_data, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; void gdata_service_query_async (GDataService *self, GDataAuthorizationDomain *domain, const gchar *feed_uri, GDataQuery *query, GType entry_type, GCancellable *cancellable, GDataQueryProgressCallback progress_callback, gpointer progress_user_data, GDestroyNotify destroy_progress_user_data, GAsyncReadyCallback callback, gpointer user_data); GDataFeed *gdata_service_query_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; GDataEntry *gdata_service_query_single_entry (GDataService *self, GDataAuthorizationDomain *domain, const gchar *entry_id, GDataQuery *query, GType entry_type, GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; void gdata_service_query_single_entry_async (GDataService *self, GDataAuthorizationDomain *domain, const gchar *entry_id, GDataQuery *query, GType entry_type, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GDataEntry *gdata_service_query_single_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; GDataEntry *gdata_service_insert_entry (GDataService *self, GDataAuthorizationDomain *domain, const gchar *upload_uri, GDataEntry *entry, GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; void gdata_service_insert_entry_async (GDataService *self, GDataAuthorizationDomain *domain, const gchar *upload_uri, GDataEntry *entry, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GDataEntry *gdata_service_insert_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; GDataEntry *gdata_service_update_entry (GDataService *self, GDataAuthorizationDomain *domain, GDataEntry *entry, GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; void gdata_service_update_entry_async (GDataService *self, GDataAuthorizationDomain *domain, GDataEntry *entry, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); GDataEntry *gdata_service_update_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC; gboolean gdata_service_delete_entry (GDataService *self, GDataAuthorizationDomain *domain, GDataEntry *entry, GCancellable *cancellable, GError **error); void gdata_service_delete_entry_async (GDataService *self, GDataAuthorizationDomain *domain, GDataEntry *entry, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data); gboolean gdata_service_delete_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error); #ifndef LIBGDATA_DISABLE_DEPRECATED SoupURI *gdata_service_get_proxy_uri (GDataService *self) G_GNUC_PURE G_GNUC_DEPRECATED_FOR (gdata_service_get_proxy_resolver); void gdata_service_set_proxy_uri (GDataService *self, SoupURI *proxy_uri) G_GNUC_DEPRECATED_FOR (gdata_service_set_proxy_resolver); #endif /* !LIBGDATA_DISABLE_DEPRECATED */ GProxyResolver *gdata_service_get_proxy_resolver (GDataService *self) G_GNUC_PURE; void gdata_service_set_proxy_resolver (GDataService *self, GProxyResolver *proxy_resolver); guint gdata_service_get_timeout (GDataService *self) G_GNUC_PURE; void gdata_service_set_timeout (GDataService *self, guint timeout); const gchar *gdata_service_get_locale (GDataService *self) G_GNUC_PURE; void gdata_service_set_locale (GDataService *self, const gchar *locale); G_END_DECLS #endif /* !GDATA_SERVICE_H */