![]() |
![]() |
![]() |
UDisks Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Properties | Signals |
Cancel (IN a{sv} options);
Some operations may take a long time (hours) to complete, that is, to actually send the D-Bus reply message back. One example of such an operation is the Format() method that is used to format a block device.
When such operations are initated, a job object implementing this interface may be created so the progress can be tracked by the caller (and also other observers).
The object(s) that a job affects (such as block devices or drives) can be determined by looking at the "Objects" property. Among other things, this can be used to draw a spinner in the user interface next to e.g. an icon for the drive or device in question.
A job may convey progress (if the underlying tool used supports it), see the "ExpectedEndTime" property.
When a job completes, the "Completed" signal is emitted.
To cancel a job use the Cancel()
method. This will cause the job to complete (with success
set
to FALSE
) and the D-Bus method used to initiate the operation
to return, usually returning the org.freedesktop.UDisks2.Error.Cancelled
error.
Cancel (IN a{sv} options);
Cancels the job.
|
Options (currently unused except for standard options). |
Progress readable d
How much progress has been made. Values are in the range 0 to 1.
StartTime readable t
The point in time (seconds since the Unix Epoch) that the job was started.
ExpectedEndTime readable t
The expected point in time (seconds since the Unix Epoch) that the job will complete or 0 if unknown.