← Back to branch summary

~ubuntu-branches/ubuntu/trusty/indicator-session/trusty

« back to all changes in this revision

Viewing changes to src/org.freedesktop.ConsoleKit.Session.xml

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release
  • Date: 2013-05-02 22:59:05 UTC
  • mfrom: (1.1.60)
  • Revision ID: package-import@ubuntu.com-20130502225905-pysuolshc9y1vmf4
Tags: 12.10.5daily13.05.02-0ubuntu1
Automatic snapshot from revision 388

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org.freedesktop.ConsoleKit.Session.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<node xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
3
 
 
4
 
  <interface name="org.freedesktop.ConsoleKit.Session">
5
 
    <doc:doc>
6
 
      <doc:description>
7
 
        <doc:para>Session objects represent and store information
8
 
        related to a user session.
9
 
        </doc:para>
10
 
        <doc:para>The properties associated with the Session
11
 
        specifically refer to the properties of the "session leader".
12
 
        </doc:para>
13
 
      </doc:description>
14
 
    </doc:doc>
15
 
    <method name="GetId">
16
 
      <arg name="ssid" direction="out" type="o">
17
 
        <doc:doc>
18
 
          <doc:summary>Session ID</doc:summary>
19
 
        </doc:doc>
20
 
      </arg>
21
 
      <doc:doc>
22
 
        <doc:description><doc:para>Returns the ID for Session.</doc:para>
23
 
        </doc:description>
24
 
      </doc:doc>
25
 
    </method>
26
 
    <method name="GetSeatId">
27
 
      <arg name="sid" direction="out" type="o">
28
 
        <doc:doc>
29
 
          <doc:summary>Seat ID</doc:summary>
30
 
        </doc:doc>
31
 
      </arg>
32
 
      <doc:doc>
33
 
        <doc:description><doc:para>Returns the ID for the Seat the Session is
34
 
        attached to.</doc:para>
35
 
        </doc:description>
36
 
        <doc:seealso><doc:ref type="interface" to="Seat">org.freedesktop.ConsoleKit.Seat</doc:ref></doc:seealso>
37
 
      </doc:doc>
38
 
    </method>
39
 
    <method name="GetSessionType">
40
 
      <arg name="type" direction="out" type="s">
41
 
        <doc:doc>
42
 
          <doc:summary>Session type</doc:summary>
43
 
        </doc:doc>
44
 
      </arg>
45
 
      <doc:doc>
46
 
        <doc:description>
47
 
          <doc:para>Returns the type of the session.</doc:para>
48
 
          <doc:para>Warning: we haven't yet defined the allowed values for this property.
49
 
          It is probably best to avoid this until we do.
50
 
          </doc:para>
51
 
        </doc:description>
52
 
        <doc:seealso><doc:ref type="property" to="Session:session-type">session-type</doc:ref></doc:seealso>
53
 
      </doc:doc>
54
 
    </method>
55
 
    <method name="GetUser">
56
 
      <arg name="uid" direction="out" type="u">
57
 
        <doc:doc>
58
 
          <doc:summary>User ID</doc:summary>
59
 
        </doc:doc>
60
 
      </arg>
61
 
      <doc:doc>
62
 
        <doc:description><doc:para>Returns the user that the session belongs to.</doc:para>
63
 
        </doc:description>
64
 
        <doc:deprecated version="0.1.3" instead="GetUnixUser"/>
65
 
        <doc:seealso><doc:ref type="property" to="Session:user">user</doc:ref></doc:seealso>
66
 
      </doc:doc>
67
 
    </method>
68
 
    <method name="GetUnixUser">
69
 
      <arg name="uid" direction="out" type="u">
70
 
        <doc:doc>
71
 
          <doc:summary>POSIX User ID</doc:summary>
72
 
        </doc:doc>
73
 
      </arg>
74
 
      <doc:doc>
75
 
        <doc:description><doc:para>Returns the POSIX user ID that the session belongs to.</doc:para>
76
 
        </doc:description>
77
 
        <doc:seealso><doc:ref type="property" to="Session:unix-user">unix-user</doc:ref></doc:seealso>
