From 29437f4aa9bd1bab54bde41cb1f6301803a2632e Mon Sep 17 00:00:00 2001 From: William Jon McCann Date: Sat, 10 Mar 2007 18:02:29 -0500 Subject: regenerate docs --- doc/ConsoleKit.html | 72 +++++++++++++++++++++++++------------------------- doc/ref-ck-session.xml | 36 ++++++++++++------------- 2 files changed, 54 insertions(+), 54 deletions(-) (limited to 'doc') diff --git a/doc/ConsoleKit.html b/doc/ConsoleKit.html index 3d57751..4aeac2b 100644 --- a/doc/ConsoleKit.html +++ b/doc/ConsoleKit.html @@ -1,13 +1,13 @@ ConsoleKit 0.1.3 Documentation

ConsoleKit 0.1.3 Documentation

William Jon McCann


            
-          

Version 0.1.3

Table of Contents

Introduction
I. Concepts
1. Introduction
About
Defining the Problem
II. Reference
I. D-Bus API Reference
org.freedesktop.ConsoleKit.Manager — Manager interface
org.freedesktop.ConsoleKit.Seat — Seat interface
org.freedesktop.ConsoleKit.Session — Session interface
Index

Introduction

-

Part I. Concepts

Table of Contents

1. Introduction
About
Defining the Problem

Chapter 1. Introduction

Table of Contents

About
Defining the Problem

About

+          

Version 0.1.3

Table of Contents

Introduction
I. Concepts
1. Introduction
About
Defining the Problem
II. Reference
I. D-Bus API Reference
org.freedesktop.ConsoleKit.Manager — Manager interface
org.freedesktop.ConsoleKit.Seat — Seat interface
org.freedesktop.ConsoleKit.Session — Session interface
Index

Introduction

+

Part I. Concepts

Table of Contents

1. Introduction
About
Defining the Problem

Chapter 1. Introduction

Table of Contents

About
Defining the Problem

About

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. -

Defining the Problem

-

Part II. Reference

Table of Contents

I. D-Bus API Reference
org.freedesktop.ConsoleKit.Manager — Manager interface
org.freedesktop.ConsoleKit.Seat — Seat interface
org.freedesktop.ConsoleKit.Session — Session interface

D-Bus API Reference

+

Defining the Problem

+

Part II. Reference

Table of Contents

I. D-Bus API Reference
org.freedesktop.ConsoleKit.Manager — Manager interface
org.freedesktop.ConsoleKit.Seat — Seat interface
org.freedesktop.ConsoleKit.Session — Session interface

D-Bus API Reference

ConsoleKit provides a D-Bus API for programs to obtain information about the users, sessions, and seats that are present on a system.

@@ -30,28 +30,28 @@ out 'ao' sessions) GetSystemIdleHint (out 'b' idle_hint) GetSystemIdleSinceHint (out 's' iso8601_datetime) -

Signals

SeatAdded             ('o' sid)
+

Signals

SeatAdded             ('o' sid)
 SeatRemoved           ('o' sid)
 SystemIdleHintChanged ('b' hint)
-

Implemented Interfaces

org.freedesktop.ConsoleKit.Manager implements +

Implemented Interfaces

org.freedesktop.ConsoleKit.Manager implements org.freedesktop.DBus.Introspectable, org.freedesktop.DBus.Properties -

Properties

