File: org.gnome.SessionManager.ClientPrivate.xml

package info (click to toggle)
gnome-session 49.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,716 kB
  • sloc: ansic: 7,392; xml: 591; python: 125; makefile: 48; sh: 42
file content (99 lines) | stat: -rw-r--r-- 3,339 bytes parent folder | download
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">

<!--
  org.gnome.SessionManager.ClientPrivate:
  @short_description: Plumbing for D-Bus Clients

  This interface is used by
  <link linkend='gdbus-org.gnome.SessionManager.ClientPrivate'>clients</link>
  that connect to the Session Manager via D-Bus. It largely mirrors the
  functionality available in the X11 Session Manager Protocol.
-->
<node>
  <interface name="org.gnome.SessionManager.ClientPrivate">
    <annotation name="org.gtk.GDBus.C.Name" value="ExportedClientPrivate"/>

    <!--
      EndSessionResponse:
      @is_ok: Whether or not it is OK to preceed
      @reason: The reason string

      This should be called by the client in response to the
      #org.gnome.SessionManager.ClientPrivate::QueryEndSession and
      #org.gnome.SessionManager.ClientPrivate::EndSession signals.

      When @is_ok is false, the provided reason may be displayed to the user.
      The user may choose to ignore the reason, and continue with session
      shutdown anyways.
    -->
    <method name="EndSessionResponse">
      <arg name="is_ok" type="b" direction="in"/>
      <arg name="reason" type="s" direction="in"/>
    </method>

    <!--
      Stop:

      The client should stop and and remove itself from the session in response
      to this signal.
    -->
    <signal name="Stop"/>

    <!--
      QueryEndSession:
      @flags: Flags

      This signal is used to ask the client if it is ready for the session to
      end. The client must respond by calling
      #org.gnome.SessionManager.ClientPrivate.EndSessionResponse()
      within one second of the signal emission.

      The @flags may include:

      <itemizedlist>
        <listitem><para>
          <emphasis>1</emphasis>:
          Logout is forced. The client's inhibitors and the client's
          #org.gnome.SessionManager.ClientPrivate.EndSessionResponse()
          will be ignored.
        </para></listitem>
      </itemizedlist>

      The client must not attempt to preform any actions or interact with the
      user in response to this signal. Any actions required for a clean shutdown
      must take place in response to the
      #org.gnome.SessionManager.ClientPrivate::EndSession signal.
    -->
    <signal name="QueryEndSession">
      <arg name="flags" type="u"/>
    </signal>

    <!--
      EndSession:
      @flags: Flags

      This is the signal used to inform the client that the session is about to
      end. The client will be given ten seconds to perform any actions required
      for a clean shutdown. Once done, the client must respond by calling
      #org.gnome.SessionManager.ClientPrivate.EndSessionResponse()
      within the ten second period.

      The client must not attempt to interact with the user in response to this
      signal.
    -->
    <signal name="EndSession">
      <arg name="flags" type="u"/>
    </signal>

    <!--
      CancelEndSession:

      This signal indicates to the client that a previous emission of
      #org.gnome.SessionManager.ClientPrivate::QueryEndSession has been
      cancelled. The client should resume normal operations.
    -->
    <signal name="CancelEndSession"/>

  </interface>
</node>