Blame docs/reference/html/GDataService.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataService: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch02.html" title="Core API">
Packit 4b6dd7
<link rel="prev" href="gdata-Version-Information.html" title="Version Information">
Packit 4b6dd7
<link rel="next" href="GDataQuery.html" title="GDataQuery">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Known Derived Interfaces  | 
Packit 4b6dd7
                  Properties
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataService

Packit 4b6dd7

GDataService — GData service object

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
(*GDataQueryProgressCallback) ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_is_authorized ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthorizer *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_authorizer ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_set_authorizer ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GList *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_authorization_domains ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query_single_entry ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query_single_entry_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_query_single_entry_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_insert_entry ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_insert_entry_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_insert_entry_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_update_entry ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_update_entry_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_update_entry_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_delete_entry ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_delete_entry_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_delete_entry_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
SoupURI *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_proxy_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_set_proxy_uri ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_proxy_resolver ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_set_proxy_resolver ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_timeout ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_set_timeout ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_get_locale ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_service_set_locale ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Properties

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthorizer *
Packit 4b6dd7
authorizer
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
locale
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
proxy-resolver
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
SoupURI *
Packit 4b6dd7
proxy-uri
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
timeout
Packit 4b6dd7
Read / Write
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataServiceClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
enum
Packit 4b6dd7
GDataServiceError
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
enum
Packit 4b6dd7
GDataParserError
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
enum
Packit 4b6dd7
GDataOperationType
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataService
Packit 4b6dd7
        ├── GDataCalendarService
Packit 4b6dd7
        ├── GDataContactsService
Packit 4b6dd7
        ├── GDataDocumentsService
Packit 4b6dd7
        ├── GDataFreebaseService
Packit 4b6dd7
        ├── GDataPicasaWebService
Packit 4b6dd7
        ├── GDataTasksService
Packit 4b6dd7
        ╰── GDataYouTubeService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Known Derived Interfaces

Packit 4b6dd7

Packit 4b6dd7
GDataService is required by
Packit 4b6dd7
 GDataBatchable.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/gdata-service.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataService represents a GData API service, typically a website using the GData API, such as YouTube or Google Calendar. One

Packit 4b6dd7
GDataService instance is required to issue queries to the service, handle insertions, updates and deletions, and generally
Packit 4b6dd7
communicate with the online service.

Packit 4b6dd7

If operations performed on a GDataService need authorization (such as uploading a video to YouTube or querying the user's personal calendar on

Packit 4b6dd7
Google Calendar), the service needs a GDataAuthorizer instance set as “authorizer”. Once the user is appropriately authenticated and
Packit 4b6dd7
authorized by the GDataAuthorizer implementation (see the documentation for GDataAuthorizer for details on how this is achieved for specific
Packit 4b6dd7
implementations), all operations will be automatically authorized.

Packit 4b6dd7

Note that it's not always necessary to supply a GDataAuthorizer instance to a GDataService. If the only operations to be performed on the

Packit 4b6dd7
GDataService don't need authorization (e.g. they only query public information), setting up a GDataAuthorizer is just extra overhead. See the
Packit 4b6dd7
documentation for the operations on individual GDataService subclasses to see which need authorization and which don't.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

GDataQueryProgressCallback ()

Packit 4b6dd7
void
Packit 4b6dd7
(*GDataQueryProgressCallback) (GDataEntry *entry,
Packit 4b6dd7
                               guint entry_key,
Packit 4b6dd7
                               guint entry_count,
Packit 4b6dd7
                               gpointer user_data);
Packit 4b6dd7

Callback function called for each GDataEntry parsed in a GDataFeed when loading the results of a query.

Packit 4b6dd7

It is called in the main thread, so there is no guarantee on the order in which the callbacks are executed,

Packit 4b6dd7
or whether they will be called in a timely manner. It is, however, guaranteed that they will all be called before
Packit 4b6dd7
the GAsyncReadyCallback which signals the completion of the query is called.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

a new GDataEntry

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_key

Packit 4b6dd7

the key of the entry (zero-based index of its position in the feed)

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_count

Packit 4b6dd7

the total number of entries in the feed

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

user data passed to the callback

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_is_authorized ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_service_is_authorized (GDataService *self);
Packit 4b6dd7