Description
Details
OpenSession ()
OpenSession (out 's' cookie)
OpenSessionWithParameters ()
OpenSessionWithParameters (in  'a(sv)' parameters,
-                           out 's'     cookie)
CloseSession ()
CloseSession (in  's' cookie,
-              out 'b' result)
GetSeats ()
GetSeats (out 'ao' seats)
GetCurrentSession ()
GetCurrentSession (out 'o' ssid)
GetSessionForCookie ()
GetSessionForCookie (in  's' cookie,
-                     out 'o' ssid)
GetSessionForUnixProcess ()
GetSessionForUnixProcess (in  'u' pid,
-                          out 'o' ssid)
GetSessionsForUser ()
GetSessionsForUser (in  'u'  uid,
-                    out 'ao' sessions)
GetSystemIdleHint ()
GetSystemIdleHint (out 'b' idle_hint)
GetSystemIdleSinceHint ()
GetSystemIdleSinceHint (out 's' iso8601_datetime)
Signal Details
SeatAdded ()
SeatAdded ('o' sid)
SeatRemoved ()
SeatRemoved ('o' sid)
SystemIdleHintChanged ()
SystemIdleHintChanged ('b' hint)
Property Details
Name
org.freedesktop.ConsoleKit.Seat — Seat interface
Methods
GetId            (out 'o'  sid)
+    
Properties
Description
Details
OpenSession ()
OpenSession (out 's' cookie)
OpenSessionWithParameters ()
OpenSessionWithParameters (in  'a(sv)' parameters,
+                           out 's'     cookie)
CloseSession ()
CloseSession (in  's' cookie,
+              out 'b' result)
GetSeats ()
GetSeats (out 'ao' seats)
GetCurrentSession ()
GetCurrentSession (out 'o' ssid)
GetSessionForCookie ()
GetSessionForCookie (in  's' cookie,
+                     out 'o' ssid)
GetSessionForUnixProcess ()
GetSessionForUnixProcess (in  'u' pid,
+                          out 'o' ssid)
GetSessionsForUser ()
GetSessionsForUser (in  'u'  uid,
+                    out 'ao' sessions)
GetSystemIdleHint ()
GetSystemIdleHint (out 'b' idle_hint)
GetSystemIdleSinceHint ()
GetSystemIdleSinceHint (out 's' iso8601_datetime)
Signal Details
SeatAdded ()
SeatAdded ('o' sid)
SeatRemoved ()
SeatRemoved ('o' sid)
SystemIdleHintChanged ()
SystemIdleHintChanged ('b' hint)
Property Details
Name
org.freedesktop.ConsoleKit.Seat — Seat interface
Methods
GetId            (out 'o'  sid)
 GetSessions      (out 'ao' sessions)
 GetActiveSession (out 'o'  ssid)
 ActivateSession  (in  'o'  ssid)
-
Signals
ActiveSessionChanged ('o' sid)
+
Signals
ActiveSessionChanged ('o' sid)
 SessionAdded         ('o' sid)
 SessionRemoved       ('o' sid)
-
Implemented Interfaces
org.freedesktop.ConsoleKit.Seat implements
+
Implemented Interfaces
org.freedesktop.ConsoleKit.Seat implements
     org.freedesktop.DBus.Introspectable,
     org.freedesktop.DBus.Properties
-    
Properties
Description
Details
GetId ()
GetId (out 'o' sid)
GetSessions ()
GetSessions (out 'ao' sessions)
GetActiveSession ()
GetActiveSession (out 'o' ssid)
ActivateSession ()
ActivateSession (in  'o' ssid)
Signal Details
ActiveSessionChanged ()
ActiveSessionChanged ('o' sid)
SessionAdded ()
SessionAdded ('o' sid)
SessionRemoved ()
SessionRemoved ('o' sid)
Property Details
Name
org.freedesktop.ConsoleKit.Session — Session interface
Methods
GetId               (out 'o' ssid)
+    
Properties
Description
Details
GetId ()
GetId (out 'o' sid)
GetSessions ()
GetSessions (out 'ao' sessions)
GetActiveSession ()
GetActiveSession (out 'o' ssid)
ActivateSession ()
ActivateSession (in  'o' ssid)
Signal Details
ActiveSessionChanged ()
ActiveSessionChanged ('o' sid)
SessionAdded ()
SessionAdded ('o' sid)
SessionRemoved ()
SessionRemoved ('o' sid)
Property Details
Name
org.freedesktop.ConsoleKit.Session — Session interface
Methods
GetId               (out 'o' ssid)
 GetSeatId           (out 'o' sid)
 GetSessionType      (out 's' type)
 GetUser             (out 'i' uid)
@@ -68,29 +68,29 @@
 GetIdleHint         (out 'b' idle_hint)
 GetIdleSinceHint    (out 's' iso8601_datetime)
 SetIdleHint         (in  'b' idle_hint)
-
Signals
ActiveChanged   ('b' is_active)
+
Signals
ActiveChanged   ('b' is_active)
 IdleHintChanged ('b' hint)
 Lock            ()
 Unlock          ()
