Geoclue.ClientProxy¶

Subclasses:: None

Methods¶

Inherited:: Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2), Geoclue.Client (11)
Structs:: GObject.ObjectClass (5)

class	`create` (desktop_id, accuracy_level, cancellable, callback, *user_data)
class	`create_finish` (result)
class	`create_full` (desktop_id, accuracy_level, flags, cancellable, callback, *user_data)
class	`create_full_finish` (result)
class	`create_full_sync` (desktop_id, accuracy_level, flags, cancellable)
class	`create_sync` (desktop_id, accuracy_level, cancellable)
class	`new` (connection, flags, name, object_path, cancellable, callback, *user_data)
class	`new_finish` (res)
class	`new_for_bus` (bus_type, flags, name, object_path, cancellable, callback, *user_data)
class	`new_for_bus_finish` (res)
class	`new_for_bus_sync` (bus_type, flags, name, object_path, cancellable)
class	`new_sync` (connection, flags, name, object_path, cancellable)

Virtual Methods¶

Inherited:: Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1), Geoclue.Client (3)

Properties¶

Inherited:: Gio.DBusProxy (9), Geoclue.Client (6)

Signals¶

Inherited:: Gio.DBusProxy (2), GObject.Object (1), Geoclue.Client (3)

Fields¶

Inherited:: Gio.DBusProxy (2), GObject.Object (1), Geoclue.Client (3)

Name	Type	Access	Description
parent_instance	`Gio.DBusProxy`	r

Class Details¶

class Geoclue.ClientProxy(**kwargs)¶

Bases:: Gio.DBusProxy, Geoclue.Client
Abstract:: No
Structure:: Geoclue.ClientProxyClass

The Geoclue.ClientProxy structure contains only private data and should only be accessed using the provided API.

classmethod create(desktop_id, accuracy_level, cancellable, callback, *user_data)¶

Parameters:

desktop_id (str) – The desktop file id (the basename of the desktop file).
accuracy_level (Geoclue.AccuracyLevel) – The requested accuracy level as Geoclue.AccuracyLevel.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the results are ready.
user_data (object or None) – User data to pass to callback.

A utility function to create a Geoclue.ClientProxy without having to deal with a Geoclue.Manager. See also Geoclue.ClientProxy.create_full() which improves resource management.

This is identitcal to calling Geoclue.ClientProxy.create_full() without any flags set.

See Geoclue.ClientProxy.create_sync() for the synchronous, blocking version of this function.

classmethod create_finish(result)¶