78
 
      </doc:doc>
79
 
    </method>
80
 
    <method name="GetX11Display">
81
 
      <arg name="display" direction="out" type="s">
82
 
        <doc:doc>
83
 
          <doc:summary>The value of the X11 display</doc:summary>
84
 
        </doc:doc>
85
 
      </arg>
86
 
      <doc:doc>
87
 
        <doc:description><doc:para>Returns the value of the X11 DISPLAY for this session
88
 
        if one is present.</doc:para>
89
 
        </doc:description>
90
 
        <doc:seealso><doc:ref type="property" to="Session:x11-display">x11-display</doc:ref></doc:seealso>
91
 
      </doc:doc>
92
 
    </method>
93
 
    <method name="GetX11DisplayDevice">
94
 
       <arg name="x11_display_device" direction="out" type="s">
95
 
        <doc:doc>
96
 
          <doc:summary>The value of the X11 display device</doc:summary>
97
 
        </doc:doc>
98
 
      </arg>
99
 
      <doc:doc>
100
 
        <doc:description><doc:para>Returns the value of the display device (aka TTY) that the
101
 
        X11 display for the session is connected to.  If there is no x11-display set then this value
102
 
        is undefined.</doc:para>
103
 
        </doc:description>
104
 
        <doc:seealso><doc:ref type="property" to="Session:x11-display-device">x11-display-device</doc:ref></doc:seealso>
105
 
      </doc:doc>
106
 
    </method>
107
 
    <method name="GetDisplayDevice">
108
 
      <arg name="display_device" direction="out" type="s">
109
 
        <doc:doc>
110
 
          <doc:summary>The value of the display device</doc:summary>
111
 
        </doc:doc>
112
 
      </arg>
113
 
      <doc:doc>
114
 
        <doc:description><doc:para>Returns the value of the display device (aka TTY) that the
115
 
        session is connected to.</doc:para>
116
 
        </doc:description>
117
 
        <doc:seealso><doc:ref type="property" to="Session:display-device">display-device</doc:ref></doc:seealso>
118
 
      </doc:doc>
119
 
    </method>
120
 
    <method name="GetRemoteHostName">
121
 
      <arg name="remote_host_name" direction="out" type="s">
122
 
        <doc:doc>
123
 
          <doc:summary>The remote host name</doc:summary>
124
 
        </doc:doc>
125
 
      </arg>
126
 
      <doc:doc>
127
 
        <doc:description><doc:para>Returns the value of the remote host name for the session.
128
 
        </doc:para>
129
 
        </doc:description>
130
 
        <doc:seealso><doc:ref type="property" to="Session:remote-host-name">remote-host-name</doc:ref></doc:seealso>
131
 
      </doc:doc>
132
 
    </method>
133
 
    <method name="GetLoginSessionId">
134
 
       <arg name="login_session_id" direction="out" type="s">
135
 
        <doc:doc>
136
 
          <doc:summary>The value of the native system login session ID</doc:summary>
137
 
        </doc:doc>
138
 
      </arg>
139
 
      <doc:doc>
140
 
        <doc:description><doc:para>Returns the value of the login session ID that the
141
 
        underlying system uses to enforce session boundaries.  If there is no login session ID
142
 
        set then this value is an empty string.</doc:para>
143
 
        </doc:description>
144
 
      </doc:doc>
145
 
    </method>
146
 
    <method name="IsActive">
147
 
      <arg name="active" direction="out" type="b">
148
 
        <doc:doc>
149
 
          <doc:summary>TRUE if the session is active, otherwise FALSE</doc:summary>
150
 
        </doc:doc>
151
 
      </arg>
152
 
      <doc:doc>
153
 
        <doc:description><doc:para>Returns whether the session is active on the Seat that
154
 
        it is attached to.</doc:para>
155
 
        <doc:para>If the session is not attached to a seat this value is undefined.
156
 
        </doc:para>
157
 
        </doc:description>
158
 
        <doc:seealso><doc:ref type="property" to="Session:active">active</doc:ref></doc:seealso>