-
Implemented Interfaces
org.freedesktop.ConsoleKit.Session implements
+
Implemented Interfaces
org.freedesktop.ConsoleKit.Session implements
     org.freedesktop.DBus.Introspectable,
     org.freedesktop.DBus.Properties
-    
Properties
'user'               read      'i'
-'session-type'       read      's'
-'remote-host-name'   read      's'
-'display-device'     read      's'
-'x11-display'        read      's'
-'x11-display-device' read      's'
-'active'             read      'b'
-'is-local'           read      'b'
-'idle-hint'          read      'b'
-
Description
Details
GetId ()
GetId (out 'o' ssid)
GetSeatId ()
GetSeatId (out 'o' sid)
GetSessionType ()
GetSessionType (out 's' type)
GetUser ()
GetUser (out 'i' uid)
GetX11Display ()
GetX11Display (out 's' display)
GetX11DisplayDevice ()
GetX11DisplayDevice (out 's' x11_display_device)
GetDisplayDevice ()
GetDisplayDevice (out 's' display_device)
GetRemoteHostName ()
GetRemoteHostName (out 's' remote_host_name)
IsActive ()
IsActive (out 'b' active)
IsLocal ()
IsLocal (out 'b' local)
GetCreationTime ()
GetCreationTime (out 's' iso8601_datetime)
Activate ()
Activate ()
Lock ()
Lock ()
Unlock ()
Unlock ()
GetIdleHint ()
GetIdleHint (out 'b' idle_hint)
GetIdleSinceHint ()
GetIdleSinceHint (out 's' iso8601_datetime)
SetIdleHint ()
SetIdleHint (in  'b' idle_hint)
Signal Details
ActiveChanged ()
ActiveChanged ('b' is_active)
IdleHintChanged ()
IdleHintChanged ('b' hint)
Lock ()
Lock ()
Unlock ()
Unlock ()
Property Details
'user'
'user'  read      'i'
-
'session-type'
'session-type'  read      's'
-
'remote-host-name'
'remote-host-name'  read      's'
-
'display-device'
'display-device'  read      's'
-
'x11-display'
'x11-display'  read      's'
-
'x11-display-device'
'x11-display-device'  read      's'
-
'active'
'active'  read      'b'
-
'is-local'
'is-local'  read      'b'
-
'idle-hint'
'idle-hint'  read      'b'
-
Index
A
Activate
Session
method, Activate ()
ActivateSession
Seat
method, ActivateSession ()
active
Session
property, 'active'
ActiveChanged
Session
signal, ActiveChanged ()
ActiveSessionChanged
Seat
signal, ActiveSessionChanged ()
C
CloseSession
Manager
method, CloseSession ()
D
display-device
Session
property, 'display-device'
G
GetActiveSession
Seat
method, GetActiveSession ()
GetCreationTime
Session
method, GetCreationTime ()
GetCurrentSession
Manager
method, GetCurrentSession ()
GetDisplayDevice
Session
method, GetDisplayDevice ()
GetId
Seat
method, GetId ()
Session
method, GetId ()
GetIdleHint
Session
method, GetIdleHint ()
GetIdleSinceHint
Session
method, GetIdleSinceHint ()
GetRemoteHostName
Session
method, GetRemoteHostName ()
GetSeatId
Session
method, GetSeatId ()
GetSeats
Manager
method, GetSeats ()
GetSessionForCookie
Manager
method, GetSessionForCookie ()
GetSessionForUnixProcess
Manager
method, GetSessionForUnixProcess ()
GetSessions
Seat
method, GetSessions ()
GetSessionsForUser
Manager
method, GetSessionsForUser ()
GetSessionType
Session
method, GetSessionType ()
GetSystemIdleHint
Manager
method, GetSystemIdleHint ()
GetSystemIdleSinceHint
Manager
method, GetSystemIdleSinceHint ()
GetUser
Session
method, GetUser ()
GetX11Display
Session
method, GetX11Display ()
GetX11DisplayDevice
Session
method, GetX11DisplayDevice ()
I
idle-hint
Session
property, 'idle-hint'
IdleHintChanged
Session
signal, IdleHintChanged ()
is-local
Session
property, 'is-local'
IsActive
Session
method, IsActive ()
IsLocal
Session
method, IsLocal ()
L
Lock
Session
method, Lock ()
signal, Lock ()
O
OpenSession
Manager
method, OpenSession ()
OpenSessionWithParameters
Manager
method, OpenSessionWithParameters ()
R
remote-host-name
Session
property, 'remote-host-name'
S
SeatAdded
Manager
signal, SeatAdded ()
SeatRemoved
Manager
signal, SeatRemoved ()
session-type
Session
property, 'session-type'
SessionAdded
Seat
signal, SessionAdded ()
SessionRemoved
Seat
signal, SessionRemoved ()
SetIdleHint
Session
method, SetIdleHint ()
SystemIdleHintChanged
Manager
signal, SystemIdleHintChanged ()
U
Unlock
Session
method, Unlock ()
signal, Unlock ()
user
Session
property, 'user'
X
x11-display
Session
property, 'x11-display'
x11-display-device
Session
property, 'x11-display-device'

