source-git / libgdata

Clone
Source Code
GIT

Blame docs/reference/html/GDataContactsService.html

c8 master
  1.   f44c28bddb28f45ab9e064328a87bd104cb56ad7
  2.   docs
  3.   reference
  4.   html
  5.   GDataContactsService.html
Blob History Raw
Packit 4b6dd7
Packit 4b6dd7 
<html>
Packit 4b6dd7 
<head>
Packit 4b6dd7 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7 
<title>GDataContactsService: 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="ch15.html" title="Google Contacts API">
Packit 4b6dd7 
<link rel="prev" href="ch15.html" title="Google Contacts API">
Packit 4b6dd7 
<link rel="next" href="GDataContactsQuery.html" title="GDataContactsQuery">
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 
                  Implemented Interfaces
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 
GDataContactsService
Packit 4b6dd7 
GDataContactsService — GData Contacts 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 
GDataContactsService *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_new ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataAuthorizationDomain *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_get_primary_authorization_domain ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_contacts ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_contacts_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataContactsContact *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_insert_contact ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_insert_contact_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_groups ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_groups_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataContactsGroup *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_insert_group ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_insert_group_async ()
Packit 4b6dd7
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 
GDataContactsService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
 
Packit 4b6dd7 
GDataContactsServiceClass
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Object Hierarchy
Packit 4b6dd7 
    GObject
Packit 4b6dd7 
    ╰── GDataService
Packit 4b6dd7 
        ╰── GDataContactsService
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Implemented Interfaces
Packit 4b6dd7
Packit 4b6dd7 
GDataContactsService implements
Packit 4b6dd7 
 GDataBatchable.
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Includes
Packit 4b6dd7 
#include <gdata/services/contacts/gdata-contacts-service.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Description
Packit 4b6dd7 
GDataContactsService is a subclass of GDataService for communicating with the GData API of Google Contacts. It supports querying
Packit 4b6dd7 
for, inserting, editing and deleting contacts from a Google address book.
Packit 4b6dd7 
For more details of Google Contacts' GData API, see the
Packit 4b6dd7 
online documentation.
Packit 4b6dd7
Packit 4b6dd7 
Example 20. Querying for Groups
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 
        