Determines whether the service is authorized for all the GDataAuthorizationDomains it belongs to (as returned by

Packit 4b6dd7
gdata_service_get_authorization_domains()). If the service's “authorizer” is NULL, FALSE is always returned.

Packit 4b6dd7

This is basically a convenience method for checking that the service's GDataAuthorizer is authorized for all the service's

Packit 4b6dd7
GDataAuthorizationDomains.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the service is authorized for all its domains, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_authorizer ()

Packit 4b6dd7
GDataAuthorizer *
Packit 4b6dd7
gdata_service_get_authorizer (GDataService *self);
Packit 4b6dd7

Gets the GDataAuthorizer object currently in use by the service. See the documentation for “authorizer” for more details.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the authorizer object for this service, or NULL.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_authorizer ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_set_authorizer (GDataService *self,
Packit 4b6dd7
                              GDataAuthorizer *authorizer);
Packit 4b6dd7

Sets “authorizer” to authorizer

Packit 4b6dd7
. This may be NULL if the service will only make requests in future which don't require authorization.
Packit 4b6dd7
See the documentation for “authorizer” for more information.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

authorizer

Packit 4b6dd7

a new authorizer object for the service, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_authorization_domains ()

Packit 4b6dd7
GList *
Packit 4b6dd7
gdata_service_get_authorization_domains
Packit 4b6dd7
                               (GType service_type);
Packit 4b6dd7

Retrieves the full list of GDataAuthorizationDomains which relate to the specified service_type

Packit 4b6dd7
. All the
Packit 4b6dd7
GDataAuthorizationDomains are unique and interned, so can be compared with other domains by simple pointer comparison.

Packit 4b6dd7

Note that in addition to this method, GDataService subclasses may expose some or all of their authorization domains individually by means of

Packit 4b6dd7
individual accessor functions.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service_type

Packit 4b6dd7

the GType of the GDataService subclass to retrieve the authorization domains for

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

an unordered list of GDataAuthorizationDomains; free with

Packit 4b6dd7
g_list_free(). 

Packit 4b6dd7

[transfer container][element-type GDataAuthorizationDomain]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query ()

Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
gdata_service_query (GDataService *self,
Packit 4b6dd7
                     GDataAuthorizationDomain *domain,
Packit 4b6dd7
                     const gchar *feed_uri,
Packit 4b6dd7
                     GDataQuery *query,
Packit 4b6dd7
                     GType entry_type,
Packit 4b6dd7
                     GCancellable *cancellable,
Packit 4b6dd7
                     GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                     gpointer progress_user_data,
Packit 4b6dd7
                     GError **error);
Packit 4b6dd7

Queries the service's feed_uri

Packit 4b6dd7
 feed to build a GDataFeed.

Packit 4b6dd7

If cancellable

Packit 4b6dd7
 is not NULL, then the operation can be cancelled by triggering the cancellable
Packit 4b6dd7
 object from another thread.
Packit 4b6dd7
If the operation was cancelled before or during network activity, the error G_IO_ERROR_CANCELLED will be returned. Cancellation has no effect
Packit 4b6dd7
after network activity has finished, however, and the query will return successfully (or return an error sent by the server) if it is first
Packit 4b6dd7
cancelled after network activity has finished. See the overview of cancellation for
Packit 4b6dd7
more details.

Packit 4b6dd7

A GDATA_SERVICE_ERROR_PROTOCOL_ERROR will be returned if the server indicates there is a problem with the query, but subclasses may override

Packit 4b6dd7
this and return their own errors. See their documentation for more details.

Packit 4b6dd7

For each entry in the response feed, progress_callback

Packit 4b6dd7
 will be called in the main thread. If there was an error parsing the XML response,
Packit 4b6dd7
a GDataParserError will be returned.

Packit 4b6dd7

If the query is successful and the feed supports pagination, query

Packit 4b6dd7
 will be updated with the pagination URIs, and the next or previous page
Packit 4b6dd7
can then be loaded by calling gdata_query_next_page() or gdata_query_previous_page() before running the query again.

Packit 4b6dd7

If the GDataQuery's ETag is set and it finds a match on the server, NULL will be returned, but error

Packit 4b6dd7
 will remain unset. Otherwise,
Packit 4b6dd7
query
Packit 4b6dd7
's ETag will be updated with the ETag from the returned feed, if available.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the query falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

