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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ConsoleKit 0.1.3 Documentation</title><link rel="stylesheet" href="docbook.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.72.0" /></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="index"></a>ConsoleKit 0.1.3 Documentation</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">William Jon</span> <span class="surname">McCann</span></h3><div class="affiliation"><div class="address"><p><br />
<code class="email"><<a href="mailto:mccann@jhu.edu">mccann@jhu.edu</a>></code><br />
</p></div></div></div></div></div><div><p class="releaseinfo">Version 0.1.3</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#id2950350">Introduction</a></span></dt><dt><span class="part"><a href="#id2950360">I. Concepts</a></span></dt><dd><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id2981062">About</a></span></dt><dt><span class="sect1"><a href="#id2981076">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#id2981086">Relevant art</a></span></dt></dl></dd><dt><span class="chapter"><a href="#terms">2. Terminology</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id2945367">Session</a></span></dt><dt><span class="sect1"><a href="#id2945164">Session leader</a></span></dt><dt><span class="sect1"><a href="#id2945174">Seat</a></span></dt></dl></dd><dt><span class="chapter"><a href="#design">3. Design</a></span></dt></dl></dd><dt><span class="part"><a href="#id2945194">II. Reference</a></span></dt><dd><dl><dt><span class="reference"><a href="#dbus-reference">I. D-Bus API Reference</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></dd></dl></dd><dt><span class="index"><a href="#id2996860">Index</a></span></dt></dl></div><div class="preface" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id2950350"></a>Introduction</h2></div></div></div><p>
</p></div><div class="part" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2950360"></a>Part I. Concepts</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id2981062">About</a></span></dt><dt><span class="sect1"><a href="#id2981076">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#id2981086">Relevant art</a></span></dt></dl></dd><dt><span class="chapter"><a href="#terms">2. Terminology</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id2945367">Session</a></span></dt><dt><span class="sect1"><a href="#id2945164">Session leader</a></span></dt><dt><span class="sect1"><a href="#id2945174">Seat</a></span></dt></dl></dd><dt><span class="chapter"><a href="#design">3. Design</a></span></dt></dl></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id2981062">About</a></span></dt><dt><span class="sect1"><a href="#id2981076">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#id2981086">Relevant art</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2981062"></a>About</h2></div></div></div><p>
ConsoleKit is a framework for keeping track of the various
users, sessions, and seats present on a system. It
provides a mechanism for software to react to changes of any of
these items or of any of the metadata associated with them.
</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2981076"></a>Defining the Problem</h2></div></div></div><p>
</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2981086"></a>Relevant art</h2></div></div></div><p>
</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="terms"></a>Chapter 2. Terminology</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id2945367">Session</a></span></dt><dt><span class="sect1"><a href="#id2945164">Session leader</a></span></dt><dt><span class="sect1"><a href="#id2945174">Seat</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2945367"></a>Session</h2></div></div></div><p>
ConsoleKit is a framework for keeping track of the various
users, sessions, and seats present on a system. It
provides a mechanism for software to react to changes of any of
these items or of any of the metadata associated with them.
</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2945164"></a>Session leader</h2></div></div></div><p>
</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id2945174"></a>Seat</h2></div></div></div><p>
</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="design"></a>Chapter 3. Design</h2></div></div></div></div></div><div class="part" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2945194"></a>Part II. Reference</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="reference"><a href="#dbus-reference">I. D-Bus API Reference</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></dd></dl></div><div class="reference" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="dbus-reference"></a>D-Bus API Reference</h1></div></div><hr /></div><div class="partintro" lang="en" xml:lang="en"><div></div><p>
ConsoleKit provides a D-Bus API for programs to obtain information about the
users, sessions, and seats that are present on a system.
</p><p>
Please see the other sections of this manual for an introduction to
these concepts.
</p><p>
This API is not yet stable and is likely to change in the future.
</p><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></div></div><div class="refentry" lang="en" xml:lang="en"><a id="Manager"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Manager — Manager interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Manager.OpenSession">OpenSession</a> (out 's' cookie)
<a href="#Manager.OpenSessionWithParameters">OpenSessionWithParameters</a> (in 'a(sv)' parameters,
out 's' cookie)
<a href="#Manager.CloseSession">CloseSession</a> (in 's' cookie,
out 'b' result)
<a href="#Manager.GetSeats">GetSeats</a> (out 'ao' seats)
<a href="#Manager.GetSessionForCookie">GetSessionForCookie</a> (in 's' cookie,
out 'o' ssid)
<a href="#Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</a> (in 'u' pid,
out 'o' ssid)
<a href="#Manager.GetCurrentSession">GetCurrentSession</a> (out 'o' ssid)
<a href="#Manager.GetSessionsForUnixUser">GetSessionsForUnixUser</a> (in 'u' uid,
out 'ao' sessions)
<a href="#Manager.GetSessionsForUser">GetSessionsForUser</a> (in 'u' uid,
out 'ao' sessions)
<a href="#Manager.GetSystemIdleHint">GetSystemIdleHint</a> (out 'b' idle_hint)
<a href="#Manager.GetSystemIdleSinceHint">GetSystemIdleSinceHint</a> (out 's' iso8601_datetime)
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2990155"></a><h2>Signals</h2><pre class="synopsis"><a href="#Manager::SeatAdded">SeatAdded</a> ('o' sid)
<a href="#Manager::SeatRemoved">SeatRemoved</a> ('o' sid)
<a href="#Manager::SystemIdleHintChanged">SystemIdleHintChanged</a> ('b' hint)
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2990197"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Manager implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2990214"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2990230"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2990244"></a><h2>Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2990252"></a><h3><a id="Manager.OpenSession"></a>OpenSession ()</h3><a id="id2990262" class="indexterm"></a><pre class="programlisting">OpenSession (out 's' cookie)</pre></div><p>This method requests that a new <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a>
be created for the calling process. The properties of this new Session are set automatically
from information collected about the calling process.
</p><p>This new session exists until the calling process disconnects from the system bus or
calls <a href="#Manager.CloseSession"><code class="function">CloseSession()</code></a>.
</p><p>It is the responsibility of the calling process to set the environment variable
XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
be made available to child processes of the caller so that they may be identified
as members of this session.
</p><p>See this simple example:
</p><div class="informalexample"><pre class="programlisting">
DBusError error;
DBusMessage *message;
DBusMessage *reply;
message = dbus_message_new_method_call ("org.freedesktop.ConsoleKit",
"/org/freedesktop/ConsoleKit/Manager",
"org.freedesktop.ConsoleKit.Manager",
"OpenSession");
if (message == NULL) {
goto out;
}
dbus_error_init (&error);
reply = dbus_connection_send_with_reply_and_block (connector->connection,
message,
-1,
&error);
if (reply == NULL) {
goto out;
}
dbus_error_init (&error);
if (! dbus_message_get_args (reply,
&error,
DBUS_TYPE_STRING, &cookie,
DBUS_TYPE_INVALID)) {
goto out;
}
</pre></div><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the new session</dd></dl></div><p>
See also:
<a href="#Manager.OpenSessionWithParameters"><code class="function">OpenSessionWithParameters()</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2990377"></a><h3><a id="Manager.OpenSessionWithParameters"></a>OpenSessionWithParameters ()</h3><a id="id2990388" class="indexterm"></a><pre class="programlisting">OpenSessionWithParameters (in 'a(sv)' parameters,
out 's' cookie)</pre></div><p>This method requests that a new <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a>
be created for the calling process. The properties of this new Session are from the
parameters provided.
</p><p>This new session exists until the calling process disconnects from the system bus or
calls <a href="#Manager.CloseSession"><code class="function">CloseSession()</code></a>.
</p><p>It is the responsibility of the calling process to set the environment variable
XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
be made available to child processes of the caller so that they may be identified
as members of this session.
</p><p>See the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> properties for a list of valid parameters.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>parameters</code></em>:</span></dt><dd>An array of sets of property names and values</dd><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the new session</dd></dl></div><p class="permission">This method is restricted to privileged users by D-Bus policy.</p><p>
See also:
<a href="#Session" title="org.freedesktop.ConsoleKit.Session">org.freedesktop.ConsoleKit.Session</a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2990494"></a><h3><a id="Manager.CloseSession"></a>CloseSession ()</h3><a id="id2990504" class="indexterm"></a><pre class="programlisting">CloseSession (in 's' cookie,
out 'b' result)</pre></div><p>This method is used to close the session identified by the supplied cookie.
</p><p>The session can only be closed by the same process that opened the session.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the session</dd><dt><span class="term"><em class="parameter"><code>result</code></em>:</span></dt><dd>Whether the session was successfully closed</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990556"></a><h3><a id="Manager.GetSeats"></a>GetSeats ()</h3><a id="id2990566" class="indexterm"></a><pre class="programlisting">GetSeats (out 'ao' seats)</pre></div><p>This gets a list of all the <a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">Seats</a>
that are currently present on the system.</p><p>Each Seat ID is an D-Bus object path for the object that implements the
<a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">Seat</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>seats</code></em>:</span></dt><dd>an array of Seat IDs</dd></dl></div><p>
See also:
<a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2990627"></a><h3><a id="Manager.GetSessionForCookie"></a>GetSessionForCookie ()</h3><a id="id2990638" class="indexterm"></a><pre class="programlisting">GetSessionForCookie (in 's' cookie,
out 'o' ssid)</pre></div><p>Returns the session ID that is associated with the specified cookie.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the session</dd><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990686"></a><h3><a id="Manager.GetSessionForUnixProcess"></a>GetSessionForUnixProcess ()</h3><a id="id2990697" class="indexterm"></a><pre class="programlisting">GetSessionForUnixProcess (in 'u' pid,
out 'o' ssid)</pre></div><p>Attempts to determine the session ID for the specified
POSIX process ID (pid).
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>pid</code></em>:</span></dt><dd>The POSIX process ID</dd><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990744"></a><h3><a id="Manager.GetCurrentSession"></a>GetCurrentSession ()</h3><a id="id2990755" class="indexterm"></a><pre class="programlisting">GetCurrentSession (out 'o' ssid)</pre></div><p>Attempts to determine the session ID that the caller belongs to.
</p><p>See this example of using dbus-send:
</p><div class="informalexample"><pre class="programlisting">
dbus-send --system --dest=org.freedesktop.ConsoleKit \
--type=method_call --print-reply --reply-timeout=2000 \
/org/freedesktop/ConsoleKit/Manager \
org.freedesktop.ConsoleKit.Manager.GetCurrentSession
</pre></div><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990802"></a><h3><a id="Manager.GetSessionsForUnixUser"></a>GetSessionsForUnixUser ()</h3><a id="id2990814" class="indexterm"></a><pre class="programlisting">GetSessionsForUnixUser (in 'u' uid,
out 'ao' sessions)</pre></div><p>This gets a list of all the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a>
that are currently open for the specified user.</p><p>Each Session ID is an D-Bus object path for the object that implements the
<a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>POSIX User identification</dd><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990879"></a><h3><a id="Manager.GetSessionsForUser"></a>GetSessionsForUser ()</h3><a id="id2990889" class="indexterm"></a><pre class="programlisting">GetSessionsForUser (in 'u' uid,
out 'ao' sessions)</pre></div><p>This gets a list of all the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a>
that are currently open for the specified user.</p><p>Each Session ID is an D-Bus object path for the object that implements the
<a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>User identification</dd><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><code class="literal">GetSessionsForUser</code> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
<a href="#Manager.GetSessionsForUnixUser"><code class="function">GetSessionsForUnixUser</code></a>
instead.</p></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2990979"></a><h3><a id="Manager.GetSystemIdleHint"></a>GetSystemIdleHint ()</h3><a id="id2990990" class="indexterm"></a><pre class="programlisting">GetSystemIdleHint (out 'b' idle_hint)</pre></div><p>Returns TRUE if the <a href="#Session:idle-hint"><code class="literal">idle-hint</code></a>
property of every open session is TRUE or if there are no open sessions.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>The value of the system-idle-hint</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2991036"></a><h3><a id="Manager.GetSystemIdleSinceHint"></a>GetSystemIdleSinceHint ()</h3><a id="id2991047" class="indexterm"></a><pre class="programlisting">GetSystemIdleSinceHint (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to
the time of the last change of the system-idle-hint.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2991083"></a><h2>Signal Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2991091"></a><h3><a id="Manager::SeatAdded"></a>The SeatAdded signal</h3><a id="id2991102" class="indexterm"></a><pre class="programlisting">SeatAdded ('o' sid)</pre></div><p>Emitted when a Seat has been added to the system.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>The Seat ID for the added seat</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2991135"></a><h3><a id="Manager::SeatRemoved"></a>The SeatRemoved signal</h3><a id="id2991146" class="indexterm"></a><pre class="programlisting">SeatRemoved ('o' sid)</pre></div><p>Emitted when a Seat has been removed from the system.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>The Seat ID for the removed seat</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2991180"></a><h3><a id="Manager::SystemIdleHintChanged"></a>The SystemIdleHintChanged signal</h3><a id="id2991191" class="indexterm"></a><pre class="programlisting">SystemIdleHintChanged ('b' hint)</pre></div><p>Emitted when the value of the system-idle-hint has changed.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>hint</code></em>:</span></dt><dd>The value of the system-idle-hint</dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2991226"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en" xml:lang="en"><div class="refentry.separator"><hr /></div><a id="Seat"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Seat — Seat interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Seat.GetId">GetId</a> (out 'o' sid)
<a href="#Seat.GetSessions">GetSessions</a> (out 'ao' sessions)
<a href="#Seat.GetActiveSession">GetActiveSession</a> (out 'o' ssid)
<a href="#Seat.ActivateSession">ActivateSession</a> (in 'o' ssid)
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992494"></a><h2>Signals</h2><pre class="synopsis"><a href="#Seat::ActiveSessionChanged">ActiveSessionChanged</a> ('o' ssid)
<a href="#Seat::SessionAdded">SessionAdded</a> ('o' ssid)
<a href="#Seat::SessionRemoved">SessionRemoved</a> ('o' ssid)
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992537"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Seat implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992554"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992570"></a><h2>Description</h2><p>
</p><p>A seat is a collection of sessions and a set of hardware (usually at
least a keyboard and mouse). Only one session may be active on a
seat at a time.</p><p>
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992590"></a><h2>Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2992598"></a><h3><a id="Seat.GetId"></a>GetId ()</h3><a id="id2992608" class="indexterm"></a><pre class="programlisting">GetId (out 'o' sid)</pre></div>Returns the ID for Seat.
<div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2992637"></a><h3><a id="Seat.GetSessions"></a>GetSessions ()</h3><a id="id2992648" class="indexterm"></a><pre class="programlisting">GetSessions (out 'ao' sessions)</pre></div><p>This gets a list of all the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a>
that are currently attached to this seat.</p><p>Each Session ID is an D-Bus object path for the object that implements the
<a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2992700"></a><h3><a id="Seat.GetActiveSession"></a>GetActiveSession ()</h3><a id="id2992711" class="indexterm"></a><pre class="programlisting">GetActiveSession (out 'o' ssid)</pre></div><p>Gets the Session ID that is currently active on this Seat.</p><p>Returns NULL if there is no active session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2992749"></a><h3><a id="Seat.ActivateSession"></a>ActivateSession ()</h3><a id="id2992759" class="indexterm"></a><pre class="programlisting">ActivateSession (in 'o' ssid)</pre></div><p>Attempt to activate the specified session. In most
cases, if successful, this will cause the session to
become visible and take control of the hardware that is
associated with this seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><p>
See also:
<a href="#Session.Activate"><code class="function">Activate()</code></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992809"></a><h2>Signal Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2992817"></a><h3><a id="Seat::ActiveSessionChanged"></a>The ActiveSessionChanged signal</h3><a id="id2992828" class="indexterm"></a><pre class="programlisting">ActiveSessionChanged ('o' ssid)</pre></div><p>Emitted when the active session has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2992861"></a><h3><a id="Seat::SessionAdded"></a>The SessionAdded signal</h3><a id="id2992872" class="indexterm"></a><pre class="programlisting">SessionAdded ('o' ssid)</pre></div><p>Emitted when a session has been added to the seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2992905"></a><h3><a id="Seat::SessionRemoved"></a>The SessionRemoved signal</h3><a id="id2992916" class="indexterm"></a><pre class="programlisting">SessionRemoved ('o' ssid)</pre></div><p>Emitted when a session has been removed from the seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2992950"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en" xml:lang="en"><div class="refentry.separator"><hr /></div><a id="Session"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Session — Session interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Session.GetId">GetId</a> (out 'o' ssid)
<a href="#Session.GetSeatId">GetSeatId</a> (out 'o' sid)
<a href="#Session.GetSessionType">GetSessionType</a> (out 's' type)
<a href="#Session.GetUser">GetUser</a> (out 'i' uid)
<a href="#Session.GetUnixUser">GetUnixUser</a> (out 'i' uid)
<a href="#Session.GetX11Display">GetX11Display</a> (out 's' display)
<a href="#Session.GetX11DisplayDevice">GetX11DisplayDevice</a> (out 's' x11_display_device)
<a href="#Session.GetDisplayDevice">GetDisplayDevice</a> (out 's' display_device)
<a href="#Session.GetRemoteHostName">GetRemoteHostName</a> (out 's' remote_host_name)
<a href="#Session.IsActive">IsActive</a> (out 'b' active)
<a href="#Session.IsLocal">IsLocal</a> (out 'b' local)
<a href="#Session.GetCreationTime">GetCreationTime</a> (out 's' iso8601_datetime)
<a href="#Session.Activate">Activate</a> ()
<a href="#Session.Lock">Lock</a> ()
<a href="#Session.Unlock">Unlock</a> ()
<a href="#Session.GetIdleHint">GetIdleHint</a> (out 'b' idle_hint)
<a href="#Session.GetIdleSinceHint">GetIdleSinceHint</a> (out 's' iso8601_datetime)
<a href="#Session.SetIdleHint">SetIdleHint</a> (in 'b' idle_hint)
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2993692"></a><h2>Signals</h2><pre class="synopsis"><a href="#Session::ActiveChanged">ActiveChanged</a> ('b' is_active)
<a href="#Session::IdleHintChanged">IdleHintChanged</a> ('b' hint)
<a href="#Session::Lock">Lock</a> ()
<a href="#Session::Unlock">Unlock</a> ()
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2993742"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Session implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2993758"></a><h2>Properties</h2><pre class="synopsis"><a href="#Session:unix-user">'unix-user'</a> readwrite 'u'
<a href="#Session:user">'user'</a> readwrite 'u'
<a href="#Session:session-type">'session-type'</a> readwrite 's'
<a href="#Session:remote-host-name">'remote-host-name'</a> readwrite 's'
<a href="#Session:display-device">'display-device'</a> readwrite 's'
<a href="#Session:x11-display">'x11-display'</a> readwrite 's'
<a href="#Session:x11-display-device">'x11-display-device'</a> readwrite 's'
<a href="#Session:active">'active'</a> readwrite 'b'
<a href="#Session:is-local">'is-local'</a> readwrite 'b'
<a href="#Session:idle-hint">'idle-hint'</a> readwrite 'b'
</pre></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2993859"></a><h2>Description</h2><p>
</p><p>Session objects represent and store information
related to a user session.
</p><p>
</p><p>The properties associated with the Session
specifically refer to the properties of the "session leader".
</p><p>
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2993883"></a><h2>Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2993891"></a><h3><a id="Session.GetId"></a>GetId ()</h3><a id="id2993902" class="indexterm"></a><pre class="programlisting">GetId (out 'o' ssid)</pre></div><p>Returns the ID for Session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2993933"></a><h3><a id="Session.GetSeatId"></a>GetSeatId ()</h3><a id="id2993944" class="indexterm"></a><pre class="programlisting">GetSeatId (out 'o' sid)</pre></div><p>Returns the ID for the Seat the Session is
attached to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div><p>
See also:
<a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2993985"></a><h3><a id="Session.GetSessionType"></a>GetSessionType ()</h3><a id="id2993995" class="indexterm"></a><pre class="programlisting">GetSessionType (out 's' type)</pre></div><p>Returns the type of the session.</p><p>Warning: we haven't yet defined the allowed values for this property.
It is probably best to avoid this until we do.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>type</code></em>:</span></dt><dd>Session type</dd></dl></div><p>
See also:
<a href="#Session:session-type"><code class="literal">session-type</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994046"></a><h3><a id="Session.GetUser"></a>GetUser ()</h3><a id="id2994056" class="indexterm"></a><pre class="programlisting">GetUser (out 'i' uid)</pre></div><p>Returns the user that the session belongs to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>User ID</dd></dl></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><code class="literal">GetUser</code> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
<a href="#Session.GetUnixUser"><code class="function">GetUnixUser</code></a>
instead.</p></div><p>
See also:
<a href="#Session:user"><code class="literal">user</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994123"></a><h3><a id="Session.GetUnixUser"></a>GetUnixUser ()</h3><a id="id2994133" class="indexterm"></a><pre class="programlisting">GetUnixUser (out 'i' uid)</pre></div><p>Returns the POSIX user ID that the session belongs to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>POSIX User ID</dd></dl></div><p>
See also:
<a href="#Session:unix-user"><code class="literal">unix-user</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994177"></a><h3><a id="Session.GetX11Display"></a>GetX11Display ()</h3><a id="id2994187" class="indexterm"></a><pre class="programlisting">GetX11Display (out 's' display)</pre></div><p>Returns the value of the X11 DISPLAY for this session
if one is present.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>display</code></em>:</span></dt><dd>The value of the X11 display</dd></dl></div><p>
See also:
<a href="#Session:x11-display"><code class="literal">x11-display</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994233"></a><h3><a id="Session.GetX11DisplayDevice"></a>GetX11DisplayDevice ()</h3><a id="id2994243" class="indexterm"></a><pre class="programlisting">GetX11DisplayDevice (out 's' x11_display_device)</pre></div><p>Returns the value of the display device (aka TTY) that the
X11 display for the session is connected to. If there is no x11-display set then this value
is undefined.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>x11_display_device</code></em>:</span></dt><dd>The value of the X11 display device</dd></dl></div><p>
See also:
<a href="#Session:x11-display-device"><code class="literal">x11-display-device</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994291"></a><h3><a id="Session.GetDisplayDevice"></a>GetDisplayDevice ()</h3><a id="id2994302" class="indexterm"></a><pre class="programlisting">GetDisplayDevice (out 's' display_device)</pre></div><p>Returns the value of the display device (aka TTY) that the
session is connected to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>display_device</code></em>:</span></dt><dd>The value of the display device</dd></dl></div><p>
See also:
<a href="#Session:display-device"><code class="literal">display-device</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994347"></a><h3><a id="Session.GetRemoteHostName"></a>GetRemoteHostName ()</h3><a id="id2994358" class="indexterm"></a><pre class="programlisting">GetRemoteHostName (out 's' remote_host_name)</pre></div><p>Returns the value of the remote host name for the session.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>remote_host_name</code></em>:</span></dt><dd>The remote host name</dd></dl></div><p>
See also:
<a href="#Session:remote-host-name"><code class="literal">remote-host-name</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994404"></a><h3><a id="Session.IsActive"></a>IsActive ()</h3><a id="id2994414" class="indexterm"></a><pre class="programlisting">IsActive (out 'b' active)</pre></div><p>Returns whether the session is active on the Seat that
it is attached to.</p><p>If the session is not attached to a seat this value is undefined.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>active</code></em>:</span></dt><dd>TRUE if the session is active, otherwise FALSE</dd></dl></div><p>
See also:
<a href="#Session:active"><code class="literal">active</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994463"></a><h3><a id="Session.IsLocal"></a>IsLocal ()</h3><a id="id2994473" class="indexterm"></a><pre class="programlisting">IsLocal (out 'b' local)</pre></div><p>Returns whether the session is local</p><p>FIXME: we need to come up with a concrete definition for this value.
It was originally used as a way to identify XDMCP sessions that originate
from a remote system.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>local</code></em>:</span></dt><dd>TRUE if the session is local, otherwise FALSE</dd></dl></div><p>
See also:
<a href="#Session:is-local"><code class="literal">is-local</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994524"></a><h3><a id="Session.GetCreationTime"></a>GetCreationTime ()</h3><a id="id2994535" class="indexterm"></a><pre class="programlisting">GetCreationTime (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to
the time that the session was opened.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2994570"></a><h3><a id="Session.Activate"></a>Activate ()</h3><a id="id2994580" class="indexterm"></a><pre class="programlisting">Activate ()</pre></div><p>Attempt to activate the this session. In most
cases, if successful, this will cause the session to
become visible and become active on the seat that it
is attached to.</p><div class="variablelist"><dl></dl></div><p>
See also:
<a href="#Seat.ActivateSession"><code class="function">Seat.ActivateSession()</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994615"></a><h3><a id="Session.Lock"></a>Lock ()</h3><a id="id2994626" class="indexterm"></a><pre class="programlisting">Lock ()</pre></div><p>This will cause a <a href="#Session::Lock"><code class="literal">Lock</code></a>
signal to be emitted for this session.
</p><div class="variablelist"><dl></dl></div><p class="permission">This method is restricted to privileged users by D-Bus policy.</p><p>
See also:
<a href="#Session::Lock"><code class="literal">Lock signal</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994676"></a><h3><a id="Session.Unlock"></a>Unlock ()</h3><a id="id2994686" class="indexterm"></a><pre class="programlisting">Unlock ()</pre></div><p>This will cause an <a href="#Session::Unlock"><code class="literal">Unlock</code></a>
signal to be emitted for this session.
</p><p>This can be used by login managers to unlock a session before it is
re-activated during fast-user-switching.
</p><div class="variablelist"><dl></dl></div><p class="permission">This method is restricted to privileged users by D-Bus policy.</p><p>
See also:
<a href="#Session::Unlock"><code class="literal">Unlock signal</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994740"></a><h3><a id="Session.GetIdleHint"></a>GetIdleHint ()</h3><a id="id2994751" class="indexterm"></a><pre class="programlisting">GetIdleHint (out 'b' idle_hint)</pre></div><p>Gets the value of the <a href="#Session:idle-hint"><code class="literal">idle-hint</code></a>
property.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>The value of the idle-hint</dd></dl></div><p>
See also:
<a href="#Session:idle-hint"><code class="literal">idle-hint</code></a></p><div class="refsect2" lang="en" xml:lang="en"><a id="id2994807"></a><h3><a id="Session.GetIdleSinceHint"></a>GetIdleSinceHint ()</h3><a id="id2994817" class="indexterm"></a><pre class="programlisting">GetIdleSinceHint (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to
the time of the last change of the idle-hint.
</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2994853"></a><h3><a id="Session.SetIdleHint"></a>SetIdleHint ()</h3><a id="id2994862" class="indexterm"></a><pre class="programlisting">SetIdleHint (in 'b' idle_hint)</pre></div><p>This may be used by the session to indicate that
it is idle.
</p><p>Use of this method is restricted to the user
that owns the session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>boolean value to set the idle-hint to</dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2994902"></a><h2>Signal Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2994911"></a><h3><a id="Session::ActiveChanged"></a>The ActiveChanged signal</h3><a id="id2994921" class="indexterm"></a><pre class="programlisting">ActiveChanged ('b' is_active)</pre></div><p>Emitted when the active property has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>is_active</code></em>:</span></dt><dd>TRUE if the session is active, otherwise FALSE</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2994955"></a><h3><a id="Session::IdleHintChanged"></a>The IdleHintChanged signal</h3><a id="id2994966" class="indexterm"></a><pre class="programlisting">IdleHintChanged ('b' hint)</pre></div><p>Emitted when the idle-hint property has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>hint</code></em>:</span></dt><dd>the new value of idle-hint</dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2994999"></a><h3><a id="Session::Lock"></a>The Lock signal</h3><a id="id2995010" class="indexterm"></a><pre class="programlisting">Lock ()</pre></div><p>Emitted in response to a call to the <a href="#Session.Lock"><code class="function">Lock()</code></a> method.</p><p>It is intended that the screensaver for the session should lock the screen in response to this signal.</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995047"></a><h3><a id="Session::Unlock"></a>The Unlock signal</h3><a id="id2995057" class="indexterm"></a><pre class="programlisting">Unlock ()</pre></div><p>Emitted in response to a call to the <a href="#Session.Unlock"><code class="function">Unlock()</code></a> method.</p><p>It is intended that the screensaver for the session should unlock the screen in response to this signal.</p><div class="variablelist"><dl></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id2995095"></a><h2>Property Details</h2><div class="refsect2" lang="en" xml:lang="en"><a id="id2995103"></a><h3><a id="Session:unix-user"></a>The "unix-user" property</h3><a id="id2995114" class="indexterm"></a><pre class="programlisting">'unix-user' readwrite 'u'
</pre></div><p>The user assigned to the session.</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995135"></a><h3><a id="Session:user"></a>The "user" property</h3><a id="id2995146" class="indexterm"></a><pre class="programlisting">'user' readwrite 'u'
</pre></div><p>The user assigned to the session.</p><div class="variablelist"><dl></dl></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><code class="literal">user</code> is deprecated since version 0.1.3 and should not be used in newly-written code. Use
<a href="#Session:unix-user"><code class="literal">unix-user</code></a>
instead.</p></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995191"></a><h3><a id="Session:session-type"></a>The "session-type" property</h3><a id="id2995201" class="indexterm"></a><pre class="programlisting">'session-type' readwrite 's'
</pre></div><p>The type of the session.</p><p>Warning: we haven't yet defined the allowed values for this property.
It is probably best to avoid this until we do.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995228"></a><h3><a id="Session:remote-host-name"></a>The "remote-host-name" property</h3><a id="id2995240" class="indexterm"></a><pre class="programlisting">'remote-host-name' readwrite 's'
</pre></div><p>The remote host name for the session.
</p><p>This will be set in situations where the session is
opened and controlled from a remote system.
</p><p>For example, this value will be set when the
session is created from an SSH or XDMCP connection.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995272"></a><h3><a id="Session:display-device"></a>The "display-device" property</h3><a id="id2995283" class="indexterm"></a><pre class="programlisting">'display-device' readwrite 's'
</pre></div><p>The display device (aka TTY) that the
session is connected to.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995306"></a><h3><a id="Session:x11-display"></a>The "x11-display" property</h3><a id="id2995316" class="indexterm"></a><pre class="programlisting">'x11-display' readwrite 's'
</pre></div><p>Value of the X11 DISPLAY for this session
if one is present.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995338"></a><h3><a id="Session:x11-display-device"></a>The "x11-display-device" property</h3><a id="id2995349" class="indexterm"></a><pre class="programlisting">'x11-display-device' readwrite 's'
</pre></div><p>
The display device (aka TTY) that the X11 display for the
session is connected to. If there is no x11-display set then
this value is undefined.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995374"></a><h3><a id="Session:active"></a>The "active" property</h3><a id="id2995384" class="indexterm"></a><pre class="programlisting">'active' readwrite 'b'
</pre></div><p>
Whether the session is active on the Seat that
it is attached to.</p><p>If the session is not attached to a seat this value is undefined.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995410"></a><h3><a id="Session:is-local"></a>The "is-local" property</h3><a id="id2995421" class="indexterm"></a><pre class="programlisting">'is-local' readwrite 'b'
</pre></div><p>
Whether the session is local</p><p>FIXME: we need to come up with a concrete definition for this value.
It was originally used as a way to identify XDMCP sessions that originate
from a remote system.
</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id2995449"></a><h3><a id="Session:idle-hint"></a>The "idle-hint" property</h3><a id="id2995460" class="indexterm"></a><pre class="programlisting">'idle-hint' readwrite 'b'
</pre></div><p>
This is a hint used to indicate that the session may be idle.
</p><p>
For sessions with a <a href="#Session:x11-display"><code class="literal">x11-display</code></a> set (ie. graphical
sessions), it is up to each session to delegate the
responsibility for updating this value. Typically, the
screensaver will set this.
</p><p>However, for non-graphical sessions with a <a href="#Session:display-device"><code class="literal">display-device</code></a> set
the Session object itself will periodically update this value based
on the activity detected on the display-device itself.
</p><p>
This should not be considered authoritative.
</p><div class="variablelist"><dl></dl></div></div></div></div></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a id="id2996860"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>A</h3><dl><dt>Activate</dt><dd><dl><dt>Session, <a href="#id2994570">Activate ()</a></dt></dl></dd><dt>ActivateSession</dt><dd><dl><dt>Seat, <a href="#id2992749">ActivateSession ()</a></dt></dl></dd><dt>active</dt><dd><dl><dt>Session, <a href="#id2995374">The "active" property</a></dt></dl></dd><dt>ActiveChanged</dt><dd><dl><dt>Session, <a href="#id2994911">The ActiveChanged signal</a></dt></dl></dd><dt>ActiveSessionChanged</dt><dd><dl><dt>Seat, <a href="#id2992817">The ActiveSessionChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>CloseSession</dt><dd><dl><dt>Manager, <a href="#id2990494">CloseSession ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>D</h3><dl><dt>display-device</dt><dd><dl><dt>Session, <a href="#id2995272">The "display-device" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>G</h3><dl><dt>GetActiveSession</dt><dd><dl><dt>Seat, <a href="#id2992700">GetActiveSession ()</a></dt></dl></dd><dt>GetCreationTime</dt><dd><dl><dt>Session, <a href="#id2994524">GetCreationTime ()</a></dt></dl></dd><dt>GetCurrentSession</dt><dd><dl><dt>Manager, <a href="#id2990744">GetCurrentSession ()</a></dt></dl></dd><dt>GetDisplayDevice</dt><dd><dl><dt>Session, <a href="#id2994291">GetDisplayDevice ()</a></dt></dl></dd><dt>GetId</dt><dd><dl><dt>Seat, <a href="#id2992598">GetId ()</a></dt><dt>Session, <a href="#id2993891">GetId ()</a></dt></dl></dd><dt>GetIdleHint</dt><dd><dl><dt>Session, <a href="#id2994740">GetIdleHint ()</a></dt></dl></dd><dt>GetIdleSinceHint</dt><dd><dl><dt>Session, <a href="#id2994807">GetIdleSinceHint ()</a></dt></dl></dd><dt>GetRemoteHostName</dt><dd><dl><dt>Session, <a href="#id2994347">GetRemoteHostName ()</a></dt></dl></dd><dt>GetSeatId</dt><dd><dl><dt>Session, <a href="#id2993933">GetSeatId ()</a></dt></dl></dd><dt>GetSeats</dt><dd><dl><dt>Manager, <a href="#id2990556">GetSeats ()</a></dt></dl></dd><dt>GetSessionForCookie</dt><dd><dl><dt>Manager, <a href="#id2990627">GetSessionForCookie ()</a></dt></dl></dd><dt>GetSessionForUnixProcess</dt><dd><dl><dt>Manager, <a href="#id2990686">GetSessionForUnixProcess ()</a></dt></dl></dd><dt>GetSessions</dt><dd><dl><dt>Seat, <a href="#id2992637">GetSessions ()</a></dt></dl></dd><dt>GetSessionsForUnixUser</dt><dd><dl><dt>Manager, <a href="#id2990802">GetSessionsForUnixUser ()</a></dt></dl></dd><dt>GetSessionsForUser</dt><dd><dl><dt>Manager, <a href="#id2990879">GetSessionsForUser ()</a></dt></dl></dd><dt>GetSessionType</dt><dd><dl><dt>Session, <a href="#id2993985">GetSessionType ()</a></dt></dl></dd><dt>GetSystemIdleHint</dt><dd><dl><dt>Manager, <a href="#id2990979">GetSystemIdleHint ()</a></dt></dl></dd><dt>GetSystemIdleSinceHint</dt><dd><dl><dt>Manager, <a href="#id2991036">GetSystemIdleSinceHint ()</a></dt></dl></dd><dt>GetUnixUser</dt><dd><dl><dt>Session, <a href="#id2994123">GetUnixUser ()</a></dt></dl></dd><dt>GetUser</dt><dd><dl><dt>Session, <a href="#id2994046">GetUser ()</a></dt></dl></dd><dt>GetX11Display</dt><dd><dl><dt>Session, <a href="#id2994177">GetX11Display ()</a></dt></dl></dd><dt>GetX11DisplayDevice</dt><dd><dl><dt>Session, <a href="#id2994233">GetX11DisplayDevice ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>I</h3><dl><dt>idle-hint</dt><dd><dl><dt>Session, <a href="#id2995449">The "idle-hint" property</a></dt></dl></dd><dt>IdleHintChanged</dt><dd><dl><dt>Session, <a href="#id2994955">The IdleHintChanged signal</a></dt></dl></dd><dt>is-local</dt><dd><dl><dt>Session, <a href="#id2995410">The "is-local" property</a></dt></dl></dd><dt>IsActive</dt><dd><dl><dt>Session, <a href="#id2994404">IsActive ()</a></dt></dl></dd><dt>IsLocal</dt><dd><dl><dt>Session, <a href="#id2994463">IsLocal ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lock</dt><dd><dl><dt>Session, <a href="#id2994615">Lock ()</a>, <a href="#id2994999">The Lock signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt>OpenSession</dt><dd><dl><dt>Manager, <a href="#id2990252">OpenSession ()</a></dt></dl></dd><dt>OpenSessionWithParameters</dt><dd><dl><dt>Manager, <a href="#id2990377">OpenSessionWithParameters ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>R</h3><dl><dt>remote-host-name</dt><dd><dl><dt>Session, <a href="#id2995228">The "remote-host-name" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>SeatAdded</dt><dd><dl><dt>Manager, <a href="#id2991091">The SeatAdded signal</a></dt></dl></dd><dt>SeatRemoved</dt><dd><dl><dt>Manager, <a href="#id2991135">The SeatRemoved signal</a></dt></dl></dd><dt>session-type</dt><dd><dl><dt>Session, <a href="#id2995191">The "session-type" property</a></dt></dl></dd><dt>SessionAdded</dt><dd><dl><dt>Seat, <a href="#id2992861">The SessionAdded signal</a></dt></dl></dd><dt>SessionRemoved</dt><dd><dl><dt>Seat, <a href="#id2992905">The SessionRemoved signal</a></dt></dl></dd><dt>SetIdleHint</dt><dd><dl><dt>Session, <a href="#id2994853">SetIdleHint ()</a></dt></dl></dd><dt>SystemIdleHintChanged</dt><dd><dl><dt>Manager, <a href="#id2991180">The SystemIdleHintChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>U</h3><dl><dt>unix-user</dt><dd><dl><dt>Session, <a href="#id2995103">The "unix-user" property</a></dt></dl></dd><dt>Unlock</dt><dd><dl><dt>Session, <a href="#id2994676">Unlock ()</a>, <a href="#id2995047">The Unlock signal</a></dt></dl></dd><dt>user</dt><dd><dl><dt>Session, <a href="#id2995135">The "user" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>x11-display</dt><dd><dl><dt>Session, <a href="#id2995306">The "x11-display" property</a></dt></dl></dd><dt>x11-display-device</dt><dd><dl><dt>Session, <a href="#id2995338">The "x11-display-device" property</a></dt></dl></dd></dl></div></div></div></div></body></html>
|
