1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
3
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
4
<interface name="org.gnome.SessionManager">
6
<!-- Initialization phase interfaces -->
9
<arg name="variable" type="s" direction="in">
11
<doc:summary>The variable name</doc:summary>
14
<arg name="value" type="s" direction="in">
16
<doc:summary>The value</doc:summary>
21
<doc:para>Adds the variable name to the application launch environment with the specified value. May only be used during the Session Manager initialization phase.</doc:para>
26
<method name="GetLocale">
27
<arg name="category" type="i" direction="in">
29
<doc:summary>The locale category</doc:summary>
32
<arg name="value" type="s" direction="out">
34
<doc:summary>The value</doc:summary>
39
<doc:para>Reads the current state of the specific locale category.</doc:para>
44
<method name="InitializationError">
45
<arg name="message" type="s" direction="in">
47
<doc:summary>The error message</doc:summary>
50
<arg name="fatal" type="b" direction="in">
52
<doc:summary>Whether the error should be treated as fatal</doc:summary>
57
<doc:para>May be used by applications launched during the Session Manager initialization phase to indicate there was a problem.</doc:para>
62
<!-- Running phase interfaces -->
64
<method name="RegisterClient">
65
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
66
<arg type="s" name="app_id" direction="in">
68
<doc:summary>The application identifier</doc:summary>
71
<arg type="s" name="client_startup_id" direction="in">
73
<doc:summary>Client startup identifier</doc:summary>
76
<arg type="o" name="client_id" direction="out">
78
<doc:summary>The object path of the newly registered client</doc:summary>
83
<doc:para>Register the caller as a Session Management client.</doc:para>
88
<method name="UnregisterClient">
89
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
90
<arg type="o" name="client_id" direction="in">
92
<doc:summary>The object path of the client</doc:summary>
97
<doc:para>Unregister the specified client from Session Management.</doc:para>
102
<method name="Inhibit">
103
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
104
<arg type="s" name="app_id" direction="in">
106
<doc:summary>The application identifier</doc:summary>
109
<arg type="u" name="toplevel_xid" direction="in">
111
<doc:summary>The toplevel X window identifier</doc:summary>
114
<arg type="s" name="reason" direction="in">
116
<doc:summary>The reason for the inhibit</doc:summary>
119
<arg type="u" name="flags" direction="in">
121
<doc:summary>Flags that specify what should be inhibited</doc:summary>
124
<arg type="u" name="inhibit_cookie" direction="out">
126
<doc:summary>The cookie</doc:summary>
131
Proactively indicates that the calling application is performing an action that should not be interrupted and sets a reason to be displayed to the user when an interruption is about to take placea.
134
<doc:para>Applications should invoke this method when they begin an operation that
135
should not be interrupted, such as creating a CD or DVD. The types of actions
136
that may be blocked are specified by the flags parameter. When the application
137
completes the operation it should call <doc:ref type="method" to="org.gnome.SessionManager.Uninhibit">Uninhibit()</doc:ref>
138
or disconnect from the session bus.
141
Applications should not expect that they will always be able to block the
142
action. In most cases, users will be given the option to force the action
146
Reasons should be short and to the point.
149
The flags parameter must include at least one of the following:
152
<doc:term>1</doc:term>
153
<doc:definition>Inhibit logging out</doc:definition>
156
<doc:term>2</doc:term>
157
<doc:definition>Inhibit user switching</doc:definition>
160
<doc:term>4</doc:term>
161
<doc:definition>Inhibit suspending the session or computer</doc:definition>
164
<doc:term>8</doc:term>
165
<doc:definition>Inhibit the session being marked as idle</doc:definition>
168
<doc:term>16</doc:term>
169
<doc:definition>Inhibit auto-mounting removable media for the session</doc:definition>
172
Values for flags may be bitwise or'ed together.
175
The returned cookie is used to uniquely identify this request. It should be used
176
as an argument to <doc:ref type="method" to="org.gnome.SessionManager.Uninhibit">Uninhibit()</doc:ref> in
177
order to remove the request.
183
<method name="Uninhibit">
184
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
185
<arg type="u" name="inhibit_cookie" direction="in">
187
<doc:summary>The cookie</doc:summary>
192
<doc:para>Cancel a previous call to <doc:ref type="method" to="org.gnome.SessionManager.Inhibit">Inhibit()</doc:ref> identified by the cookie.</doc:para>
197
<method name="IsInhibited">
198
<arg type="u" name="flags" direction="in">
200
<doc:summary>Flags that spefify what should be inhibited</doc:summary>
203
<arg type="b" name="is_inhibited" direction="out">
205
<doc:summary>Returns TRUE if any of the operations in the bitfield flags are inhibited</doc:summary>
210
<doc:para>Determine if operation(s) specified by the flags
211
are currently inhibited. Flags are same as those accepted
213
<doc:ref type="method" to="org.gnome.SessionManager.Inhibit">Inhibit()</doc:ref>
219
<method name="GetClients">
220
<arg name="clients" direction="out" type="ao">
222
<doc:summary>an array of client IDs</doc:summary>
227
<doc:para>This gets a list of all the <doc:ref type="interface" to="org.gnome.SessionManager.Client">Clients</doc:ref>
228
that are currently known to the session manager.</doc:para>
229
<doc:para>Each Client ID is an D-Bus object path for the object that implements the
230
<doc:ref type="interface" to="org.gnome.SessionManager.Client">Client</doc:ref> interface.</doc:para>
232
<doc:seealso><doc:ref type="interface" to="org.gnome.SessionManager.Client">org.gnome.SessionManager.Client</doc:ref></doc:seealso>
236
<method name="GetInhibitors">
237
<arg name="inhibitors" direction="out" type="ao">
239
<doc:summary>an array of inhibitor IDs</doc:summary>
244
<doc:para>This gets a list of all the <doc:ref type="interface" to="org.gnome.SessionManager.Inhibitor">Inhibitors</doc:ref>
245
that are currently known to the session manager.</doc:para>
246
<doc:para>Each Inhibitor ID is an D-Bus object path for the object that implements the
247
<doc:ref type="interface" to="org.gnome.SessionManager.Inhibitor">Inhibitor</doc:ref> interface.</doc:para>
249
<doc:seealso><doc:ref type="interface" to="org.gnome.SessionManager.Inhibitor">org.gnome.SessionManager.Inhibitor</doc:ref></doc:seealso>
254
<method name="IsAutostartConditionHandled">
255
<arg name="condition" direction="in" type="s">
257
<doc:summary>The autostart condition string</doc:summary>
260
<arg name="handled" direction="out" type="b">
262
<doc:summary>True if condition is handled, false otherwise</doc:summary>
267
<doc:para>Allows the caller to determine whether the session manager is
268
handling changes to the specified autostart condition.</doc:para>
273
<method name="Shutdown">
276
<doc:para>Request a shutdown dialog.</doc:para>
281
<method name="Reboot">
284
<doc:para>Request a reboot dialog.</doc:para>
289
<method name="CanShutdown">
290
<arg name="is_available" direction="out" type="b">
292
<doc:summary>True if shutdown is available to the user, false otherwise</doc:summary>
297
<doc:para>Allows the caller to determine whether or not it's okay to show
298
a shutdown option in the UI</doc:para>
303
<method name="Logout">
304
<arg name="mode" type="u" direction="in">
306
<doc:summary>The type of logout that is being requested</doc:summary>
311
<doc:para>Request a logout dialog</doc:para>
313
Allowed values for the mode parameter are:
316
<doc:term>0</doc:term>
317
<doc:definition>Normal.</doc:definition>
320
<doc:term>1</doc:term>
321
<doc:definition>No confirmation inferface should be shown.</doc:definition>
324
<doc:term>2</doc:term>
325
<doc:definition>Forcefully logout. No confirmation will be shown and any inhibitors will be ignored.</doc:definition>
328
Values for flags may be bitwise or'ed together.
334
<method name="IsSessionRunning">
335
<arg name="running" direction="out" type="b">
337
<doc:summary>True if the session has entered the Running phase, false otherwise</doc:summary>
342
<doc:para>Allows the caller to determine whether the session manager
343
has entered the Running phase, in case the client missed the
344
SessionRunning signal.</doc:para>
351
<signal name="ClientAdded">
352
<arg name="id" type="o">
354
<doc:summary>The object path for the added client</doc:summary>
359
<doc:para>Emitted when a client has been added to the session manager.
364
<signal name="ClientRemoved">
365
<arg name="id" type="o">
367
<doc:summary>The object path for the removed client</doc:summary>
372
<doc:para>Emitted when a client has been removed from the session manager.
378
<signal name="InhibitorAdded">
379
<arg name="id" type="o">
381
<doc:summary>The object path for the added inhibitor</doc:summary>
386
<doc:para>Emitted when an inhibitor has been added to the session manager.
391
<signal name="InhibitorRemoved">
392
<arg name="id" type="o">
394
<doc:summary>The object path for the removed inhibitor</doc:summary>
399
<doc:para>Emitted when an inhibitor has been removed from the session manager.
405
<signal name="SessionRunning">
408
<doc:para>Indicates the session has entered the Running phase.</doc:para>
413
<signal name="SessionOver">
416
<doc:para>Indicates the session is about to end.</doc:para>
423
<property name="SessionName" type="s" access="read">
426
<doc:para>The name of the session that has been loaded.</doc:para>
431
<property name="SessionIsActive" type="b" access="read">
434
<doc:para>If true, the session is currently in the
435
foreground and available for user input.</doc:para>
440
<property name="InhibitedActions" type="u" access="read">
443
<doc:para>A bitmask of flags to indicate which actions
444
are inhibited. See the Inhibit() function's description
445
for a list of possible values.</doc:para>
added
removed
src/backend-dbus/org.gnome.SessionManager.xml
