diff options
| author | William Jon McCann <mccann@jhu.edu> | 2007-03-13 03:42:04 -0400 |
|---|---|---|
| committer | William Jon McCann <mccann@jhu.edu> | 2007-03-13 03:42:04 -0400 |
| commit | 8b42a4928a0a266c3b3ae6bb13997764bc7f6405 (patch) | |
| tree | b1b1f06fdd18da4475c0dd773df364be3a0c9be0 /doc/ConsoleKit.html | |
| parent | 4595ab3d4953d6257a6fedfe5b294df67ff3581f (diff) | |
add the last bits of spec framework
The spec is the introspection format extended with
docs. There are tools to build docbook and strip
the docs to make dbus introspect xml.
Diffstat (limited to 'doc/ConsoleKit.html')
| -rw-r--r-- | doc/ConsoleKit.html | 336 |
1 files changed, 264 insertions, 72 deletions
diff --git a/doc/ConsoleKit.html b/doc/ConsoleKit.html index 4aeac2b..b79bf4d 100644 --- a/doc/ConsoleKit.html +++ b/doc/ConsoleKit.html @@ -1,13 +1,13 @@ <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ConsoleKit 0.1.3 Documentation</title><link rel="stylesheet" href="docbook.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="index"></a>ConsoleKit 0.1.3 Documentation</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">William Jon</span> <span class="surname">McCann</span></h3><div class="affiliation"><div class="address"><p><br> <code class="email"><<a href="mailto:mccann@jhu.edu">mccann@jhu.edu</a>></code><br> - </p></div></div></div></div></div><div><p class="releaseinfo">Version 0.1.3</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#id3015624">Introduction</a></span></dt><dt><span class="part"><a href="#id3015634">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="#id3050619">About</a></span></dt><dt><span class="sect1"><a href="#id2979025">Defining the Problem</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="#id3015648">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="#id3029093">Index</a></span></dt></dl></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id3015624"></a>Introduction</h2></div></div></div><p> - </p></div><div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id3015634"></a>Part I. Concepts</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id3050619">About</a></span></dt><dt><span class="sect1"><a href="#id2979025">Defining the Problem</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id3050619">About</a></span></dt><dt><span class="sect1"><a href="#id2979025">Defining the Problem</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3050619"></a>About</h2></div></div></div><p> + </p></div></div></div></div></div><div><p class="releaseinfo">Version 0.1.3</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#id2822389">Introduction</a></span></dt><dt><span class="part"><a href="#id2822399">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="#id2853100">About</a></span></dt><dt><span class="sect1"><a href="#id2853114">Defining the Problem</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="#id2853134">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="#id2868235">Index</a></span></dt></dl></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2822389"></a>Introduction</h2></div></div></div><p> + </p></div><div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id2822399"></a>Part I. Concepts</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id2853100">About</a></span></dt><dt><span class="sect1"><a href="#id2853114">Defining the Problem</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id2853100">About</a></span></dt><dt><span class="sect1"><a href="#id2853114">Defining the Problem</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2853100"></a>About</h2></div></div></div><p> ConsoleKit is a framework for keeping track of the various users, sessions, and seats present on a system. It provides a mechanism for software to react to changes of any of these items or of any of the metadata associated with them. - </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2979025"></a>Defining the Problem</h2></div></div></div><p> - </p></div></div></div><div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id3015648"></a>Part II. Reference</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="reference"><a href="#dbus-reference">I. D-Bus API Reference</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></dd></dl></div><div class="reference" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="dbus-reference"></a>D-Bus API Reference</h1></div></div><hr></div><div class="partintro" lang="en"><div></div><p> + </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2853114"></a>Defining the Problem</h2></div></div></div><p> + </p></div></div></div><div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id2853134"></a>Part II. Reference</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="reference"><a href="#dbus-reference">I. D-Bus API Reference</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></dd></dl></div><div class="reference" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="dbus-reference"></a>D-Bus API Reference</h1></div></div><hr></div><div class="partintro" lang="en"><div></div><p> ConsoleKit provides a D-Bus API for programs to obtain information about the users, sessions, and seats that are present on a system. </p><p> @@ -15,82 +15,274 @@ these concepts. </p><p> This API is not yet stable and is likely to change in the future. - </p><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></div></div><div class="refentry" lang="en"><a name="Manager"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Manager — Manager interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Manager-OpenSession">OpenSession</a> (out 's' cookie) -<a href="#Manager-OpenSessionWithParameters">OpenSessionWithParameters</a> (in 'a(sv)' parameters, + </p><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> — Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> — Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> — Session interface</span></dt></dl></div></div><div class="refentry" lang="en"><a name="Manager"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Manager — Manager interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Manager.OpenSession">OpenSession</a> (out 's' cookie) +<a href="#Manager.OpenSessionWithParameters">OpenSessionWithParameters</a> (in 'a(sv)' parameters, out 's' cookie) -<a href="#Manager-CloseSession">CloseSession</a> (in 's' cookie, +<a href="#Manager.CloseSession">CloseSession</a> (in 's' cookie, out 'b' result) -<a href="#Manager-GetSeats">GetSeats</a> (out 'ao' seats) -<a href="#Manager-GetCurrentSession">GetCurrentSession</a> (out 'o' ssid) -<a href="#Manager-GetSessionForCookie">GetSessionForCookie</a> (in 's' cookie, +<a href="#Manager.GetSeats">GetSeats</a> (out 'ao' seats) +<a href="#Manager.GetSessionForCookie">GetSessionForCookie</a> (in 's' cookie, out 'o' ssid) -<a href="#Manager-GetSessionForUnixProcess">GetSessionForUnixProcess</a> (in 'u' pid, +<a href="#Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</a> (in 'u' pid, out 'o' ssid) -<a href="#Manager-GetSessionsForUser">GetSessionsForUser</a> (in 'u' uid, +<a href="#Manager.GetCurrentSession">GetCurrentSession</a> (out 'o' ssid) +<a href="#Manager.GetSessionsForUser">GetSessionsForUser</a> (in 'u' uid, out 'ao' sessions) -<a href="#Manager-GetSystemIdleHint">GetSystemIdleHint</a> (out 'b' idle_hint) -<a href="#Manager-GetSystemIdleSinceHint">GetSystemIdleSinceHint</a> (out 's' iso8601_datetime) -</pre></div><div class="refsect1" lang="en"><a name="id2981760"></a><h2>Signals</h2><pre class="synopsis"><a href="#Manager-signal-SeatAdded">SeatAdded</a> ('o' sid) -<a href="#Manager-signal-SeatRemoved">SeatRemoved</a> ('o' sid) -<a href="#Manager-signal-SystemIdleHintChanged">SystemIdleHintChanged</a> ('b' hint) -</pre></div><div class="refsect1" lang="en"><a name="id2981803"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Manager implements +<a href="#Manager.GetSystemIdleHint">GetSystemIdleHint</a> (out 'b' idle_hint) +<a href="#Manager.GetSystemIdleSinceHint">GetSystemIdleSinceHint</a> (out 's' iso8601_datetime) +</pre></div><div class="refsect1" lang="en"><a name="id2817480"></a><h2>Signals</h2><pre class="synopsis"><a href="#Manager::SeatAdded">SeatAdded</a> ('o' sid) +<a href="#Manager::SeatRemoved">SeatRemoved</a> ('o' sid) +<a href="#Manager::SystemIdleHintChanged">SystemIdleHintChanged</a> ('b' hint) +</pre></div><div class="refsect1" lang="en"><a name="id2862092"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Manager implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties - </p></div><div class="refsect1" lang="en"><a name="id2981820"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id3024598"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id3024612"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3024622"></a><h3><a name="Manager-OpenSession"></a>OpenSession ()</h3><a class="indexterm" name="id3024634"></a><pre class="programlisting">OpenSession (out 's' cookie)</pre></div><div class="refsect2" lang="en"><a name="id3024658"></a><h3><a name="Manager-OpenSessionWithParameters"></a>OpenSessionWithParameters ()</h3><a class="indexterm" name="id3024671"></a><pre class="programlisting">OpenSessionWithParameters (in 'a(sv)' parameters, - out 's' cookie)</pre></div><div class="refsect2" lang="en"><a name="id3024695"></a><h3><a name="Manager-CloseSession"></a>CloseSession ()</h3><a class="indexterm" name="id3024708"></a><pre class="programlisting">CloseSession (in 's' cookie, - out 'b' result)</pre></div><div class="refsect2" lang="en"><a name="id3024732"></a><h3><a name="Manager-GetSeats"></a>GetSeats ()</h3><a class="indexterm" name="id3024744"></a><pre class="programlisting">GetSeats (out 'ao' seats)</pre></div><div class="refsect2" lang="en"><a name="id3024767"></a><h3><a name="Manager-GetCurrentSession"></a>GetCurrentSession ()</h3><a class="indexterm" name="id3024780"></a><pre class="programlisting">GetCurrentSession (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id3024803"></a><h3><a name="Manager-GetSessionForCookie"></a>GetSessionForCookie ()</h3><a class="indexterm" name="id3024816"></a><pre class="programlisting">GetSessionForCookie (in 's' cookie, - out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id3024840"></a><h3><a name="Manager-GetSessionForUnixProcess"></a>GetSessionForUnixProcess ()</h3><a class="indexterm" name="id3024854"></a><pre class="programlisting">GetSessionForUnixProcess (in 'u' pid, - out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id3024878"></a><h3><a name="Manager-GetSessionsForUser"></a>GetSessionsForUser ()</h3><a class="indexterm" name="id3024891"></a><pre class="programlisting">GetSessionsForUser (in 'u' uid, - out 'ao' sessions)</pre></div><div class="refsect2" lang="en"><a name="id3024915"></a><h3><a name="Manager-GetSystemIdleHint"></a>GetSystemIdleHint ()</h3><a class="indexterm" name="id3024928"></a><pre class="programlisting">GetSystemIdleHint (out 'b' idle_hint)</pre></div><div class="refsect2" lang="en"><a name="id3024950"></a><h3><a name="Manager-GetSystemIdleSinceHint"></a>GetSystemIdleSinceHint ()</h3><a class="indexterm" name="id3024963"></a><pre class="programlisting">GetSystemIdleSinceHint (out 's' iso8601_datetime)</pre></div></div><div class="refsect1" lang="en"><a name="id3024988"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id3024998"></a><h3><a name="Manager-signal-SeatAdded"></a>SeatAdded ()</h3><a class="indexterm" name="id3025012"></a><pre class="programlisting">SeatAdded ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3025035"></a><h3><a name="Manager-signal-SeatRemoved"></a>SeatRemoved ()</h3><a class="indexterm" name="id3025047"></a><pre class="programlisting">SeatRemoved ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3025070"></a><h3><a name="Manager-signal-SystemIdleHintChanged"></a>SystemIdleHintChanged ()</h3><a class="indexterm" name="id3025084"></a><pre class="programlisting">SystemIdleHintChanged ('b' hint)</pre></div></div><div class="refsect1" lang="en"><a name="id3025108"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en"><div class="refentry.separator"><hr></div><a name="Seat"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Seat — Seat interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Seat-GetId">GetId</a> (out 'o' sid) -<a href="#Seat-GetSessions">GetSessions</a> (out 'ao' sessions) -<a href="#Seat-GetActiveSession">GetActiveSession</a> (out 'o' ssid) -<a href="#Seat-ActivateSession">ActivateSession</a> (in 'o' ssid) -</pre></div><div class="refsect1" lang="en"><a name="id3025926"></a><h2>Signals</h2><pre class="synopsis"><a href="#Seat-signal-ActiveSessionChanged">ActiveSessionChanged</a> ('o' sid) -<a href="#Seat-signal-SessionAdded">SessionAdded</a> ('o' sid) -<a href="#Seat-signal-SessionRemoved">SessionRemoved</a> ('o' sid) -</pre></div><div class="refsect1" lang="en"><a name="id3025969"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Seat implements + </p></div><div class="refsect1" lang="en"><a name="id2862109"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id2862125"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id2862139"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2862147"></a><h3><a name="Manager.OpenSession"></a>OpenSession ()</h3><a class="indexterm" name="id2862157"></a><pre class="programlisting">OpenSession (out 's' cookie)</pre></div><p>This method requests that a new <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> + be created for the calling process. The properties of this new Session are set automatically + from information collected about the calling process. + </p><p>This new session exists until the calling process disconnects from the system bus or + calls <a href="#Manager.CloseSession"><code class="function">CloseSession()</code></a>. + </p><p>It is the responsibility of the calling process to set the environment variable + XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only + be made available to child processes of the caller so that they may be identified + as members of this session. + </p><p>See this simple example: + </p><div class="informalexample"><pre class="programlisting"> + DBusError error; + DBusMessage *message; + DBusMessage *reply; + + message = dbus_message_new_method_call ("org.freedesktop.ConsoleKit", + "/org/freedesktop/ConsoleKit/Manager", + "org.freedesktop.ConsoleKit.Manager", + "OpenSession"); + if (message == NULL) { + goto out; + } + + dbus_error_init (&error); + reply = dbus_connection_send_with_reply_and_block (connector->connection, + message, + -1, + &error); + if (reply == NULL) { + goto out; + } + + dbus_error_init (&error); + if (! dbus_message_get_args (reply, + &error, + DBUS_TYPE_STRING, &cookie, + DBUS_TYPE_INVALID)) { + goto out; + } + + </pre></div><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the new session</dd></dl></div><p> +See also: +<a href="#Manager.OpenSessionWithParameters"><code class="function">OpenSessionWithParameters()</code></a></p><div class="refsect2" lang="en"><a name="id2862272"></a><h3><a name="Manager.OpenSessionWithParameters"></a>OpenSessionWithParameters ()</h3><a class="indexterm" name="id2862283"></a><pre class="programlisting">OpenSessionWithParameters (in 'a(sv)' parameters, + out 's' cookie)</pre></div><p>This method requests that a new <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> + be created for the calling process. The properties of this new Session are from the + parameters provided. + </p><p>This new session exists until the calling process disconnects from the system bus or + calls <a href="#Manager.CloseSession"><code class="function">CloseSession()</code></a>. + </p><p>It is the responsibility of the calling process to set the environment variable + XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only + be made available to child processes of the caller so that they may be identified + as members of this session. + </p><p>See the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> properties for a list of valid parameters.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>parameters</code></em>:</span></dt><dd>An array of sets of property names and values</dd><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the new session</dd></dl></div><p class="permission">This method is restricted to privileged users by D-Bus policy.</p><p> +See also: +<a href="#Session" title="org.freedesktop.ConsoleKit.Session">org.freedesktop.ConsoleKit.Session</a></p><div class="refsect2" lang="en"><a name="id2862389"></a><h3><a name="Manager.CloseSession"></a>CloseSession ()</h3><a class="indexterm" name="id2862399"></a><pre class="programlisting">CloseSession (in 's' cookie, + out 'b' result)</pre></div><p>This method is used to close the session identified by the supplied cookie. + </p><p>The session can only be closed by the same process that opened the session. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the session</dd><dt><span class="term"><em class="parameter"><code>result</code></em>:</span></dt><dd>Whether the session was successfully closed</dd></dl></div><div class="refsect2" lang="en"><a name="id2862451"></a><h3><a name="Manager.GetSeats"></a>GetSeats ()</h3><a class="indexterm" name="id2862461"></a><pre class="programlisting">GetSeats (out 'ao' seats)</pre></div><p>This gets a list of all the <a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">Seats</a> + that are currently present on the system.</p><p>Each Seat ID is an D-Bus object path for the object that implements the + <a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">Seat</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>seats</code></em>:</span></dt><dd>an array of Seat IDs</dd></dl></div><p> +See also: +<a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p><div class="refsect2" lang="en"><a name="id2862522"></a><h3><a name="Manager.GetSessionForCookie"></a>GetSessionForCookie ()</h3><a class="indexterm" name="id2862533"></a><pre class="programlisting">GetSessionForCookie (in 's' cookie, + out 'o' ssid)</pre></div><p>Returns the session ID that is associated with the specified cookie. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>cookie</code></em>:</span></dt><dd>The secret cookie that is used to identify the session</dd><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en"><a name="id2862580"></a><h3><a name="Manager.GetSessionForUnixProcess"></a>GetSessionForUnixProcess ()</h3><a class="indexterm" name="id2862592"></a><pre class="programlisting">GetSessionForUnixProcess (in 'u' pid, + out 'o' ssid)</pre></div><p>Attempts to determine the session ID for the specified + POSIX process ID (pid). + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>pid</code></em>:</span></dt><dd>The POSIX process ID</dd><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en"><a name="id2862639"></a><h3><a name="Manager.GetCurrentSession"></a>GetCurrentSession ()</h3><a class="indexterm" name="id2862650"></a><pre class="programlisting">GetCurrentSession (out 'o' ssid)</pre></div><p>Attempts to determine the session ID that the caller belongs to. + </p><p>See this example of using dbus-send: + </p><div class="informalexample"><pre class="programlisting"> + dbus-send --system --dest=org.freedesktop.ConsoleKit \ + --type=method_call --print-reply --reply-timeout=2000 \ + /org/freedesktop/ConsoleKit/Manager \ + org.freedesktop.ConsoleKit.Manager.GetCurrentSession + </pre></div><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>The object identifier for the current session</dd></dl></div><div class="refsect2" lang="en"><a name="id2862697"></a><h3><a name="Manager.GetSessionsForUser"></a>GetSessionsForUser ()</h3><a class="indexterm" name="id2862708"></a><pre class="programlisting">GetSessionsForUser (in 'u' uid, + out 'ao' sessions)</pre></div><p>This gets a list of all the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a> + that are currently open for the specified user.</p><p>Each Session ID is an D-Bus object path for the object that implements the + <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>User identification</dd><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><div class="refsect2" lang="en"><a name="id2862773"></a><h3><a name="Manager.GetSystemIdleHint"></a>GetSystemIdleHint ()</h3><a class="indexterm" name="id2862783"></a><pre class="programlisting">GetSystemIdleHint (out 'b' idle_hint)</pre></div><p>Returns TRUE if the <a href="#Session:idle-hint"><code class="literal">idle-hint</code></a> + property of every open session is TRUE or if there are no open sessions. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>The value of the system-idle-hint</dd></dl></div><div class="refsect2" lang="en"><a name="id2862830"></a><h3><a name="Manager.GetSystemIdleSinceHint"></a>GetSystemIdleSinceHint ()</h3><a class="indexterm" name="id2862842"></a><pre class="programlisting">GetSystemIdleSinceHint (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to + the time of the last change of the system-idle-hint. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2862877"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2862886"></a><h3><a name="Manager::SeatAdded"></a>The SeatAdded signal</h3><a class="indexterm" name="id2862896"></a><pre class="programlisting">SeatAdded ('o' sid)</pre></div><p>Emitted when a Seat has been added to the system. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>The Seat ID for the added seat</dd></dl></div><div class="refsect2" lang="en"><a name="id2862930"></a><h3><a name="Manager::SeatRemoved"></a>The SeatRemoved signal</h3><a class="indexterm" name="id2862940"></a><pre class="programlisting">SeatRemoved ('o' sid)</pre></div><p>Emitted when a Seat has been removed from the system. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>The Seat ID for the removed seat</dd></dl></div><div class="refsect2" lang="en"><a name="id2862974"></a><h3><a name="Manager::SystemIdleHintChanged"></a>The SystemIdleHintChanged signal</h3><a class="indexterm" name="id2862985"></a><pre class="programlisting">SystemIdleHintChanged ('b' hint)</pre></div><p>Emitted when the value of the system-idle-hint has changed. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>hint</code></em>:</span></dt><dd>The value of the system-idle-hint</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2863020"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en"><div class="refentry.separator"><hr></div><a name="Seat"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Seat — Seat interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Seat.GetId">GetId</a> (out 'o' sid) +<a href="#Seat.GetSessions">GetSessions</a> (out 'ao' sessions) +<a href="#Seat.GetActiveSession">GetActiveSession</a> (out 'o' ssid) +<a href="#Seat.ActivateSession">ActivateSession</a> (in 'o' ssid) +</pre></div><div class="refsect1" lang="en"><a name="id2864183"></a><h2>Signals</h2><pre class="synopsis"><a href="#Seat::ActiveSessionChanged">ActiveSessionChanged</a> ('o' ssid) +<a href="#Seat::SessionAdded">SessionAdded</a> ('o' ssid) +<a href="#Seat::SessionRemoved">SessionRemoved</a> ('o' ssid) +</pre></div><div class="refsect1" lang="en"><a name="id2864226"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Seat implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties - </p></div><div class="refsect1" lang="en"><a name="id3025986"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id3026001"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id3026014"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3026025"></a><h3><a name="Seat-GetId"></a>GetId ()</h3><a class="indexterm" name="id3026037"></a><pre class="programlisting">GetId (out 'o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3026060"></a><h3><a name="Seat-GetSessions"></a>GetSessions ()</h3><a class="indexterm" name="id3026072"></a><pre class="programlisting">GetSessions (out 'ao' sessions)</pre></div><div class="refsect2" lang="en"><a name="id3026095"></a><h3><a name="Seat-GetActiveSession"></a>GetActiveSession ()</h3><a class="indexterm" name="id3026109"></a><pre class="programlisting">GetActiveSession (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id3026132"></a><h3><a name="Seat-ActivateSession"></a>ActivateSession ()</h3><a class="indexterm" name="id3026145"></a><pre class="programlisting">ActivateSession (in 'o' ssid)</pre></div></div><div class="refsect1" lang="en"><a name="id3026169"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id3026180"></a><h3><a name="Seat-signal-ActiveSessionChanged"></a>ActiveSessionChanged ()</h3><a class="indexterm" name="id3026194"></a><pre class="programlisting">ActiveSessionChanged ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3026216"></a><h3><a name="Seat-signal-SessionAdded"></a>SessionAdded ()</h3><a class="indexterm" name="id3026230"></a><pre class="programlisting">SessionAdded ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3026252"></a><h3><a name="Seat-signal-SessionRemoved"></a>SessionRemoved ()</h3><a class="indexterm" name="id3026265"></a><pre class="programlisting">SessionRemoved ('o' sid)</pre></div></div><div class="refsect1" lang="en"><a name="id3026289"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en"><div class="refentry.separator"><hr></div><a name="Session"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Session — Session interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Session-GetId">GetId</a> (out 'o' ssid) -<a href="#Session-GetSeatId">GetSeatId</a> (out 'o' sid) -<a href="#Session-GetSessionType">GetSessionType</a> (out 's' type) -<a href="#Session-GetUser">GetUser</a> (out 'i' uid) -<a href="#Session-GetX11Display">GetX11Display</a> (out 's' display) -<a href="#Session-GetX11DisplayDevice">GetX11DisplayDevice</a> (out 's' x11_display_device) -<a href="#Session-GetDisplayDevice">GetDisplayDevice</a> (out 's' display_device) -<a href="#Session-GetRemoteHostName">GetRemoteHostName</a> (out 's' remote_host_name) -<a href="#Session-IsActive">IsActive</a> (out 'b' active) -<a href="#Session-IsLocal">IsLocal</a> (out 'b' local) -<a href="#Session-GetCreationTime">GetCreationTime</a> (out 's' iso8601_datetime) -<a href="#Session-Activate">Activate</a> () -<a href="#Session-Lock">Lock</a> () -<a href="#Session-Unlock">Unlock</a> () -<a href="#Session-GetIdleHint">GetIdleHint</a> (out 'b' idle_hint) -<a href="#Session-GetIdleSinceHint">GetIdleSinceHint</a> (out 's' iso8601_datetime) -<a href="#Session-SetIdleHint">SetIdleHint</a> (in 'b' idle_hint) -</pre></div><div class="refsect1" lang="en"><a name="id3026944"></a><h2>Signals</h2><pre class="synopsis"><a href="#Session-signal-ActiveChanged">ActiveChanged</a> ('b' is_active) -<a href="#Session-signal-IdleHintChanged">IdleHintChanged</a> ('b' hint) -<a href="#Session-signal-Lock">Lock</a> () -<a href="#Session-signal-Unlock">Unlock</a> () -</pre></div><div class="refsect1" lang="en"><a name="id3026995"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Session implements + </p></div><div class="refsect1" lang="en"><a name="id2864242"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id2864258"></a><h2>Description</h2><p> + + </p><p>A seat is a collection of sessions and a set of hardware (usually at +least a keyboard and mouse). Only one session may be active on a +seat at a time.</p><p> + + </p></div><div class="refsect1" lang="en"><a name="id2864279"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2864287"></a><h3><a name="Seat.GetId"></a>GetId ()</h3><a class="indexterm" name="id2864297"></a><pre class="programlisting">GetId (out 'o' sid)</pre></div>Returns the ID for Seat. + <div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div><div class="refsect2" lang="en"><a name="id2864326"></a><h3><a name="Seat.GetSessions"></a>GetSessions ()</h3><a class="indexterm" name="id2864336"></a><pre class="programlisting">GetSessions (out 'ao' sessions)</pre></div><p>This gets a list of all the <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Sessions</a> + that are currently attached to this seat.</p><p>Each Session ID is an D-Bus object path for the object that implements the + <a href="#Session" title="org.freedesktop.ConsoleKit.Session">Session</a> interface.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sessions</code></em>:</span></dt><dd>an array of Session IDs</dd></dl></div><div class="refsect2" lang="en"><a name="id2864389"></a><h3><a name="Seat.GetActiveSession"></a>GetActiveSession ()</h3><a class="indexterm" name="id2864400"></a><pre class="programlisting">GetActiveSession (out 'o' ssid)</pre></div><p>Gets the Session ID that is currently active on this Seat.</p><p>Returns NULL if there is no active session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en"><a name="id2864438"></a><h3><a name="Seat.ActivateSession"></a>ActivateSession ()</h3><a class="indexterm" name="id2864448"></a><pre class="programlisting">ActivateSession (in 'o' ssid)</pre></div><p>Attempt to activate the specified session. In most + cases, if successful, this will cause the session to + become visible and take control of the hardware that is + associated with this seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><p> +See also: +<a href="#Session.Activate"><code class="function">Activate()</code></a></p></div><div class="refsect1" lang="en"><a name="id2864498"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2864506"></a><h3><a name="Seat::ActiveSessionChanged"></a>The ActiveSessionChanged signal</h3><a class="indexterm" name="id2864517"></a><pre class="programlisting">ActiveSessionChanged ('o' ssid)</pre></div><p>Emitted when the active session has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en"><a name="id2864550"></a><h3><a name="Seat::SessionAdded"></a>The SessionAdded signal</h3><a class="indexterm" name="id2864561"></a><pre class="programlisting">SessionAdded ('o' ssid)</pre></div><p>Emitted when a session has been added to the seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en"><a name="id2864594"></a><h3><a name="Seat::SessionRemoved"></a>The SessionRemoved signal</h3><a class="indexterm" name="id2864604"></a><pre class="programlisting">SessionRemoved ('o' ssid)</pre></div><p>Emitted when a session has been removed from the seat.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2864639"></a><h2>Property Details</h2></div></div><div class="refentry" lang="en"><div class="refentry.separator"><hr></div><a name="Session"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>org.freedesktop.ConsoleKit.Session — Session interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Session.GetId">GetId</a> (out 'o' ssid) +<a href="#Session.GetSeatId">GetSeatId</a> (out 'o' sid) +<a href="#Session.GetSessionType">GetSessionType</a> (out 's' type) +<a href="#Session.GetUser">GetUser</a> (out 'i' uid) +<a href="#Session.GetX11Display">GetX11Display</a> (out 's' display) +<a href="#Session.GetX11DisplayDevice">GetX11DisplayDevice</a> (out 's' x11_display_device) +<a href="#Session.GetDisplayDevice">GetDisplayDevice</a> (out 's' display_device) +<a href="#Session.GetRemoteHostName">GetRemoteHostName</a> (out 's' remote_host_name) +<a href="#Session.IsActive">IsActive</a> (out 'b' active) +<a href="#Session.IsLocal">IsLocal</a> (out 'b' local) +<a href="#Session.GetCreationTime">GetCreationTime</a> (out 's' iso8601_datetime) +<a href="#Session.Activate">Activate</a> () +<a href="#Session.Lock">Lock</a> () +<a href="#Session.Unlock">Unlock</a> () +<a href="#Session.GetIdleHint">GetIdleHint</a> (out 'b' idle_hint) +<a href="#Session.GetIdleSinceHint">GetIdleSinceHint</a> (out 's' iso8601_datetime) +<a href="#Session.SetIdleHint">SetIdleHint</a> (in 'b' idle_hint) +</pre></div><div class="refsect1" lang="en"><a name="id2865373"></a><h2>Signals</h2><pre class="synopsis"><a href="#Session::ActiveChanged">ActiveChanged</a> ('b' is_active) +<a href="#Session::IdleHintChanged">IdleHintChanged</a> ('b' hint) +<a href="#Session::Lock">Lock</a> () +<a href="#Session::Unlock">Unlock</a> () +</pre></div><div class="refsect1" lang="en"><a name="id2865422"></a><h2>Implemented Interfaces</h2><p>org.freedesktop.ConsoleKit.Session implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties - </p></div><div class="refsect1" lang="en"><a name="id3027012"></a><h2>Properties</h2><pre class="synopsis"><a href="#Session-property-user">'user'</a> readwrite 'u' -<a href="#Session-property-session-type">'session-type'</a> readwrite 's' -<a href="#Session-property-remote-host-name">'remote-host-name'</a> readwrite 's' -<a href="#Session-property-display-device">'display-device'</a> readwrite 's' -<a href="#Session-property-x11-display">'x11-display'</a> readwrite 's' -<a href="#Session-property-x11-display-device">'x11-display-device'</a> readwrite 's' -<a href="#Session-property-active">'active'</a> readwrite 'b' -<a href="#Session-property-is-local">'is-local'</a> readwrite 'b' -<a href="#Session-property-idle-hint">'idle-hint'</a> readwrite 'b' -</pre></div><div class="refsect1" lang="en"><a name="id3027108"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id3027122"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3027132"></a><h3><a name="Session-GetId"></a>GetId ()</h3><a class="indexterm" name="id3027144"></a><pre class="programlisting">GetId (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id3027167"></a><h3><a name="Session-GetSeatId"></a>GetSeatId ()</h3><a class="indexterm" name="id3027180"></a><pre class="programlisting">GetSeatId (out 'o' sid)</pre></div><div class="refsect2" lang="en"><a name="id3027203"></a><h3><a name="Session-GetSessionType"></a>GetSessionType ()</h3><a class="indexterm" name="id3027216"></a><pre class="programlisting">GetSessionType (out 's' type)</pre></div><div class="refsect2" lang="en"><a name="id3027238"></a><h3><a name="Session-GetUser"></a>GetUser ()</h3><a class="indexterm" name="id3027251"></a><pre class="programlisting">GetUser (out 'i' uid)</pre></div><div class="refsect2" lang="en"><a name="id3027274"></a><h3><a name="Session-GetX11Display"></a>GetX11Display ()</h3><a class="indexterm" name="id3027287"></a><pre class="programlisting">GetX11Display (out 's' display)</pre></div><div class="refsect2" lang="en"><a name="id3027310"></a><h3><a name="Session-GetX11DisplayDevice"></a>GetX11DisplayDevice ()</h3><a class="indexterm" name="id3027323"></a><pre class="programlisting">GetX11DisplayDevice (out 's' x11_display_device)</pre></div><div class="refsect2" lang="en"><a name="id3027346"></a><h3><a name="Session-GetDisplayDevice"></a>GetDisplayDevice ()</h3><a class="indexterm" name="id3027359"></a><pre class="programlisting">GetDisplayDevice (out 's' display_device)</pre></div><div class="refsect2" lang="en"><a name="id3027383"></a><h3><a name="Session-GetRemoteHostName"></a>GetRemoteHostName ()</h3><a class="indexterm" name="id3027395"></a><pre class="programlisting">GetRemoteHostName (out 's' remote_host_name)</pre></div><div class="refsect2" lang="en"><a name="id3027419"></a><h3><a name="Session-IsActive"></a>IsActive ()</h3><a class="indexterm" name="id3027431"></a><pre class="programlisting">IsActive (out 'b' active)</pre></div><div class="refsect2" lang="en"><a name="id3027454"></a><h3><a name="Session-IsLocal"></a>IsLocal ()</h3><a class="indexterm" name="id3027467"></a><pre class="programlisting">IsLocal (out 'b' local)</pre></div><div class="refsect2" lang="en"><a name="id3027489"></a><h3><a name="Session-GetCreationTime"></a>GetCreationTime ()</h3><a class="indexterm" name="id3027503"></a><pre class="programlisting">GetCreationTime (out 's' iso8601_datetime)</pre></div><div class="refsect2" lang="en"><a name="id3027526"></a><h3><a name="Session-Activate"></a>Activate ()</h3><a class="indexterm" name="id3027538"></a><pre class="programlisting">Activate ()</pre></div><div class="refsect2" lang="en"><a name="id3027561"></a><h3><a name="Session-Lock"></a>Lock ()</h3><a class="indexterm" name="id3027573"></a><pre class="programlisting">Lock ()</pre></div><div class="refsect2" lang="en"><a name="id3027596"></a><h3><a name="Session-Unlock"></a>Unlock ()</h3><a class="indexterm" name="id3027608"></a><pre class="programlisting">Unlock ()</pre></div><div class="refsect2" lang="en"><a name="id3027631"></a><h3><a name="Session-GetIdleHint"></a>GetIdleHint ()</h3><a class="indexterm" name="id3027643"></a><pre class="programlisting">GetIdleHint (out 'b' idle_hint)</pre></div><div class="refsect2" lang="en"><a name="id3027666"></a><h3><a name="Session-GetIdleSinceHint"></a>GetIdleSinceHint ()</h3><a class="indexterm" name="id3027680"></a><pre class="programlisting">GetIdleSinceHint (out 's' iso8601_datetime)</pre></div><div class="refsect2" lang="en"><a name="id3027703"></a><h3><a name="Session-SetIdleHint"></a>SetIdleHint ()</h3><a class="indexterm" name="id3027715"></a><pre class="programlisting">SetIdleHint (in 'b' idle_hint)</pre></div></div><div class="refsect1" lang="en"><a name="id3027739"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id3027750"></a><h3><a name="Session-signal-ActiveChanged"></a>ActiveChanged ()</h3><a class="indexterm" name="id3027763"></a><pre class="programlisting">ActiveChanged ('b' is_active)</pre></div><div class="refsect2" lang="en"><a name="id3027786"></a><h3><a name="Session-signal-IdleHintChanged"></a>IdleHintChanged ()</h3><a class="indexterm" name="id3027799"></a><pre class="programlisting">IdleHintChanged ('b' hint)</pre></div><div class="refsect2" lang="en"><a name="id3027823"></a><h3><a name="Session-signal-Lock"></a>Lock ()</h3><a class="indexterm" name="id3027835"></a><pre class="programlisting">Lock ()</pre></div><div class="refsect2" lang="en"><a name="id3027858"></a><h3><a name="Session-signal-Unlock"></a>Unlock ()</h3><a class="indexterm" name="id3027871"></a><pre class="programlisting">Unlock ()</pre></div></div><div class="refsect1" lang="en"><a name="id3027895"></a><h2>Property Details</h2><div class="refsect2" lang="en"><a name="id3027905"></a><h3><a name="Session-property-user"></a>'user'</h3><a class="indexterm" name="id3027918"></a><pre class="programlisting">'user' readwrite 'u' -</pre></div><div class="refsect2" lang="en"><a name="id3027941"></a><h3><a name="Session-property-session-type"></a>'session-type'</h3><a class="indexterm" name="id3027954"></a><pre class="programlisting">'session-type' readwrite 's' -</pre></div><div class="refsect2" lang="en"><a name="id3027976"></a><h3><a name="Session-property-remote-host-name"></a>'remote-host-name'</h3><a class="indexterm" name="id3027990"></a><pre class="programlisting">'remote-host-name' readwrite 's' -</pre></div><div class="refsect2" lang="en"><a name="id3028013"></a><h3><a name="Session-property-display-device"></a>'display-device'</h3><a class="indexterm" name="id3028026"></a><pre class="programlisting">'display-device' readwrite 's' -</pre></div><div class="refsect2" lang="en"><a name="id3028049"></a><h3><a name="Session-property-x11-display"></a>'x11-display'</h3><a class="indexterm" name="id3028063"></a><pre class="programlisting">'x11-display' readwrite 's' -</pre></div><div class="refsect2" lang="en"><a name="id3028086"></a><h3><a name="Session-property-x11-display-device"></a>'x11-display-device'</h3><a class="indexterm" name="id3028100"></a><pre class="programlisting">'x11-display-device' readwrite 's' -</pre></div><div class="refsect2" lang="en"><a name="id3028123"></a><h3><a name="Session-property-active"></a>'active'</h3><a class="indexterm" name="id3028136"></a><pre class="programlisting">'active' readwrite 'b' -</pre></div><div class="refsect2" lang="en"><a name="id3028159"></a><h3><a name="Session-property-is-local"></a>'is-local'</h3><a class="indexterm" name="id3028172"></a><pre class="programlisting">'is-local' readwrite 'b' -</pre></div><div class="refsect2" lang="en"><a name="id3028195"></a><h3><a name="Session-property-idle-hint"></a>'idle-hint'</h3><a class="indexterm" name="id3028208"></a><pre class="programlisting">'idle-hint' readwrite 'b' -</pre></div></div></div></div></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="id3029093"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>A</h3><dl><dt>Activate</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027526">Activate ()</a></dt></dl></dd></dl></dd><dt>ActivateSession</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id3026132">ActivateSession ()</a></dt></dl></dd></dl></dd><dt>active</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028123">'active'</a></dt></dl></dd></dl></dd><dt>ActiveChanged</dt><dd><dl><dt>Session</dt><dd><dl><dt>signal, <a href="#id3027750">ActiveChanged ()</a></dt></dl></dd></dl></dd><dt>ActiveSessionChanged</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id3026180">ActiveSessionChanged ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>CloseSession</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024695">CloseSession ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>D</h3><dl><dt>display-device</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028013">'display-device'</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>G</h3><dl><dt>GetActiveSession</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id3026095">GetActiveSession ()</a></dt></dl></dd></dl></dd><dt>GetCreationTime</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027489">GetCreationTime ()</a></dt></dl></dd></dl></dd><dt>GetCurrentSession</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024767">GetCurrentSession ()</a></dt></dl></dd></dl></dd><dt>GetDisplayDevice</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027346">GetDisplayDevice ()</a></dt></dl></dd></dl></dd><dt>GetId</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id3026025">GetId ()</a></dt></dl></dd><dt>Session</dt><dd><dl><dt>method, <a href="#id3027132">GetId ()</a></dt></dl></dd></dl></dd><dt>GetIdleHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027631">GetIdleHint ()</a></dt></dl></dd></dl></dd><dt>GetIdleSinceHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027666">GetIdleSinceHint ()</a></dt></dl></dd></dl></dd><dt>GetRemoteHostName</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027383">GetRemoteHostName ()</a></dt></dl></dd></dl></dd><dt>GetSeatId</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027167">GetSeatId ()</a></dt></dl></dd></dl></dd><dt>GetSeats</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024732">GetSeats ()</a></dt></dl></dd></dl></dd><dt>GetSessionForCookie</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024803">GetSessionForCookie ()</a></dt></dl></dd></dl></dd><dt>GetSessionForUnixProcess</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024840">GetSessionForUnixProcess ()</a></dt></dl></dd></dl></dd><dt>GetSessions</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id3026060">GetSessions ()</a></dt></dl></dd></dl></dd><dt>GetSessionsForUser</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024878">GetSessionsForUser ()</a></dt></dl></dd></dl></dd><dt>GetSessionType</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027203">GetSessionType ()</a></dt></dl></dd></dl></dd><dt>GetSystemIdleHint</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024915">GetSystemIdleHint ()</a></dt></dl></dd></dl></dd><dt>GetSystemIdleSinceHint</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024950">GetSystemIdleSinceHint ()</a></dt></dl></dd></dl></dd><dt>GetUser</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027238">GetUser ()</a></dt></dl></dd></dl></dd><dt>GetX11Display</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027274">GetX11Display ()</a></dt></dl></dd></dl></dd><dt>GetX11DisplayDevice</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027310">GetX11DisplayDevice ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>I</h3><dl><dt>idle-hint</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028195">'idle-hint'</a></dt></dl></dd></dl></dd><dt>IdleHintChanged</dt><dd><dl><dt>Session</dt><dd><dl><dt>signal, <a href="#id3027786">IdleHintChanged ()</a></dt></dl></dd></dl></dd><dt>is-local</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028159">'is-local'</a></dt></dl></dd></dl></dd><dt>IsActive</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027419">IsActive ()</a></dt></dl></dd></dl></dd><dt>IsLocal</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027454">IsLocal ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lock</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027561">Lock ()</a></dt><dt>signal, <a href="#id3027823">Lock ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt>OpenSession</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024622">OpenSession ()</a></dt></dl></dd></dl></dd><dt>OpenSessionWithParameters</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id3024658">OpenSessionWithParameters ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>R</h3><dl><dt>remote-host-name</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3027976">'remote-host-name'</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>SeatAdded</dt><dd><dl><dt>Manager</dt><dd><dl><dt>signal, <a href="#id3024998">SeatAdded ()</a></dt></dl></dd></dl></dd><dt>SeatRemoved</dt><dd><dl><dt>Manager</dt><dd><dl><dt>signal, <a href="#id3025035">SeatRemoved ()</a></dt></dl></dd></dl></dd><dt>session-type</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3027941">'session-type'</a></dt></dl></dd></dl></dd><dt>SessionAdded</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id3026216">SessionAdded ()</a></dt></dl></dd></dl></dd><dt>SessionRemoved</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id3026252">SessionRemoved ()</a></dt></dl></dd></dl></dd><dt>SetIdleHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027703">SetIdleHint ()</a></dt></dl></dd></dl></dd><dt>SystemIdleHintChanged</dt><dd><dl><dt>Manager</dt><dd><dl><dt>signal, <a href="#id3025070">SystemIdleHintChanged ()</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>U</h3><dl><dt>Unlock</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id3027596">Unlock ()</a></dt><dt>signal, <a href="#id3027858">Unlock ()</a></dt></dl></dd></dl></dd><dt>user</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3027905">'user'</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>x11-display</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028049">'x11-display'</a></dt></dl></dd></dl></dd><dt>x11-display-device</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id3028086">'x11-display-device'</a></dt></dl></dd></dl></dd></dl></div></div></div></div></body></html> + </p></div><div class="refsect1" lang="en"><a name="id2865439"></a><h2>Properties</h2><pre class="synopsis"><a href="#Session:user">'user'</a> readwrite 'u' +<a href="#Session:session-type">'session-type'</a> readwrite 's' +<a href="#Session:remote-host-name">'remote-host-name'</a> readwrite 's' +<a href="#Session:display-device">'display-device'</a> readwrite 's' +<a href="#Session:x11-display">'x11-display'</a> readwrite 's' +<a href="#Session:x11-display-device">'x11-display-device'</a> readwrite 's' +<a href="#Session:active">'active'</a> readwrite 'b' +<a href="#Session:is-local">'is-local'</a> readwrite 'b' +<a href="#Session:idle-hint">'idle-hint'</a> readwrite 'b' +</pre></div><div class="refsect1" lang="en"><a name="id2865531"></a><h2>Description</h2><p> + + </p><p>Session objects represent and store information + related to a user session. + </p><p> + </p><p>The properties associated with the Session + specifically refer to the properties of the "session leader". + </p><p> + + </p></div><div class="refsect1" lang="en"><a name="id2865555"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2865563"></a><h3><a name="Session.GetId"></a>GetId ()</h3><a class="indexterm" name="id2865574"></a><pre class="programlisting">GetId (out 'o' ssid)</pre></div><p>Returns the ID for Session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>ssid</code></em>:</span></dt><dd>Session ID</dd></dl></div><div class="refsect2" lang="en"><a name="id2865605"></a><h3><a name="Session.GetSeatId"></a>GetSeatId ()</h3><a class="indexterm" name="id2865616"></a><pre class="programlisting">GetSeatId (out 'o' sid)</pre></div><p>Returns the ID for the Seat the Session is + attached to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>sid</code></em>:</span></dt><dd>Seat ID</dd></dl></div><p> +See also: +<a href="#Seat" title="org.freedesktop.ConsoleKit.Seat">org.freedesktop.ConsoleKit.Seat</a></p><div class="refsect2" lang="en"><a name="id2865657"></a><h3><a name="Session.GetSessionType"></a>GetSessionType ()</h3><a class="indexterm" name="id2865667"></a><pre class="programlisting">GetSessionType (out 's' type)</pre></div><p>Returns the type of the session.</p><p>Warning: we haven't yet defined the allowed values for this property. + It is probably best to avoid this until we do. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>type</code></em>:</span></dt><dd>Session type</dd></dl></div><p> +See also: +<a href="#Session:session-type"><code class="literal">session-type</code></a></p><div class="refsect2" lang="en"><a name="id2865718"></a><h3><a name="Session.GetUser"></a>GetUser ()</h3><a class="indexterm" name="id2865728"></a><pre class="programlisting">GetUser (out 'i' uid)</pre></div><p>Returns the user that the session belongs to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>uid</code></em>:</span></dt><dd>User ID</dd></dl></div><p> +See also: +<a href="#Session:user"><code class="literal">user</code></a></p><div class="refsect2" lang="en"><a name="id2865772"></a><h3><a name="Session.GetX11Display"></a>GetX11Display ()</h3><a class="indexterm" name="id2865782"></a><pre class="programlisting">GetX11Display (out 's' display)</pre></div><p>Returns the value of the X11 DISPLAY for this session + if one is present.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>display</code></em>:</span></dt><dd>The value of the X11 display</dd></dl></div><p> +See also: +<a href="#Session:x11-display"><code class="literal">x11-display</code></a></p><div class="refsect2" lang="en"><a name="id2865827"></a><h3><a name="Session.GetX11DisplayDevice"></a>GetX11DisplayDevice ()</h3><a class="indexterm" name="id2865838"></a><pre class="programlisting">GetX11DisplayDevice (out 's' x11_display_device)</pre></div><p>Returns the value of the display device (aka TTY) that the + X11 display for the session is connected to. If there is no x11-display set then this value + is undefined.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>x11_display_device</code></em>:</span></dt><dd>The value of the X11 display device</dd></dl></div><p> +See also: +<a href="#Session:x11-display-device"><code class="literal">x11-display-device</code></a></p><div class="refsect2" lang="en"><a name="id2865886"></a><h3><a name="Session.GetDisplayDevice"></a>GetDisplayDevice ()</h3><a class="indexterm" name="id2865897"></a><pre class="programlisting">GetDisplayDevice (out 's' display_device)</pre></div><p>Returns the value of the display device (aka TTY) that the + session is connected to.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>display_device</code></em>:</span></dt><dd>The value of the display device</dd></dl></div><p> +See also: +<a href="#Session:display-device"><code class="literal">display-device</code></a></p><div class="refsect2" lang="en"><a name="id2865942"></a><h3><a name="Session.GetRemoteHostName"></a>GetRemoteHostName ()</h3><a class="indexterm" name="id2865953"></a><pre class="programlisting">GetRemoteHostName (out 's' remote_host_name)</pre></div><p>Returns the value of the remote host name for the session. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>remote_host_name</code></em>:</span></dt><dd>The remote host name</dd></dl></div><p> +See also: +<a href="#Session:remote-host-name"><code class="literal">remote-host-name</code></a></p><div class="refsect2" lang="en"><a name="id2865999"></a><h3><a name="Session.IsActive"></a>IsActive ()</h3><a class="indexterm" name="id2866009"></a><pre class="programlisting">IsActive (out 'b' active)</pre></div><p>Returns whether the session is active on the Seat that + it is attached to.</p><p>If the session is not attached to a seat this value is undefined. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>active</code></em>:</span></dt><dd>TRUE if the session is active, otherwise FALSE</dd></dl></div><p> +See also: +<a href="#Session:active"><code class="literal">active</code></a></p><div class="refsect2" lang="en"><a name="id2866058"></a><h3><a name="Session.IsLocal"></a>IsLocal ()</h3><a class="indexterm" name="id2866068"></a><pre class="programlisting">IsLocal (out 'b' local)</pre></div><p>Returns whether the session is local</p><p>FIXME: we need to come up with a concrete definition for this value. + It was originally used as a way to identify XDMCP sessions that originate + from a remote system. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>local</code></em>:</span></dt><dd>TRUE if the session is local, otherwise FALSE</dd></dl></div><p> +See also: +<a href="#Session:is-local"><code class="literal">is-local</code></a></p><div class="refsect2" lang="en"><a name="id2866119"></a><h3><a name="Session.GetCreationTime"></a>GetCreationTime ()</h3><a class="indexterm" name="id2866129"></a><pre class="programlisting">GetCreationTime (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to + the time that the session was opened. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div><div class="refsect2" lang="en"><a name="id2866164"></a><h3><a name="Session.Activate"></a>Activate ()</h3><a class="indexterm" name="id2866174"></a><pre class="programlisting">Activate ()</pre></div><p>Attempt to activate the this session. In most + cases, if successful, this will cause the session to + become visible and become active on the seat that it + is attached to.</p><div class="variablelist"><dl></dl></div><p> +See also: +<a href="#Seat.ActivateSession"><code class="function">Seat.ActivateSession()</code></a></p><div class="refsect2" lang="en"><a name="id2866210"></a><h3><a name="Session.Lock"></a>Lock ()</h3><a class="indexterm" name="id2866221"></a><pre class="programlisting">Lock ()</pre></div><p>This will cause a <a href="#Session::Lock"><code class="literal">Lock</code></a> + signal to be emitted for this session. + </p><div class="variablelist"><dl></dl></div><p> +See also: +<a href="#Session::Lock"><code class="literal">Lock signal</code></a></p><div class="refsect2" lang="en"><a name="id2866265"></a><h3><a name="Session.Unlock"></a>Unlock ()</h3><a class="indexterm" name="id2866275"></a><pre class="programlisting">Unlock ()</pre></div><p>This will cause an <a href="#Session::Unlock"><code class="literal">Unlock</code></a> + signal to be emitted for this session. + </p><p>This can be used by login managers to unlock a session before it is + re-activated during fast-user-switching. + </p><div class="variablelist"><dl></dl></div><p> +See also: +<a href="#Session::Unlock"><code class="literal">Unlock signal</code></a></p><div class="refsect2" lang="en"><a name="id2866324"></a><h3><a name="Session.GetIdleHint"></a>GetIdleHint ()</h3><a class="indexterm" name="id2866334"></a><pre class="programlisting">GetIdleHint (out 'b' idle_hint)</pre></div><p>Gets the value of the <a href="#Session:idle-hint"><code class="literal">idle-hint</code></a> + property. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>The value of the idle-hint</dd></dl></div><p> +See also: +<a href="#Session:idle-hint"><code class="literal">idle-hint</code></a></p><div class="refsect2" lang="en"><a name="id2866390"></a><h3><a name="Session.GetIdleSinceHint"></a>GetIdleSinceHint ()</h3><a class="indexterm" name="id2866401"></a><pre class="programlisting">GetIdleSinceHint (out 's' iso8601_datetime)</pre></div><p>Returns an ISO 8601 date-time string that corresponds to + the time of the last change of the idle-hint. + </p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>iso8601_datetime</code></em>:</span></dt><dd>An ISO 8601 format date-type string</dd></dl></div><div class="refsect2" lang="en"><a name="id2866436"></a><h3><a name="Session.SetIdleHint"></a>SetIdleHint ()</h3><a class="indexterm" name="id2866446"></a><pre class="programlisting">SetIdleHint (in 'b' idle_hint)</pre></div><p>This may be used by the session to indicate that + it is idle. + </p><p>Use of this method is restricted to the user + that owns the session.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>idle_hint</code></em>:</span></dt><dd>boolean value to set the idle-hint to</dd></dl></div></div><div class="refsect1" lang="en"><a name="id2866486"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2866494"></a><h3><a name="Session::ActiveChanged"></a>The ActiveChanged signal</h3><a class="indexterm" name="id2866505"></a><pre class="programlisting">ActiveChanged ('b' is_active)</pre></div><p>Emitted when the active property has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>is_active</code></em>:</span></dt><dd>TRUE if the session is active, otherwise FALSE</dd></dl></div><div class="refsect2" lang="en"><a name="id2866539"></a><h3><a name="Session::IdleHintChanged"></a>The IdleHintChanged signal</h3><a class="indexterm" name="id2866550"></a><pre class="programlisting">IdleHintChanged ('b' hint)</pre></div><p>Emitted when the idle-hint property has changed.</p><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>hint</code></em>:</span></dt><dd>the new value of idle-hint</dd></dl></div><div class="refsect2" lang="en"><a name="id2866583"></a><h3><a name="Session::Lock"></a>The Lock signal</h3><a class="indexterm" name="id2866593"></a><pre class="programlisting">Lock ()</pre></div><p>Emitted in response to a call to the <a href="#Session.Lock"><code class="function">Lock()</code></a> method.</p><p>It is intended that the screensaver for the session should lock the screen in response to this signal.</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866631"></a><h3><a name="Session::Unlock"></a>The Unlock signal</h3><a class="indexterm" name="id2866640"></a><pre class="programlisting">Unlock ()</pre></div><p>Emitted in response to a call to the <a href="#Session.Unlock"><code class="function">Unlock()</code></a> method.</p><p>It is intended that the screensaver for the session should unlock the screen in response to this signal.</p><div class="variablelist"><dl></dl></div></div><div class="refsect1" lang="en"><a name="id2866679"></a><h2>Property Details</h2><div class="refsect2" lang="en"><a name="id2866687"></a><h3><a name="Session:user"></a>The "user" property</h3><a class="indexterm" name="id2866697"></a><pre class="programlisting">'user' readwrite 'u' +</pre></div><p>The user assigned to the session.</p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866719"></a><h3><a name="Session:session-type"></a>The "session-type" property</h3><a class="indexterm" name="id2866729"></a><pre class="programlisting">'session-type' readwrite 's' +</pre></div><p>The type of the session.</p><p>Warning: we haven't yet defined the allowed values for this property. + It is probably best to avoid this until we do. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866757"></a><h3><a name="Session:remote-host-name"></a>The "remote-host-name" property</h3><a class="indexterm" name="id2866768"></a><pre class="programlisting">'remote-host-name' readwrite 's' +</pre></div><p>The remote host name for the session. + </p><p>This will be set in situations where the session is + opened and controlled from a remote system. + </p><p>For example, this value will be set when the + session is created from an SSH or XDMCP connection. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866801"></a><h3><a name="Session:display-device"></a>The "display-device" property</h3><a class="indexterm" name="id2866811"></a><pre class="programlisting">'display-device' readwrite 's' +</pre></div><p>The display device (aka TTY) that the + session is connected to. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866834"></a><h3><a name="Session:x11-display"></a>The "x11-display" property</h3><a class="indexterm" name="id2866844"></a><pre class="programlisting">'x11-display' readwrite 's' +</pre></div><p>Value of the X11 DISPLAY for this session + if one is present. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866866"></a><h3><a name="Session:x11-display-device"></a>The "x11-display-device" property</h3><a class="indexterm" name="id2866878"></a><pre class="programlisting">'x11-display-device' readwrite 's' +</pre></div><p> + The display device (aka TTY) that the X11 display for the + session is connected to. If there is no x11-display set then + this value is undefined. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866902"></a><h3><a name="Session:active"></a>The "active" property</h3><a class="indexterm" name="id2866912"></a><pre class="programlisting">'active' readwrite 'b' +</pre></div><p> + Whether the session is active on the Seat that + it is attached to.</p><p>If the session is not attached to a seat this value is undefined. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866939"></a><h3><a name="Session:is-local"></a>The "is-local" property</h3><a class="indexterm" name="id2866950"></a><pre class="programlisting">'is-local' readwrite 'b' +</pre></div><p> + Whether the session is local</p><p>FIXME: we need to come up with a concrete definition for this value. + It was originally used as a way to identify XDMCP sessions that originate + from a remote system. + </p><div class="variablelist"><dl></dl></div><div class="refsect2" lang="en"><a name="id2866977"></a><h3><a name="Session:idle-hint"></a>The "idle-hint" property</h3><a class="indexterm" name="id2866989"></a><pre class="programlisting">'idle-hint' readwrite 'b' +</pre></div><p> + This is a hint used to indicate that the session may be idle. + </p><p> + For sessions with a <a href="#Session:x11-display"><code class="literal">x11-display</code></a> set (ie. graphical + sessions), it is up to each session to delegate the + responsibility for updating this value. Typically, the + screensaver will set this. + </p><p>However, for non-graphical sessions with a <a href="#Session:display-device"><code class="literal">display-device</code></a> set + the Session object itself will periodically update this value based + on the activity detected on the display-device itself. + </p><p> + This should not be considered authoritative. + </p><div class="variablelist"><dl></dl></div></div></div></div></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="id2868235"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>A</h3><dl><dt>Activate</dt><dd><dl><dt>Session, <a href="#id2866164">Activate ()</a></dt></dl></dd><dt>ActivateSession</dt><dd><dl><dt>Seat, <a href="#id2864438">ActivateSession ()</a></dt></dl></dd><dt>active</dt><dd><dl><dt>Session, <a href="#id2866902">The "active" property</a></dt></dl></dd><dt>ActiveChanged</dt><dd><dl><dt>Session, <a href="#id2866494">The ActiveChanged signal</a></dt></dl></dd><dt>ActiveSessionChanged</dt><dd><dl><dt>Seat, <a href="#id2864506">The ActiveSessionChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>C</h3><dl><dt>CloseSession</dt><dd><dl><dt>Manager, <a href="#id2862389">CloseSession ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>D</h3><dl><dt>display-device</dt><dd><dl><dt>Session, <a href="#id2866801">The "display-device" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>G</h3><dl><dt>GetActiveSession</dt><dd><dl><dt>Seat, <a href="#id2864389">GetActiveSession ()</a></dt></dl></dd><dt>GetCreationTime</dt><dd><dl><dt>Session, <a href="#id2866119">GetCreationTime ()</a></dt></dl></dd><dt>GetCurrentSession</dt><dd><dl><dt>Manager, <a href="#id2862639">GetCurrentSession ()</a></dt></dl></dd><dt>GetDisplayDevice</dt><dd><dl><dt>Session, <a href="#id2865886">GetDisplayDevice ()</a></dt></dl></dd><dt>GetId</dt><dd><dl><dt>Seat, <a href="#id2864287">GetId ()</a></dt><dt>Session, <a href="#id2865563">GetId ()</a></dt></dl></dd><dt>GetIdleHint</dt><dd><dl><dt>Session, <a href="#id2866324">GetIdleHint ()</a></dt></dl></dd><dt>GetIdleSinceHint</dt><dd><dl><dt>Session, <a href="#id2866390">GetIdleSinceHint ()</a></dt></dl></dd><dt>GetRemoteHostName</dt><dd><dl><dt>Session, <a href="#id2865942">GetRemoteHostName ()</a></dt></dl></dd><dt>GetSeatId</dt><dd><dl><dt>Session, <a href="#id2865605">GetSeatId ()</a></dt></dl></dd><dt>GetSeats</dt><dd><dl><dt>Manager, <a href="#id2862451">GetSeats ()</a></dt></dl></dd><dt>GetSessionForCookie</dt><dd><dl><dt>Manager, <a href="#id2862522">GetSessionForCookie ()</a></dt></dl></dd><dt>GetSessionForUnixProcess</dt><dd><dl><dt>Manager, <a href="#id2862580">GetSessionForUnixProcess ()</a></dt></dl></dd><dt>GetSessions</dt><dd><dl><dt>Seat, <a href="#id2864326">GetSessions ()</a></dt></dl></dd><dt>GetSessionsForUser</dt><dd><dl><dt>Manager, <a href="#id2862697">GetSessionsForUser ()</a></dt></dl></dd><dt>GetSessionType</dt><dd><dl><dt>Session, <a href="#id2865657">GetSessionType ()</a></dt></dl></dd><dt>GetSystemIdleHint</dt><dd><dl><dt>Manager, <a href="#id2862773">GetSystemIdleHint ()</a></dt></dl></dd><dt>GetSystemIdleSinceHint</dt><dd><dl><dt>Manager, <a href="#id2862830">GetSystemIdleSinceHint ()</a></dt></dl></dd><dt>GetUser</dt><dd><dl><dt>Session, <a href="#id2865718">GetUser ()</a></dt></dl></dd><dt>GetX11Display</dt><dd><dl><dt>Session, <a href="#id2865772">GetX11Display ()</a></dt></dl></dd><dt>GetX11DisplayDevice</dt><dd><dl><dt>Session, <a href="#id2865827">GetX11DisplayDevice ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>I</h3><dl><dt>idle-hint</dt><dd><dl><dt>Session, <a href="#id2866977">The "idle-hint" property</a></dt></dl></dd><dt>IdleHintChanged</dt><dd><dl><dt>Session, <a href="#id2866539">The IdleHintChanged signal</a></dt></dl></dd><dt>is-local</dt><dd><dl><dt>Session, <a href="#id2866939">The "is-local" property</a></dt></dl></dd><dt>IsActive</dt><dd><dl><dt>Session, <a href="#id2865999">IsActive ()</a></dt></dl></dd><dt>IsLocal</dt><dd><dl><dt>Session, <a href="#id2866058">IsLocal ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lock</dt><dd><dl><dt>Session, <a href="#id2866210">Lock ()</a>, <a href="#id2866583">The Lock signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>O</h3><dl><dt>OpenSession</dt><dd><dl><dt>Manager, <a href="#id2862147">OpenSession ()</a></dt></dl></dd><dt>OpenSessionWithParameters</dt><dd><dl><dt>Manager, <a href="#id2862272">OpenSessionWithParameters ()</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>R</h3><dl><dt>remote-host-name</dt><dd><dl><dt>Session, <a href="#id2866757">The "remote-host-name" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>SeatAdded</dt><dd><dl><dt>Manager, <a href="#id2862886">The SeatAdded signal</a></dt></dl></dd><dt>SeatRemoved</dt><dd><dl><dt>Manager, <a href="#id2862930">The SeatRemoved signal</a></dt></dl></dd><dt>session-type</dt><dd><dl><dt>Session, <a href="#id2866719">The "session-type" property</a></dt></dl></dd><dt>SessionAdded</dt><dd><dl><dt>Seat, <a href="#id2864550">The SessionAdded signal</a></dt></dl></dd><dt>SessionRemoved</dt><dd><dl><dt>Seat, <a href="#id2864594">The SessionRemoved signal</a></dt></dl></dd><dt>SetIdleHint</dt><dd><dl><dt>Session, <a href="#id2866436">SetIdleHint ()</a></dt></dl></dd><dt>SystemIdleHintChanged</dt><dd><dl><dt>Manager, <a href="#id2862974">The SystemIdleHintChanged signal</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>U</h3><dl><dt>Unlock</dt><dd><dl><dt>Session, <a href="#id2866265">Unlock ()</a>, <a href="#id2866631">The Unlock signal</a></dt></dl></dd><dt>user</dt><dd><dl><dt>Session, <a href="#id2866687">The "user" property</a></dt></dl></dd></dl></div><div class="indexdiv"><h3>X</h3><dl><dt>x11-display</dt><dd><dl><dt>Session, <a href="#id2866834">The "x11-display" property</a></dt></dl></dd><dt>x11-display-device</dt><dd><dl><dt>Session, <a href="#id2866866">The "x11-display-device" property</a></dt></dl></dd></dl></div></div></div></div></body></html> |