summaryrefslogtreecommitdiff
path: root/doc/xml/ref-ck-manager.xml
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2009-07-14 17:41:06 +0200
committerMichael Biebl <biebl@debian.org>2009-07-14 17:41:06 +0200
commit1f223c41689bbbd64f8749ff7c09967a49407022 (patch)
tree940cfec56674c79c9a00820529f9c98f7dd6f48a /doc/xml/ref-ck-manager.xml
parent517ae9bab3e1aeda58ef4f042fa1346d411a9a4c (diff)
downloadconsolekit-upstream/0.2.10.tar.gz
Imported Upstream version 0.2.10upstream/0.2.10
Diffstat (limited to 'doc/xml/ref-ck-manager.xml')
-rw-r--r--doc/xml/ref-ck-manager.xml20
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/xml/ref-ck-manager.xml b/doc/xml/ref-ck-manager.xml
index 2aceef8..3eb3a92 100644
--- a/doc/xml/ref-ck-manager.xml
+++ b/doc/xml/ref-ck-manager.xml
@@ -8,12 +8,15 @@
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Methods</title>
- <synopsis><link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie)
+ <synopsis><link linkend="Manager.Restart">Restart</link> ()
+<link linkend="Manager.Stop">Stop</link> ()
+<link linkend="Manager.OpenSession">OpenSession</link> (out 's' cookie)
<link linkend="Manager.OpenSessionWithParameters">OpenSessionWithParameters</link> (in 'a(sv)' parameters,
out 's' cookie)
<link linkend="Manager.CloseSession">CloseSession</link> (in 's' cookie,
out 'b' result)
<link linkend="Manager.GetSeats">GetSeats</link> (out 'ao' seats)
+<link linkend="Manager.GetSessions">GetSessions</link> (out 'ao' sessions)
<link linkend="Manager.GetSessionForCookie">GetSessionForCookie</link> (in 's' cookie,
out 'o' ssid)
<link linkend="Manager.GetSessionForUnixProcess">GetSessionForUnixProcess</link> (in 'u' pid,
@@ -49,7 +52,11 @@
<title role="desc.title">Description</title>
<para/>
</refsect1>
- <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2>
+ <refsect1 role="details"><title role="details.title">Details</title><refsect2><title><anchor role="function" id="Manager.Restart"/>Restart ()</title><indexterm><primary>Restart</primary><secondary>Manager</secondary></indexterm><programlisting>Restart ()</programlisting></refsect2>
+ <para>This method initiates a request to restart (ie. reboot) the computer system.</para>
+ <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.Stop"/>Stop ()</title><indexterm><primary>Stop</primary><secondary>Manager</secondary></indexterm><programlisting>Stop ()</programlisting></refsect2>
+ <para>This method initiates a request to stop (ie. shutdown) the computer system.</para>
+ <variablelist role="params"/><refsect2><title><anchor role="function" id="Manager.OpenSession"/>OpenSession ()</title><indexterm><primary>OpenSession</primary><secondary>Manager</secondary></indexterm><programlisting>OpenSession (out 's' cookie)</programlisting></refsect2>
<para>This method requests that a new <link linkend="Session">Session</link>
be created for the calling process. The properties of this new Session are set automatically
from information collected about the calling process.
@@ -126,7 +133,14 @@ See also:
<link linkend="Seat">Seat</link> interface.</para>
<variablelist role="params"><varlistentry><term><parameter>seats</parameter>:</term><listitem><simpara>an array of Seat IDs</simpara></listitem></varlistentry></variablelist><para>
See also:
-<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para><refsect2><title><anchor role="function" id="Manager.GetSessionForCookie"/>GetSessionForCookie ()</title><indexterm><primary>GetSessionForCookie</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionForCookie (in 's' cookie,
+<link linkend="Seat">org.freedesktop.ConsoleKit.Seat</link></para><refsect2><title><anchor role="function" id="Manager.GetSessions"/>GetSessions ()</title><indexterm><primary>GetSessions</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessions (out 'ao' sessions)</programlisting></refsect2>
+ <para>This gets a list of all the <link linkend="Sessions">Sessions</link>
+ that are currently present on the system.</para>
+ <para>Each Session ID is an D-Bus object path for the object that implements the
+ <link linkend="Session">Session</link> interface.</para>
+ <variablelist role="params"><varlistentry><term><parameter>sessions</parameter>:</term><listitem><simpara>an array of Session IDs</simpara></listitem></varlistentry></variablelist><para>
+See also:
+<link linkend="Session">org.freedesktop.ConsoleKit.Session</link></para><refsect2><title><anchor role="function" id="Manager.GetSessionForCookie"/>GetSessionForCookie ()</title><indexterm><primary>GetSessionForCookie</primary><secondary>Manager</secondary></indexterm><programlisting>GetSessionForCookie (in 's' cookie,
out 'o' ssid)</programlisting></refsect2>
<para>Returns the session ID that is associated with the specified cookie.
</para>