159
 
      </doc:doc>
160
 
    </method>
161
 
    <method name="IsLocal">
162
 
      <arg name="local" direction="out" type="b">
163
 
        <doc:doc>
164
 
          <doc:summary>TRUE if the session is local, otherwise FALSE</doc:summary>
165
 
        </doc:doc>
166
 
      </arg>
167
 
      <doc:doc>
168
 
        <doc:description><doc:para>Returns whether the session is local</doc:para>
169
 
        <doc:para>FIXME: we need to come up with a concrete definition for this value.
170
 
        It was originally used as a way to identify XDMCP sessions that originate
171
 
        from a remote system.
172
 
        </doc:para>
173
 
        </doc:description>
174
 
        <doc:seealso><doc:ref type="property" to="Session:is-local">is-local</doc:ref></doc:seealso>
175
 
      </doc:doc>
176
 
    </method>
177
 
    <method name="GetCreationTime">
178
 
      <arg name="iso8601_datetime" type="s" direction="out">
179
 
        <doc:doc>
180
 
          <doc:summary>An ISO 8601 format date-type string</doc:summary>
181
 
        </doc:doc>
182
 
      </arg>
183
 
      <doc:doc>
184
 
        <doc:description>
185
 
          <doc:para>Returns an ISO 8601 date-time string that corresponds to
186
 
          the time that the session was opened.
187
 
          </doc:para>
188
 
        </doc:description>
189
 
      </doc:doc>
190
 
    </method>
191
 
 
192
 
    <method name="Activate">
193
 
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
194
 
      <doc:doc>
195
 
        <doc:description>
196
 
          <doc:para>Attempt to activate the this session.  In most
197
 
          cases, if successful, this will cause the session to
198
 
          become visible and become active on the seat that it
199
 
          is attached to.</doc:para>
200
 
        </doc:description>
201
 
        <doc:seealso><doc:ref type="method" to="Seat.ActivateSession">Seat.ActivateSession()</doc:ref></doc:seealso>
202
 
      </doc:doc>
203
 
    </method>
204
 
    <method name="Lock">
205
 
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
206
 
      <doc:doc>
207
 
        <doc:description>
208
 
          <doc:para>This will cause a <doc:ref type="signal" to="Session::Lock">Lock</doc:ref>
209
 
          signal to be emitted for this session.
210
 
          </doc:para>
211
 
        </doc:description>
212
 
        <doc:permission>This method is restricted to privileged users by D-Bus policy.</doc:permission>
213
 
        <doc:seealso><doc:ref type="signal" to="Session::Lock">Lock signal</doc:ref></doc:seealso>
214
 
      </doc:doc>
215
 
    </method>
216
 
    <method name="Unlock">
217
 
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
218
 
      <doc:doc>
219
 
        <doc:description>
220
 
          <doc:para>This will cause an <doc:ref type="signal" to="Session::Unlock">Unlock</doc:ref>
221
 
          signal to be emitted for this session.
222
 
          </doc:para>
223
 
          <doc:para>This can be used by login managers to unlock a session before it is
224
 
          re-activated during fast-user-switching.
225
 
          </doc:para>
226
 
        </doc:description>
227
 
        <doc:permission>This method is restricted to privileged users by D-Bus policy.</doc:permission>
228
 
        <doc:seealso><doc:ref type="signal" to="Session::Unlock">Unlock signal</doc:ref></doc:seealso>
229
 
      </doc:doc>
230
 
    </method>
231
 
 
232
 
    <method name="GetIdleHint">
233
 
      <arg name="idle_hint" type="b" direction="out">
234
 
        <doc:doc>
235
 
          <doc:summary>The value of the idle-hint</doc:summary>
236
 
        </doc:doc>
237
 
      </arg>
238
 
      <doc:doc>
239
 
        <doc:description>
240
 
          <doc:para>Gets the value of the <doc:ref type="property" to="Session:idle-hint">idle-hint</doc:ref>
241
 
          property.
242
 
          </doc:para>
243
 
        </doc:description>
244
 
        <doc:seealso><doc:ref type="property" to="Session:idle-hint">idle-hint</doc:ref></doc:seealso>
