summaryrefslogtreecommitdiffstats
path: root/doc/spec
diff options
context:
space:
mode:
authorWilliam Jon McCann <mccann@jhu.edu>2007-03-13 13:50:58 -0400
committerWilliam Jon McCann <mccann@jhu.edu>2007-03-13 13:50:58 -0400
commit0f1d6b3b234a1f8d8c6b9dff38388ab58f695b64 (patch)
tree20233bd1ae56b5bd0b9a3434f37266e1a0d76f40 /doc/spec
parent921b5e02edf59117b64385edbe4d191819d90abd (diff)
deprecate the user properties and add unix-user properties
Also added deprecated notes to the docs. New code should be using GetUnixUser instead of GetUser etc.
Diffstat (limited to 'doc/spec')
-rw-r--r--doc/spec/ck-manager.xml22
-rw-r--r--doc/spec/ck-session.xml21
2 files changed, 43 insertions, 0 deletions
diff --git a/doc/spec/ck-manager.xml b/doc/spec/ck-manager.xml
index 998df32..077782f 100644
--- a/doc/spec/ck-manager.xml
+++ b/doc/spec/ck-manager.xml
@@ -192,6 +192,27 @@
</doc:description>
</doc:doc>
</method>
+ <method name="GetSessionsForUnixUser">
+ <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
+ <arg name="uid" direction="in" type="u">
+ <doc:doc>
+ <doc:summary>POSIX User identification</doc:summary>
+ </doc:doc>
+ </arg>
+ <arg name="sessions" direction="out" type="ao">
+ <doc:doc>
+ <doc:summary>an array of Session IDs</doc:summary>
+ </doc:doc>
+ </arg>
+ <doc:doc>
+ <doc:description>
+ <doc:para>This gets a list of all the <doc:ref type="interface" to="Session">Sessions</doc:ref>
+ that are currently open for the specified user.</doc:para>
+ <doc:para>Each Session ID is an D-Bus object path for the object that implements the
+ <doc:ref type="interface" to="Session">Session</doc:ref> interface.</doc:para>
+ </doc:description>
+ </doc:doc>
+ </method>
<method name="GetSessionsForUser">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="uid" direction="in" type="u">
@@ -211,6 +232,7 @@
<doc:para>Each Session ID is an D-Bus object path for the object that implements the
<doc:ref type="interface" to="Session">Session</doc:ref> interface.</doc:para>
</doc:description>
+ <doc:deprecated version="0.1.3" instead="GetSessionsForUnixUser"/>
</doc:doc>
</method>
diff --git a/doc/spec/ck-session.xml b/doc/spec/ck-session.xml
index 5b1d843..c927c8c 100644
--- a/doc/spec/ck-session.xml
+++ b/doc/spec/ck-session.xml
@@ -61,9 +61,22 @@
<doc:doc>
<doc:description><doc:para>Returns the user that the session belongs to.</doc:para>
</doc:description>
+ <doc:deprecated version="0.1.3" instead="GetUnixUser"/>
<doc:seealso><doc:ref type="property" to="Session:user">user</doc:ref></doc:seealso>
</doc:doc>
</method>
+ <method name="GetUnixUser">
+ <arg name="uid" direction="out" type="i">
+ <doc:doc>
+ <doc:summary>POSIX User ID</doc:summary>
+ </doc:doc>
+ </arg>
+ <doc:doc>
+ <doc:description><doc:para>Returns the POSIX user ID that the session belongs to.</doc:para>
+ </doc:description>
+ <doc:seealso><doc:ref type="property" to="Session:unix-user">unix-user</doc:ref></doc:seealso>
+ </doc:doc>
+ </method>
<method name="GetX11Display">
<arg name="display" direction="out" type="s">
<doc:doc>
@@ -291,11 +304,19 @@
</doc:doc>
</signal>
+ <property name="unix-user" type="u" access="readwrite">
+ <doc:doc>
+ <doc:description>
+ <doc:para>The user assigned to the session.</doc:para>
+ </doc:description>
+ </doc:doc>
+ </property>
<property name="user" type="u" access="readwrite">
<doc:doc>
<doc:description>
<doc:para>The user assigned to the session.</doc:para>
</doc:description>
+ <doc:deprecated version="0.1.3" instead="unix-user"/>
</doc:doc>
</property>
<property name="session-type" type="s" access="readwrite">