summaryrefslogtreecommitdiff
path: root/xfce4-session/xfsm-manager-dbus.xml
blob: c4b6735703701ea185828d3b7ff8be84c274467b (plain)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?xml version="1.0" encoding="UTF-8"?>

<!--
     TODO:

     * define errors and list what methods can throw which errors
     * be sure the states in both GetState() methods make sense,
       and see if there are others that should be included
     * should we include the SM client ID string in the ClientRegistered
       and/or ClientDisconnected() signals?
     * include a "ShutdownStarted" signal?
     * extra shutdown type for "safe suspend" aka "s2both"?
-->

<node name="/org/xfce/SessionManager">
    <interface name="org.xfce.Session.Manager">
        <annotation name="org.freedesktop.DBus.GLib.CSymbol"
                    value="xfsm_manager_dbus"/>
        <annotation name="org.freedesktop.DBus.GLib.ClientCSymbol"
                    value="xfsm_manager_dbus_client"/>

        <!--
             (String, String, String) org.xfce.Session.Manager.GetInfo()

             Returns:

             @name: The session manager's name.
             @version: The session manager's version.
             @vendor: The vendor releasing the session manager.
        -->
        <method name="GetInfo">
            <arg direction="out" name="name" type="s"/>
            <arg direction="out" name="version" type="s"/>
            <arg direction="out" name="vendor" type="s"/>
        </method>

        <!--
             ObjectPath[] org.xfce.Session.Manager.ListClients()

             Retrieves a list of session clients from the session
             manager, as a list of D-Bus object paths.  These
             object paths all support the org.xfce.Session.Client
             interface.
        -->
        <method name="ListClients">
            <arg direction="out" name="clients" type="ao"/>
        </method>

        <!--
             Unsigned Int org.xfce.Session.Manager.GetState()

             Queries the session manager for its current operating
             state.  Valid values are:
                 0  Startup: the session manager is starting up and
                    restoring clients from the previous session.
                 1  Idle: the session manager has started up and is
                    waiting for client events.
                 2  Checkpoint: the session manager is saving the
                    client list and instructing clients to save state.
                 3  Shutdown: the session manager is shutting down.
                 4  Shutdown Phase 2: the session manager is shutting
                    down and is allowing clients which have requested
                    extra time to save their state to do so.
        -->
        <method name="GetState">
            <arg direction="out" name="state" type="u"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Checkpoint(String session_name)

             @session_name: The name of the session to save.  Pass the
                            empty string ("") to use the name of the
                            currently-running session.

             Instructs the session manager to save state and save all
             client state, without ending the session.
        -->
        <method name="Checkpoint">
            <arg direction="in" name="session_name" type="s"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Logout
        -->
        <method name="Logout">
            <arg direction="in" name="show_dialog" type="b"/>
            <arg direction="in" name="allow_save" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Shutdown
        -->
        <method name="Shutdown">
            <arg direction="in" name="allow_save" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.CanShutdown
        -->
        <method name="CanShutdown">
            <arg direction="out" name="can_shutdown" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Restart
        -->
        <method name="Restart">
            <arg direction="in" name="allow_save" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.CanRestart
        -->
        <method name="CanRestart">
            <arg direction="out" name="can_restart" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Suspend

             This will possibly be removed in the future
        -->
        <method name="Suspend" />

        <!--
             void org.Xfce.Session.Manager.CanSuspend

             This will possibly be removed in the future
        -->
        <method name="CanSuspend">
            <arg direction="out" name="can_suspend" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.Hibernate

             This will possibly be removed in the future
        -->
        <method name="Hibernate" />

        <!--
             void org.Xfce.Session.Manager.CanHibernate

             This will possibly be removed in the future
        -->
        <method name="CanHibernate">
            <arg direction="out" name="can_hibernate" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.HybridSleep

             This will possibly be removed in the future
        -->
        <method name="HybridSleep" />

        <!--
             void org.Xfce.Session.Manager.CanHybridSleep

             This will possibly be removed in the future
        -->
        <method name="CanHybridSleep">
            <arg direction="out" name="can_hybrid_sleep" type="b"/>
        </method>

        <!--
             void org.Xfce.Session.Manager.SwitchUser
        -->
        <method name="SwitchUser" />

        <!--
             ObjectPath[] org.Xfce.Session.Manager.RegisterClient

             @app_id: The application identifier
             @client_startup_id: Client startup identifier

             Returns:
             @client_id: The object path of the newly registered client

             Register the caller as a Session Management client.
        -->
        <method name="RegisterClient">
            <arg direction="in" name="app_id" type="s" />
            <arg direction="in" name="client_startup_id" type="s" />
            <arg direction="out" name="client_id" type="o" />
        </method>

        <!--
             void org.Xfce.Session.Manager.UnregisterClient

             @client_id: The object path of the previously registered client

             Unregister the specified client from Session Management.
        -->
        <method name="UnregisterClient">
            <arg direction="in" name="client_id" type="o" />
        </method>

        <!--
             void org.xfce.Session.Manager.StateChanged(Unsigned Int old_state,
                                                        Unsigned Int new_state)

             @old_state: The SM's previous state.
             @new_state: The SM's new (current) state.

             Emitted when the session manager's state changes.
             See GetState() above for valid values for the
             arguments.
        -->
        <signal name="StateChanged">
            <arg name="old_state" type="u"/>
            <arg name="new_state" type="u"/>
        </signal>

        <!--
             void org.xfce.Session.Manager.ClientRegistered(ObjectPath client)

             @client: A D-Bus object path.

             Emitted when a new client is registered.
        -->
        <signal name="ClientRegistered">
            <arg name="client" type="o"/>
        </signal>

        <!--
             void org.xfce.Session.Manager.ShutdownCancelled()

             Emitted when a previously-started shutdown has been
             cancelled.
        -->
        <signal name="ShutdownCancelled"/>
    </interface>
</node>