idle-inhibit/org.freedesktop.ScreenSaver.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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>