Blame docs/reference/html/GDataBatchOperation.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>GDataBatchOperation: 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="ch04.html" title="Batch Operation API">
Packit 4b6dd7
<link rel="prev" href="GDataBatchable.html" title="GDataBatchable">
Packit 4b6dd7
<link rel="next" href="ch05.html" title="Authentication/Authorization API">
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
                  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

GDataBatchOperation

Packit 4b6dd7

GDataBatchOperation — GData batch operation 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
(*GDataBatchOperationCallback) ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_add_query ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_add_insertion ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_add_update ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
guint
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_add_deletion ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_run ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_run_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_run_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataService *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_get_service ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_get_authorization_domain ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
const gchar *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_batch_operation_get_feed_uri ()
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
GDataAuthorizationDomain *
Packit 4b6dd7
authorization-domain
Packit 4b6dd7
Read / Write / Construct Only
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gchar *
Packit 4b6dd7
feed-uri
Packit 4b6dd7
Read / Write / Construct Only
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataService *
Packit 4b6dd7
service
Packit 4b6dd7
Read / Write / Construct Only
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
GDataBatchOperation
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataBatchOperationClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
enum
Packit 4b6dd7
GDataBatchOperationType
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GObject
Packit 4b6dd7
    ╰── GDataBatchOperation
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

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

Description

Packit 4b6dd7

GDataBatchOperation is a transient standalone class which represents and handles a single batch operation request to a service. To make a batch

Packit 4b6dd7
operation request: create a new GDataBatchOperation; add the required queries, insertions, updates and deletions to the operation using
Packit 4b6dd7
gdata_batch_operation_add_query(), gdata_batch_operation_add_insertion(), gdata_batch_operation_add_update() and
Packit 4b6dd7
gdata_batch_operation_add_deletion(), respectively; run the request with gdata_batch_operation_run() or gdata_batch_operation_run_async(); and
Packit 4b6dd7
handle the results in the callback functions which are invoked by the operation as the results are received and parsed.

Packit 4b6dd7

If authorization is required for any of the requests in the batch operation, the GDataService set in “service” must have

Packit 4b6dd7
a GDataAuthorizer set as its “authorizer” property, and that authorizer must be authorized for the GDataAuthorizationDomain set
Packit 4b6dd7
in “authorization-domain”. It's not possible for requests in a single batch operation to be authorized under multiple domains;
Packit 4b6dd7
in that case, the requests must be split up across several batch operations using different authorization domains.

Packit 4b6dd7

If all of the requests in the batch operation don't require authorization (i.e. they all operate on public data; see the documentation for the

Packit 4b6dd7
GDataService subclass in question's operations for details of which require authorization), “authorization-domain” can be set
Packit 4b6dd7
to NULL to save the overhead of sending authorization data to the online service.

Packit 4b6dd7
Packit 4b6dd7

Example 5. Running a Synchronous Operation

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
42
Packit 4b6dd7
43
Packit 4b6dd7
44
Packit 4b6dd7
45
Packit 4b6dd7
        