feed_uri

Packit 4b6dd7

the feed URI to query, including the host name and protocol

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with the query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_type

Packit 4b6dd7

a GType for the GDataEntrys to build from the XML

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_callback

Packit 4b6dd7

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

Packit 4b6dd7
[allow-none][scope call][closure progress_user_data]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataFeed of query results, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_query_async (GDataService *self,
Packit 4b6dd7
                           GDataAuthorizationDomain *domain,
Packit 4b6dd7
                           const gchar *feed_uri,
Packit 4b6dd7
                           GDataQuery *query,
Packit 4b6dd7
                           GType entry_type,
Packit 4b6dd7
                           GCancellable *cancellable,
Packit 4b6dd7
                           GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                           gpointer progress_user_data,
Packit 4b6dd7
                           GDestroyNotify destroy_progress_user_data,
Packit 4b6dd7
                           GAsyncReadyCallback callback,
Packit 4b6dd7
                           gpointer user_data);
Packit 4b6dd7

Queries the service's feed_uri

Packit 4b6dd7
 feed to build a GDataFeed. self
Packit 4b6dd7
, feed_uri
Packit 4b6dd7
 and
Packit 4b6dd7
query
Packit 4b6dd7
 are all reffed/copied when this function is called, so can safely be freed after this function returns.

Packit 4b6dd7