Parameters:: result (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Geoclue.ClientProxy.create().
Raises:: GLib.Error
Returns:: The constructed proxy object or None if error is set.
Return type:: Geoclue.ClientProxy

Finishes an operation started with Geoclue.ClientProxy.create().

classmethod create_full(desktop_id, accuracy_level, flags, cancellable, callback, *user_data)¶

Parameters:

desktop_id (str) – The desktop file id (the basename of the desktop file).
accuracy_level (Geoclue.AccuracyLevel) – The requested accuracy level as Geoclue.AccuracyLevel.
flags (Geoclue.ClientProxyCreateFlags) – Geoclue.ClientProxyCreateFlags to modify the creation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the results are ready.
user_data (object or None) – User data to pass to callback.

A utility function to create a Geoclue.ClientProxy without having to deal with a Geoclue.Manager.

By setting the Geoclue.ClientProxyCreateFlags.AUTO_DELETE flag you can ensure that the client will be deleted again from the geoclue service when it is destroyed. This flag should be used unless you are doing explicit resource management.

See Geoclue.ClientProxy.create_full_sync() for the synchronous, blocking version of this function.

classmethod create_full_finish(result)¶

Parameters:: result (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Geoclue.ClientProxy.create().
Raises:: GLib.Error
Returns:: The constructed proxy object or None if error is set.
Return type:: Geoclue.ClientProxy

Finishes an operation started with Geoclue.ClientProxy.create_full().

classmethod create_full_sync(desktop_id, accuracy_level, flags, cancellable)¶

Parameters:

desktop_id (str) – The desktop file id (the basename of the desktop file).
accuracy_level (Geoclue.AccuracyLevel) – The requested accuracy level as Geoclue.AccuracyLevel.
flags (Geoclue.ClientProxyCreateFlags) – Geoclue.ClientProxyCreateFlags to modify the creation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The constructed proxy object or None if error is set.

Return type:

Geoclue.ClientProxy

The synchronous and blocking version of Geoclue.ClientProxy.create_full().

By setting the Geoclue.ClientProxyCreateFlags.AUTO_DELETE flag you can ensure that the client will be deleted again from the geoclue service when it is destroyed. This flag should be used unless you are doing explicit resource management.

classmethod create_sync(desktop_id, accuracy_level, cancellable)¶

Parameters:

desktop_id (str) – The desktop file id (the basename of the desktop file).
accuracy_level (Geoclue.AccuracyLevel) – The requested accuracy level as Geoclue.AccuracyLevel.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The constructed proxy object or None if error is set.

Return type:

Geoclue.ClientProxy

The synchronous and blocking version of Geoclue.ClientProxy.create(). See also Geoclue.ClientProxy.create_full_sync() which improves resource management.

This function is identical to calling Geoclue.ClientProxy.create_full_sync() without any flags set.

classmethod new(connection, flags, name, object_path, cancellable, callback, *user_data)¶

Parameters:

connection (Gio.DBusConnection) – A Gio.DBusConnection.
flags (Gio.DBusProxyFlags) – Flags from the Gio.DBusProxyFlags enumeration.
name (str or None) – A bus name (well-known or unique) or None if connection is not a message bus connection.
object_path (str) – An object path.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied.
user_data (object or None) – User data to pass to callback.

Asynchronously creates a proxy for the D-Bus interface ‘org.freedesktop.GeoClue2.Client [gdbus-interface-org-freedesktop-GeoClue2-Client.top_of_page]’. See Gio.DBusProxy.new() for more details.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Geoclue.ClientProxy.new_finish() to get the result of the operation.

See Geoclue.ClientProxy.new_sync() for the synchronous, blocking version of this constructor.

classmethod new_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Geoclue.ClientProxy.new().
Raises:: GLib.Error
Returns:: The constructed proxy object or None if error is set.
Return type:: Geoclue.ClientProxy

Finishes an operation started with Geoclue.ClientProxy.new().

classmethod new_for_bus(bus_type, flags, name, object_path, cancellable, callback, *user_data)¶

Parameters:

bus_type (Gio.BusType) – A Gio.BusType.
flags (Gio.DBusProxyFlags) – Flags from the Gio.DBusProxyFlags enumeration.
name (str) – A bus name (well-known or unique).
object_path (str) – An object path.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied.
user_data (object or None) – User data to pass to callback.

Like Geoclue.ClientProxy.new() but takes a Gio.BusType instead of a Gio.DBusConnection.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call Geoclue.ClientProxy.new_for_bus_finish() to get the result of the operation.

See Geoclue.ClientProxy.new_for_bus_sync() for the synchronous, blocking version of this constructor.

classmethod new_for_bus_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to Geoclue.ClientProxy.new_for_bus().
Raises:: GLib.Error
Returns:: The constructed proxy object or None if error is set.
Return type:: Geoclue.ClientProxy

Finishes an operation started with Geoclue.ClientProxy.new_for_bus().

classmethod new_for_bus_sync(bus_type, flags, name, object_path, cancellable)¶

Parameters:

bus_type (Gio.BusType) – A Gio.BusType.
flags (Gio.DBusProxyFlags) – Flags from the Gio.DBusProxyFlags enumeration.
name (str) – A bus name (well-known or unique).
object_path (str) – An object path.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The constructed proxy object or None if error is set.

Return type:

Geoclue.ClientProxy

Like Geoclue.ClientProxy.new_sync() but takes a Gio.BusType instead of a Gio.DBusConnection.

The calling thread is blocked until a reply is received.

See Geoclue.ClientProxy.new_for_bus() for the asynchronous version of this constructor.

classmethod new_sync(connection, flags, name, object_path, cancellable)¶

Parameters:

connection (Gio.DBusConnection) – A Gio.DBusConnection.
flags (Gio.DBusProxyFlags) – Flags from the Gio.DBusProxyFlags enumeration.
name (str or None) – A bus name (well-known or unique) or None if connection is not a message bus connection.
object_path (str) – An object path.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The constructed proxy object or None if error is set.

Return type:

Geoclue.ClientProxy

Synchronously creates a proxy for the D-Bus interface ‘org.freedesktop.GeoClue2.Client [gdbus-interface-org-freedesktop-GeoClue2-Client.top_of_page]’. See Gio.DBusProxy.new_sync() for more details.

The calling thread is blocked until a reply is received.

See Geoclue.ClientProxy.new() for the asynchronous version of this constructor.