blumia/dde-application-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add api/dbus and docs/TODO.md

Browse Source 
Signed-off-by: black-desk <me@black-desk.cn>
This commit is contained in:
black-desk
2023-05-26 10:05:56 +08:00
parent 0316297d8a
commit d05e3fee70
6 changed files with 374 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
api/dbus/org.desktopspec.JobManager1.xml Normal file
View File

@ -0,0 +1,46 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<interface name="org.desktopspec.JobManager1">
<annotation
name="org.freedesktop.DBus.Description"
value="All method might block will return a DBus object path,
which implement org.desktopspec.JobManager1.Job.
This interface is design to provide some DBus signals to help
caller to watch the Jobs they invoked.
Caller should not interst in all the Jobs, as there are some
Jobs not created by them.
So the method to list all exsiting Jobs is NOT provided.
NOTE:
Signal emitted by this interface MIGHT be peer-to-peer."
/>
<signal name="JobNew">
<arg type="o" name="job" />
<arg type="o" name="source" />
<annotation
name="org.freedesktop.DBus.Description"
value="`source` is the DBus object produce this job."
/>
</signal>
<signal name="JobRemoved">
<arg type="o" name="job" />
<arg type="s" name="status" />
<arg type="s" name="message" />
<arg type="v" name="result" />
<annotation
name="org.freedesktop.DBus.Description"
value="This signal report the job remove event.
`status` is the `status` porperty of that Job
when it got removed.
`message` is the human readable message
for caller to report to user or just simple logging.
`result` is the result this job produce if it success.
Method that return an object of Job
should always have document
about the type and meaning of the `result`."
/>
</signal>
</interface>
</node>