guint op_id, op_id2;
Packit 4b6dd7
GDataBatchOperation *operation;
Packit 4b6dd7
GDataContactsContact *contact;
Packit 4b6dd7
GDataService *service;
Packit 4b6dd7
GDataAuthorizationDomain *domain;
Packit 4b6dd7
Packit 4b6dd7
service = create_contacts_service ();
Packit 4b6dd7
domain = get_authorization_domain_from_service (service);
Packit 4b6dd7
contact = create_new_contact ();
Packit 4b6dd7
batch_link = gdata_feed_look_up_link (contacts_feed, GDATA_LINK_BATCH);
Packit 4b6dd7
Packit 4b6dd7
operation = gdata_batchable_create_operation (GDATA_BATCHABLE (service), domain, gdata_link_get_uri (batch_link));
Packit 4b6dd7
Packit 4b6dd7
/* Add to the operation to insert a new contact and query for another one */
Packit 4b6dd7
op_id = gdata_batch_operation_add_insertion (operation, GDATA_ENTRY (contact), insertion_cb, user_data);
Packit 4b6dd7
op_id2 = gdata_batch_operation_add_query (operation, gdata_entry_get_id (other_contact), GDATA_TYPE_CONTACTS_CONTACT, query_cb, user_data);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (contact);
Packit 4b6dd7
g_object_unref (domain);
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7
/* Run the operations in a blocking fashion. Ideally, check and free the error as appropriate after running the operation. */
Packit 4b6dd7
gdata_batch_operation_run (operation, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (operation);
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
insertion_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_id == op_id, operation_type == GDATA_BATCH_OPERATION_INSERTION */
Packit 4b6dd7
Packit 4b6dd7
    /* Process the new inserted entry, ideally after checking for errors. Note that the entry should be reffed if it needs to stay
Packit 4b6dd7
     * alive after execution of the callback finishes. */
Packit 4b6dd7
    process_inserted_entry (entry, user_data);
Packit 4b6dd7
}
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
query_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    /* operation_id == op_id2, operation_type == GDATA_BATCH_OPERATION_QUERY */
Packit 4b6dd7
Packit 4b6dd7
    /* Process the results of the query, ideally after checking for errors. Note that the entry should be reffed if it needs to
Packit 4b6dd7
     * stay alive after execution of the callback finishes. */
Packit 4b6dd7
    process_queried_entry (entry, user_data);
Packit 4b6dd7
}
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

GDataBatchOperationCallback ()