245
 
      </doc:doc>
246
 
    </method>
247
 
    <method name="GetIdleSinceHint">
248
 
      <arg name="iso8601_datetime" type="s" direction="out">
249
 
        <doc:doc>
250
 
          <doc:summary>An ISO 8601 format date-type string</doc:summary>
251
 
        </doc:doc>
252
 
      </arg>
253
 
      <doc:doc>
254
 
        <doc:description>
255
 
          <doc:para>Returns an ISO 8601 date-time string that corresponds to
256
 
          the time of the last change of the idle-hint.
257
 
          </doc:para>
258
 
        </doc:description>
259
 
      </doc:doc>
260
 
    </method>
261
 
    <method name="SetIdleHint">
262
 
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
263
 
      <arg name="idle_hint" type="b" direction="in">
264
 
        <doc:doc>
265
 
          <doc:summary>boolean value to set the idle-hint to</doc:summary>
266
 
        </doc:doc>
267
 
      </arg>
268
 
      <doc:doc>
269
 
        <doc:description>
270
 
          <doc:para>This may be used by the session to indicate that
271
 
          it is idle.
272
 
          </doc:para>
273
 
          <doc:para>Use of this method is restricted to the user
274
 
          that owns the session.</doc:para>
275
 
        </doc:description>
276
 
      </doc:doc>
277
 
    </method>
278
 
 
279
 
    <signal name="ActiveChanged">
280
 
      <arg name="is_active" type="b">
281
 
        <doc:doc>
282
 
          <doc:summary>TRUE if the session is active, otherwise FALSE</doc:summary>
283
 
        </doc:doc>
284
 
      </arg>
285
 
      <doc:doc>
286
 
        <doc:description>
287
 
          <doc:para>Emitted when the active property has changed.</doc:para>
288
 
        </doc:description>
289
 
      </doc:doc>
290
 
    </signal>
291
 
    <signal name="IdleHintChanged">
292
 
      <arg name="hint" type="b">
293
 
        <doc:doc>
294
 
          <doc:summary>the new value of idle-hint</doc:summary>
295
 
        </doc:doc>
296
 
      </arg>
297
 
      <doc:doc>
298
 
        <doc:description>
299
 
          <doc:para>Emitted when the idle-hint property has changed.</doc:para>
300
 
        </doc:description>
301
 
      </doc:doc>
302
 
    </signal>
303
 
    <signal name="Lock">
304
 
      <doc:doc>
305
 
        <doc:description>
306
 
          <doc:para>Emitted in response to a call to the <doc:ref type="method" to="Session.Lock">Lock()</doc:ref> method.</doc:para>
307
 
          <doc:para>It is intended that the screensaver for the session should lock the screen in response to this signal.</doc:para>
308
 
        </doc:description>
309
 
      </doc:doc>
310
 
    </signal>
311
 
    <signal name="Unlock">
312
 
      <doc:doc>
313
 
        <doc:description>
314
 
          <doc:para>Emitted in response to a call to the <doc:ref type="method" to="Session.Unlock">Unlock()</doc:ref> method.</doc:para>
315
 
          <doc:para>It is intended that the screensaver for the session should unlock the screen in response to this signal.</doc:para>
316
 
        </doc:description>
317
 
      </doc:doc>
318
 
    </signal>
319
 
 
320
 
    <property name="unix-user" type="u" access="readwrite">
321
 
      <doc:doc>
322
 
        <doc:description>
323
 
          <doc:para>The user assigned to the session.</doc:para>
324
 
        </doc:description>
325
 
      </doc:doc>
326
 
    </property>
327
 
    <property name="user" type="u" access="readwrite">
328
 
      <doc:doc>
329
 
        <doc:description>
330
 
          <doc:para>The user assigned to the session.</doc:para>
331
 
        </doc:description>
332
 
        <doc:deprecated version="0.1.3" instead="unix-user"/>
333
 
      </doc:doc>
334
 
    </property>
335
 
    <property name="session-type" type="s" access="readwrite">
336
 
      <doc:doc>
