Generic interface for exposing long running jobs to the UI. More...
import"sbIJobProgress.idl";
Public Member Functions | |
| nsIStringEnumerator | getErrorMessages () |
| Enumerate all the errors encountered during the job. More... | |
| void | addJobProgressListener (in sbIJobProgressListener aListener) |
| Add a listener to be notified when significant job progress has been made. More... | |
| void | removeJobProgressListener (in sbIJobProgressListener aListener) |
| Remove a previously added listener. More... | |
Public Attributes | |
| const unsigned short | STATUS_FAILED = 0x00 |
| Constant indicating that the job has completed with errors. More... | |
| const unsigned short | STATUS_SUCCEEDED = 0x10 |
| Constant indicating that the job has completed. More... | |
| const unsigned short | STATUS_RUNNING = 0x20 |
| Constant indicating that the job is active. More... | |
| readonly attribute unsigned short | status |
| Current status of the job. More... | |
| readonly attribute boolean | blocked |
| If true, progress of job is blocked (e.g., due to locked resource). More... | |
| readonly attribute AString | statusText |
| Localized message describing the status of the job. More... | |
| readonly attribute AString | titleText |
| Localized message describing the type or purpose of the job. More... | |
| readonly attribute unsigned long | progress |
| Number of work units completed. More... | |
| readonly attribute unsigned long | total |
| Total number of work units to be completed May be set to 0 if the job length is indeterminate. More... | |
| readonly attribute unsigned long | errorCount |
| Number of errors that have been encountered. More... | |
Generic interface for exposing long running jobs to the UI.
This is a first-stab at a generic way to expose job progress to the UI. This interface should be used for things like file importing, copying to devices and metadata syncing.
Definition at line 45 of file sbIJobProgress.idl.
| void sbIJobProgress::addJobProgressListener | ( | in sbIJobProgressListener | aListener | ) |
Add a listener to be notified when significant job progress has been made.
| aListener | The listener instance |
| nsIStringEnumerator sbIJobProgress::getErrorMessages | ( | ) |
Enumerate all the errors encountered during the job.
| void sbIJobProgress::removeJobProgressListener | ( | in sbIJobProgressListener | aListener | ) |
Remove a previously added listener.
| aListener | The listener instance |
| readonly attribute boolean sbIJobProgress::blocked |
If true, progress of job is blocked (e.g., due to locked resource).
Definition at line 71 of file sbIJobProgress.idl.
| readonly attribute unsigned long sbIJobProgress::errorCount |
Number of errors that have been encountered.
Definition at line 99 of file sbIJobProgress.idl.
| readonly attribute unsigned long sbIJobProgress::progress |
Number of work units completed.
Definition at line 87 of file sbIJobProgress.idl.
| readonly attribute unsigned short sbIJobProgress::status |
Current status of the job.
Definition at line 66 of file sbIJobProgress.idl.
| const unsigned short sbIJobProgress::STATUS_FAILED = 0x00 |
Constant indicating that the job has completed with errors.
Definition at line 50 of file sbIJobProgress.idl.
| const unsigned short sbIJobProgress::STATUS_RUNNING = 0x20 |
Constant indicating that the job is active.
Definition at line 60 of file sbIJobProgress.idl.
| const unsigned short sbIJobProgress::STATUS_SUCCEEDED = 0x10 |
Constant indicating that the job has completed.
Definition at line 55 of file sbIJobProgress.idl.
| readonly attribute AString sbIJobProgress::statusText |
Localized message describing the status of the job.
Definition at line 76 of file sbIJobProgress.idl.
| readonly attribute AString sbIJobProgress::titleText |
Localized message describing the type or purpose of the job.
Definition at line 81 of file sbIJobProgress.idl.
| readonly attribute unsigned long sbIJobProgress::total |
Total number of work units to be completed May be set to 0 if the job length is indeterminate.
Definition at line 93 of file sbIJobProgress.idl.
