GData.AccessHandler

Implementations:

GData.CalendarCalendar, GData.DocumentsEntry

Methods

	get_rules (service, cancellable, progress_callback, *progress_user_data)
	get_rules_async (service, cancellable, progress_callback, progress_user_data, callback, *user_data)

Virtual Methods

do_get_rules (service, cancellable, progress_callback, progress_user_data)

Properties

None

Signals

None

Fields

None

Class Details

class GData.AccessHandler

Bases:

GObject.GInterface

Structure:

GData.AccessHandlerIface

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

New in version 0.3.0.

get_rules(service, cancellable, progress_callback, *progress_user_data)

Parameters:

• service (GData.Service) – a GData.Service

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when a rule 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 access control rules, or None; unref with GObject.Object.unref()

Return type:

GData.Feed

Retrieves a GData.Feed containing all the access rules which apply to the given GData.AccessHandler. Only the owner of a GData.AccessHandler may view its rule feed.

If cancellable is not None, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned.

A GData.ServiceError.PROTOCOL_ERROR will be returned if the server indicates there is a problem with the query.

For each rule in the response feed, progress_callback will be called in the main thread. If there was an error parsing the XML response, a GData.ParserError will be returned.

New in version 0.3.0.

get_rules_async(service, cancellable, progress_callback, progress_user_data, callback, *user_data)

Parameters:

• service (GData.Service) – a GData.Service

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when a rule 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

Retrieves a GData.Feed containing all the access rules which apply to the given GData.AccessHandler. Only the owner of a GData.AccessHandler may view its rule feed. self and service are both reffed when this function is called, so can safely be unreffed after this function returns.

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

When the operation is finished, callback will be called. You can then call GData.Service.query_finish() to get the results of the operation.

New in version 0.9.1.

do_get_rules(service, cancellable, progress_callback, progress_user_data) virtual

Parameters:

• service (GData.Service) – a GData.Service

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when a rule is loaded, or None

• progress_user_data (object or None) – data to pass to the progress_callback function

Returns:

a GData.Feed of access control rules, or None; unref with GObject.Object.unref()

Return type:

GData.Feed

Retrieves a GData.Feed containing all the access rules which apply to the given GData.AccessHandler. Only the owner of a GData.AccessHandler may view its rule feed.

If cancellable is not None, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned.

A GData.ServiceError.PROTOCOL_ERROR will be returned if the server indicates there is a problem with the query.

For each rule in the response feed, progress_callback will be called in the main thread. If there was an error parsing the XML response, a GData.ParserError will be returned.

New in version 0.3.0.