For more details, see gdata_service_query(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_service_query_finish()
Packit 4b6dd7
to get the results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the query falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

feed_uri

Packit 4b6dd7

the feed URI to query, including the host name and protocol

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with the query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_type

Packit 4b6dd7

a GType for the GDataEntrys to build from the XML

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_callback

Packit 4b6dd7

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

Packit 4b6dd7
[allow-none][closure progress_user_data]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

destroy_progress_user_data

Packit 4b6dd7

the function to call when progress_callback

Packit 4b6dd7
will not be called any more, or NULL. This function will be
Packit 4b6dd7
called with progress_user_data
Packit 4b6dd7
as a parameter and can be used to free any memory allocated for it. 

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the query is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.1

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query_finish ()

Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
gdata_service_query_finish (GDataService *self,
Packit 4b6dd7
                            GAsyncResult *async_result,
Packit 4b6dd7
                            GError **error);
Packit 4b6dd7

Finishes an asynchronous query operation started with gdata_service_query_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataFeed of query results, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query_single_entry ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_query_single_entry (GDataService *self,
Packit 4b6dd7
                                  GDataAuthorizationDomain *domain,
Packit 4b6dd7
                                  const gchar *entry_id,
Packit 4b6dd7
                                  GDataQuery *query,
Packit 4b6dd7
                                  GType entry_type,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GError **error);
Packit 4b6dd7

Retrieves information about the single entry with the given entry_id

Packit 4b6dd7
. entry_id
Packit 4b6dd7
 should be as returned by
Packit 4b6dd7
gdata_entry_get_id().

Packit 4b6dd7

Parameters and errors are as for gdata_service_query(). Most of the properties of query

Packit 4b6dd7
 aren't relevant, and
Packit 4b6dd7
will cause a server-side error if used. The most useful property to use is “etag”, which will cause the
Packit 4b6dd7
server to not return anything if the entry hasn't been modified since it was given the specified ETag; thus saving
Packit 4b6dd7
bandwidth. If the server does not return anything for this reason, gdata_service_query_single_entry() will return
Packit 4b6dd7
NULL, but will not set an error in error
Packit 4b6dd7
.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the query falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_id

Packit 4b6dd7

the entry ID of the desired entry

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with the query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_type

Packit 4b6dd7

a GType for the GDataEntry to build from the XML

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

a GCancellable, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query_single_entry_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_query_single_entry_async
Packit 4b6dd7
                               (GDataService *self,
Packit 4b6dd7
                                GDataAuthorizationDomain *domain,
Packit 4b6dd7
                                const gchar *entry_id,
Packit 4b6dd7
                                GDataQuery *query,
Packit 4b6dd7
                                GType entry_type,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Retrieves information about the single entry with the given entry_id

Packit 4b6dd7
. entry_id
Packit 4b6dd7
 should be as returned by
Packit 4b6dd7
gdata_entry_get_id(). self
Packit 4b6dd7
, query
Packit 4b6dd7
 and entry_id
Packit 4b6dd7
 are reffed/copied when this
Packit 4b6dd7
function is called, so can safely be freed after this function returns.

Packit 4b6dd7

For more details, see gdata_service_query_single_entry(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_service_query_single_entry_finish()
Packit 4b6dd7
to get the results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the query falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_id

Packit 4b6dd7

the entry ID of the desired entry

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with the query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry_type

Packit 4b6dd7

a GType for the GDataEntry to build from the XML

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the query is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_query_single_entry_finish ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_query_single_entry_finish
Packit 4b6dd7
                               (GDataService *self,
Packit 4b6dd7
                                GAsyncResult *async_result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous query operation for a single entry, as started with gdata_service_query_single_entry_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_insert_entry ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_insert_entry (GDataService *self,
Packit 4b6dd7
                            GDataAuthorizationDomain *domain,
Packit 4b6dd7
                            const gchar *upload_uri,
Packit 4b6dd7
                            GDataEntry *entry,
Packit 4b6dd7
                            GCancellable *cancellable,
Packit 4b6dd7
                            GError **error);
Packit 4b6dd7

Inserts entry

Packit 4b6dd7
 by uploading it to the online service at upload_uri
Packit 4b6dd7
. For more information about the concept of inserting entries, see
Packit 4b6dd7
the online documentation for the GData
Packit 4b6dd7
protocol.

Packit 4b6dd7

The service will return an updated version of the entry, which is the return value of this function on success.

Packit 4b6dd7

If cancellable

Packit 4b6dd7
 is not NULL, then the operation can be cancelled by triggering the cancellable
Packit 4b6dd7
 object from another thread.
Packit 4b6dd7
If the operation was cancelled before or during network activity, the error G_IO_ERROR_CANCELLED will be returned. Cancellation has no effect
Packit 4b6dd7
after network activity has finished, however, and the insertion will return successfully (or return an error sent by the server) if it is first
Packit 4b6dd7
cancelled after network activity has finished. See the overview of cancellation for
Packit 4b6dd7
more details.

Packit 4b6dd7

If the entry is marked as already having been inserted a GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED error will be returned immediately

Packit 4b6dd7
(there will be no network requests).

Packit 4b6dd7

If there is an error inserting the entry, a GDATA_SERVICE_ERROR_PROTOCOL_ERROR error will be returned. Currently, subclasses

Packit 4b6dd7
cannot cannot override this or provide more specific errors.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the insertion operation falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

upload_uri

Packit 4b6dd7

the URI to which the upload should be sent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to insert

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

an updated GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_insert_entry_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_insert_entry_async (GDataService *self,
Packit 4b6dd7
                                  GDataAuthorizationDomain *domain,
Packit 4b6dd7
                                  const gchar *upload_uri,
Packit 4b6dd7
                                  GDataEntry *entry,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GAsyncReadyCallback callback,
Packit 4b6dd7
                                  gpointer user_data);
Packit 4b6dd7

Inserts entry

Packit 4b6dd7
 by uploading it to the online service at upload_uri
Packit 4b6dd7
. self
Packit 4b6dd7
, upload_uri
Packit 4b6dd7
 and
Packit 4b6dd7
entry
Packit 4b6dd7
 are all reffed/copied when this function is called, so can safely be freed after this function returns.

Packit 4b6dd7

For more details, see gdata_service_insert_entry(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_service_insert_entry_finish()
Packit 4b6dd7
to get the results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the insertion operation falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

upload_uri

Packit 4b6dd7

the URI to which the upload should be sent

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to insert

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when insertion is finished, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_insert_entry_finish ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_insert_entry_finish (GDataService *self,
Packit 4b6dd7
                                   GAsyncResult *async_result,
Packit 4b6dd7
                                   GError **error);
Packit 4b6dd7

Finishes an asynchronous entry insertion operation started with gdata_service_insert_entry_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

an updated GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.3.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_update_entry ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_update_entry (GDataService *self,
Packit 4b6dd7
                            GDataAuthorizationDomain *domain,
Packit 4b6dd7
                            GDataEntry *entry,
Packit 4b6dd7
                            GCancellable *cancellable,
Packit 4b6dd7
                            GError **error);
Packit 4b6dd7

Updates entry

Packit 4b6dd7
 by PUTting it to its edit link's URI. For more information about the concept of updating entries, see
Packit 4b6dd7
the online documentation for the GData
Packit 4b6dd7
protocol.

Packit 4b6dd7

The service will return an updated version of the entry, which is the return value of this function on success.

Packit 4b6dd7

If cancellable

Packit 4b6dd7
 is not NULL, then the operation can be cancelled by triggering the cancellable
Packit 4b6dd7
 object from another thread.
Packit 4b6dd7
If the operation was cancelled before or during network activity, the error G_IO_ERROR_CANCELLED will be returned. Cancellation has no effect
Packit 4b6dd7
after network activity has finished, however, and the update will return successfully (or return an error sent by the server) if it is first
Packit 4b6dd7
cancelled after network activity has finished. See the overview of cancellation for
Packit 4b6dd7
more details.

Packit 4b6dd7

If there is an error updating the entry, a GDATA_SERVICE_ERROR_PROTOCOL_ERROR error will be returned. Currently, subclasses

Packit 4b6dd7
cannot cannot override this or provide more specific errors.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the update operation falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to update

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

an updated GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_update_entry_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_update_entry_async (GDataService *self,
Packit 4b6dd7
                                  GDataAuthorizationDomain *domain,
Packit 4b6dd7
                                  GDataEntry *entry,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GAsyncReadyCallback callback,
Packit 4b6dd7
                                  gpointer user_data);
Packit 4b6dd7

Updates entry

Packit 4b6dd7
 by PUTting it to its edit link's URI. self
Packit 4b6dd7
 and
Packit 4b6dd7
entry
Packit 4b6dd7
 are both reffed when this function is called, so can safely be unreffed after this function returns.

Packit 4b6dd7

For more details, see gdata_service_update_entry(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_service_update_entry_finish()
Packit 4b6dd7
to get the results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the update operation falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to update

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the update is finished, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_update_entry_finish ()

Packit 4b6dd7
GDataEntry *
Packit 4b6dd7
gdata_service_update_entry_finish (GDataService *self,
Packit 4b6dd7
                                   GAsyncResult *async_result,
Packit 4b6dd7
                                   GError **error);
Packit 4b6dd7

Finishes an asynchronous entry update operation started with gdata_service_update_entry_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

an updated GDataEntry, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.3.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_delete_entry ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_service_delete_entry (GDataService *self,
Packit 4b6dd7
                            GDataAuthorizationDomain *domain,
Packit 4b6dd7
                            GDataEntry *entry,
Packit 4b6dd7
                            GCancellable *cancellable,
Packit 4b6dd7
                            GError **error);
Packit 4b6dd7

Deletes entry

Packit 4b6dd7
 from the server. For more information about the concept of deleting entries, see the

Packit 4b6dd7
online documentation for the GData
Packit 4b6dd7

protocol.

Packit 4b6dd7

If cancellable

Packit 4b6dd7
 is not NULL, then the operation can be cancelled by triggering the cancellable
Packit 4b6dd7
 object from another thread.
Packit 4b6dd7
If the operation was cancelled before or during network activity, the error G_IO_ERROR_CANCELLED will be returned. Cancellation has no effect
Packit 4b6dd7
after network activity has finished, however, and the deletion will return successfully (or return an error sent by the server) if it is first
Packit 4b6dd7
cancelled after network activity has finished. See the overview of cancellation for
Packit 4b6dd7
more details.

Packit 4b6dd7

If there is an error deleting the entry, a GDATA_SERVICE_ERROR_PROTOCOL_ERROR error will be returned. Currently, subclasses

Packit 4b6dd7
cannot cannot override this or provide more specific errors.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the deletion falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to delete

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE on success, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_delete_entry_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_delete_entry_async (GDataService *self,
Packit 4b6dd7
                                  GDataAuthorizationDomain *domain,
Packit 4b6dd7
                                  GDataEntry *entry,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GAsyncReadyCallback callback,
Packit 4b6dd7
                                  gpointer user_data);
Packit 4b6dd7

Deletes entry

Packit 4b6dd7
 from the server. self
Packit 4b6dd7
 and entry
Packit 4b6dd7
 are both reffed when this function is called,
Packit 4b6dd7
so can safely be unreffed after this function returns.

Packit 4b6dd7

For more details, see gdata_service_delete_entry(), which is the synchronous version of this function.

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_service_delete_entry_finish()
Packit 4b6dd7
to get the results of the operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

domain

Packit 4b6dd7

the GDataAuthorizationDomain the deletion falls under, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

entry

Packit 4b6dd7

the GDataEntry to delete

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when deletion is finished, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_delete_entry_finish ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_service_delete_entry_finish (GDataService *self,
Packit 4b6dd7
                                   GAsyncResult *async_result,
Packit 4b6dd7
                                   GError **error);
Packit 4b6dd7

Finishes an asynchronous entry deletion operation started with gdata_service_delete_entry_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

async_result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE on success, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.3.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_proxy_uri ()

Packit 4b6dd7
SoupURI *
Packit 4b6dd7
gdata_service_get_proxy_uri (GDataService *self);
Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_proxy_uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_service_get_proxy_resolver() instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Gets the proxy URI on the GDataService's SoupSession.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the proxy URI, or NULL.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.2.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_proxy_uri ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_set_proxy_uri (GDataService *self,
Packit 4b6dd7
                             SoupURI *proxy_uri);
Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_proxy_uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use gdata_service_set_proxy_resolver() instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Sets the proxy URI on the SoupSession used internally by the given GDataService.

Packit 4b6dd7
This forces all requests through the given proxy.

Packit 4b6dd7

If proxy_uri

Packit 4b6dd7
 is NULL, no proxy will be used.

Packit 4b6dd7

Note that if a GDataAuthorizer is being used with this GDataService, the authorizer might also need its proxy URI setting.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

proxy_uri

Packit 4b6dd7

the proxy URI, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.2.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_proxy_resolver ()

Packit 4b6dd7
GProxyResolver *
Packit 4b6dd7
gdata_service_get_proxy_resolver (GDataService *self);
Packit 4b6dd7

gdata_service_get_proxy_resolver is deprecated and should not be used in newly-written code.

Packit 4b6dd7

Gets the GProxyResolver on the GDataService's SoupSession.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GProxyResolver, or NULL.

Packit 4b6dd7

[transfer none][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_proxy_resolver ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_set_proxy_resolver (GDataService *self,
Packit 4b6dd7
                                  GProxyResolver *proxy_resolver);
Packit 4b6dd7

Sets the GProxyResolver on the SoupSession used internally by the given GDataService.

Packit 4b6dd7

Setting this will clear the “proxy-uri” property.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

proxy_resolver

Packit 4b6dd7

a GProxyResolver, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_timeout ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_service_get_timeout (GDataService *self);
Packit 4b6dd7

Gets the “timeout” property; the network timeout, in seconds.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the timeout, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_timeout ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_set_timeout (GDataService *self,
Packit 4b6dd7
                           guint timeout);
Packit 4b6dd7

Sets the “timeout” property; the network timeout, in seconds.

Packit 4b6dd7

If timeout

Packit 4b6dd7
 is 0, network operations will never time out.

Packit 4b6dd7

Note that if a GDataAuthorizer is being used with this GDataService, the authorizer might also need its timeout setting.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

timeout

Packit 4b6dd7

the timeout, or 0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_get_locale ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_service_get_locale (GDataService *self);
Packit 4b6dd7

Returns the locale currently being used for network requests, or NULL if the locale is the default.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the current locale

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_service_set_locale ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_service_set_locale (GDataService *self,
Packit 4b6dd7
                          const gchar *locale);
Packit 4b6dd7

Set the locale used for network requests to locale

Packit 4b6dd7
, given in standard Unix locale format. See “locale” for more details.

Packit 4b6dd7

Note that while it's possible to change the locale after sending network requests, it is unsupported, as the server-side software may behave

Packit 4b6dd7
unexpectedly. The only supported use of this function is after creation of a service, but before any network requests are made.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataService

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

locale

Packit 4b6dd7

the new locale in Unix locale format, or NULL for the default locale.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataService

Packit 4b6dd7
typedef struct _GDataService GDataService;
Packit 4b6dd7

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

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataServiceClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	GObjectClass parent;
Packit 4b6dd7
Packit 4b6dd7
	const gchar *api_version;
Packit 4b6dd7
	GType feed_type;
Packit 4b6dd7
Packit 4b6dd7
	void (*append_query_headers) (GDataService *self, GDataAuthorizationDomain *domain, SoupMessage *message);
Packit 4b6dd7
	void (*parse_error_response) (GDataService *self, GDataOperationType operation_type, guint status, const gchar *reason_phrase,
Packit 4b6dd7
	                              const gchar *response_body, gint length, GError **error);
Packit 4b6dd7
	GList *(*get_authorization_domains) (void);
Packit 4b6dd7
	GDataFeed *(*parse_feed) (GDataService *self,
Packit 4b6dd7
	                          GDataAuthorizationDomain *domain,
Packit 4b6dd7
	                          GDataQuery *query,
Packit 4b6dd7
	                          GType entry_type,
Packit 4b6dd7
	                          SoupMessage *message,
Packit 4b6dd7
	                          GCancellable *cancellable,
Packit 4b6dd7
	                          GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
	                          gpointer progress_user_data,
Packit 4b6dd7
	                          GError **error);
Packit 4b6dd7
} GDataServiceClass;
Packit 4b6dd7
Packit 4b6dd7

The class structure for the GDataService type.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GObjectClass parent;

Packit 4b6dd7

the parent class

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

const gchar *api_version;

Packit 4b6dd7

the version of the GData API used by the service (typically 2)

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GType feed_type;

Packit 4b6dd7

the GType of the feed class (subclass of GDataFeed) to use for query results from this service

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

append_query_headers ()

Packit 4b6dd7

a function to allow subclasses to append their own headers to queries before they are submitted to the online service,

Packit 4b6dd7
using the given authorization domain; new in version 0.9.0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parse_error_response ()

Packit 4b6dd7

a function to parse error responses to queries from the online service. It should set the error

Packit 4b6dd7
from the status, reason phrase and response body it is passed.

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_authorization_domains ()

Packit 4b6dd7

a function to return a newly-allocated list of all the GDataAuthorizationDomains the service makes use of;

Packit 4b6dd7
while the list should be newly-allocated, the individual domains should not be; not implementing this function is equivalent to returning an
Packit 4b6dd7
empty list; new in version 0.9.0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

parse_feed ()

Packit 4b6dd7

a function to parse feed responses to queries from the online

Packit 4b6dd7
service; new in version 0.17.0

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

enum GDataServiceError

Packit 4b6dd7

Error codes for GDataService operations.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_UNAVAILABLE

Packit 4b6dd7
Packit 4b6dd7

The service is unavailable due to maintainence or other reasons (e.g. network errors at the server end)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_PROTOCOL_ERROR

Packit 4b6dd7
Packit 4b6dd7

The client or server unexpectedly strayed from the protocol (fatal error)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED

Packit 4b6dd7
Packit 4b6dd7

An entry has already been inserted, and cannot be re-inserted

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED

Packit 4b6dd7
Packit 4b6dd7

The user attempted to do something which required authentication, and they weren't authenticated or

Packit 4b6dd7
didn't have authorization for the operation

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_NOT_FOUND

Packit 4b6dd7
Packit 4b6dd7

A requested resource (feed or entry) was not found on the server

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_CONFLICT

Packit 4b6dd7
Packit 4b6dd7

There was a conflict when updating an entry on the server; the server-side copy was modified inbetween downloading

Packit 4b6dd7
and uploading the modified entry

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_FORBIDDEN

Packit 4b6dd7
Packit 4b6dd7

Generic error for a forbidden action (not due to having insufficient permissions)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_BAD_QUERY_PARAMETER

Packit 4b6dd7
Packit 4b6dd7

A given query parameter was invalid for the query type

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_NETWORK_ERROR

Packit 4b6dd7
Packit 4b6dd7

The service is unavailable due to local network errors (e.g. no Internet connection)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_PROXY_ERROR

Packit 4b6dd7
Packit 4b6dd7

The service is unavailable due to proxy network errors (e.g. proxy unreachable)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_WITH_BATCH_OPERATION

Packit 4b6dd7
Packit 4b6dd7

Generic error when running a batch operation and the whole operation fails

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_SERVICE_ERROR_API_QUOTA_EXCEEDED

Packit 4b6dd7
Packit 4b6dd7

The API request quota for this

Packit 4b6dd7
developer account has been exceeded for the current time period (e.g. day).
Packit 4b6dd7
Try again later. (Since: 0.16.0.)

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

enum GDataParserError

Packit 4b6dd7

Error codes for XML or JSON parsing operations.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_PARSER_ERROR_PARSING_STRING

Packit 4b6dd7
Packit 4b6dd7

Error parsing the XML or JSON syntax itself

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_PARSER_ERROR_EMPTY_DOCUMENT

Packit 4b6dd7
Packit 4b6dd7

Empty document

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

enum GDataOperationType

Packit 4b6dd7

Representations of the different operations performed by the library.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_QUERY

Packit 4b6dd7
Packit 4b6dd7

a query

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_INSERTION

Packit 4b6dd7
Packit 4b6dd7

an insertion of a GDataEntry

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_UPDATE

Packit 4b6dd7
Packit 4b6dd7

an update of a GDataEntry

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_DELETION

Packit 4b6dd7
Packit 4b6dd7

a deletion of a GDataEntry

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_DOWNLOAD

Packit 4b6dd7
Packit 4b6dd7

a download of a file

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_UPLOAD

Packit 4b6dd7
Packit 4b6dd7

an upload of a file

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_AUTHENTICATION

Packit 4b6dd7
Packit 4b6dd7

authentication with the service

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDATA_OPERATION_BATCH

Packit 4b6dd7
Packit 4b6dd7

a batch operation with GDataBatchOperation

Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.6.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “authorizer” property

Packit 4b6dd7
  “authorizer”               GDataAuthorizer *
Packit 4b6dd7

An object which implements GDataAuthorizer. This should have previously been authenticated authorized against this service type (and

Packit 4b6dd7
potentially other service types). The service will use the authorizer to add an authorization token to each request it performs.

Packit 4b6dd7

Your application should call methods on the GDataAuthorizer object itself in order to authenticate with the Google accounts service and

Packit 4b6dd7
authorize against this service type. See the documentation for the particular GDataAuthorizer implementation being used for more details.

Packit 4b6dd7

The authorizer for a service can be changed at runtime for a different GDataAuthorizer object or NULL without affecting ongoing requests

Packit 4b6dd7
and operations.

Packit 4b6dd7

Note that it's only necessary to set an authorizer on the service if your application is going to make requests of the service which

Packit 4b6dd7
require authorization. For example, listing the current most popular videos on YouTube does not require authorization, but uploading a
Packit 4b6dd7
video to YouTube does. It's an unnecessary overhead to require the user to authorize against a service when not strictly required.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “locale” property

Packit 4b6dd7
  “locale”                   gchar *
Packit 4b6dd7

The locale to use for network requests, in Unix locale format. (e.g. "en_GB", "cs", "de_DE".) Use NULL for the default "C" locale

Packit 4b6dd7
(typically "en_US").

Packit 4b6dd7

Typically, this locale will be used by the server-side software to localise results, such as by translating category names, or by choosing

Packit 4b6dd7
geographically relevant search results. This will vary from service to service.

Packit 4b6dd7

The server-side behaviour is undefined if it doesn't support a given locale.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “proxy-resolver” property

Packit 4b6dd7
  “proxy-resolver”           GProxyResolver *
Packit 4b6dd7

The GProxyResolver used to determine a proxy URI. Setting this will clear the “proxy-uri” property.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.15.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “proxy-uri” property

Packit 4b6dd7
  “proxy-uri”                SoupURI *
Packit 4b6dd7

The proxy URI used internally for all network requests.

Packit 4b6dd7

Note that if a GDataAuthorizer is being used with this GDataService, the authorizer might also need its proxy URI setting.

Packit 4b6dd7
Packit 4b6dd7

GDataService:proxy-uri has been deprecated since version 0.15.0 and should not be used in newly-written code.

Packit 4b6dd7

Use “proxy-resolver” instead, which gives more flexibility over the proxy used.

Packit 4b6dd7
Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Since: 0.2.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “timeout” property

Packit 4b6dd7
  “timeout”                  guint
Packit 4b6dd7

A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be cancelled and

Packit 4b6dd7
GDATA_SERVICE_ERROR_NETWORK_ERROR will be returned.

Packit 4b6dd7

If the timeout is 0, operations will never time out.

Packit 4b6dd7

Note that if a GDataAuthorizer is being used with this GDataService, the authorizer might also need its timeout setting.

Packit 4b6dd7

Flags: Read / Write

Packit 4b6dd7

Default value: 0

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>