Blame doc/problems-service/html/re04.html

Packit 8ea169
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>org.freedesktop.Problems2.Task</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Problems API"><link rel="up" href="ch02.html" title="Chapter 2. Interfaces"><link rel="prev" href="re03.html" title="org.freedesktop.Problems2.Session"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 8ea169
          org.freedesktop.Problems2.Task
Packit 8ea169
        Prev Chapter 2. Interfaces 

Packit 8ea169
          org.freedesktop.Problems2.Task
Packit 8ea169
        

org.freedesktop.Problems2.Task — Represents an long running task

Synopsis

Methods

Packit 8ea169
                Start
Packit 8ea169
              (IN Dict<String,Variant> options);
 
Packit 8ea169
                Cancel
Packit 8ea169
              (IN Int32 flags);
 
Packit 8ea169
                Finish
Packit 8ea169
              (OUT Dict<String,Variant> results,  OUT Int32 code);
 

Properties

READ Dict<String,Variant> Details ;
READ Int32 Status ;

Methods

Packit 8ea169
            org.freedesktop.Problems2.Task.Start
Packit 8ea169
          
Packit 8ea169
                Start
Packit 8ea169
              (IN Dict<String,Variant> options);
 

Request to start processing of the task. This method can be called only if the status property equals TASK_READY.

Packit 8ea169
                options
Packit 8ea169
              

For future needs

Packit 8ea169
            org.freedesktop.Problems2.Task.Cancel
Packit 8ea169
          
Packit 8ea169
                Cancel
Packit 8ea169
              (IN Int32 flags);
 

Request to cancel processing of the task. The task will be disposed after that. This method can be called only if the status property equals TASK_PROCESSING.

Packit 8ea169
                flags
Packit 8ea169
              

For future needs

Packit 8ea169
            org.freedesktop.Problems2.Task.Finish
Packit 8ea169
          
Packit 8ea169
                Finish
Packit 8ea169
              (OUT Dict<String,Variant> results,  OUT Int32 code);
 

Takes the results and dispose the task. The method can be called only if the status property equals TASK_DONE.

Packit 8ea169
                results
Packit 8ea169
              

The parameter for returning the results.

Packit 8ea169
                code
Packit 8ea169
              

Return code

Packit 8ea169
                        

0

Successfully finished

non 0

Processing failed - check status code of the task type.

Packit 8ea169
                    

D-Bus Properties

Packit 8ea169
            Accessed using the org.freedesktop.DBus.Properties interface.
Packit 8ea169
          

READ Dict<String,Variant> Details ;

Any details that the specific task provides.

READ Int32 Status ;

This property supports org.freedesktop.DBus.Properties.PropertiesChanged signal.

Packit 8ea169
                        

0

TASK_NEW: processing can be started

1

TASK_RUNNING: the task is being processed

2

TASK_STOPPED: processing has been stopped - the task can define several stop points where the users can adjust the configuration

3

TASK_CANCELED: processing has been canceled

4

TASK_FAILED: processing has been failed

5

TASK_DONE: processing has been finished

Packit 8ea169
                

Packit 8ea169
          org.freedesktop.Problems2.Session
Packit 8ea169
         Home </body></html>