summaryrefslogtreecommitdiffstats
path: root/idle-inhibit/org.freedesktop.ScreenSaver.xml
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2012-12-07 16:42:54 +0100
committerOwen W. Taylor <otaylor@fishsoup.net>2013-02-12 12:03:46 -0500
commit806462d8f6c3a2c0fac3488e94763e46ecef896c (patch)
treee9b2ac840a97b50bed212132b894f04be74106fa /idle-inhibit/org.freedesktop.ScreenSaver.xml
parent77da08959a92a9873794ca0242d0a3ffea33befc (diff)
downloadxdg-specs-806462d8f6c3a2c0fac3488e94763e46ecef896c.tar.xz
Add idle-inhibit D-Bus service spec
Diffstat (limited to 'idle-inhibit/org.freedesktop.ScreenSaver.xml')
-rw-r--r--idle-inhibit/org.freedesktop.ScreenSaver.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/idle-inhibit/org.freedesktop.ScreenSaver.xml b/idle-inhibit/org.freedesktop.ScreenSaver.xml
new file mode 100644
index 0000000..23278ad
--- /dev/null
+++ b/idle-inhibit/org.freedesktop.ScreenSaver.xml
@@ -0,0 +1,38 @@
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<tp:spec xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+ <tp:title>Idle Inhibition Service API Specification</tp:title>
+ <tp:version>0.1</tp:version>
+ <tp:copyright>
+ Copyright (C) 2012 Bastien Nocera &lt;hadess@hadess.net&gt;
+ </tp:copyright>
+<node name="/org/freedesktop/ScreenSaver">
+ <interface name="org.freedesktop.ScreenSaver">
+ <tp:docstring>
+ The Idle Inhibition Service manages the inhibition requests.
+ </tp:docstring>
+
+ <method name="Inhibit">
+ <tp:docstring>Inhibit idleness for the caller application.</tp:docstring>
+
+ <arg name="application_name" type="s" direction="in">
+ <tp:docstring>A unique identifier for the application, usually a reverse domain (such as 'org.freedesktop.example').</tp:docstring>
+ </arg>
+
+ <arg name="reason_for_inhibit" type="s" direction="in">
+ <tp:docstring>A human-readable and possibly translated string explaining the reason why idleness is inhibited (such as 'Playing a movie').</tp:docstring>
+ </arg>
+
+ <arg name="cookie" type="u" direction="out">
+ <tp:docstring>A cookie uniquely representing the inhibition request, to be passed to UnInhibit when done.</tp:docstring>
+ </arg>
+ </method>
+ <method name="UnInhibit">
+ <tp:docstring>Disable inhibit idleness for the caller application.</tp:docstring>
+
+ <arg name="cookie" type="u" direction="in">
+ <tp:docstring>A cookie representing the inhibition request, as returned by the 'Inhibit' function.</tp:docstring>
+ </arg>
+ </method>
+ </interface>
+</node>
+</tp:spec>