GDataContactsService *service;
Packit 4b6dd7 
GDataFeed *feed;
Packit 4b6dd7 
GList *i;
Packit 4b6dd7 
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7 
/* Create a service */
Packit 4b6dd7 
service = create_contacts_service ();
Packit 4b6dd7
Packit 4b6dd7 
/* Query for groups */
Packit 4b6dd7 
feed = gdata_contacts_service_query_groups (service, NULL, NULL, NULL, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7 
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7 
if (error != NULL) {
Packit 4b6dd7 
    g_error ("Error querying for groups: %s", error->message);
Packit 4b6dd7 
    g_error_free (error);
Packit 4b6dd7 
    return;
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
/* Iterate through the returned groups and do something with them */
Packit 4b6dd7 
for (i = gdata_feed_get_entries (feed); i != NULL; i = i->next) {
Packit 4b6dd7 
    const gchar *system_group_id, *group_name;
Packit 4b6dd7 
    gboolean is_system_group;
Packit 4b6dd7 
    GDataContactsGroup *group = GDATA_CONTACTS_GROUP (i->data);
Packit 4b6dd7
Packit 4b6dd7 
    /* Determine whether the group's a system group. If so, you should use the system group ID to provide your application's own
Packit 4b6dd7 
     * translations of the group name, as it's not translated. */
Packit 4b6dd7 
    system_group_id = gdata_contacts_group_get_system_group_id (group);
Packit 4b6dd7 
    is_system_group = (system_group_id != NULL) ? TRUE : FALSE;
Packit 4b6dd7 
    group_name = (is_system_group == TRUE) ? get_group_name_for_system_group_id (system_group_id)
Packit 4b6dd7 
                                           : gdata_entry_get_title (GDATA_ENTRY (group));
Packit 4b6dd7
Packit 4b6dd7 
    /* Do something with the group here, such as insert it into a UI. Note that system groups are not allowed to be deleted,
Packit 4b6dd7 
     * so you may want to make certain parts of your UI insensitive accordingly if the group is a system group. */
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
g_object_unref (feed);
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 

The Contacts service can be manipulated using batch operations, too. See the
Packit 4b6dd7 
online documentation on batch
Packit 4b6dd7 
operations for more information.
Packit 4b6dd7
Packit 4b6dd7 
Example 21. Performing a Batch Operation on Contacts
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 
46
Packit 4b6dd7 
47
Packit 4b6dd7 
48
Packit 4b6dd7 
49
Packit 4b6dd7 
50
Packit 4b6dd7 
51
Packit 4b6dd7 
52
Packit 4b6dd7 
53
Packit 4b6dd7 
54
Packit 4b6dd7 
55
Packit 4b6dd7 
56
Packit 4b6dd7 
57
Packit 4b6dd7 
58
Packit 4b6dd7 
59
Packit 4b6dd7 
60
Packit 4b6dd7 
        
GDataContactsService *service;
Packit 4b6dd7 
GDataBatchOperation *operation;
Packit 4b6dd7 
GDataFeed *feed;
Packit 4b6dd7 
GDataLink *batch_link;
Packit 4b6dd7 
GList *i;
Packit 4b6dd7 
GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7 
/* Create a service */
Packit 4b6dd7 
service = create_contacts_service ();
Packit 4b6dd7
Packit 4b6dd7 
/* Create the batch operation; this requires that we have done a query first so that we can get the batch link */
Packit 4b6dd7 
feed = do_some_query (service);
Packit 4b6dd7 
batch_link = gdata_feed_look_up_link (feed, GDATA_LINK_BATCH);
Packit 4b6dd7 
operation = gdata_batchable_create_operation (GDATA_BATCHABLE (service), gdata_link_get_uri (batch_link));
Packit 4b6dd7 
g_object_unref (feed);
Packit 4b6dd7
Packit 4b6dd7 
gdata_batch_operation_add_query (operation, contact_entry_id_to_query, GDATA_TYPE_CONTACTS_CONTACT,
Packit 4b6dd7 
                                 (GDataBatchOperationCallback) batch_query_cb, user_data);
Packit 4b6dd7 
gdata_batch_operation_add_insertion (operation, new_entry, (GDataBatchOperationCallback) batch_insertion_cb, user_data);
Packit 4b6dd7 
gdata_batch_operation_add_update (operation, old_entry, (GDataBatchOperationCallback) batch_update_cb, user_data);
Packit 4b6dd7 
gdata_batch_operation_add_deletion (operation, entry_to_delete, (GDataBatchOperationCallback) batch_deletion_cb, user_data);
Packit 4b6dd7
Packit 4b6dd7 
/* Run the batch operation and handle the results in the various callbacks */
Packit 4b6dd7 
gdata_test_batch_operation_run (operation, NULL, &error);
Packit 4b6dd7
Packit 4b6dd7 
g_object_unref (operation);
Packit 4b6dd7 
g_object_unref (service);
Packit 4b6dd7
Packit 4b6dd7 
if (error != NULL) {
Packit 4b6dd7 
    g_error ("Error running batch operation: %s", error->message);
Packit 4b6dd7 
    g_error_free (error);
Packit 4b6dd7 
    return;
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
static void
Packit 4b6dd7 
batch_query_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7 
{
Packit 4b6dd7 
    /* operation_type == GDATA_BATCH_OPERATION_QUERY */
Packit 4b6dd7 
    /* Reference and do something with the returned entry. */
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
static void
Packit 4b6dd7 
batch_insertion_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7 
{
Packit 4b6dd7 
    /* operation_type == GDATA_BATCH_OPERATION_INSERTION */
Packit 4b6dd7 
    /* Reference and do something with the returned entry. */
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
static void
Packit 4b6dd7 
batch_update_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7 
{
Packit 4b6dd7 
    /* operation_type == GDATA_BATCH_OPERATION_UPDATE */
Packit 4b6dd7 
    /* Reference and do something with the returned entry. */
Packit 4b6dd7 
}
Packit 4b6dd7
Packit 4b6dd7 
static void
Packit 4b6dd7 
batch_deletion_cb (guint operation_id, GDataBatchOperationType operation_type, GDataEntry *entry, GError *error, gpointer user_data)
Packit 4b6dd7 
{
Packit 4b6dd7 
    /* operation_type == GDATA_BATCH_OPERATION_DELETION, entry == NULL */
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 
gdata_contacts_service_new ()
Packit 4b6dd7 
GDataContactsService *
Packit 4b6dd7 
gdata_contacts_service_new (GDataAuthorizer *authorizer);
Packit 4b6dd7 
Creates a new GDataContactsService using the given GDataAuthorizer. If authorizer
Packit 4b6dd7 
 is NULL, all requests are made as an unauthenticated user.
Packit 4b6dd7
Packit 4b6dd7 
Parameters
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
authorizer
Packit 4b6dd7 
a GDataAuthorizer to authorize the service's requests, or NULL.
Packit 4b6dd7 
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Returns
Packit 4b6dd7 
 a new GDataContactsService, or NULL; unref with g_object_unref()
Packit 4b6dd7
Packit 4b6dd7 
Since: 0.9.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_get_primary_authorization_domain ()
Packit 4b6dd7 
GDataAuthorizationDomain *
Packit 4b6dd7 
gdata_contacts_service_get_primary_authorization_domain
Packit 4b6dd7 
                               (void);
Packit 4b6dd7 
The primary GDataAuthorizationDomain for interacting with Google Contacts. This will not normally need to be used, as it's used internally
Packit 4b6dd7 
by the GDataContactsService methods. However, if using the plain GDataService methods to implement custom queries or requests which libgdata
Packit 4b6dd7 
does not support natively, then this domain may be needed to authorize the requests.
Packit 4b6dd7 
The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.
Packit 4b6dd7
Packit 4b6dd7 
Returns
Packit 4b6dd7 
the service's authorization domain.
Packit 4b6dd7 
[transfer none]
Packit 4b6dd7
Packit 4b6dd7 
Since: 0.9.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_contacts ()
Packit 4b6dd7 
GDataFeed *
Packit 4b6dd7 
gdata_contacts_service_query_contacts (GDataContactsService *self,
Packit 4b6dd7 
                                       GDataQuery *query,
Packit 4b6dd7 
                                       GCancellable *cancellable,
Packit 4b6dd7 
                                       GDataQueryProgressCallback progress_callback,
Packit 4b6dd7 
                                       gpointer progress_user_data,
Packit 4b6dd7 
                                       GError **error);
Packit 4b6dd7 
Queries the service to return a list of contacts matching the given query
Packit 4b6dd7 
.
Packit 4b6dd7 
For more details, see gdata_service_query().
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 GDataContactsService
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 
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; unref with g_object_unref().
Packit 4b6dd7 
[transfer full]
Packit 4b6dd7
Packit 4b6dd7 
Since: 0.2.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_query_contacts_async ()
Packit 4b6dd7 
void
Packit 4b6dd7 
gdata_contacts_service_query_contacts_async
Packit 4b6dd7 
                               (GDataContactsService *self,
Packit 4b6dd7 
                                GDataQuery *query,
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 to return a list of contacts matching the given query
Packit 4b6dd7 
. self
Packit 4b6dd7 
 and
Packit 4b6dd7 
query
Packit 4b6dd7 
 are all reffed when this function is called, so can safely be unreffed after this function returns.
Packit 4b6dd7 
For more details, see gdata_contacts_service_query_contacts(), which is the synchronous version of this function,
Packit 4b6dd7 
and gdata_service_query_async(), which is the base asynchronous query function.
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 GDataContactsService
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 
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_contacts_service_insert_contact ()
Packit 4b6dd7 
GDataContactsContact *
Packit 4b6dd7 
gdata_contacts_service_insert_contact (GDataContactsService *self,
Packit 4b6dd7 
                                       GDataContactsContact *contact,
Packit 4b6dd7 
                                       GCancellable *cancellable,
Packit 4b6dd7 
                                       GError **error);
Packit 4b6dd7 
Inserts contact
Packit 4b6dd7 
 by uploading it to the online contacts service.
Packit 4b6dd7 
For more details, see gdata_service_insert_entry().
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 GDataContactsService
Packit 4b6dd7 
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
contact
Packit 4b6dd7 
the GDataContactsContact 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 GDataContactsContact, or NULL; unref with g_object_unref().
Packit 4b6dd7 
[transfer full]
Packit 4b6dd7
Packit 4b6dd7 
Since: 0.2.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
gdata_contacts_service_insert_contact_async ()
Packit 4b6dd7 
void
Packit 4b6dd7 
gdata_contacts_service_insert_contact_async
Packit 4b6dd7 
                               (GDataContactsService *self,
Packit 4b6dd7 
                                GDataContactsContact *contact,
Packit 4b6dd7 
                                GCancellable *cancellable,
Packit 4b6dd7 
                                GAsyncReadyCallback callback,
Packit 4b6dd7 
                                gpointer user_data);
Packit 4b6dd7 
Inserts contact
Packit 4b6dd7 
 by uploading it to the online contacts service. self
Packit 4b6dd7 
 and contact
Packit 4b6dd7 
 are both reffed when this function is called, so can safely be
Packit 4b6dd7 
unreffed after this function returns.
Packit 4b6dd7 
callback
Packit 4b6dd7 
 should call gdata_service_insert_entry_finish() to obtain a GDataContactsContact representing the inserted contact and to check for
Packit 4b6dd7 
possible errors.
Packit 4b6dd7 
For more details, see gdata_contacts_service_insert_contact(), which is the synchronous version of this function,
Packit 4b6dd7 
and gdata_service_insert_entry_async(), which is the base asynchronous insertion function.
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 GDataContactsService
Packit 4b6dd7 
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
contact
Packit 4b6dd7 
the GDataContactsContact 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
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_contacts_service_query_groups ()
Packit 4b6dd7 
GDataFeed *
Packit 4b6dd7 
gdata_contacts_service_query_groups (GDataContactsService *self,
Packit 4b6dd7 
                                     GDataQuery *query,
Packit 4b6dd7 
                                     GCancellable *cancellable,
Packit 4b6dd7 
                                     GDataQueryProgressCallback progress_callback,
Packit 4b6dd7 
                                     gpointer progress_user_data,
Packit 4b6dd7 
                                     GError **error);
Packit 4b6dd7 
Queries the service to return a list of groups matching the given query
Packit 4b6dd7 
.
Packit 4b6dd7 
For more details, see gdata_service_query().
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 GDataContactsService
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 
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; 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_contacts_service_query_groups_async ()
Packit 4b6dd7 
void
Packit 4b6dd7 
gdata_contacts_service_query_groups_async
Packit 4b6dd7 
                               (GDataContactsService *self,
Packit 4b6dd7 
                                GDataQuery *query,
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 to return a list of groups matching the given query
Packit 4b6dd7 
. self
Packit 4b6dd7 
 and query
Packit 4b6dd7 
 are all reffed when this function is called, so can
Packit 4b6dd7 
safely be unreffed after this function returns.
Packit 4b6dd7 
For more details, see gdata_contacts_service_query_groups(), which is the synchronous version of this function, and gdata_service_query_async(),
Packit 4b6dd7 
which is the base asynchronous query function.
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 GDataContactsService
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 
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_contacts_service_insert_group ()
Packit 4b6dd7 
GDataContactsGroup *
Packit 4b6dd7 
gdata_contacts_service_insert_group (GDataContactsService *self,
Packit 4b6dd7 
                                     GDataContactsGroup *group,
Packit 4b6dd7 
                                     GCancellable *cancellable,
Packit 4b6dd7 
                                     GError **error);
Packit 4b6dd7 
Inserts a new contact group described by group
Packit 4b6dd7 
. The user must be authenticated to use this function.
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 GDataContactsService
Packit 4b6dd7 
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
group
Packit 4b6dd7 
a GDataContactsGroup to create on the server
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 
the inserted GDataContactsGroup; 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_contacts_service_insert_group_async ()
Packit 4b6dd7 
void
Packit 4b6dd7 
gdata_contacts_service_insert_group_async
Packit 4b6dd7 
                               (GDataContactsService *self,
Packit 4b6dd7 
                                GDataContactsGroup *group,
Packit 4b6dd7 
                                GCancellable *cancellable,
Packit 4b6dd7 
                                GAsyncReadyCallback callback,
Packit 4b6dd7 
                                gpointer user_data);
Packit 4b6dd7 
Inserts a new contact group described by group
Packit 4b6dd7 
. The user must be authenticated to use this function. self
Packit 4b6dd7 
 and group
Packit 4b6dd7 
 are both reffed when this
Packit 4b6dd7 
function is called, so can safely be unreffed after this function returns.
Packit 4b6dd7 
callback
Packit 4b6dd7 
 should call gdata_service_insert_entry_finish() to obtain a GDataContactsGroup representing the inserted group and to check for possible
Packit 4b6dd7 
errors.
Packit 4b6dd7 
For more details, see gdata_contacts_service_insert_group(), which is the synchronous version of this function, and
Packit 4b6dd7 
gdata_service_insert_entry_async(), which is the base asynchronous insertion function.
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 GDataContactsService
Packit 4b6dd7 
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
group
Packit 4b6dd7 
the GDataContactsGroup 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
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 
Types and Values
Packit 4b6dd7
Packit 4b6dd7 
GDataContactsService
Packit 4b6dd7 
typedef struct _GDataContactsService GDataContactsService;
Packit 4b6dd7 
All the fields in the GDataContactsService structure are private and should never be accessed directly.
Packit 4b6dd7 
Since: 0.2.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
GDataContactsServiceClass
Packit 4b6dd7 
typedef struct {
Packit 4b6dd7 
} GDataContactsServiceClass;
Packit 4b6dd7
Packit 4b6dd7 
All the fields in the GDataContactsServiceClass structure are private and should never be accessed directly.
Packit 4b6dd7 
Since: 0.2.0
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7 
Generated by GTK-Doc V1.26.1
Packit 4b6dd7 
</body>
Packit 4b6dd7 
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation