summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWilliam Jon McCann <mccann@jhu.edu>2007-03-10 17:05:06 -0500
committerWilliam Jon McCann <mccann@jhu.edu>2007-03-10 17:05:06 -0500
commit6ce9a74f69f611bc5aeeb57a4bf9efea19774938 (patch)
treeb9f7497e073be42679864e12157239526da2ddbc /doc
parent50ff6eda31c06cea4e3b8010d114e66cfdb3f6e6 (diff)
add the generated doc html
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/ConsoleKit.html96
2 files changed, 96 insertions, 1 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
index 4337b46..958a222 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1,6 +1,5 @@
Makefile
Makefile.in
ConsoleKit.xml
-ConsoleKit.html
*.o
*~
diff --git a/doc/ConsoleKit.html b/doc/ConsoleKit.html
new file mode 100644
index 0000000..3d57751
--- /dev/null
+++ b/doc/ConsoleKit.html
@@ -0,0 +1,96 @@
+<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">&lt;<a href="mailto:mccann@jhu.edu">mccann@jhu.edu</a>&gt;</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="#id2828623">Introduction</a></span></dt><dt><span class="part"><a href="#id2828633">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="#id2893974">About</a></span></dt><dt><span class="sect1"><a href="#id2871072">Defining the Problem</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="#id2828646">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"> &#8212; Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> &#8212; Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> &#8212; Session interface</span></dt></dl></dd></dl></dd><dt><span class="index"><a href="#id2870174">Index</a></span></dt></dl></div><div class="preface" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id2828623"></a>Introduction</h2></div></div></div><p>
+ </p></div><div class="part" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id2828633"></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="#id2893974">About</a></span></dt><dt><span class="sect1"><a href="#id2871072">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="#id2893974">About</a></span></dt><dt><span class="sect1"><a href="#id2871072">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="id2893974"></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="id2871072"></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="id2828646"></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"> &#8212; Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> &#8212; Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> &#8212; 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>
+ Please see the other sections of this manual for an introduction to
+ these concepts.
+ </p><p>
+ This API is not yet stable and is likely to change in the future.
+ </p><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="refentrytitle"><a href="#Manager">org.freedesktop.ConsoleKit.Manager</a></span><span class="refpurpose"> &#8212; Manager interface</span></dt><dt><span class="refentrytitle"><a href="#Seat">org.freedesktop.ConsoleKit.Seat</a></span><span class="refpurpose"> &#8212; Seat interface</span></dt><dt><span class="refentrytitle"><a href="#Session">org.freedesktop.ConsoleKit.Session</a></span><span class="refpurpose"> &#8212; 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 &#8212; Manager interface</p></div><div class="refsynopsisdiv"><h2>Methods</h2><pre class="synopsis"><a href="#Manager-OpenSession">OpenSession</a> (out 's' cookie)
+<a href="#Manager-OpenSessionWithParameters">OpenSessionWithParameters</a> (in 'a(sv)' parameters,
+ out 's' cookie)
+<a href="#Manager-CloseSession">CloseSession</a> (in 's' cookie,
+ out 'b' result)
+<a href="#Manager-GetSeats">GetSeats</a> (out 'ao' seats)
+<a href="#Manager-GetCurrentSession">GetCurrentSession</a> (out 'o' ssid)
+<a href="#Manager-GetSessionForCookie">GetSessionForCookie</a> (in 's' cookie,
+ out 'o' ssid)
+<a href="#Manager-GetSessionForUnixProcess">GetSessionForUnixProcess</a> (in 'u' pid,
+ out 'o' ssid)
+<a href="#Manager-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="id2822682"></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="id2822725"></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="id2822743"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id2865681"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id2865694"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2865704"></a><h3><a name="Manager-OpenSession"></a>OpenSession ()</h3><a class="indexterm" name="id2865717"></a><pre class="programlisting">OpenSession (out 's' cookie)</pre></div><div class="refsect2" lang="en"><a name="id2865740"></a><h3><a name="Manager-OpenSessionWithParameters"></a>OpenSessionWithParameters ()</h3><a class="indexterm" name="id2865753"></a><pre class="programlisting">OpenSessionWithParameters (in 'a(sv)' parameters,
+ out 's' cookie)</pre></div><div class="refsect2" lang="en"><a name="id2865778"></a><h3><a name="Manager-CloseSession"></a>CloseSession ()</h3><a class="indexterm" name="id2865791"></a><pre class="programlisting">CloseSession (in 's' cookie,
+ out 'b' result)</pre></div><div class="refsect2" lang="en"><a name="id2865814"></a><h3><a name="Manager-GetSeats"></a>GetSeats ()</h3><a class="indexterm" name="id2865827"></a><pre class="programlisting">GetSeats (out 'ao' seats)</pre></div><div class="refsect2" lang="en"><a name="id2865849"></a><h3><a name="Manager-GetCurrentSession"></a>GetCurrentSession ()</h3><a class="indexterm" name="id2865862"></a><pre class="programlisting">GetCurrentSession (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id2865885"></a><h3><a name="Manager-GetSessionForCookie"></a>GetSessionForCookie ()</h3><a class="indexterm" name="id2865898"></a><pre class="programlisting">GetSessionForCookie (in 's' cookie,
+ out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id2865922"></a><h3><a name="Manager-GetSessionForUnixProcess"></a>GetSessionForUnixProcess ()</h3><a class="indexterm" name="id2865936"></a><pre class="programlisting">GetSessionForUnixProcess (in 'u' pid,
+ out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id2865960"></a><h3><a name="Manager-GetSessionsForUser"></a>GetSessionsForUser ()</h3><a class="indexterm" name="id2865973"></a><pre class="programlisting">GetSessionsForUser (in 'u' uid,
+ out 'ao' sessions)</pre></div><div class="refsect2" lang="en"><a name="id2865997"></a><h3><a name="Manager-GetSystemIdleHint"></a>GetSystemIdleHint ()</h3><a class="indexterm" name="id2866010"></a><pre class="programlisting">GetSystemIdleHint (out 'b' idle_hint)</pre></div><div class="refsect2" lang="en"><a name="id2866032"></a><h3><a name="Manager-GetSystemIdleSinceHint"></a>GetSystemIdleSinceHint ()</h3><a class="indexterm" name="id2866046"></a><pre class="programlisting">GetSystemIdleSinceHint (out 's' iso8601_datetime)</pre></div></div><div class="refsect1" lang="en"><a name="id2866070"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2866081"></a><h3><a name="Manager-signal-SeatAdded"></a>SeatAdded ()</h3><a class="indexterm" name="id2866094"></a><pre class="programlisting">SeatAdded ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2866117"></a><h3><a name="Manager-signal-SeatRemoved"></a>SeatRemoved ()</h3><a class="indexterm" name="id2866130"></a><pre class="programlisting">SeatRemoved ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2866152"></a><h3><a name="Manager-signal-SystemIdleHintChanged"></a>SystemIdleHintChanged ()</h3><a class="indexterm" name="id2866166"></a><pre class="programlisting">SystemIdleHintChanged ('b' hint)</pre></div></div><div class="refsect1" lang="en"><a name="id2866190"></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 &#8212; 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="id2867008"></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="id2867051"></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="id2867068"></a><h2>Properties</h2><pre class="synopsis"></pre></div><div class="refsect1" lang="en"><a name="id2867084"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id2867097"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2867108"></a><h3><a name="Seat-GetId"></a>GetId ()</h3><a class="indexterm" name="id2867120"></a><pre class="programlisting">GetId (out 'o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2867143"></a><h3><a name="Seat-GetSessions"></a>GetSessions ()</h3><a class="indexterm" name="id2867155"></a><pre class="programlisting">GetSessions (out 'ao' sessions)</pre></div><div class="refsect2" lang="en"><a name="id2867178"></a><h3><a name="Seat-GetActiveSession"></a>GetActiveSession ()</h3><a class="indexterm" name="id2867191"></a><pre class="programlisting">GetActiveSession (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id2867215"></a><h3><a name="Seat-ActivateSession"></a>ActivateSession ()</h3><a class="indexterm" name="id2867227"></a><pre class="programlisting">ActivateSession (in 'o' ssid)</pre></div></div><div class="refsect1" lang="en"><a name="id2867252"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2867262"></a><h3><a name="Seat-signal-ActiveSessionChanged"></a>ActiveSessionChanged ()</h3><a class="indexterm" name="id2867276"></a><pre class="programlisting">ActiveSessionChanged ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2867299"></a><h3><a name="Seat-signal-SessionAdded"></a>SessionAdded ()</h3><a class="indexterm" name="id2867312"></a><pre class="programlisting">SessionAdded ('o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2867334"></a><h3><a name="Seat-signal-SessionRemoved"></a>SessionRemoved ()</h3><a class="indexterm" name="id2867348"></a><pre class="programlisting">SessionRemoved ('o' sid)</pre></div></div><div class="refsect1" lang="en"><a name="id2867371"></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 &#8212; 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="id2868026"></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="id2868077"></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="id2868094"></a><h2>Properties</h2><pre class="synopsis"><a href="#Session-property-user">'user'</a> read 'i'
+<a href="#Session-property-session-type">'session-type'</a> read 's'
+<a href="#Session-property-remote-host-name">'remote-host-name'</a> read 's'
+<a href="#Session-property-display-device">'display-device'</a> read 's'
+<a href="#Session-property-x11-display">'x11-display'</a> read 's'
+<a href="#Session-property-x11-display-device">'x11-display-device'</a> read 's'
+<a href="#Session-property-active">'active'</a> read 'b'
+<a href="#Session-property-is-local">'is-local'</a> read 'b'
+<a href="#Session-property-idle-hint">'idle-hint'</a> read 'b'
+</pre></div><div class="refsect1" lang="en"><a name="id2868190"></a><h2>Description</h2><p></p></div><div class="refsect1" lang="en"><a name="id2868204"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2868214"></a><h3><a name="Session-GetId"></a>GetId ()</h3><a class="indexterm" name="id2868227"></a><pre class="programlisting">GetId (out 'o' ssid)</pre></div><div class="refsect2" lang="en"><a name="id2868249"></a><h3><a name="Session-GetSeatId"></a>GetSeatId ()</h3><a class="indexterm" name="id2868262"></a><pre class="programlisting">GetSeatId (out 'o' sid)</pre></div><div class="refsect2" lang="en"><a name="id2868285"></a><h3><a name="Session-GetSessionType"></a>GetSessionType ()</h3><a class="indexterm" name="id2868298"></a><pre class="programlisting">GetSessionType (out 's' type)</pre></div><div class="refsect2" lang="en"><a name="id2868321"></a><h3><a name="Session-GetUser"></a>GetUser ()</h3><a class="indexterm" name="id2868333"></a><pre class="programlisting">GetUser (out 'i' uid)</pre></div><div class="refsect2" lang="en"><a name="id2868356"></a><h3><a name="Session-GetX11Display"></a>GetX11Display ()</h3><a class="indexterm" name="id2868369"></a><pre class="programlisting">GetX11Display (out 's' display)</pre></div><div class="refsect2" lang="en"><a name="id2868393"></a><h3><a name="Session-GetX11DisplayDevice"></a>GetX11DisplayDevice ()</h3><a class="indexterm" name="id2868405"></a><pre class="programlisting">GetX11DisplayDevice (out 's' x11_display_device)</pre></div><div class="refsect2" lang="en"><a name="id2868428"></a><h3><a name="Session-GetDisplayDevice"></a>GetDisplayDevice ()</h3><a class="indexterm" name="id2868442"></a><pre class="programlisting">GetDisplayDevice (out 's' display_device)</pre></div><div class="refsect2" lang="en"><a name="id2868465"></a><h3><a name="Session-GetRemoteHostName"></a>GetRemoteHostName ()</h3><a class="indexterm" name="id2868477"></a><pre class="programlisting">GetRemoteHostName (out 's' remote_host_name)</pre></div><div class="refsect2" lang="en"><a name="id2868501"></a><h3><a name="Session-IsActive"></a>IsActive ()</h3><a class="indexterm" name="id2868514"></a><pre class="programlisting">IsActive (out 'b' active)</pre></div><div class="refsect2" lang="en"><a name="id2868536"></a><h3><a name="Session-IsLocal"></a>IsLocal ()</h3><a class="indexterm" name="id2868549"></a><pre class="programlisting">IsLocal (out 'b' local)</pre></div><div class="refsect2" lang="en"><a name="id2868572"></a><h3><a name="Session-GetCreationTime"></a>GetCreationTime ()</h3><a class="indexterm" name="id2868585"></a><pre class="programlisting">GetCreationTime (out 's' iso8601_datetime)</pre></div><div class="refsect2" lang="en"><a name="id2868608"></a><h3><a name="Session-Activate"></a>Activate ()</h3><a class="indexterm" name="id2868620"></a><pre class="programlisting">Activate ()</pre></div><div class="refsect2" lang="en"><a name="id2868643"></a><h3><a name="Session-Lock"></a>Lock ()</h3><a class="indexterm" name="id2868656"></a><pre class="programlisting">Lock ()</pre></div><div class="refsect2" lang="en"><a name="id2868678"></a><h3><a name="Session-Unlock"></a>Unlock ()</h3><a class="indexterm" name="id2868691"></a><pre class="programlisting">Unlock ()</pre></div><div class="refsect2" lang="en"><a name="id2868713"></a><h3><a name="Session-GetIdleHint"></a>GetIdleHint ()</h3><a class="indexterm" name="id2868725"></a><pre class="programlisting">GetIdleHint (out 'b' idle_hint)</pre></div><div class="refsect2" lang="en"><a name="id2868749"></a><h3><a name="Session-GetIdleSinceHint"></a>GetIdleSinceHint ()</h3><a class="indexterm" name="id2868762"></a><pre class="programlisting">GetIdleSinceHint (out 's' iso8601_datetime)</pre></div><div class="refsect2" lang="en"><a name="id2868785"></a><h3><a name="Session-SetIdleHint"></a>SetIdleHint ()</h3><a class="indexterm" name="id2868797"></a><pre class="programlisting">SetIdleHint (in 'b' idle_hint)</pre></div></div><div class="refsect1" lang="en"><a name="id2868821"></a><h2>Signal Details</h2><div class="refsect2" lang="en"><a name="id2868832"></a><h3><a name="Session-signal-ActiveChanged"></a>ActiveChanged ()</h3><a class="indexterm" name="id2868845"></a><pre class="programlisting">ActiveChanged ('b' is_active)</pre></div><div class="refsect2" lang="en"><a name="id2868868"></a><h3><a name="Session-signal-IdleHintChanged"></a>IdleHintChanged ()</h3><a class="indexterm" name="id2868882"></a><pre class="programlisting">IdleHintChanged ('b' hint)</pre></div><div class="refsect2" lang="en"><a name="id2868905"></a><h3><a name="Session-signal-Lock"></a>Lock ()</h3><a class="indexterm" name="id2868918"></a><pre class="programlisting">Lock ()</pre></div><div class="refsect2" lang="en"><a name="id2868940"></a><h3><a name="Session-signal-Unlock"></a>Unlock ()</h3><a class="indexterm" name="id2868954"></a><pre class="programlisting">Unlock ()</pre></div></div><div class="refsect1" lang="en"><a name="id2868977"></a><h2>Property Details</h2><div class="refsect2" lang="en"><a name="id2868988"></a><h3><a name="Session-property-user"></a>'user'</h3><a class="indexterm" name="id2869001"></a><pre class="programlisting">'user' read 'i'
+</pre></div><div class="refsect2" lang="en"><a name="id2869023"></a><h3><a name="Session-property-session-type"></a>'session-type'</h3><a class="indexterm" name="id2869036"></a><pre class="programlisting">'session-type' read 's'
+</pre></div><div class="refsect2" lang="en"><a name="id2869059"></a><h3><a name="Session-property-remote-host-name"></a>'remote-host-name'</h3><a class="indexterm" name="id2869072"></a><pre class="programlisting">'remote-host-name' read 's'
+</pre></div><div class="refsect2" lang="en"><a name="id2869095"></a><h3><a name="Session-property-display-device"></a>'display-device'</h3><a class="indexterm" name="id2869109"></a><pre class="programlisting">'display-device' read 's'
+</pre></div><div class="refsect2" lang="en"><a name="id2869131"></a><h3><a name="Session-property-x11-display"></a>'x11-display'</h3><a class="indexterm" name="id2869145"></a><pre class="programlisting">'x11-display' read 's'
+</pre></div><div class="refsect2" lang="en"><a name="id2869168"></a><h3><a name="Session-property-x11-display-device"></a>'x11-display-device'</h3><a class="indexterm" name="id2869182"></a><pre class="programlisting">'x11-display-device' read 's'
+</pre></div><div class="refsect2" lang="en"><a name="id2869206"></a><h3><a name="Session-property-active"></a>'active'</h3><a class="indexterm" name="id2869219"></a><pre class="programlisting">'active' read 'b'
+</pre></div><div class="refsect2" lang="en"><a name="id2869241"></a><h3><a name="Session-property-is-local"></a>'is-local'</h3><a class="indexterm" name="id2869254"></a><pre class="programlisting">'is-local' read 'b'
+</pre></div><div class="refsect2" lang="en"><a name="id2869277"></a><h3><a name="Session-property-idle-hint"></a>'idle-hint'</h3><a class="indexterm" name="id2869290"></a><pre class="programlisting">'idle-hint' read 'b'
+</pre></div></div></div></div></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a name="id2870174"></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="#id2868608">Activate ()</a></dt></dl></dd></dl></dd><dt>ActivateSession</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id2867215">ActivateSession ()</a></dt></dl></dd></dl></dd><dt>active</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id2869206">'active'</a></dt></dl></dd></dl></dd><dt>ActiveChanged</dt><dd><dl><dt>Session</dt><dd><dl><dt>signal, <a href="#id2868832">ActiveChanged ()</a></dt></dl></dd></dl></dd><dt>ActiveSessionChanged</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id2867262">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="#id2865778">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="#id2869095">'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="#id2867178">GetActiveSession ()</a></dt></dl></dd></dl></dd><dt>GetCreationTime</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868572">GetCreationTime ()</a></dt></dl></dd></dl></dd><dt>GetCurrentSession</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865849">GetCurrentSession ()</a></dt></dl></dd></dl></dd><dt>GetDisplayDevice</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868428">GetDisplayDevice ()</a></dt></dl></dd></dl></dd><dt>GetId</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id2867108">GetId ()</a></dt></dl></dd><dt>Session</dt><dd><dl><dt>method, <a href="#id2868214">GetId ()</a></dt></dl></dd></dl></dd><dt>GetIdleHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868713">GetIdleHint ()</a></dt></dl></dd></dl></dd><dt>GetIdleSinceHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868749">GetIdleSinceHint ()</a></dt></dl></dd></dl></dd><dt>GetRemoteHostName</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868465">GetRemoteHostName ()</a></dt></dl></dd></dl></dd><dt>GetSeatId</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868249">GetSeatId ()</a></dt></dl></dd></dl></dd><dt>GetSeats</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865814">GetSeats ()</a></dt></dl></dd></dl></dd><dt>GetSessionForCookie</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865885">GetSessionForCookie ()</a></dt></dl></dd></dl></dd><dt>GetSessionForUnixProcess</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865922">GetSessionForUnixProcess ()</a></dt></dl></dd></dl></dd><dt>GetSessions</dt><dd><dl><dt>Seat</dt><dd><dl><dt>method, <a href="#id2867143">GetSessions ()</a></dt></dl></dd></dl></dd><dt>GetSessionsForUser</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865960">GetSessionsForUser ()</a></dt></dl></dd></dl></dd><dt>GetSessionType</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868285">GetSessionType ()</a></dt></dl></dd></dl></dd><dt>GetSystemIdleHint</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865997">GetSystemIdleHint ()</a></dt></dl></dd></dl></dd><dt>GetSystemIdleSinceHint</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2866032">GetSystemIdleSinceHint ()</a></dt></dl></dd></dl></dd><dt>GetUser</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868321">GetUser ()</a></dt></dl></dd></dl></dd><dt>GetX11Display</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868356">GetX11Display ()</a></dt></dl></dd></dl></dd><dt>GetX11DisplayDevice</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868393">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="#id2869277">'idle-hint'</a></dt></dl></dd></dl></dd><dt>IdleHintChanged</dt><dd><dl><dt>Session</dt><dd><dl><dt>signal, <a href="#id2868868">IdleHintChanged ()</a></dt></dl></dd></dl></dd><dt>is-local</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id2869241">'is-local'</a></dt></dl></dd></dl></dd><dt>IsActive</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868501">IsActive ()</a></dt></dl></dd></dl></dd><dt>IsLocal</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868536">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="#id2868643">Lock ()</a></dt><dt>signal, <a href="#id2868905">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="#id2865704">OpenSession ()</a></dt></dl></dd></dl></dd><dt>OpenSessionWithParameters</dt><dd><dl><dt>Manager</dt><dd><dl><dt>method, <a href="#id2865740">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="#id2869059">'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="#id2866081">SeatAdded ()</a></dt></dl></dd></dl></dd><dt>SeatRemoved</dt><dd><dl><dt>Manager</dt><dd><dl><dt>signal, <a href="#id2866117">SeatRemoved ()</a></dt></dl></dd></dl></dd><dt>session-type</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id2869023">'session-type'</a></dt></dl></dd></dl></dd><dt>SessionAdded</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id2867299">SessionAdded ()</a></dt></dl></dd></dl></dd><dt>SessionRemoved</dt><dd><dl><dt>Seat</dt><dd><dl><dt>signal, <a href="#id2867334">SessionRemoved ()</a></dt></dl></dd></dl></dd><dt>SetIdleHint</dt><dd><dl><dt>Session</dt><dd><dl><dt>method, <a href="#id2868785">SetIdleHint ()</a></dt></dl></dd></dl></dd><dt>SystemIdleHintChanged</dt><dd><dl><dt>Manager</dt><dd><dl><dt>signal, <a href="#id2866152">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="#id2868678">Unlock ()</a></dt><dt>signal, <a href="#id2868940">Unlock ()</a></dt></dl></dd></dl></dd><dt>user</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id2868988">'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="#id2869131">'x11-display'</a></dt></dl></dd></dl></dd><dt>x11-display-device</dt><dd><dl><dt>Session</dt><dd><dl><dt>property, <a href="#id2869168">'x11-display-device'</a></dt></dl></dd></dl></dd></dl></div></div></div></div></body></html>