+    
Properties
'user'               readwrite 'u'
+'session-type'       readwrite 's'
+'remote-host-name'   readwrite 's'
+'display-device'     readwrite 's'
+'x11-display'        readwrite 's'
+'x11-display-device' readwrite 's'
+'active'             readwrite 'b'
+'is-local'           readwrite 'b'
+'idle-hint'          readwrite 'b'
+
Description
Details
GetId ()
GetId (out 'o' ssid)
GetSeatId ()
GetSeatId (out 'o' sid)
GetSessionType ()
GetSessionType (out 's' type)
GetUser ()
GetUser (out 'i' uid)
GetX11Display ()
GetX11Display (out 's' display)
GetX11DisplayDevice ()
GetX11DisplayDevice (out 's' x11_display_device)
GetDisplayDevice ()
GetDisplayDevice (out 's' display_device)
GetRemoteHostName ()
GetRemoteHostName (out 's' remote_host_name)
IsActive ()
IsActive (out 'b' active)
IsLocal ()
IsLocal (out 'b' local)
GetCreationTime ()
GetCreationTime (out 's' iso8601_datetime)
Activate ()
Activate ()
Lock ()
Lock ()
Unlock ()
Unlock ()
GetIdleHint ()
GetIdleHint (out 'b' idle_hint)
GetIdleSinceHint ()
GetIdleSinceHint (out 's' iso8601_datetime)
SetIdleHint ()
SetIdleHint (in  'b' idle_hint)
Signal Details
ActiveChanged ()
ActiveChanged ('b' is_active)
IdleHintChanged ()
IdleHintChanged ('b' hint)
Lock ()
Lock ()
Unlock ()
Unlock ()
Property Details
'user'
'user'  readwrite 'u'
+
'session-type'
'session-type'  readwrite 's'
+
'remote-host-name'
'remote-host-name'  readwrite 's'
+
'display-device'
'display-device'  readwrite 's'
+
'x11-display'
'x11-display'  readwrite 's'
+
'x11-display-device'
'x11-display-device'  readwrite 's'
+
'active'
'active'  readwrite 'b'
+
'is-local'
'is-local'  readwrite 'b'
+
'idle-hint'
'idle-hint'  readwrite 'b'
+
Index
A
Activate
Session
method, Activate ()
ActivateSession
Seat
method, ActivateSession ()
active
Session
property, 'active'
ActiveChanged
Session
signal, ActiveChanged ()
ActiveSessionChanged
Seat
signal, ActiveSessionChanged ()
C
CloseSession
Manager
method, CloseSession ()
D
display-device
Session
property, 'display-device'
G
GetActiveSession
Seat
method, GetActiveSession ()
GetCreationTime
Session
method, GetCreationTime ()
GetCurrentSession
Manager
method, GetCurrentSession ()
GetDisplayDevice
Session
method, GetDisplayDevice ()
GetId
Seat
method, GetId ()
Session
method, GetId ()
GetIdleHint
Session
method, GetIdleHint ()
GetIdleSinceHint
Session
method, GetIdleSinceHint ()
GetRemoteHostName
Session
method, GetRemoteHostName ()
GetSeatId
Session
method, GetSeatId ()
GetSeats
Manager
method, GetSeats ()
GetSessionForCookie
Manager
method, GetSessionForCookie ()
GetSessionForUnixProcess
Manager
method, GetSessionForUnixProcess ()
GetSessions
Seat
method, GetSessions ()
GetSessionsForUser
Manager
method, GetSessionsForUser ()
GetSessionType
Session
method, GetSessionType ()
GetSystemIdleHint
Manager
method, GetSystemIdleHint ()
GetSystemIdleSinceHint
Manager
method, GetSystemIdleSinceHint ()
GetUser
Session
method, GetUser ()
GetX11Display
Session
method, GetX11Display ()
GetX11DisplayDevice
Session
method, GetX11DisplayDevice ()
I
idle-hint
Session
property, 'idle-hint'
IdleHintChanged
Session
signal, IdleHintChanged ()
is-local
Session
property, 'is-local'
IsActive
Session
method, IsActive ()
IsLocal
Session
method, IsLocal ()
L
Lock
Session
method, Lock ()
signal, Lock ()
O
OpenSession
Manager
method, OpenSession ()
OpenSessionWithParameters
Manager
method, OpenSessionWithParameters ()
R
remote-host-name
Session
property, 'remote-host-name'
S
SeatAdded
Manager
signal, SeatAdded ()
SeatRemoved
Manager
signal, SeatRemoved ()
session-type
Session
property, 'session-type'
SessionAdded
Seat
signal, SessionAdded ()
SessionRemoved
Seat
signal, SessionRemoved ()
SetIdleHint
Session
method, SetIdleHint ()
SystemIdleHintChanged
Manager
signal, SystemIdleHintChanged ()
U
Unlock
Session
method, Unlock ()
signal, Unlock ()
user
Session
property, 'user'
X
x11-display
Session
property, 'x11-display'
x11-display-device
Session
property, 'x11-display-device'

