summaryrefslogtreecommitdiffstats
path: root/doc/ref-ck-manager.xml
blob: c2392f358768db65d6765ad18d34d2fc3c0036c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<refentry id="Manager">
  <refmeta>
    <refentrytitle role="top_of_page">org.freedesktop.ConsoleKit.Manager</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>org.freedesktop.ConsoleKit.Manager</refname>
    <refpurpose>Manager interface</refpurpose>
  </refnamediv>
  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis><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-GetCurrentSession">GetCurrentSession</link>         (out 'o'     ssid)
<link linkend="Manager-GetSessionForCookie">GetSessionForCookie</link>       (in  's'     cookie,
                           out 'o'     ssid)
<link linkend="Manager-GetSessionForUnixProcess">GetSessionForUnixProcess</link>  (in  'u'     pid,
                           out 'o'     ssid)
<link linkend="Manager-GetSessionsForUser">GetSessionsForUser</link>        (in  'u'     uid,
                           out 'ao'    sessions)
<link linkend="Manager-GetSystemIdleHint">GetSystemIdleHint</link>         (out 'b'     idle_hint)
<link linkend="Manager-GetSystemIdleSinceHint">GetSystemIdleSinceHint</link>    (out 's'     iso8601_datetime)
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="signal_proto">
    <title role="signal_proto.title">Signals</title>
    <synopsis><link linkend="Manager-signal-SeatAdded">SeatAdded</link>             ('o' sid)
<link linkend="Manager-signal-SeatRemoved">SeatRemoved</link>           ('o' sid)
<link linkend="Manager-signal-SystemIdleHintChanged">SystemIdleHintChanged</link> ('b' hint)
</synopsis>
  </refsect1>
  <refsect1 role="impl_interfaces">
    <title role="impl_interfaces.title">Implemented Interfaces</title>
    <para>org.freedesktop.ConsoleKit.Manager implements
    org.freedesktop.DBus.Introspectable,
    org.freedesktop.DBus.Properties
    </para>
  </refsect1>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis/>
  </refsect1>
  <refsect1 role="desc">
    <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>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>OpenSession (out 's' cookie)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-OpenSessionWithParameters"/>OpenSessionWithParameters ()</title>
      <indexterm>
        <primary>OpenSessionWithParameters</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>OpenSessionWithParameters (in  'a(sv)' parameters,
                           out 's'     cookie)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-CloseSession"/>CloseSession ()</title>
      <indexterm>
        <primary>CloseSession</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>CloseSession (in  's' cookie,
              out 'b' result)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSeats"/>GetSeats ()</title>
      <indexterm>
        <primary>GetSeats</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSeats (out 'ao' seats)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetCurrentSession"/>GetCurrentSession ()</title>
      <indexterm>
        <primary>GetCurrentSession</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetCurrentSession (out 'o' ssid)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSessionForCookie"/>GetSessionForCookie ()</title>
      <indexterm>
        <primary>GetSessionForCookie</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSessionForCookie (in  's' cookie,
                     out 'o' ssid)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSessionForUnixProcess"/>GetSessionForUnixProcess ()</title>
      <indexterm>
        <primary>GetSessionForUnixProcess</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSessionForUnixProcess (in  'u' pid,
                          out 'o' ssid)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSessionsForUser"/>GetSessionsForUser ()</title>
      <indexterm>
        <primary>GetSessionsForUser</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSessionsForUser (in  'u'  uid,
                    out 'ao' sessions)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSystemIdleHint"/>GetSystemIdleHint ()</title>
      <indexterm>
        <primary>GetSystemIdleHint</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSystemIdleHint (out 'b' idle_hint)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-GetSystemIdleSinceHint"/>GetSystemIdleSinceHint ()</title>
      <indexterm>
        <primary>GetSystemIdleSinceHint</primary>
        <secondary>Manager</secondary>
        <tertiary>method</tertiary>
      </indexterm>
      <programlisting>GetSystemIdleSinceHint (out 's' iso8601_datetime)</programlisting>
    </refsect2>
  </refsect1>
  <refsect1 role="signals">
    <title role="signals.title">Signal Details</title>
    <refsect2>
      <title><anchor role="function" id="Manager-signal-SeatAdded"/>SeatAdded ()</title>
      <indexterm>
        <primary>SeatAdded</primary>
        <secondary>Manager</secondary>
        <tertiary>signal</tertiary>
      </indexterm>
      <programlisting>SeatAdded ('o' sid)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-signal-SeatRemoved"/>SeatRemoved ()</title>
      <indexterm>
        <primary>SeatRemoved</primary>
        <secondary>Manager</secondary>
        <tertiary>signal</tertiary>
      </indexterm>
      <programlisting>SeatRemoved ('o' sid)</programlisting>
    </refsect2>
    <refsect2>
      <title><anchor role="function" id="Manager-signal-SystemIdleHintChanged"/>SystemIdleHintChanged ()</title>
      <indexterm>
        <primary>SystemIdleHintChanged</primary>
        <secondary>Manager</secondary>
        <tertiary>signal</tertiary>
      </indexterm>
      <programlisting>SystemIdleHintChanged ('b' hint)</programlisting>
    </refsect2>
  </refsect1>
  <refsect1 role="property_details">
    <title role="property_details.title">Property Details</title>
  </refsect1>
</refentry>