337
 
        <doc:description>
338
 
          <doc:para>The type of the session.</doc:para>
339
 
          <doc:para>Warning: we haven't yet defined the allowed values for this property.
340
 
          It is probably best to avoid this until we do.
341
 
          </doc:para>
342
 
        </doc:description>
343
 
      </doc:doc>
344
 
    </property>
345
 
    <property name="remote-host-name" type="s" access="readwrite">
346
 
      <doc:doc>
347
 
        <doc:description>
348
 
          <doc:para>The remote host name for the session.
349
 
          </doc:para>
350
 
          <doc:para>This will be set in situations where the session is
351
 
          opened and controlled from a remote system.
352
 
          </doc:para>
353
 
          <doc:para>For example, this value will be set when the
354
 
          session is created from an SSH or XDMCP connection.
355
 
          </doc:para>
356
 
        </doc:description>
357
 
      </doc:doc>
358
 
    </property>
359
 
    <property name="display-device" type="s" access="readwrite">
360
 
      <doc:doc>
361
 
        <doc:description>
362
 
          <doc:para>The display device (aka TTY) that the
363
 
          session is connected to.
364
 
          </doc:para>
365
 
        </doc:description>
366
 
      </doc:doc>
367
 
    </property>
368
 
    <property name="x11-display" type="s" access="readwrite">
369
 
      <doc:doc>
370
 
        <doc:description>
371
 
          <doc:para>Value of the X11 DISPLAY for this session
372
 
          if one is present.
373
 
          </doc:para>
374
 
        </doc:description>
375
 
      </doc:doc>
376
 
    </property>
377
 
    <property name="x11-display-device" type="s" access="readwrite">
378
 
      <doc:doc>
379
 
        <doc:description>
380
 
          <doc:para>
381
 
          The display device (aka TTY) that the X11 display for the
382
 
          session is connected to.  If there is no x11-display set then
383
 
          this value is undefined.
384
 
          </doc:para>
385
 
        </doc:description>
386
 
      </doc:doc>
387
 
    </property>
388
 
    <property name="active" type="b" access="readwrite">
389
 
      <doc:doc>
390
 
        <doc:description>
391
 
          <doc:para>
392
 
          Whether the session is active on the Seat that
393
 
          it is attached to.</doc:para>
394
 
          <doc:para>If the session is not attached to a seat this value is undefined.
395
 
          </doc:para>
396
 
        </doc:description>
397
 
      </doc:doc>
398
 
    </property>
399
 
    <property name="is-local" type="b" access="readwrite">
400
 
      <doc:doc>
401
 
        <doc:description>
402
 
          <doc:para>
403
 
          Whether the session is local</doc:para>
404
 
          <doc:para>FIXME: we need to come up with a concrete definition for this value.
405
 
          It was originally used as a way to identify XDMCP sessions that originate
406
 
          from a remote system.
407
 
          </doc:para>
408
 
        </doc:description>
409
 
      </doc:doc>
410
 
    </property>
411
 
    <property name="idle-hint" type="b" access="readwrite">
412
 
      <doc:doc>
413
 
        <doc:description>
414
 
          <doc:para>
415
 
          This is a hint used to indicate that the session may be idle.
416
 
          </doc:para>
417
 
          <doc:para>
418
 
          For sessions with a <doc:ref type="property" to="Session:x11-display">x11-display</doc:ref> set (ie. graphical
419
 
          sessions), it is up to each session to delegate the
420
 
          responsibility for updating this value.  Typically, the
421
 
          screensaver will set this.
422
 
          </doc:para>
423
 
          <doc:para>However, for non-graphical sessions with a <doc:ref type="property" to="Session:display-device">display-device</doc:ref> set
424
 
          the Session object itself will periodically update this value based
425
 
          on the activity detected on the display-device itself.
426
 
          </doc:para>
427
 
          <doc:para>
428
 
          This should not be considered authoritative.
429
 
          </doc:para>
430
 
        </doc:description>
431
 
      </doc:doc>
432
 
    </property>
433
 
 
434
 
  </interface>
435
 
</node>