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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
|
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="Consolekit2 : ConsoleKit2 is a framework for defining and tracking users, login sessions, and seats.">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Consolekit2</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/ConsoleKit2/ConsoleKit2">View on GitHub</a>
<h1 id="project_title">Consolekit2</h1>
<h2 id="project_tagline">ConsoleKit2 is a framework for defining and tracking users, login sessions, and seats.</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/ConsoleKit2/ConsoleKit2/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/ConsoleKit2/ConsoleKit2/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a id="consolekit2-documentation" class="anchor" href="#consolekit2-documentation" aria-hidden="true"><span class="octicon octicon-link"></span></a>ConsoleKit2 Documentation</h1>
<h2>
<a id="chapter-1-introduction" class="anchor" href="#chapter-1-introduction" aria-hidden="true"><span class="octicon octicon-link"></span></a>Chapter 1. Introduction</h2>
<p><a href="https://scan.coverity.com/projects/3199"><img src="https://scan.coverity.com/projects/3199/badge.svg" alt="Coverity Scan Build Status"></a></p>
<p><a href="https://www.transifex.com/projects/p/consolekit2/">Help translate ConsoleKit2</a></p>
<p><a href="https://github.com/ConsoleKit2/ConsoleKit2/issues">Report bugs and feature requests</a></p>
<p><a href="https://github.com/ConsoleKit2/ConsoleKit2">Help develop ConsoleKit2</a></p>
<p>Communication can be done through github comments/issues as well as on the IRC channel ConsoleKit2 on freenode.
You can easily join the channel by going to <a href="http://webchat.freenode.net/">Freenode Webchat</a></p>
<!-- Content pasted from autogenerated doc/dbus/ConsoleKit.html -->
<div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="preface"><a href="#idm139925508996528">Introduction</a></span></dt><dt><span class="part"><a href="#idm139925508098176">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="#idm139925511259600">About</a></span></dt><dt><span class="sect1"><a href="#idm139925511073024">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#idm139925511071488">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="#idm139925508076480">Session</a></span></dt><dt><span class="sect1"><a href="#idm139925508073008">Session leader</a></span></dt><dt><span class="sect1"><a href="#idm139925508079088">Seat</a></span></dt></dl></dd><dt><span class="chapter"><a href="#design">3. Design</a></span></dt><dd><dl><dt><span class="sect1"><a href="#idm139925511701296">Session Lifecycle</a></span></dt><dt><span class="sect1"><a href="#idm139925511728192">Expected Usage</a></span></dt><dd><dl><dt><span class="sect2"><a href="#idm139925507318912">Text Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507313712">Graphical Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507306128">System Daemon</a></span></dt><dt><span class="sect2"><a href="#idm139925507302448">Hardware Abstraction Layer</a></span></dt><dt><span class="sect2"><a href="#idm139925507297152">Fast User Switching Agent</a></span></dt><dt><span class="sect2"><a href="#idm139925507288736">Session Daemon (aka Policy Agent)</a></span></dt><dt><span class="sect2"><a href="#idm139925507285040">Session Application</a></span></dt></dl></dd></dl></dd></dl></dd><dt><span class="part"><a href="#idm139925507274016">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="#idm139925506131984">Index</a></span></dt></dl></div><div class="preface"><div class="titlepage"><div><div><h1 class="title"><a id="idm139925508996528"></a>Introduction</h1></div></div></div><p>
</p></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a id="idm139925508098176"></a>Part I. Concepts</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#idm139925511259600">About</a></span></dt><dt><span class="sect1"><a href="#idm139925511073024">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#idm139925511071488">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="#idm139925508076480">Session</a></span></dt><dt><span class="sect1"><a href="#idm139925508073008">Session leader</a></span></dt><dt><span class="sect1"><a href="#idm139925508079088">Seat</a></span></dt></dl></dd><dt><span class="chapter"><a href="#design">3. Design</a></span></dt><dd><dl><dt><span class="sect1"><a href="#idm139925511701296">Session Lifecycle</a></span></dt><dt><span class="sect1"><a href="#idm139925511728192">Expected Usage</a></span></dt><dd><dl><dt><span class="sect2"><a href="#idm139925507318912">Text Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507313712">Graphical Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507306128">System Daemon</a></span></dt><dt><span class="sect2"><a href="#idm139925507302448">Hardware Abstraction Layer</a></span></dt><dt><span class="sect2"><a href="#idm139925507297152">Fast User Switching Agent</a></span></dt><dt><span class="sect2"><a href="#idm139925507288736">Session Daemon (aka Policy Agent)</a></span></dt><dt><span class="sect2"><a href="#idm139925507285040">Session Application</a></span></dt></dl></dd></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="#idm139925511259600">About</a></span></dt><dt><span class="sect1"><a href="#idm139925511073024">Defining the Problem</a></span></dt><dt><span class="sect1"><a href="#idm139925511071488">Relevant art</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925511259600"></a>About</h2></div></div></div><p>
ConsoleKit2 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.
ConsoleKit2 also allows fast switching between open sessions on
the computer.
</p><p>
ConsoleKit2 is a fork of ConsoleKit since it is no longer maintained.
Information on ConsoleKit can be found at:
http://freedesktop.org/wiki/Software/ConsoleKit/
William Jon McCann was the primary maintainer of ConsoleKit and
most of this documentation was written by him for ConsoleKit. It
has been adapted for ConsoleKit2.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925511073024"></a>Defining the Problem</h2></div></div></div><p>
A simple example is two users logging into a computer at the same time.
They may be sharing the same set of hardware for their graphical session,
such as the monitor, keyboard, and mouse. ConsoleKit2 will keep track of
those resouces and which session is active and should have use of that
hardware at a given time.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925511071488"></a>Relevant art</h2></div></div></div><p>
Logind is a Linux daemon providing the similar functionality to ConsoleKit2.
</p></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="terms"></a>Chapter 2. Terminology</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="#idm139925508076480">Session</a></span></dt><dt><span class="sect1"><a href="#idm139925508073008">Session leader</a></span></dt><dt><span class="sect1"><a href="#idm139925508079088">Seat</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925508076480"></a>Session</h2></div></div></div><p>
A session is a collection of all processes that share knowledge of a
secret. In the typical (or ideal) case, these processes all originate
from a single common ancestor.
</p><p>
As an implementation detail, for now, this secret should be stored in
the process environment by the session leader under the name
XDG_SESSION_COOKIE. When and if we are able to take advantage of a
mechanism in the underlying system to store session registration
information - we will. However, such a mechanism is not known at the
present time.
</p><p>
Using an environment variable does have certain advantages. For one,
it is quite easy for a process to opt-out of a Session by simply
unsetting the XDG_SESSION_COOKIE variable.
</p><p>
Limitations of using an environment variable implementation include
not being able to strictly limit visibility of the secret to a particular
process ancestry. So, it is not possible to enforce session boundaries
other than on a per-user basis. For example, we don't yet have a way
to prevent a process from moving between sessions owned by the same
user.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925508073008"></a>Session leader</h2></div></div></div><p>
The session leader is the process that requests that a new session be
opened. It does this by connecting to the D-Bus system bus and using
either org.freedesktop.ConsoleKit.Manager.OpenSession() or
org.freedesktop.ConsoleKit.Manager.OpenSessionWithParameters(). The session
that it registers will remain open until the connection to the system
bus is lost or it calls org.freedesktop.ConsoleKit.Manager.CloseSession().
</p><p>
The session leader is the only process for which CloseSession() will
be allowed.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925508079088"></a>Seat</h2></div></div></div><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>
At the present time, all Sessions that are considered "local" to
a system will be added the the first Seat and every other Session
will be added to its own Seat.
</p><p>
True, hardware, multi-seat capabilities will be added in a later release.
</p></div></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="design"></a>Chapter 3. Design</h2></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="#idm139925511701296">Session Lifecycle</a></span></dt><dt><span class="sect1"><a href="#idm139925511728192">Expected Usage</a></span></dt><dd><dl><dt><span class="sect2"><a href="#idm139925507318912">Text Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507313712">Graphical Login Manager</a></span></dt><dt><span class="sect2"><a href="#idm139925507306128">System Daemon</a></span></dt><dt><span class="sect2"><a href="#idm139925507302448">Hardware Abstraction Layer</a></span></dt><dt><span class="sect2"><a href="#idm139925507297152">Fast User Switching Agent</a></span></dt><dt><span class="sect2"><a href="#idm139925507288736">Session Daemon (aka Policy Agent)</a></span></dt><dt><span class="sect2"><a href="#idm139925507285040">Session Application</a></span></dt></dl></dd></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925511701296"></a>Session Lifecycle</h2></div></div></div><p>
The session leader process is responsible for asking
ConsoleKit2 to open a new session. In this respect, it is
similar to the traditional POSIX user login accounting framework.
In the typical case, the session leader is either an immediate descendant of
a login manager or the login manager itself. The leader makes a connection to the D-Bus system bus and asks ConsoleKit2 to open a session. There are two methods available for opening a session: org.freedesktop.ConsoleKit.Manager.OpenSession() and org.freedesktop.ConsoleKit.Manager.OpenSessionWithParameters().
</p><p>
If the operation succeeds, a secret cookie will be returned to the session leader. The session leader should store this secret in the environment as XDG_SESSION_COOKIE so that it may be shared with its child processes.
</p><p>
At this point the session will be registered with ConsoleKit2 and a particular
set of information about the session will be stored along with it.
</p><p>
ConsoleKit2 will decide, based on the information associated with the session, what Seat the session will be added to.
</p><p>
It will also be determined, based on the same set of information, whether the Session will control the hardware associated with the Seat. In other words, whether the Session will be active for the Seat it is attached to. The exact mechanism for this determination depends on the type of Seat and the capabilities of the host system.
</p><p>
The Session will remain open until the Session Leader disconnects from the D-Bus system bus or calls org.freedesktop.ConsoleKit.Manager.CloseSession(). The session will be removed from its Seat, and deregistered.
</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idm139925511728192"></a>Expected Usage</h2></div></div></div><p>Use of this service will usually follow one of the following patterns:</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507318912"></a>Text Login Manager</h3></div></div></div><p>This pattern operates as the Session Leader for a new Session. This pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To open a new Session.</li><li class="listitem">To set properties for the Session.</li><li class="listitem">To maintain a connection to the D-Bus system bus.</li><li class="listitem">To close the Session at logout.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507313712"></a>Graphical Login Manager</h3></div></div></div><p>In addition to the requirements for the Text Graphical Login Manager, this pattern is typically used to show information about currently open sessions. It needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To determine which Seat it is running on.</li><li class="listitem">To know if the current seat supports session switching.</li><li class="listitem">A list of all sessions on the current Seat.</li><li class="listitem">To know which session is active for the current Seat.</li><li class="listitem">To know when the session active state changes.</li><li class="listitem">To know when sessions are added or removed.</li><li class="listitem">Access to the metadata for any open Session.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507306128"></a>System Daemon</h3></div></div></div><p>This is generally a daemon process running outside of a user session as a special user. This pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To know if any user sessions are open.</li><li class="listitem">To know if the system is currently being used.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507302448"></a>Hardware Abstraction Layer</h3></div></div></div><p>This is a special case of System Daemon that provides catalogs and control mechanisms for hardware devices. In addition to the requirements of System Daemon, this pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To determine what hardware is associated with a Seat.</li><li class="listitem">To determine what Session is active and inactive on a particular Seat.</li><li class="listitem">To know when the session active state changes.</li><li class="listitem">To determine what Session a process belongs to.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507297152"></a>Fast User Switching Agent</h3></div></div></div><p>This is related to the Graphical Login Manager and provides a shortcut to similar functionality. It is usually a tool available in the user session that allows one to quickly switch to another user session. This pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To determine which session it is running in.</li><li class="listitem">To determine which Seat it is running on.</li><li class="listitem">To know if the current seat supports session switching.</li><li class="listitem">A list of all sessions on the current Seat.</li><li class="listitem">Which session is active for the current Seat.</li><li class="listitem">To know when the session active state changes.</li><li class="listitem">Access to the metadata for any open Session.</li><li class="listitem">To know when sessions are added or removed.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507288736"></a>Session Daemon (aka Policy Agent)</h3></div></div></div><p>This is typically a daemon running in a user session that acts on policy only when the session is active. This pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To determine which session it is running in.</li><li class="listitem">To know when the session active state changes.</li></ol></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="idm139925507285040"></a>Session Application</h3></div></div></div><p>This is typically an application running in a user session that may alter its behavior when the session active state changes. This pattern needs:
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">To determine which session it is running in.</li><li class="listitem">To know when the session active state changes.</li></ol></div></div></div></div></div><div class="part"><div class="titlepage"><div><div><h1 class="title"><a id="idm139925507274016"></a>Part II. Reference</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><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"><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"><div></div><p>
ConsoleKit2 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><strong>Table of Contents</strong></p><dl class="toc"><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"><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 class="link" href="#Manager.Restart">Restart</a>()
<a class="link" href="#Manager.CanRestart">CanRestart</a>(out'b'can_restart)
<a class="link" href="#Manager.Stop">Stop</a>()
<a class="link" href="#Manager.CanStop">CanStop</a>(out'b'can_stop)
<a class="link" href="#Manager.Reboot">Reboot</a>(in'b'policykit_interactivity)
<a class="link" href="#Manager.CanReboot">CanReboot</a>(out's'can_reboot)
<a class="link" href="#Manager.PowerOff">PowerOff</a>(in'b'policykit_interactivity)
<a class="link" href="#Manager.CanPowerOff">CanPowerOff</a>(out's'can_poweroff)
<a class="link" href="#Manager.Suspend">Suspend</a>(in'b'policykit_interactivity)
<a class="link" href="#Manager.CanSuspend">CanSuspend</a>(out's'can_suspend)
<a class="link" href="#Manager.Hibernate">Hibernate</a>(in'b'policykit_interactivity)
<a class="link" href="#Manager.CanHibernate">CanHibernate</a>(out's'can_hibernate)
<a class="link" href="#Manager.HybridSleep">HybridSleep</a>(in'b'policykit_interactivity)
<a class="link" href="#Manager.CanHybridSleep">CanHybridSleep</a>(out's'can_hybridsleep)
<a class="link" href="#Manager.Inhibit">Inhibit</a>(in's'what,
in's'who,
in's'why,
in's'mode,
out'h'fd)
<a class="link" href="#Manager.ListInhibitors">ListInhibitors</a>(out'a(ssssuu)'inhibitors)
<a class="link" href="#Manager.OpenSession">OpenSession</a>(out's'cookie)
<a class="link" href="#Manager.OpenSessionWithParameters">OpenSessionWithParameters</a>(in'a(sv)'parameters,
out's'cookie)
<a class="link" href="#Manager.CloseSession">CloseSession</a>(in's'cookie,
out'b'result)
<a class="link" href="#Manager.GetSeats">GetSeats</a>(out'ao'seats)
<a class="link" href="#Manager.GetSessions">GetSessions</a>(out'ao'sessions)
<a class="link" href="#Manager.GetSessionForCookie">GetSessionForCookie</a>(in's'cookie,
out'o'ssid)
<a class="link" href="#Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</a>(in'u'pid,
out'o'ssid)
<a class="link" href="#Manager.GetCurrentSession">GetCurrentSession</a>(out'o'ssid)
<a class="link" href="#Manager.GetSessionsForUnixUser">GetSessionsForUnixUser</a>(in'u'uid,
out'ao'sessions)
<a class="link" href="#Manager.GetSessionsForUser">GetSessionsForUser</a>(in'u'uid,
out'ao'sessions)
<a class="link" href="#Manager.GetSystemIdleHint">GetSystemIdleHint</a>(out'b'idle_hint)
<a class="link" href="#Manager.GetSystemIdleSinceHint">GetSystemIdleSinceHint</a>(out's'iso8601_datetime)
</pre></div><div class="refsect1"><a id="idm139925507193248"></a><h2>Signals</h2><pre class="synopsis"><a class="link" href="#Manager::SeatAdded">SeatAdded</a>('o'sid)
<a class="link" href="#Manager::SeatRemoved">SeatRemoved</a>('o'sid)
<a class="link" href="#Manager::SystemIdleHintChanged">SystemIdleHintChanged</a>('b'hint)
<a class="link" href="#Manager::PrepareForShutdown">PrepareForShutdown</a>('b'active)
<a class="link" href="#Manager::PrepareForSleep">PrepareForSleep</a>('b'active)
</pre></div><div class="refsect1"><a id="idm139925507188384"></a><h2>Implemented Interfaces</h2><p>
Objects implementing org.freedesktop.ConsoleKit.Manager also implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1"><a id="idm139925507186576"></a><h2>Description</h2><p></p></div><div class="refsect1"><a id="idm139925507185072"></a><h2>Details</h2><div class="refsect2"><a id="idm139925507183952"></a><h3><a id="Manager.Restart"></a>Restart ()</h3><a id="idm139925507182960" class="indexterm"></a><pre class="programlisting">Restart ()</pre><p>This method initiates a request to restart (ie. reboot) the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p></div><div class="refsect2"><a id="idm139925507180368"></a><h3><a id="Manager.CanRestart"></a>CanRestart ()</h3><a id="idm139925507179376" class="indexterm"></a><pre class="programlisting">CanRestart (out'b'can_restart)</pre><p>This method returns whether the user is authorized to restart the computer system.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_restart</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507175264"></a><h3><a id="Manager.Stop"></a>Stop ()</h3><a id="idm139925507174272" class="indexterm"></a><pre class="programlisting">Stop ()</pre><p>This method initiates a request to stop (ie. shutdown) the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p></div><div class="refsect2"><a id="idm139925507171584"></a><h3><a id="Manager.CanStop"></a>CanStop ()</h3><a id="idm139925507170592" class="indexterm"></a><pre class="programlisting">CanStop (out'b'can_stop)</pre><p>This method returns whether the user is authorized to shutdown the computer system.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_stop</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507166480"></a><h3><a id="Manager.Reboot"></a>Reboot ()</h3><a id="idm139925507165488" class="indexterm"></a><pre class="programlisting">Reboot (in'b'policykit_interactivity)</pre><p>This method emulates the logind implementation. This method initiates a request to reboot the computer system.
</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>policykit_interactivity</code></em>:</span></dt><dd>policykit_interactivity determines whether PolicyKit (if enabled) should interactively ask the user for authentication credentials if it needs to.</dd></dl></div></div><div class="refsect2"><a id="idm139925507160576"></a><h3><a id="Manager.CanReboot"></a>CanReboot ()</h3><a id="idm139925507159584" class="indexterm"></a><pre class="programlisting">CanReboot (out's'can_reboot)</pre><p>This method emulates the logind implementation.</p><p>Returns whether the system supports rebooting and whether the calling user is eligible to reboot the system.</p><p>Returns one of "na", "yes", "no" or "challenge".</p><p>If "na" is returned rebooting is not available because of hardware support.</p><p>If "yes" is returned rebooting is supported and the user may suspend without further authentication.</p><p>If "no" is returned rebooting is available but the user is not allowed to reboot.</p><p>If "challenge" is returned rebooting is available, but only after authorization.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_reboot</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507152352"></a><h3><a id="Manager.PowerOff"></a>PowerOff ()</h3><a id="idm139925507151360" class="indexterm"></a><pre class="programlisting">PowerOff (in'b'policykit_interactivity)</pre><p>This method initiates a request to shutdown the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>policykit_interactivity</code></em>:</span></dt><dd>policykit_interactivity determines whether PolicyKit (if enabled) should interactively ask the user for authentication credentials if it needs to.</dd></dl></div></div><div class="refsect2"><a id="idm139925507146592"></a><h3><a id="Manager.CanPowerOff"></a>CanPowerOff ()</h3><a id="idm139925507145600" class="indexterm"></a><pre class="programlisting">CanPowerOff (out's'can_poweroff)</pre><p>This method emulates the logind implementation.</p><p>Returns whether the system supports shutdown and whether the calling user is eligible to shutdown the system.</p><p>Returns one of "na", "yes", "no" or "challenge".</p><p>If "na" is returned shutdown is not available because of hardware support.</p><p>If "yes" is returned shutdown is supported and the user may hibernate without further authentication.</p><p>If "no" is returned shutdown is available but the user is not allowed to shutdown.</p><p>If "challenge" is returned shutdown is available, but only after authorization.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_poweroff</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507138368"></a><h3><a id="Manager.Suspend"></a>Suspend ()</h3><a id="idm139925507137376" class="indexterm"></a><pre class="programlisting">Suspend (in'b'policykit_interactivity)</pre><p>This method initiates a request to suspend the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>policykit_interactivity</code></em>:</span></dt><dd>policykit_interactivity determines whether PolicyKit (if enabled) should interactively ask the user for authentication credentials if it needs to.</dd></dl></div></div><div class="refsect2"><a id="idm139925507132528"></a><h3><a id="Manager.CanSuspend"></a>CanSuspend ()</h3><a id="idm139925507131536" class="indexterm"></a><pre class="programlisting">CanSuspend (out's'can_suspend)</pre><p>This method emulates the logind implementation.</p><p>Returns whether the system supports suspending and whether the calling user is eligible to hibernate the system.</p><p>Returns one of "na", "yes", "no" or "challenge".</p><p>If "na" is returned suspending is not available because of hardware support.</p><p>If "yes" is returned suspending is supported and the user may suspend without further authentication.</p><p>If "no" is returned suspending is available but the user is not allowed to suspend.</p><p>If "challenge" is returned suspending is available, but only after authorization.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><p>Since 0.9.1</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_suspend</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507124304"></a><h3><a id="Manager.Hibernate"></a>Hibernate ()</h3><a id="idm139925507123312" class="indexterm"></a><pre class="programlisting">Hibernate (in'b'policykit_interactivity)</pre><p>This method initiates a request to hibernate the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>policykit_interactivity</code></em>:</span></dt><dd>policykit_interactivity determines whether PolicyKit (if enabled) should interactively ask the user for authentication credentials if it needs to.</dd></dl></div></div><div class="refsect2"><a id="idm139925507118464"></a><h3><a id="Manager.CanHibernate"></a>CanHibernate ()</h3><a id="idm139925507117472" class="indexterm"></a><pre class="programlisting">CanHibernate (out's'can_hibernate)</pre><p>This method emulates the logind implementation.</p><p>Returns whether the system supports hibernation and whether the calling user is eligible to hibernate the system.</p><p>Returns one of "na", "yes", "no" or "challenge".</p><p>If "na" is returned hibernation is not available because of hardware support.</p><p>If "yes" is returned hibernation is supported and the user may hibernate without further authentication.</p><p>If "no" is returned hibernation is available but the user is not allowed to hibernate.</p><p>If "challenge" is returned hibernation is available, but only after authorization.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><p>Since 0.9.1</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_hibernate</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507110224"></a><h3><a id="Manager.HybridSleep"></a>HybridSleep ()</h3><a id="idm139925507109232" class="indexterm"></a><pre class="programlisting">HybridSleep (in'b'policykit_interactivity)</pre><p>This method initiates a request to hybrid sleep (suspend + hibernate) the computer system.</p><p>May fail with: CK_MANAGER_ERROR_INHIBITED, CK_MANAGER_ERROR_INSUFFICIENT_PERMISSION, CK_MANAGER_ERROR_AUTHORIZATION_REQUIRED,
CK_MANAGER_ERROR_GENERAL, CK_MANAGER_ERROR_BUSY</p><p>Since 0.9.2</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>policykit_interactivity</code></em>:</span></dt><dd>policykit_interactivity determines whether PolicyKit (if enabled) should interactively ask the user for authentication credentials if it needs to.</dd></dl></div></div><div class="refsect2"><a id="idm139925507104352"></a><h3><a id="Manager.CanHybridSleep"></a>CanHybridSleep ()</h3><a id="idm139925507103360" class="indexterm"></a><pre class="programlisting">CanHybridSleep (out's'can_hybridsleep)</pre><p>This method emulates the logind implementation.</p><p>Returns whether the system supports hybrid sleep (suspend + hibernate) and whether the calling user is eligible to hybrid sleep the system.</p><p>Returns one of "na", "yes", "no" or "challenge".</p><p>If "na" is returned hybrid sleeping is not available because of hardware support.</p><p>If "yes" is returned hybrid sleeping is supported and the user may hybrid sleep without further authentication.</p><p>If "no" is returned hybrid sleeping is available but the user is not allowed to hybrid sleep.</p><p>If "challenge" is returned hybrid sleeping is available, but only after authorization.</p><p>May fail with: CK_MANAGER_ERROR_FAILED if polkit is used and fails checking authorization.</p><p>Since 0.9.1</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_hybridsleep</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507096064"></a><h3><a id="Manager.Inhibit"></a>Inhibit ()</h3><a id="idm139925507095072" class="indexterm"></a><pre class="programlisting">Inhibit (in's'what,
in's'who,
in's'why,
in's'mode,
out'h'fd)</pre><p>Inhibit locks are named pipes used by ConsoleKit2 to prevent the system from performing actions such as suspending, restarting, or going idle. There are various reasons and application would like to prevent one or more of these functions such as a movie player preventing the screen saving from activating or a package manager ensuring an application installs before allowing the computer to shutdown.</p><p>Note: Each application can have only one lock open at any given time. Multiple applications can hold locks to the same thing, for example a media player application and a cd burning application can both prevent the system from being marked idle.</p><p>May fail with: CK_MANAGER_ERROR_INVALID_INPUT, CK_MANAGER_ERROR_OOM, CK_MANAGER_ERROR_GENERAL</p><p>Since 0.9.0</p><p>See this simple example:
</p><div class="informalexample"><pre class="programlisting">
DBusConnection *bus_connection;
DBusMessage *message = NULL, *reply = NULL;
DBusError error;
gint fd = -1;
const char *what = "shutdown:sleep";
const char *who = "Xfburn";
const char *why = "Burning a DVD, interrupting now will ruin the DVD.";
const char *mode = "block";
message = dbus_message_new_method_call ("org.freedesktop.ConsoleKit",
"/org/freedesktop/ConsoleKit/Manager",
"org.freedesktop.ConsoleKit.Manager",
"Inhibit");
if (!message)
{
g_warning ("Unable to call Inhibit()");
return fd;
}
if (!dbus_message_append_args (message,
DBUS_TYPE_STRING, &what,
DBUS_TYPE_STRING, &who,
DBUS_TYPE_STRING, &why,
DBUS_TYPE_STRING, &mode,
DBUS_TYPE_INVALID))
{
g_warning ("Unable to call Inhibit()");
dbus_message_unref (message);
return fd;
}
reply = dbus_connection_send_with_reply_and_block (bus_connection, message, -1, &error);
if (!reply)
{
g_warning ("Unable to inhibit: %s", error.message);
dbus_message_unref (message);
return fd;
}
if (!dbus_message_get_args (reply, &error,
DBUS_TYPE_UNIX_FD, &fd,
DBUS_TYPE_INVALID))
{
g_warning ("Inhibit() reply parsing failed: %s", error.message);
}
dbus_message_unref (message);
dbus_message_unref (reply);
dbus_error_free (&error);
return fd;
</pre></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>what</code></em>:</span></dt><dd>What is a colon-separated list of lock types. The list of lock types are: shutdown, sleep, idle, handle-power-key, handle-suspend-key, handle-hibernate-key. Example: "shutdown:idle"</dd><dt><span class="term"><em class="parameter"><code>who</code></em>:</span></dt><dd>Who is a human-readable, descriptive string of who is taking the lock. Example: "Xfburn"</dd><dt><span class="term"><em class="parameter"><code>why</code></em>:</span></dt><dd>Why is a human-readable, descriptive string of why the program is taking the lock. Example: "Burning a DVD, interrupting now will ruin the DVD."</dd><dt><span class="term"><em class="parameter"><code>mode</code></em>:</span></dt><dd>Mode is either "block" or "delay" which determines if the inhibit lock is mandatory or should just delay the operation to a certain maximum time.</dd><dt><span class="term"><em class="parameter"><code>fd</code></em>:</span></dt><dd>Returns a file descriptor that encapsulates the lock, or -1 on failure. As soon as the file descriptor is closed (and all its duplicates) the lock is automatically released. If the client dies while the lock is taken it is automatically closed and the lock is released.</dd></dl></div></div><div class="refsect2"><a id="idm139925507078768"></a><h3><a id="Manager.ListInhibitors"></a>ListInhibitors ()</h3><a id="idm139925507077776" class="indexterm"></a><pre class="programlisting">ListInhibitors (out'a(ssssuu)'inhibitors)</pre><p>This method emulates the logind implementation.</p><p>Returns the current list of inhibitors, an array of strings representing the what, who, why, mode, and two unsigned int32 representing the user ID and process ID.</p><p>May fail with: CK_MANAGER_ERROR_GENERAL or CK_MANAGER_ERROR_NOTHING_INHIBITED.</p><p>Since 0.9.5</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>inhibitors</code></em>:</span></dt><dd></dd></dl></div></div><div class="refsect2"><a id="idm139925507072832"></a><h3><a id="Manager.OpenSession"></a>OpenSession ()</h3><a id="idm139925507071840" class="indexterm"></a><pre class="programlisting">OpenSession (out's'cookie)</pre><p>This method requests that a new <a class="link" 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 class="link" 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>May fail with: CK_MANAGER_ERROR_GENERAL</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 class="variablelist"><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 class="link" href="#Manager.OpenSessionWithParameters"><code class="function">OpenSessionWithParameters()</code></a></p></div><div class="refsect2"><a id="idm139925507260128"></a><h3><a id="Manager.OpenSessionWithParameters"></a>OpenSessionWithParameters ()</h3><a id="idm139925507258960" class="indexterm"></a><pre class="programlisting">OpenSessionWithParameters (in'a(sv)'parameters,
out's'cookie)</pre><p>This method requests that a new <a class="link" 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 class="link" 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 class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> properties for a list of valid parameters.</p><p>May fail with: CK_MANAGER_ERROR_GENERAL</p><div class="variablelist"><dl class="variablelist"><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><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Permissions</h3><p class="permission">This method is restricted to privileged users by D-Bus policy.</p></div><p>
See also:
<a class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">org.freedesktop.ConsoleKit.Session</a></p></div><div class="refsect2"><a id="idm139925507040000"></a><h3><a id="Manager.CloseSession"></a>CloseSession ()</h3><a id="idm139925507039008" class="indexterm"></a><pre class="programlisting">CloseSession (in's'cookie,
out'b'result)</pre><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 class="variablelist"><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><div class="refsect2"><a id="idm139925507033520"></a><h3><a id="Manager.GetSeats"></a>GetSeats ()</h3><a id="idm139925507032528" class="indexterm"></a><pre class="programlisting">GetSeats (out'ao'seats)</pre><p>This gets a list of all the <a class="link" 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 class="link" href="#Seat" title="org.freedesktop.ConsoleKit.Seat">Seat</a> interface.</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p></div><div class="refsect2"><a id="idm139925507026400"></a><h3><a id="Manager.GetSessions"></a>GetSessions ()</h3><a id="idm139925507025408" class="indexterm"></a><pre class="programlisting">GetSessions (out'ao'sessions)</pre><p>This gets a list of all the <a class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a>
that are currently present on the system.</p><p>Each Session ID is an D-Bus object path for the object that implements the
<a class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><p>
See also:
<a class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">org.freedesktop.ConsoleKit.Session</a></p></div><div class="refsect2"><a id="idm139925507019280"></a><h3><a id="Manager.GetSessionForCookie"></a>GetSessionForCookie ()</h3><a id="idm139925507018288" class="indexterm"></a><pre class="programlisting">GetSessionForCookie (in's'cookie,
out'o'ssid)</pre><p>Returns the session ID that is associated with the specified cookie.
</p><p>May fail with: CK_MANAGER_ERROR_GENERAL</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925507012896"></a><h3><a id="Manager.GetSessionForUnixProcess"></a>GetSessionForUnixProcess ()</h3><a id="idm139925507011904" class="indexterm"></a><pre class="programlisting">GetSessionForUnixProcess (in'u'pid,
out'o'ssid)</pre><p>Attempts to determine the session ID for the specified
POSIX process ID (pid).
</p><p>May fail with: CK_MANAGER_ERROR_GENERAL</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925507006496"></a><h3><a id="Manager.GetCurrentSession"></a>GetCurrentSession ()</h3><a id="idm139925507005504" class="indexterm"></a><pre class="programlisting">GetCurrentSession (out'o'ssid)</pre><p>Attempts to determine the session ID that the caller belongs to.
</p><p>May fail with: CK_MANAGER_ERROR_GENERAL</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 class="variablelist"><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><div class="refsect2"><a id="idm139925507000128"></a><h3><a id="Manager.GetSessionsForUnixUser"></a>GetSessionsForUnixUser ()</h3><a id="idm139925506999136" class="indexterm"></a><pre class="programlisting">GetSessionsForUnixUser (in'u'uid,
out'ao'sessions)</pre><p>This gets a list of all the <a class="link" 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 class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925506992416"></a><h3><a id="Manager.GetSessionsForUser"></a>GetSessionsForUser ()</h3><a id="idm139925506991424" class="indexterm"></a><pre class="programlisting">GetSessionsForUser (in'u'uid,
out'ao'sessions)</pre><p>This gets a list of all the <a class="link" 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 class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Manager.GetSessionsForUnixUser"><code class="function">GetSessionsForUnixUser</code></a>
instead.</p></div></div><div class="refsect2"><a id="idm139925506982352"></a><h3><a id="Manager.GetSystemIdleHint"></a>GetSystemIdleHint ()</h3><a id="idm139925506981360" class="indexterm"></a><pre class="programlisting">GetSystemIdleHint (out'b'idle_hint)</pre><p>Returns TRUE if the <a class="link" 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 class="variablelist"><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><div class="refsect2"><a id="idm139925506976608"></a><h3><a id="Manager.GetSystemIdleSinceHint"></a>GetSystemIdleSinceHint ()</h3><a id="idm139925506975616" class="indexterm"></a><pre class="programlisting">GetSystemIdleSinceHint (out's'iso8601_datetime)</pre><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 class="variablelist"><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><div class="refsect1"><a id="idm139925506971696"></a><h2>Signal Details</h2><div class="refsect2"><a id="idm139925506970576"></a><h3><a id="Manager::SeatAdded"></a>The SeatAdded signal</h3><a id="idm139925506969584" class="indexterm"></a><pre class="programlisting">SeatAdded ('o'sid)</pre><p>Emitted when a Seat has been added to the system.
</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925506965856"></a><h3><a id="Manager::SeatRemoved"></a>The SeatRemoved signal</h3><a id="idm139925506964864" class="indexterm"></a><pre class="programlisting">SeatRemoved ('o'sid)</pre><p>Emitted when a Seat has been removed from the system.
</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925506961136"></a><h3><a id="Manager::SystemIdleHintChanged"></a>The SystemIdleHintChanged signal</h3><a id="idm139925506960144" class="indexterm"></a><pre class="programlisting">SystemIdleHintChanged ('b'hint)</pre><p>Emitted when the value of the system-idle-hint has changed.
</p><div class="variablelist"><dl class="variablelist"><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="refsect2"><a id="idm139925506956416"></a><h3><a id="Manager::PrepareForShutdown"></a>The PrepareForShutdown signal</h3><a id="idm139925506955424" class="indexterm"></a><pre class="programlisting">PrepareForShutdown ('b'active)</pre><p>Emitted when the system is halting (active = TRUE). If
successful there will not be a FALSE signal emitted since
the system will poweroff or reboot. It will emit a FALSE
signal if the shutdown operation failed.
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>active</code></em>:</span></dt><dd>TRUE when the system is starting to halt.</dd></dl></div></div><div class="refsect2"><a id="idm139925506951472"></a><h3><a id="Manager::PrepareForSleep"></a>The PrepareForSleep signal</h3><a id="idm139925506950480" class="indexterm"></a><pre class="programlisting">PrepareForSleep ('b'active)</pre><p>Emitted when the system is starting the sleep process.
It will emit with an active = FALSE when resuming from sleep
or if the sleep operation failed.
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>active</code></em>:</span></dt><dd>TRUE when starting to sleep.</dd></dl></div></div></div></div><div class="refentry"><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 class="link" href="#Seat.GetId">GetId</a>(out'o'sid)
<a class="link" href="#Seat.GetSessions">GetSessions</a>(out'ao'sessions)
<a class="link" href="#Seat.GetDevices">GetDevices</a>(out'a(ss)'devices)
<a class="link" href="#Seat.GetActiveSession">GetActiveSession</a>(out'o'ssid)
<a class="link" href="#Seat.CanActivateSessions">CanActivateSessions</a>(out'b'can_activate)
<a class="link" href="#Seat.ActivateSession">ActivateSession</a>(in'o'ssid)
</pre></div><div class="refsect1"><a id="idm139925506681920"></a><h2>Signals</h2><pre class="synopsis"><a class="link" href="#Seat::ActiveSessionChanged">ActiveSessionChanged</a>('o'ssid)
<a class="link" href="#Seat::SessionAdded">SessionAdded</a>('o'ssid)
<a class="link" href="#Seat::SessionRemoved">SessionRemoved</a>('o'ssid)
<a class="link" href="#Seat::DeviceAdded">DeviceAdded</a>('(ss)'device)
<a class="link" href="#Seat::DeviceRemoved">DeviceRemoved</a>('(ss)'device)
</pre></div><div class="refsect1"><a id="idm139925506677056"></a><h2>Implemented Interfaces</h2><p>
Objects implementing org.freedesktop.ConsoleKit.Seat also implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1"><a id="idm139925506675248"></a><h2>Description</h2><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></div><div class="refsect1"><a id="idm139925506673584"></a><h2>Details</h2><div class="refsect2"><a id="idm139925506672464"></a><h3><a id="Seat.GetId"></a>GetId ()</h3><a id="idm139925506671472" class="indexterm"></a><pre class="programlisting">GetId (out'o'sid)</pre><p>Returns the ID for Seat.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506667824"></a><h3><a id="Seat.GetSessions"></a>GetSessions ()</h3><a id="idm139925506666832" class="indexterm"></a><pre class="programlisting">GetSessions (out'ao'sessions)</pre><p>This gets a list of all the <a class="link" 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 class="link" href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div></div><div class="refsect2"><a id="idm139925506661456"></a><h3><a id="Seat.GetDevices"></a>GetDevices ()</h3><a id="idm139925506660464" class="indexterm"></a><pre class="programlisting">GetDevices (out'a(ss)'devices)</pre><p>This gets a list of all the devices
that are currently associated with this seat.</p><p>Each device is an D-Bus structure that represents
the device type and the device id.
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>devices</code></em>:</span></dt><dd>an array of devices</dd></dl></div></div><div class="refsect2"><a id="idm139925506656192"></a><h3><a id="Seat.GetActiveSession"></a>GetActiveSession ()</h3><a id="idm139925506655200" class="indexterm"></a><pre class="programlisting">GetActiveSession (out'o'ssid)</pre><p>Gets the Session ID that is currently active on this Seat.</p><p>Fails with CK_SEAT_ERROR_NO_ACTIVE_SESSION if there is no active session.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506651072"></a><h3><a id="Seat.CanActivateSessions"></a>CanActivateSessions ()</h3><a id="idm139925506650080" class="indexterm"></a><pre class="programlisting">CanActivateSessions (out'b'can_activate)</pre><p>Used to determine whether the seat supports session activation.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>can_activate</code></em>:</span></dt><dd>TRUE if seat supports session activation</dd></dl></div></div><div class="refsect2"><a id="idm139925506646480"></a><h3><a id="Seat.ActivateSession"></a>ActivateSession ()</h3><a id="idm139925506645488" class="indexterm"></a><pre class="programlisting">ActivateSession (in'o'ssid)</pre><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><p>May fail with: CK_SEAT_ERROR_FAILED, CK_SEAT_ERROR_ALREADY_ACTIVE, CK_SEAT_ERROR_NOT_SUPPORTED</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><p>
See also:
<a class="link" href="#Session.Activate"><code class="function">Activate()</code></a></p></div></div><div class="refsect1"><a id="idm139925506639856"></a><h2>Signal Details</h2><div class="refsect2"><a id="idm139925506638736"></a><h3><a id="Seat::ActiveSessionChanged"></a>The ActiveSessionChanged signal</h3><a id="idm139925506637744" class="indexterm"></a><pre class="programlisting">ActiveSessionChanged ('o'ssid)</pre><p>Emitted when the active session has changed.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506634096"></a><h3><a id="Seat::SessionAdded"></a>The SessionAdded signal</h3><a id="idm139925506633104" class="indexterm"></a><pre class="programlisting">SessionAdded ('o'ssid)</pre><p>Emitted when a session has been added to the seat.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506629456"></a><h3><a id="Seat::SessionRemoved"></a>The SessionRemoved signal</h3><a id="idm139925506628464" class="indexterm"></a><pre class="programlisting">SessionRemoved ('o'ssid)</pre><p>Emitted when a session has been removed from the seat.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506624816"></a><h3><a id="Seat::DeviceAdded"></a>The DeviceAdded signal</h3><a id="idm139925506623824" class="indexterm"></a><pre class="programlisting">DeviceAdded ('(ss)'device)</pre><p>Emitted when a device has been associated with the seat.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>device</code></em>:</span></dt><dd>Device structure</dd></dl></div></div><div class="refsect2"><a id="idm139925506620096"></a><h3><a id="Seat::DeviceRemoved"></a>The DeviceRemoved signal</h3><a id="idm139925506619104" class="indexterm"></a><pre class="programlisting">DeviceRemoved ('(ss)'device)</pre><p>Emitted when a device has been dissociated from the seat.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>device</code></em>:</span></dt><dd>Device structure</dd></dl></div></div></div></div><div class="refentry"><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 class="link" href="#Session.GetId">GetId</a>(out'o'ssid)
<a class="link" href="#Session.GetSeatId">GetSeatId</a>(out'o'sid)
<a class="link" href="#Session.GetSessionType">GetSessionType</a>(out's'type)
<a class="link" href="#Session.GetUser">GetUser</a>(out'u'uid)
<a class="link" href="#Session.GetUnixUser">GetUnixUser</a>(out'u'uid)
<a class="link" href="#Session.GetXDGRuntimeDir">GetXDGRuntimeDir</a>(out's'xdg_runtime_dir)
<a class="link" href="#Session.GetX11Display">GetX11Display</a>(out's'display)
<a class="link" href="#Session.GetX11DisplayDevice">GetX11DisplayDevice</a>(out's'x11_display_device)
<a class="link" href="#Session.GetDisplayDevice">GetDisplayDevice</a>(out's'display_device)
<a class="link" href="#Session.GetRemoteHostName">GetRemoteHostName</a>(out's'remote_host_name)
<a class="link" href="#Session.GetLoginSessionId">GetLoginSessionId</a>(out's'login_session_id)
<a class="link" href="#Session.IsActive">IsActive</a>(out'b'active)
<a class="link" href="#Session.IsLocal">IsLocal</a>(out'b'local)
<a class="link" href="#Session.GetCreationTime">GetCreationTime</a>(out's'iso8601_datetime)
<a class="link" href="#Session.Activate">Activate</a>()
<a class="link" href="#Session.Lock">Lock</a>()
<a class="link" href="#Session.Unlock">Unlock</a>()
<a class="link" href="#Session.GetIdleHint">GetIdleHint</a>(out'b'idle_hint)
<a class="link" href="#Session.GetIdleSinceHint">GetIdleSinceHint</a>(out's'iso8601_datetime)
<a class="link" href="#Session.SetIdleHint">SetIdleHint</a>(in'b'idle_hint)
</pre></div><div class="refsect1"><a id="idm139925506517696"></a><h2>Signals</h2><pre class="synopsis"><a class="link" href="#Session::ActiveChanged">ActiveChanged</a>('b'is_active)
<a class="link" href="#Session::IdleHintChanged">IdleHintChanged</a>('b'hint)
<a class="link" href="#Session::Lock">Lock</a>()
<a class="link" href="#Session::Unlock">Unlock</a>()
</pre></div><div class="refsect1"><a id="idm139925506513456"></a><h2>Implemented Interfaces</h2><p>
Objects implementing org.freedesktop.ConsoleKit.Session also implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p></div><div class="refsect1"><a id="idm139925506511648"></a><h2>Properties</h2><pre class="synopsis"><a class="link" href="#Session:unix-user">'unix-user'</a>read'u'
<a class="link" href="#Session:user">'user'</a>read'u'
<a class="link" href="#Session:session-type">'session-type'</a>readwrite's'
<a class="link" href="#Session:remote-host-name">'remote-host-name'</a>read's'
<a class="link" href="#Session:display-device">'display-device'</a>read's'
<a class="link" href="#Session:x11-display">'x11-display'</a>read's'
<a class="link" href="#Session:x11-display-device">'x11-display-device'</a>read's'
<a class="link" href="#Session:active">'active'</a>readwrite'b'
<a class="link" href="#Session:is-local">'is-local'</a>read'b'
<a class="link" href="#Session:idle-hint">'idle-hint'</a>readwrite'b'
</pre></div><div class="refsect1"><a id="idm139925506503664"></a><h2>Description</h2><p>Session objects represent and store information
related to a user session.
</p><p>The properties associated with the Session
specifically refer to the properties of the "session leader".
</p></div><div class="refsect1"><a id="idm139925506501520"></a><h2>Details</h2><div class="refsect2"><a id="idm139925506500400"></a><h3><a id="Session.GetId"></a>GetId ()</h3><a id="idm139925506499408" class="indexterm"></a><pre class="programlisting">GetId (out'o'ssid)</pre><p>Returns the ID for Session.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506495888"></a><h3><a id="Session.GetSeatId"></a>GetSeatId ()</h3><a id="idm139925506494896" class="indexterm"></a><pre class="programlisting">GetSeatId (out'o'sid)</pre><p>Returns the ID for the Seat the Session is
attached to.</p><p>May fail with CK_SESSION_ERROR_FAILED if the session isn't attached to a seat</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div><p>
See also:
<a class="link" href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p></div><div class="refsect2"><a id="idm139925506490144"></a><h3><a id="Session.GetSessionType"></a>GetSessionType ()</h3><a id="idm139925506489152" class="indexterm"></a><pre class="programlisting">GetSessionType (out's'type)</pre><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 class="variablelist"><dt><span class="term"><em class="parameter"><code>type</code></em>:</span></dt><dd>Session type</dd></dl></div><p>
See also:
<a class="link" href="#Session:session-type"><code class="literal">session-type</code></a></p></div><div class="refsect2"><a id="idm139925506483840"></a><h3><a id="Session.GetUser"></a>GetUser ()</h3><a id="idm139925506482848" class="indexterm"></a><pre class="programlisting">GetUser (out'u'uid)</pre><p>Returns the user that the session belongs to.</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Session.GetUnixUser"><code class="function">GetUnixUser</code></a>
instead.</p></div><p>
See also:
<a class="link" href="#Session:user"><code class="literal">user</code></a></p></div><div class="refsect2"><a id="idm139925506475856"></a><h3><a id="Session.GetUnixUser"></a>GetUnixUser ()</h3><a id="idm139925506474864" class="indexterm"></a><pre class="programlisting">GetUnixUser (out'u'uid)</pre><p>Returns the POSIX user ID that the session belongs to.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>POSIX User ID</dd></dl></div><p>
See also:
<a class="link" href="#Session:unix-user"><code class="literal">unix-user</code></a></p></div><div class="refsect2"><a id="idm139925506470224"></a><h3><a id="Session.GetXDGRuntimeDir"></a>GetXDGRuntimeDir ()</h3><a id="idm139925506469232" class="indexterm"></a><pre class="programlisting">GetXDGRuntimeDir (out's'xdg_runtime_dir)</pre><p>Returns the XDG_RUNTIME_DIR location of the session.
The XDG_RUNTIME_DIR is the same for all sessions of the same user and will be automatically
removed once the last session of the user is closed.</p><p>May fail with: CK_SESSION_ERROR_FAILED if it failed to create a runtime dir for the user (such as root).</p><p>Since 1.1.0</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>xdg_runtime_dir</code></em>:</span></dt><dd>XDG_RUNTIME_DIR</dd></dl></div></div><div class="refsect2"><a id="idm139925506464592"></a><h3><a id="Session.GetX11Display"></a>GetX11Display ()</h3><a id="idm139925506463600" class="indexterm"></a><pre class="programlisting">GetX11Display (out's'display)</pre><p>Returns the value of the X11 DISPLAY for this session
if one is present.</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Session:x11-display"><code class="literal">x11-display</code></a></p></div><div class="refsect2"><a id="idm139925506458864"></a><h3><a id="Session.GetX11DisplayDevice"></a>GetX11DisplayDevice ()</h3><a id="idm139925506457872" class="indexterm"></a><pre class="programlisting">GetX11DisplayDevice (out's'x11_display_device)</pre><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 class="variablelist"><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 class="link" href="#Session:x11-display-device"><code class="literal">x11-display-device</code></a></p></div><div class="refsect2"><a id="idm139925506453040"></a><h3><a id="Session.GetDisplayDevice"></a>GetDisplayDevice ()</h3><a id="idm139925506452048" class="indexterm"></a><pre class="programlisting">GetDisplayDevice (out's'display_device)</pre><p>Returns the value of the display device (aka TTY) that the
session is connected to.</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Session:display-device"><code class="literal">display-device</code></a></p></div><div class="refsect2"><a id="idm139925506447296"></a><h3><a id="Session.GetRemoteHostName"></a>GetRemoteHostName ()</h3><a id="idm139925506446304" class="indexterm"></a><pre class="programlisting">GetRemoteHostName (out's'remote_host_name)</pre><p>Returns the value of the remote host name for the session.
</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Session:remote-host-name"><code class="literal">remote-host-name</code></a></p></div><div class="refsect2"><a id="idm139925506441584"></a><h3><a id="Session.GetLoginSessionId"></a>GetLoginSessionId ()</h3><a id="idm139925506440592" class="indexterm"></a><pre class="programlisting">GetLoginSessionId (out's'login_session_id)</pre><p>Returns the value of the login session ID that the
underlying system uses to enforce session boundaries. If there is no login session ID
set then this value is an empty string.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>login_session_id</code></em>:</span></dt><dd>The value of the native system login session ID</dd></dl></div></div><div class="refsect2"><a id="idm139925506436864"></a><h3><a id="Session.IsActive"></a>IsActive ()</h3><a id="idm139925506435872" class="indexterm"></a><pre class="programlisting">IsActive (out'b'active)</pre><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 class="variablelist"><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 class="link" href="#Session:active"><code class="literal">active</code></a></p></div><div class="refsect2"><a id="idm139925506430656"></a><h3><a id="Session.IsLocal"></a>IsLocal ()</h3><a id="idm139925506429664" class="indexterm"></a><pre class="programlisting">IsLocal (out'b'local)</pre><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 class="variablelist"><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 class="link" href="#Session:is-local"><code class="literal">is-local</code></a></p></div><div class="refsect2"><a id="idm139925506424432"></a><h3><a id="Session.GetCreationTime"></a>GetCreationTime ()</h3><a id="idm139925506423440" class="indexterm"></a><pre class="programlisting">GetCreationTime (out's'iso8601_datetime)</pre><p>Returns an ISO 8601 date-time string that corresponds to
the time that the session was opened.
</p><div class="variablelist"><dl class="variablelist"><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="refsect2"><a id="idm139925506419664"></a><h3><a id="Session.Activate"></a>Activate ()</h3><a id="idm139925506418672" class="indexterm"></a><pre class="programlisting">Activate ()</pre><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><p>May fail with: CK_SESSION_ERROR_ALREADY_ACTIVE, CK_SESSION_ERROR_NOT_SUPPORTED, CK_SESSION_ERROR_GENERAL</p><p>
See also:
<a class="link" href="#Seat.ActivateSession"><code class="function">Seat.ActivateSession()</code></a></p></div><div class="refsect2"><a id="idm139925506414816"></a><h3><a id="Session.Lock"></a>Lock ()</h3><a id="idm139925506413824" class="indexterm"></a><pre class="programlisting">Lock ()</pre><p>This will cause a <a class="link" href="#Session::Lock"><code class="literal">Lock</code></a>
signal to be emitted for this session.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Permissions</h3><p class="permission">This method is restricted to privileged users by D-Bus policy.</p></div><p>
See also:
<a class="link" href="#Session::Lock"><code class="literal">Lock signal</code></a></p></div><div class="refsect2"><a id="idm139925506408656"></a><h3><a id="Session.Unlock"></a>Unlock ()</h3><a id="idm139925506407664" class="indexterm"></a><pre class="programlisting">Unlock ()</pre><p>This will cause an <a class="link" 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="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Permissions</h3><p class="permission">This method is restricted to privileged users by D-Bus policy.</p></div><p>
See also:
<a class="link" href="#Session::Unlock"><code class="literal">Unlock signal</code></a></p></div><div class="refsect2"><a id="idm139925506401968"></a><h3><a id="Session.GetIdleHint"></a>GetIdleHint ()</h3><a id="idm139925506400976" class="indexterm"></a><pre class="programlisting">GetIdleHint (out'b'idle_hint)</pre><p>Gets the value of the <a class="link" href="#Session:idle-hint"><code class="literal">idle-hint</code></a>
property.
</p><div class="variablelist"><dl class="variablelist"><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 class="link" href="#Session:idle-hint"><code class="literal">idle-hint</code></a></p></div><div class="refsect2"><a id="idm139925506395216"></a><h3><a id="Session.GetIdleSinceHint"></a>GetIdleSinceHint ()</h3><a id="idm139925506394224" class="indexterm"></a><pre class="programlisting">GetIdleSinceHint (out's'iso8601_datetime)</pre><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 class="variablelist"><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="refsect2"><a id="idm139925506390432"></a><h3><a id="Session.SetIdleHint"></a>SetIdleHint ()</h3><a id="idm139925506389440" class="indexterm"></a><pre class="programlisting">SetIdleHint (in'b'idle_hint)</pre><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 class="variablelist"><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><div class="refsect1"><a id="idm139925506385088"></a><h2>Signal Details</h2><div class="refsect2"><a id="idm139925506383968"></a><h3><a id="Session::ActiveChanged"></a>The ActiveChanged signal</h3><a id="idm139925506382976" class="indexterm"></a><pre class="programlisting">ActiveChanged ('b'is_active)</pre><p>Emitted when the active property has changed.</p><div class="variablelist"><dl class="variablelist"><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><div class="refsect2"><a id="idm139925506379328"></a><h3><a id="Session::IdleHintChanged"></a>The IdleHintChanged signal</h3><a id="idm139925506378336" class="indexterm"></a><pre class="programlisting">IdleHintChanged ('b'hint)</pre><p>Emitted when the idle-hint property has changed.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>hint</code></em>:</span></dt><dd>the new value of idle-hint</dd></dl></div></div><div class="refsect2"><a id="idm139925506374688"></a><h3><a id="Session::Lock"></a>The Lock signal</h3><a id="idm139925506373696" class="indexterm"></a><pre class="programlisting">Lock ()</pre><p>Emitted in response to a call to the <a class="link" 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><div class="refsect2"><a id="idm139925506370192"></a><h3><a id="Session::Unlock"></a>The Unlock signal</h3><a id="idm139925506369200" class="indexterm"></a><pre class="programlisting">Unlock ()</pre><p>Emitted in response to a call to the <a class="link" 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></div><div class="refsect1"><a id="idm139925506365552"></a><h2>Property Details</h2><div class="refsect2"><a id="idm139925506364432"></a><h3><a id="Session:unix-user"></a>The "unix-user" property</h3><a id="idm139925506363440" class="indexterm"></a><pre class="programlisting">'unix-user'read'u'
</pre><p>The user assigned to the session.</p></div><div class="refsect2"><a id="idm139925506361424"></a><h3><a id="Session:user"></a>The "user" property</h3><a id="idm139925506360432" class="indexterm"></a><pre class="programlisting">'user'read'u'
</pre><p>The user assigned to the session.</p><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 class="link" href="#Session:unix-user"><code class="literal">unix-user</code></a>
instead.</p></div></div><div class="refsect2"><a id="idm139925506356064"></a><h3><a id="Session:session-type"></a>The "session-type" property</h3><a id="idm139925506355072" class="indexterm"></a><pre class="programlisting">'session-type'readwrite's'
</pre><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><div class="refsect2"><a id="idm139925506352512"></a><h3><a id="Session:remote-host-name"></a>The "remote-host-name" property</h3><a id="idm139925506351520" class="indexterm"></a><pre class="programlisting">'remote-host-name'read's'
</pre><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><div class="refsect2"><a id="idm139925506348480"></a><h3><a id="Session:display-device"></a>The "display-device" property</h3><a id="idm139925506347488" class="indexterm"></a><pre class="programlisting">'display-device'read's'
</pre><p>The display device (aka TTY) that the
session is connected to.
</p></div><div class="refsect2"><a id="idm139925506345376"></a><h3><a id="Session:x11-display"></a>The "x11-display" property</h3><a id="idm139925506344384" class="indexterm"></a><pre class="programlisting">'x11-display'read's'
</pre><p>Value of the X11 DISPLAY for this session
if one is present.
</p></div><div class="refsect2"><a id="idm139925506342272"></a><h3><a id="Session:x11-display-device"></a>The "x11-display-device" property</h3><a id="idm139925506341280" class="indexterm"></a><pre class="programlisting">'x11-display-device'read's'
</pre><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><div class="refsect2"><a id="idm139925506339056"></a><h3><a id="Session:active"></a>The "active" property</h3><a id="idm139925506338064" class="indexterm"></a><pre class="programlisting">'active'readwrite'b'
</pre><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><div class="refsect2"><a id="idm139925506335472"></a><h3><a id="Session:is-local"></a>The "is-local" property</h3><a id="idm139925506334480" class="indexterm"></a><pre class="programlisting">'is-local'read'b'
</pre><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><div class="refsect2"><a id="idm139925506331872"></a><h3><a id="Session:idle-hint"></a>The "idle-hint" property</h3><a id="idm139925506330880" class="indexterm"></a><pre class="programlisting">'idle-hint'readwrite'b'
</pre><p>
This is a hint used to indicate that the session may be idle.
</p><p>
For sessions with a <a class="link" 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 class="link" 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></div></div></div></div><div class="index"><div class="titlepage"><div><div><h1 class="title"><a id="idm139925506131984"></a>Index</h1></div></div></div><div xmlns:xlink="http://www.w3.org/1999/xlink" class="index"><div class="indexdiv"><h3>A</h3><dl><dt id="ientry-idm139925506418672">Activate</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506419664">Activate ()</a></dt></dl></dd><dt id="ientry-idm139925506645488">ActivateSession</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506646480">ActivateSession ()</a></dt></dl></dd><dt id="ientry-idm139925506338064">active</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506339056">The "active" property</a></dt></dl></dd><dt id="ientry-idm139925506382976">ActiveChanged</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506383968">The ActiveChanged signal</a></dt></dl></dd><dt id="ientry-idm139925506637744">ActiveSessionChanged</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506638736">The ActiveSessionChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>C</h3><dl><dt id="ientry-idm139925506650080">CanActivateSessions</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506651072">CanActivateSessions ()</a></dt></dl></dd><dt id="ientry-idm139925507117472">CanHibernate</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507118464">CanHibernate ()</a></dt></dl></dd><dt id="ientry-idm139925507103360">CanHybridSleep</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507104352">CanHybridSleep ()</a></dt></dl></dd><dt id="ientry-idm139925507145600">CanPowerOff</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507146592">CanPowerOff ()</a></dt></dl></dd><dt id="ientry-idm139925507159584">CanReboot</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507160576">CanReboot ()</a></dt></dl></dd><dt id="ientry-idm139925507179376">CanRestart</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507180368">CanRestart ()</a></dt></dl></dd><dt id="ientry-idm139925507170592">CanStop</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507171584">CanStop ()</a></dt></dl></dd><dt id="ientry-idm139925507131536">CanSuspend</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507132528">CanSuspend ()</a></dt></dl></dd><dt id="ientry-idm139925507039008">CloseSession</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507040000">CloseSession ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>D</h3><dl><dt id="ientry-idm139925506623824">DeviceAdded</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506624816">The DeviceAdded signal</a></dt></dl></dd><dt id="ientry-idm139925506619104">DeviceRemoved</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506620096">The DeviceRemoved signal</a></dt></dl></dd><dt id="ientry-idm139925506347488">display-device</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506348480">The "display-device" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>G</h3><dl><dt id="ientry-idm139925506655200">GetActiveSession</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506656192">GetActiveSession ()</a></dt></dl></dd><dt id="ientry-idm139925506423440">GetCreationTime</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506424432">GetCreationTime ()</a></dt></dl></dd><dt id="ientry-idm139925507005504">GetCurrentSession</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507006496">GetCurrentSession ()</a></dt></dl></dd><dt id="ientry-idm139925506660464">GetDevices</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506661456">GetDevices ()</a></dt></dl></dd><dt id="ientry-idm139925506452048">GetDisplayDevice</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506453040">GetDisplayDevice ()</a></dt></dl></dd><dt id="ientry-idm139925506671472">GetId</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506672464">GetId ()</a></dt><dt>Session, <a class="indexterm" href="#idm139925506500400">GetId ()</a></dt></dl></dd><dt id="ientry-idm139925506400976">GetIdleHint</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506401968">GetIdleHint ()</a></dt></dl></dd><dt id="ientry-idm139925506394224">GetIdleSinceHint</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506395216">GetIdleSinceHint ()</a></dt></dl></dd><dt id="ientry-idm139925506440592">GetLoginSessionId</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506441584">GetLoginSessionId ()</a></dt></dl></dd><dt id="ientry-idm139925506446304">GetRemoteHostName</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506447296">GetRemoteHostName ()</a></dt></dl></dd><dt id="ientry-idm139925506494896">GetSeatId</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506495888">GetSeatId ()</a></dt></dl></dd><dt id="ientry-idm139925507032528">GetSeats</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507033520">GetSeats ()</a></dt></dl></dd><dt id="ientry-idm139925507018288">GetSessionForCookie</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507019280">GetSessionForCookie ()</a></dt></dl></dd><dt id="ientry-idm139925507011904">GetSessionForUnixProcess</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507012896">GetSessionForUnixProcess ()</a></dt></dl></dd><dt id="ientry-idm139925507025408">GetSessions</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507026400">GetSessions ()</a></dt><dt>Seat, <a class="indexterm" href="#idm139925506667824">GetSessions ()</a></dt></dl></dd><dt id="ientry-idm139925506999136">GetSessionsForUnixUser</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507000128">GetSessionsForUnixUser ()</a></dt></dl></dd><dt id="ientry-idm139925506991424">GetSessionsForUser</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506992416">GetSessionsForUser ()</a></dt></dl></dd><dt id="ientry-idm139925506489152">GetSessionType</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506490144">GetSessionType ()</a></dt></dl></dd><dt id="ientry-idm139925506981360">GetSystemIdleHint</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506982352">GetSystemIdleHint ()</a></dt></dl></dd><dt id="ientry-idm139925506975616">GetSystemIdleSinceHint</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506976608">GetSystemIdleSinceHint ()</a></dt></dl></dd><dt id="ientry-idm139925506474864">GetUnixUser</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506475856">GetUnixUser ()</a></dt></dl></dd><dt id="ientry-idm139925506482848">GetUser</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506483840">GetUser ()</a></dt></dl></dd><dt id="ientry-idm139925506463600">GetX11Display</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506464592">GetX11Display ()</a></dt></dl></dd><dt id="ientry-idm139925506457872">GetX11DisplayDevice</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506458864">GetX11DisplayDevice ()</a></dt></dl></dd><dt id="ientry-idm139925506469232">GetXDGRuntimeDir</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506470224">GetXDGRuntimeDir ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>H</h3><dl><dt id="ientry-idm139925507123312">Hibernate</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507124304">Hibernate ()</a></dt></dl></dd><dt id="ientry-idm139925507109232">HybridSleep</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507110224">HybridSleep ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>I</h3><dl><dt id="ientry-idm139925506330880">idle-hint</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506331872">The "idle-hint" property</a></dt></dl></dd><dt id="ientry-idm139925506378336">IdleHintChanged</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506379328">The IdleHintChanged signal</a></dt></dl></dd><dt id="ientry-idm139925507095072">Inhibit</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507096064">Inhibit ()</a></dt></dl></dd><dt id="ientry-idm139925506334480">is-local</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506335472">The "is-local" property</a></dt></dl></dd><dt id="ientry-idm139925506435872">IsActive</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506436864">IsActive ()</a></dt></dl></dd><dt id="ientry-idm139925506429664">IsLocal</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506430656">IsLocal ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>L</h3><dl><dt id="ientry-idm139925507077776">ListInhibitors</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507078768">ListInhibitors ()</a></dt></dl></dd><dt id="ientry-idm139925506413824">Lock</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506414816">Lock ()</a>, <a class="indexterm" href="#idm139925506374688">The Lock signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt id="ientry-idm139925507071840">OpenSession</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507072832">OpenSession ()</a></dt></dl></dd><dt id="ientry-idm139925507258960">OpenSessionWithParameters</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507260128">OpenSessionWithParameters ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>P</h3><dl><dt id="ientry-idm139925507151360">PowerOff</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507152352">PowerOff ()</a></dt></dl></dd><dt id="ientry-idm139925506955424">PrepareForShutdown</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506956416">The PrepareForShutdown signal</a></dt></dl></dd><dt id="ientry-idm139925506950480">PrepareForSleep</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506951472">The PrepareForSleep signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>R</h3><dl><dt id="ientry-idm139925507165488">Reboot</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507166480">Reboot ()</a></dt></dl></dd><dt id="ientry-idm139925506351520">remote-host-name</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506352512">The "remote-host-name" property</a></dt></dl></dd><dt id="ientry-idm139925507182960">Restart</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507183952">Restart ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt id="ientry-idm139925506969584">SeatAdded</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506970576">The SeatAdded signal</a></dt></dl></dd><dt id="ientry-idm139925506964864">SeatRemoved</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506965856">The SeatRemoved signal</a></dt></dl></dd><dt id="ientry-idm139925506355072">session-type</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506356064">The "session-type" property</a></dt></dl></dd><dt id="ientry-idm139925506633104">SessionAdded</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506634096">The SessionAdded signal</a></dt></dl></dd><dt id="ientry-idm139925506628464">SessionRemoved</dt><dd><dl><dt>Seat, <a class="indexterm" href="#idm139925506629456">The SessionRemoved signal</a></dt></dl></dd><dt id="ientry-idm139925506389440">SetIdleHint</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506390432">SetIdleHint ()</a></dt></dl></dd><dt id="ientry-idm139925507174272">Stop</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507175264">Stop ()</a></dt></dl></dd><dt id="ientry-idm139925507137376">Suspend</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925507138368">Suspend ()</a></dt></dl></dd><dt id="ientry-idm139925506960144">SystemIdleHintChanged</dt><dd><dl><dt>Manager, <a class="indexterm" href="#idm139925506961136">The SystemIdleHintChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>U</h3><dl><dt id="ientry-idm139925506363440">unix-user</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506364432">The "unix-user" property</a></dt></dl></dd><dt id="ientry-idm139925506407664">Unlock</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506408656">Unlock ()</a>, <a class="indexterm" href="#idm139925506370192">The Unlock signal</a></dt></dl></dd><dt id="ientry-idm139925506360432">user</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506361424">The "user" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt id="ientry-idm139925506344384">x11-display</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506345376">The "x11-display" property</a></dt></dl></dd><dt id="ientry-idm139925506341280">x11-display-device</dt><dd><dl><dt>Session, <a class="indexterm" href="#idm139925506342272">The "x11-display-device" property</a></dt></dl></dd></dl></div></div></div></div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Consolekit2 maintained by <a href="https://github.com/ConsoleKit2">ConsoleKit2</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>
|
