GData.ContactsService¶

Subclasses:: None

Methods¶

Inherited:: GData.Service (27), GObject.Object (37), GData.Batchable (1)
Structs:: GObject.ObjectClass (5)

class	`get_primary_authorization_domain` ()
class	`new` (authorizer)
	`insert_contact` (contact, cancellable)
	`insert_contact_async` (contact, cancellable, callback, *user_data)
	`insert_group` (group, cancellable)
	`insert_group_async` (group, cancellable, callback, *user_data)
	`query_contacts` (query, cancellable, progress_callback, *progress_user_data)
	`query_contacts_async` (query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	`query_groups` (query, cancellable, progress_callback, *progress_user_data)
	`query_groups_async` (query, cancellable, progress_callback, progress_user_data, callback, *user_data)

Virtual Methods¶

Inherited:: GData.Service (2), GObject.Object (7)

Properties¶

Inherited:: GData.Service (5)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Service`	r

Class Details¶

class GData.ContactsService(**kwargs)¶

Bases:: GData.Service, GData.Batchable
Abstract:: No
Structure:: GData.ContactsServiceClass

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

New in version 0.2.0.

classmethod get_primary_authorization_domain()¶

Returns:: the service’s authorization domain
Return type:: GData.AuthorizationDomain

The primary GData.AuthorizationDomain for interacting with Google Contacts. This will not normally need to be used, as it’s used internally by the GData.ContactsService methods. However, if using the plain GData.Service methods to implement custom queries or requests which libgdata does not support natively, then this domain may be needed to authorize the requests.

The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.

New in version 0.9.0.

classmethod new(authorizer)¶

Parameters:: authorizer (GData.Authorizer or None) – a GData.Authorizer to authorize the service’s requests, or None
Returns:: a new GData.ContactsService, or None; unref with GObject.Object.unref()
Return type:: GData.ContactsService

Creates a new GData.ContactsService using the given GData.Authorizer. If authorizer is None, all requests are made as an unauthenticated user.

New in version 0.9.0.

insert_contact(contact, cancellable)¶

Parameters:

contact (GData.ContactsContact) – the GData.ContactsContact to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

an updated GData.ContactsContact, or None; unref with GObject.Object.unref()

Return type:

GData.ContactsContact

Inserts contact by uploading it to the online contacts service.

For more details, see GData.Service.insert_entry().

New in version 0.2.0.

insert_contact_async(contact, cancellable, callback, *user_data)¶

Parameters:

contact (GData.ContactsContact) – the GData.ContactsContact to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when insertion is finished
user_data (object or None) – data to pass to the callback function

Inserts contact by uploading it to the online contacts service. self and contact are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.insert_entry_finish() to obtain a GData.ContactsContact representing the inserted contact and to check for possible errors.

For more details, see GData.ContactsService.insert_contact(), which is the synchronous version of this function, and GData.Service.insert_entry_async(), which is the base asynchronous insertion function.

New in version 0.7.0.

insert_group(group, cancellable)¶

Parameters:

group (GData.ContactsGroup) – a GData.ContactsGroup to create on the server
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

the inserted GData.ContactsGroup; unref with GObject.Object.unref()

Return type:

GData.ContactsGroup

Inserts a new contact group described by group. The user must be authenticated to use this function.

New in version 0.7.0.

insert_group_async(group, cancellable, callback, *user_data)¶

Parameters:

group (GData.ContactsGroup) – the GData.ContactsGroup to insert
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when insertion is finished
user_data (object or None) – data to pass to the callback function

Inserts a new contact group described by group. The user must be authenticated to use this function. self and group are both reffed when this function is called, so can safely be unreffed after this function returns.

callback should call GData.Service.insert_entry_finish() to obtain a GData.ContactsGroup representing the inserted group and to check for possible errors.

For more details, see GData.ContactsService.insert_group(), which is the synchronous version of this function, and GData.Service.insert_entry_async(), which is the base asynchronous insertion function.

New in version 0.7.0.

query_contacts(query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of query results; unref with GObject.Object.unref()

Return type:

GData.Feed

Queries the service to return a list of contacts matching the given query.

For more details, see GData.Service.query().

New in version 0.2.0.

query_contacts_async(query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the query is finished
user_data (object or None) – data to pass to the callback function

Queries the service to return a list of contacts matching the given query. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see GData.ContactsService.query_contacts(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.9.1.

query_groups(query, cancellable, progress_callback, *progress_user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of query results; unref with GObject.Object.unref()

Return type:

GData.Feed

Queries the service to return a list of groups matching the given query.

For more details, see GData.Service.query().

New in version 0.7.0.

query_groups_async(query, cancellable, progress_callback, progress_user_data, callback, *user_data)¶

Parameters:

query (GData.Query or None) – a GData.Query with the query parameters, or None
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when an entry is loaded, or None
progress_user_data (object or None) – data to pass to the progress_callback function
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the query is finished
user_data (object or None) – data to pass to the callback function

Queries the service to return a list of groups matching the given query. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see GData.ContactsService.query_groups(), which is the synchronous version of this function, and GData.Service.query_async(), which is the base asynchronous query function.

New in version 0.9.1.