Packit 4b6dd7
void
Packit 4b6dd7
(*GDataBatchOperationCallback) (guint operation_id,
Packit 4b6dd7
                                GDataBatchOperationType operation_type,
Packit 4b6dd7
                                GDataEntry *entry,
Packit 4b6dd7
                                GError *error,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Callback function called once for each operation in a batch operation run. The operation is identified by operation_id

Packit 4b6dd7
 and operation_type
Packit 4b6dd7
 (where
Packit 4b6dd7
operation_id
Packit 4b6dd7
 is the ID returned by the relevant call to gdata_batch_operation_add_query(), gdata_batch_operation_add_insertion(),
Packit 4b6dd7
gdata_batch_operation_add_update() or gdata_batch_operation_add_deletion(), and operation_type
Packit 4b6dd7
 shows which one of the above was called).

Packit 4b6dd7

If the operation was successful, the resulting GDataEntry will be passed in as entry

Packit 4b6dd7
, and error
Packit 4b6dd7
 will be NULL. Otherwise, entry
Packit 4b6dd7
 will be NULL
Packit 4b6dd7
and a descriptive error will be in error
Packit 4b6dd7
. If operation_type
Packit 4b6dd7
 is GDATA_BATCH_OPERATION_DELETION, entry
Packit 4b6dd7
 will always be NULL, and error
Packit 4b6dd7
 will be
Packit 4b6dd7
NULL or non-NULL as appropriate.

Packit 4b6dd7

If the callback code needs to retain a copy of entry

Packit 4b6dd7
, it must be referenced (with g_object_ref()). Similarly, error
Packit 4b6dd7
 is owned by the calling code,
Packit 4b6dd7
and must not be freed.

Packit 4b6dd7

The callback is called in the main thread, and there is no guarantee on the order in which the callbacks for the operations in a run 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 the GAsyncReadyCallback which
Packit 4b6dd7
signals the completion of the run (if initiated with gdata_batch_operation_run_async()) is called; or gdata_batch_operation_run() returns (if
Packit 4b6dd7
initiated synchronously).

Packit 4b6dd7
Packit 4b6dd7

Parameters

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

operation_id

Packit 4b6dd7

the operation ID returned from gdata_batch_operation_add_*()

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

operation_type

Packit 4b6dd7

the type of operation which was requested

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

entry

Packit 4b6dd7

the result of the operation, or NULL

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

error

Packit 4b6dd7

a GError describing any error which occurred, or NULL

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

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_add_query ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_batch_operation_add_query (GDataBatchOperation *self,
Packit 4b6dd7
                                 const gchar *id,
Packit 4b6dd7
                                 GType entry_type,
Packit 4b6dd7
                                 GDataBatchOperationCallback callback,
Packit 4b6dd7
                                 gpointer user_data);
Packit 4b6dd7

Add a query to the GDataBatchOperation, to be executed when the operation is run. The query will return a GDataEntry (of subclass type

Packit 4b6dd7
entry_type
Packit 4b6dd7
) representing the given entry id
Packit 4b6dd7
. The ID is of the same format as that returned by gdata_entry_get_id().

Packit 4b6dd7

Note that a single batch operation should not operate on a given GDataEntry more than once, as there's no guarantee about the order in which the

Packit 4b6dd7
batch operation's operations will be performed.

Packit 4b6dd7

callback

Packit 4b6dd7
 will be called when the GDataBatchOperation is run with gdata_batch_operation_run() (in which case it will be called in the thread which
Packit 4b6dd7
ran the batch operation), or with gdata_batch_operation_run_async() (in which case it will be called in an idle handler in the main thread). The
Packit 4b6dd7
operation_id
Packit 4b6dd7
 passed to the callback will match the return value of gdata_batch_operation_add_query(), and the operation_type
Packit 4b6dd7
 will be
Packit 4b6dd7
GDATA_BATCH_OPERATION_QUERY. If the query was successful, the resulting entry will be passed to the callback function as entry
Packit 4b6dd7
, and error
Packit 4b6dd7
 will
Packit 4b6dd7
be NULL. If, however, the query was unsuccessful, entry
Packit 4b6dd7
 will be NULL and error
Packit 4b6dd7
 will contain a GError detailing what went wrong.

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 GDataBatchOperation

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

id

Packit 4b6dd7

the ID of the entry being queried for

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

entry_type

Packit 4b6dd7

the type of the entry which will be returned

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

callback

Packit 4b6dd7

a GDataBatchOperationCallback to call when the query is finished, or NULL.

Packit 4b6dd7
[scope async]
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
Packit 4b6dd7

Returns

Packit 4b6dd7

operation ID for the added query, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_add_insertion ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_batch_operation_add_insertion (GDataBatchOperation *self,
Packit 4b6dd7
                                     GDataEntry *entry,
Packit 4b6dd7
                                     GDataBatchOperationCallback callback,
Packit 4b6dd7
                                     gpointer user_data);
Packit 4b6dd7

Add an entry to the GDataBatchOperation, to be inserted on the server when the operation is run. The insertion will return the inserted version

Packit 4b6dd7
of entry
Packit 4b6dd7
. entry
Packit 4b6dd7
 is reffed by the function, so may be freed after it returns.

Packit 4b6dd7

callback

Packit 4b6dd7
 will be called as specified in the documentation for gdata_batch_operation_add_query(), with an operation_type
Packit 4b6dd7
 of
Packit 4b6dd7
GDATA_BATCH_OPERATION_INSERTION.

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 GDataBatchOperation

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

entry

Packit 4b6dd7

the GDataEntry to insert

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

callback

Packit 4b6dd7

a GDataBatchOperationCallback to call when the insertion is finished, or NULL.

Packit 4b6dd7
[scope async]
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
Packit 4b6dd7

Returns

Packit 4b6dd7

operation ID for the added insertion, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_add_update ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_batch_operation_add_update (GDataBatchOperation *self,
Packit 4b6dd7
                                  GDataEntry *entry,
Packit 4b6dd7
                                  GDataBatchOperationCallback callback,
Packit 4b6dd7
                                  gpointer user_data);
Packit 4b6dd7

Add an entry to the GDataBatchOperation, to be updated on the server when the operation is run. The update will return the updated version of

Packit 4b6dd7
entry
Packit 4b6dd7
. entry
Packit 4b6dd7
 is reffed by the function, so may be freed after it returns.

Packit 4b6dd7

Note that a single batch operation should not operate on a given GDataEntry more than once, as there's no guarantee about the order in which the

Packit 4b6dd7
batch operation's operations will be performed.

Packit 4b6dd7

callback

Packit 4b6dd7
 will be called as specified in the documentation for gdata_batch_operation_add_query(), with an operation_type
Packit 4b6dd7
 of
Packit 4b6dd7
GDATA_BATCH_OPERATION_UPDATE.

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 GDataBatchOperation

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

entry

Packit 4b6dd7

the GDataEntry to update

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

callback

Packit 4b6dd7

a GDataBatchOperationCallback to call when the update is finished, or NULL.

Packit 4b6dd7
[scope async]
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
Packit 4b6dd7

Returns

Packit 4b6dd7

operation ID for the added update, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_add_deletion ()

Packit 4b6dd7
guint
Packit 4b6dd7
gdata_batch_operation_add_deletion (GDataBatchOperation *self,
Packit 4b6dd7
                                    GDataEntry *entry,
Packit 4b6dd7
                                    GDataBatchOperationCallback callback,
Packit 4b6dd7
                                    gpointer user_data);
Packit 4b6dd7

Add an entry to the GDataBatchOperation, to be deleted on the server when the operation is run. entry

Packit 4b6dd7
 is reffed by the function, so may be freed
Packit 4b6dd7
after it returns.

Packit 4b6dd7

Note that a single batch operation should not operate on a given GDataEntry more than once, as there's no guarantee about the order in which the

Packit 4b6dd7
batch operation's operations will be performed.

Packit 4b6dd7

callback

Packit 4b6dd7
 will be called as specified in the documentation for gdata_batch_operation_add_query(), with an operation_type
Packit 4b6dd7
 of
Packit 4b6dd7
GDATA_BATCH_OPERATION_DELETION.

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 GDataBatchOperation

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

entry

Packit 4b6dd7

the GDataEntry to delete

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

callback

Packit 4b6dd7

a GDataBatchOperationCallback to call when the deletion is finished, or NULL.

Packit 4b6dd7
[scope async]
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
Packit 4b6dd7

Returns

Packit 4b6dd7

operation ID for the added deletion, or 0

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_run ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_batch_operation_run (GDataBatchOperation *self,
Packit 4b6dd7
                           GCancellable *cancellable,
Packit 4b6dd7
                           GError **error);
Packit 4b6dd7

Run the GDataBatchOperation synchronously. This will send all the operations in the batch operation to the server, and call their respective

Packit 4b6dd7
callbacks synchronously (i.e. before gdata_batch_operation_run() returns, and in the same thread that called gdata_batch_operation_run()) as the
Packit 4b6dd7
server returns results for each operation.

Packit 4b6dd7

The callbacks for all of the operations in the batch operation are always guaranteed to be called, even if the batch operation as a whole fails.

Packit 4b6dd7
Each callback will be called exactly once for each time gdata_batch_operation_run() is called.

Packit 4b6dd7

The return value of the function indicates whether the overall batch operation was successful, and doesn't indicate the status of any of the

Packit 4b6dd7
operations it comprises. gdata_batch_operation_run() could return TRUE even if all of its operations failed.

Packit 4b6dd7

cancellable

Packit 4b6dd7
 can be used to cancel the entire batch operation any time before or during the network activity. If cancellable
Packit 4b6dd7
 is cancelled
Packit 4b6dd7
after network activity has finished, gdata_batch_operation_run() will continue and finish as normal.

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 GDataBatchOperation

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

TRUE on success, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_run_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_batch_operation_run_async (GDataBatchOperation *self,
Packit 4b6dd7
                                 GCancellable *cancellable,
Packit 4b6dd7
                                 GAsyncReadyCallback callback,
Packit 4b6dd7
                                 gpointer user_data);
Packit 4b6dd7

Run the GDataBatchOperation asynchronously. This will send all the operations in the batch operation to the server, and call their respective

Packit 4b6dd7
callbacks asynchronously (i.e. in idle functions in the main thread, usually after gdata_batch_operation_run_async() has returned) as the
Packit 4b6dd7
server returns results for each operation. self
Packit 4b6dd7
 is reffed when this function is called, so can safely be unreffed after this function returns.

Packit 4b6dd7

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

Packit 4b6dd7

When the entire batch operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_batch_operation_run_finish() to get the results of
Packit 4b6dd7
the batch 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 GDataBatchOperation

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

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the batch operation 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.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_run_finish ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_batch_operation_run_finish (GDataBatchOperation *self,
Packit 4b6dd7
                                  GAsyncResult *async_result,
Packit 4b6dd7
                                  GError **error);
Packit 4b6dd7

Finishes an asynchronous batch operation run with gdata_batch_operation_run_async().

Packit 4b6dd7

Return values are as for gdata_batch_operation_run().

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 GDataBatchOperation

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.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_get_service ()

Packit 4b6dd7
GDataService *
Packit 4b6dd7
gdata_batch_operation_get_service (GDataBatchOperation *self);
Packit 4b6dd7

Gets the “service” property.

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 GDataBatchOperation

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

Returns

Packit 4b6dd7

the batch operation's attached service.

Packit 4b6dd7

[transfer none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_get_authorization_domain ()

Packit 4b6dd7
GDataAuthorizationDomain *
Packit 4b6dd7
gdata_batch_operation_get_authorization_domain
Packit 4b6dd7
                               (GDataBatchOperation *self);
Packit 4b6dd7

Gets the “authorization-domain” property.

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 GDataBatchOperation

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

Returns

Packit 4b6dd7

the GDataAuthorizationDomain used to authorize the batch operation, or NULL.

Packit 4b6dd7

[transfer none][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_batch_operation_get_feed_uri ()

Packit 4b6dd7
const gchar *
Packit 4b6dd7
gdata_batch_operation_get_feed_uri (GDataBatchOperation *self);
Packit 4b6dd7

Gets the “feed-uri” property.

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 GDataBatchOperation

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

Returns

Packit 4b6dd7

the batch operation's feed URI

Packit 4b6dd7
Packit 4b6dd7

Since: 0.7.0

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

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataBatchOperation

Packit 4b6dd7
typedef struct _GDataBatchOperation GDataBatchOperation;
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataBatchOperationClass

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
} GDataBatchOperationClass;
Packit 4b6dd7
Packit 4b6dd7

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

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

enum GDataBatchOperationType

Packit 4b6dd7

Indicates which type of batch operation caused the current GDataBatchOperationCallback to be called.

Packit 4b6dd7
Packit 4b6dd7

Members

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

GDATA_BATCH_OPERATION_QUERY

Packit 4b6dd7
Packit 4b6dd7

a query operation

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

GDATA_BATCH_OPERATION_INSERTION

Packit 4b6dd7
Packit 4b6dd7

an insertion operation

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

GDATA_BATCH_OPERATION_UPDATE

Packit 4b6dd7
Packit 4b6dd7

an update operation

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

GDATA_BATCH_OPERATION_DELETION

Packit 4b6dd7
Packit 4b6dd7

a deletion operation

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

Since: 0.7.0

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

Property Details

Packit 4b6dd7
Packit 4b6dd7

The “authorization-domain” property

Packit 4b6dd7
  “authorization-domain”     GDataAuthorizationDomain *
Packit 4b6dd7

The authorization domain for the batch operation, against which the “authorizer” for the “service” should be

Packit 4b6dd7
authorized. This may be NULL if authorization is not needed for any of the requests in the batch operation.

Packit 4b6dd7

All requests in the batch operation must be authorizable under this single authorization domain. If requests need different authorization

Packit 4b6dd7
domains, they must be performed in different batch operations.

Packit 4b6dd7

Flags: Read / Write / Construct Only

Packit 4b6dd7

Since: 0.9.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “feed-uri” property

Packit 4b6dd7
  “feed-uri”                 gchar *
Packit 4b6dd7

The feed URI that this batch operation will be sent to.

Packit 4b6dd7

Flags: Read / Write / Construct Only

Packit 4b6dd7

Default value: NULL

Packit 4b6dd7

Since: 0.7.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

The “service” property

Packit 4b6dd7
  “service”                  GDataService *
Packit 4b6dd7

The service this batch operation is attached to.

Packit 4b6dd7

Flags: Read / Write / Construct Only

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>