diff --git a/doc/ref-ck-session.xml b/doc/ref-ck-session.xml
index 0e6dd2e..9a4a4db 100644
--- a/doc/ref-ck-session.xml
+++ b/doc/ref-ck-session.xml
@@ -44,15 +44,15 @@
   
   
     Properties
-    'user'               read      'i'
-'session-type'       read      's'
-'remote-host-name'   read      's'
-'display-device'     read      's'
-'x11-display'        read      's'
-'x11-display-device' read      's'
-'active'             read      'b'
-'is-local'           read      'b'
-'idle-hint'          read      'b'
+    'user'               readwrite 'u'
+'session-type'       readwrite 's'
+'remote-host-name'   readwrite 's'
+'display-device'     readwrite 's'
+'x11-display'        readwrite 's'
+'x11-display-device' readwrite 's'
+'active'             readwrite 'b'
+'is-local'           readwrite 'b'
+'idle-hint'          readwrite 'b'
 
   
   
@@ -263,7 +263,7 @@
         Session
         property
       
-      'user'  read      'i'
+      'user'  readwrite 'u'
 
     
     
@@ -273,7 +273,7 @@
         Session
         property
       
-      'session-type'  read      's'
+      'session-type'  readwrite 's'
 
     
     
@@ -283,7 +283,7 @@
         Session
         property
       
-      'remote-host-name'  read      's'
+      'remote-host-name'  readwrite 's'
 
     
     
@@ -293,7 +293,7 @@
         Session
         property
       
-      'display-device'  read      's'
+      'display-device'  readwrite 's'
 
     
     
@@ -303,7 +303,7 @@
         Session
         property
       
-      'x11-display'  read      's'
+      'x11-display'  readwrite 's'
 
     
     
@@ -313,7 +313,7 @@
         Session
         property
       
-      'x11-display-device'  read      's'
+      'x11-display-device'  readwrite 's'
 
     
     
@@ -323,7 +323,7 @@
         Session
         property
       
-      'active'  read      'b'
+      'active'  readwrite 'b'
 
     
     
@@ -333,7 +333,7 @@
         Session
         property
       
-      'is-local'  read      'b'
+      'is-local'  readwrite 'b'
 
     
     
@@ -343,7 +343,7 @@
         Session
         property
       
-      'idle-hint'  read      'b'
+      'idle-hint'  readwrite 'b'
 
     
   
-- 
cgit v1.2.3