UDisks.Job

g GObject.GInterface GObject.GInterface UDisks.Job UDisks.Job GObject.GInterface->UDisks.Job

Implementations:
 UDisks.JobProxy, UDisks.JobSkeleton

Methods

class interface_info ()
class override_properties (klass, property_id_begin)
  call_cancel (arg_options, cancellable, callback, *user_data)
  call_cancel_finish (res)
  call_cancel_sync (arg_options, cancellable)
  complete_cancel (invocation)
  emit_completed (arg_success, arg_message)

Virtual Methods

  do_completed (arg_success, arg_message)
  do_handle_cancel (invocation, arg_options)

Properties

Name Type Flags Short Description
bytes int r/w Bytes
cancelable bool r/w Cancelable
expected-end-time int r/w ExpectedEndTime
objects [str] r/w Objects
operation str r/w Operation
progress float r/w Progress
progress-valid bool r/w ProgressValid
rate int r/w Rate
start-time int r/w StartTime
started-by-uid int r/w StartedByUID

Signals

Name Short Description
completed On the client-side, this signal is emitted whenever the D-Bus signal “Completed” is received.
handle-cancel Signal emitted when a remote caller is invoking the Cancel() D-Bus method.

Fields

None

Class Details

class UDisks.Job
Bases:GObject.GInterface
Structure:UDisks.JobIface

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

classmethod interface_info()[source]
Returns:A Gio.DBusInterfaceInfo. Do not free.
Return type:Gio.DBusInterfaceInfo

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

classmethod override_properties(klass, property_id_begin)[source]
Parameters:
Returns:

The last property id.

Return type:

int

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

call_cancel(arg_options, cancellable, callback, *user_data)[source]
Parameters:

Asynchronously invokes the Cancel() 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.Job.call_cancel_finish() to get the result of the operation.

See UDisks.Job.call_cancel_sync() for the synchronous, blocking version of this method.

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

Finishes an operation started with UDisks.Job.call_cancel().

call_cancel_sync(arg_options, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

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

Return type:

bool

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

See UDisks.Job.call_cancel() for the asynchronous version of this method.

complete_cancel(invocation)[source]
Parameters:invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the Cancel() 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.

emit_completed(arg_success, arg_message)[source]
Parameters:
  • arg_success (bool) – Argument to pass with the signal.
  • arg_message (str) – Argument to pass with the signal.

Emits the “Completed” D-Bus signal.

do_completed(arg_success, arg_message) virtual
Parameters:
  • arg_success (bool) –
  • arg_message (str) –
do_handle_cancel(invocation, arg_options) virtual
Parameters:
Return type:

bool

Signal Details

UDisks.Job.signals.completed(job, arg_success, arg_message)
Signal Name:

completed

Flags:

RUN_LAST

Parameters:
  • job (UDisks.Job) – The object which received the signal
  • arg_success (bool) – Argument.
  • arg_message (str) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal “Completed” is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

UDisks.Job.signals.handle_cancel(job, invocation, arg_options)
Signal Name:

handle-cancel

Flags:

RUN_LAST

Parameters:
Returns:

True if the invocation was handled, False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the Cancel() 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.Job.complete_cancel() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details

UDisks.Job.props.bytes
Name:bytes
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “Bytes”.

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.

New in version 2.0.0.

UDisks.Job.props.cancelable
Name:cancelable
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Represents the D-Bus property “Cancelable”.

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.Job.props.expected_end_time
Name:expected-end-time
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “ExpectedEndTime”.

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.Job.props.objects
Name:objects
Type:[str]
Default Value:[]
Flags:READABLE, WRITABLE

Represents the D-Bus property “Objects”.

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.Job.props.operation
Name:operation
Type:str
Default Value:None
Flags:READABLE, WRITABLE

Represents the D-Bus property “Operation”.

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.Job.props.progress
Name:progress
Type:float
Default Value:0.0
Flags:READABLE, WRITABLE

Represents the D-Bus property “Progress”.

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.Job.props.progress_valid
Name:progress-valid
Type:bool
Default Value:False
Flags:READABLE, WRITABLE

Represents the D-Bus property “ProgressValid”.

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.Job.props.rate
Name:rate
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “Rate”.

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.

New in version 2.0.0.

UDisks.Job.props.start_time
Name:start-time
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “StartTime”.

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.Job.props.started_by_uid
Name:started-by-uid
Type:int
Default Value:0
Flags:READABLE, WRITABLE

Represents the D-Bus property “StartedByUID”.

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.