UDisks.Loop¶

Implementations:: UDisks.LoopProxy, UDisks.LoopSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_delete` (arg_options, cancellable, callback, *user_data)
	`call_delete_finish` (res)
	`call_delete_sync` (arg_options, cancellable)
	`call_set_autoclear` (arg_value, arg_options, cancellable, callback, *user_data)
	`call_set_autoclear_finish` (res)
	`call_set_autoclear_sync` (arg_value, arg_options, cancellable)
	`complete_delete` (invocation)
	`complete_set_autoclear` (invocation)

Virtual Methods¶

	`do_handle_delete` (invocation, arg_options)
	`do_handle_set_autoclear` (invocation, arg_value, arg_options)

Properties¶

Name	Type	Flags	Short Description
`autoclear`	`bool`	r/w	Autoclear
`backing-file`	`str`	r/w	BackingFile
`setup-by-uid`	`int`	r/w	SetupByUID

Signals¶

Name	Short Description
`handle-delete`	Signal emitted when a remote caller is invoking the Delete() D-Bus method.
`handle-set-autoclear`	Signal emitted when a remote caller is invoking the SetAutoclear() D-Bus method.

Fields¶

None

Class Details¶

class UDisks.Loop¶

Bases:: GObject.GInterface
Structure:: UDisks.LoopIface

Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Loop.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the org.freedesktop.UDisks2.Loop D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the UDisks.Loop interface for a concrete class. The properties are overridden in the order they are defined.

call_delete(arg_options, cancellable, callback, *user_data)¶

Parameters:

arg_options (GLib.Variant) – Argument to pass with the method invocation.
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 or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the Delete() D-Bus method on self. 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 UDisks.Loop.call_delete_finish() to get the result of the operation.

See UDisks.Loop.call_delete_sync() for the synchronous, blocking version of this method.

call_delete_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Loop.call_delete().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with UDisks.Loop.call_delete().

call_delete_sync(arg_options, cancellable)¶

Parameters:

arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the Delete() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Loop.call_delete() for the asynchronous version of this method.

call_set_autoclear(arg_value, arg_options, cancellable, callback, *user_data)¶

Parameters:

arg_value (bool) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
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 or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the SetAutoclear() D-Bus method on self. 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 UDisks.Loop.call_set_autoclear_finish() to get the result of the operation.

See UDisks.Loop.call_set_autoclear_sync() for the synchronous, blocking version of this method.

call_set_autoclear_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.Loop.call_set_autoclear().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with UDisks.Loop.call_set_autoclear().

call_set_autoclear_sync(arg_value, arg_options, cancellable)¶

Parameters:

arg_value (bool) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the SetAutoclear() D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.Loop.call_set_autoclear() for the asynchronous version of this method.

complete_delete(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Delete() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_set_autoclear(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the SetAutoclear() D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

do_handle_delete(invocation, arg_options) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_options (GLib.Variant) –

Return type:

bool

Handler for the UDisks.Loop ::handle-delete signal.

do_handle_set_autoclear(invocation, arg_value, arg_options) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_value (bool) –
arg_options (GLib.Variant) –

Return type:

bool

Handler for the UDisks.Loop ::handle-set-autoclear signal.

Signal Details¶

UDisks.Loop.signals.handle_delete(loop, invocation, arg_options)¶

Signal Name:

handle-delete

Flags:

RUN_LAST

Parameters:

loop (UDisks.Loop) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_options (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Delete() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Loop.complete_delete() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

UDisks.Loop.signals.handle_set_autoclear(loop, invocation, arg_value, arg_options)¶

Signal Name:

handle-set-autoclear

Flags:

RUN_LAST

Parameters:

loop (UDisks.Loop) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_value (bool) – Argument passed by remote caller.
arg_options (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the SetAutoclear() D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.Loop.complete_set_autoclear() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details¶

UDisks.Loop.props.autoclear¶

Name:: autoclear
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Represents the D-Bus property “Autoclear”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

UDisks.Loop.props.backing_file¶

Name:: backing-file
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property “BackingFile”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

UDisks.Loop.props.setup_by_uid¶

Name:: setup-by-uid
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Represents the D-Bus property “SetupByUID”.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.