From c01153022b0fa850bd10503141ff081749f01d4d Mon Sep 17 00:00:00 2001 From: William Jon McCann Date: Tue, 13 Mar 2007 17:29:46 -0400 Subject: missed a namespace on the permission tag --- doc/ConsoleKit.html | 132 ++++++++++++++++++++++----------------------- doc/spec/ck-session.xml | 4 +- doc/xml/ref-ck-session.xml | 4 +- 3 files changed, 70 insertions(+), 70 deletions(-) (limited to 'doc') diff --git a/doc/ConsoleKit.html b/doc/ConsoleKit.html index eaf7b1b..638a727 100644 --- a/doc/ConsoleKit.html +++ b/doc/ConsoleKit.html @@ -2,22 +2,22 @@ ConsoleKit 0.1.3 Documentation

ConsoleKit 0.1.3 Documentation

William Jon McCann


            
-          

Version 0.1.3


Introduction

-

Part I. Concepts

Chapter 1. Introduction

About

+          

Version 0.1.3


Table of Contents

Introduction
I. Concepts
1. Introduction
About
Defining the Problem
Relevant art
2. Terminology
Session
Session leader
Seat
3. Design
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

Chapter 1. Introduction

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

-

Relevant art

-

Chapter 2. Terminology

Table of Contents

Session
Session leader
Seat

Session

+

Defining the Problem

+

Relevant art

+

Chapter 2. Terminology

Table of Contents

Session
Session leader
Seat

Session

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

Session leader

-

Seat

-

Chapter 3. Design

Part II. Reference

D-Bus API Reference


+

Session leader

+

Seat

+

Chapter 3. Design

Part II. Reference

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.

@@ -42,13 +42,13 @@ 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)

This method requests that a new Session +

Properties

Description

Details

OpenSession ()

OpenSession (out 's' cookie)

This method requests that a new Session be created for the calling process. The properties of this new Session are set automatically from information collected about the calling process.

This new session exists until the calling process disconnects from the system bus or @@ -90,7 +90,7 @@

cookie:
The secret cookie that is used to identify the new session

See also: -OpenSessionWithParameters()

OpenSessionWithParameters ()

OpenSessionWithParameters (in  'a(sv)' parameters,
+OpenSessionWithParameters()

OpenSessionWithParameters ()

OpenSessionWithParameters (in  'a(sv)' parameters,
                            out 's'     cookie)

This method requests that a new Session be created for the calling process. The properties of this new Session are from the parameters provided. @@ -102,66 +102,66 @@ See also: as members of this session.

See the Session properties for a list of valid parameters.

parameters:
An array of sets of property names and values
cookie:
The secret cookie that is used to identify the new session

This method is restricted to privileged users by D-Bus policy.

See also: -org.freedesktop.ConsoleKit.Session

CloseSession ()

CloseSession (in  's' cookie,
+org.freedesktop.ConsoleKit.Session

CloseSession ()

CloseSession (in  's' cookie,
               out 'b' result)

This method is used to close the session identified by the supplied cookie.

The session can only be closed by the same process that opened the session. -

cookie:
The secret cookie that is used to identify the session
result:
Whether the session was successfully closed

GetSeats ()

GetSeats (out 'ao' seats)

This gets a list of all the Seats +

cookie:
The secret cookie that is used to identify the session
result:
Whether the session was successfully closed

GetSeats ()

GetSeats (out 'ao' seats)

This gets a list of all the Seats that are currently present on the system.

Each Seat ID is an D-Bus object path for the object that implements the Seat interface.

seats:
an array of Seat IDs

See also: -org.freedesktop.ConsoleKit.Seat

GetSessionForCookie ()

GetSessionForCookie (in  's' cookie,
+org.freedesktop.ConsoleKit.Seat

GetSessionForCookie ()

GetSessionForCookie (in  's' cookie,
                      out 'o' ssid)

Returns the session ID that is associated with the specified cookie. -

cookie:
The secret cookie that is used to identify the session
ssid:
The object identifier for the current session

GetSessionForUnixProcess ()

GetSessionForUnixProcess (in  'u' pid,
+          

cookie:
The secret cookie that is used to identify the session
ssid:
The object identifier for the current session

GetSessionForUnixProcess ()

GetSessionForUnixProcess (in  'u' pid,
                           out 'o' ssid)

Attempts to determine the session ID for the specified POSIX process ID (pid). -

pid:
The POSIX process ID
ssid:
The object identifier for the current session

GetCurrentSession ()

GetCurrentSession (out 'o' ssid)

Attempts to determine the session ID that the caller belongs to. +

pid:
The POSIX process ID
ssid:
The object identifier for the current session

GetCurrentSession ()

GetCurrentSession (out 'o' ssid)

Attempts to determine the session ID that the caller belongs to.

See this example of using dbus-send:

   dbus-send --system --dest=org.freedesktop.ConsoleKit \
   --type=method_call --print-reply --reply-timeout=2000 \
   /org/freedesktop/ConsoleKit/Manager \
   org.freedesktop.ConsoleKit.Manager.GetCurrentSession
-          
ssid:
The object identifier for the current session

GetSessionsForUnixUser ()

GetSessionsForUnixUser (in  'u'  uid,
+          
ssid:
The object identifier for the current session

GetSessionsForUnixUser ()

GetSessionsForUnixUser (in  'u'  uid,
                         out 'ao' sessions)

This gets a list of all the Sessions that are currently open for the specified user.

Each Session ID is an D-Bus object path for the object that implements the - Session interface.

uid:
POSIX User identification
sessions:
an array of Session IDs

GetSessionsForUser ()

GetSessionsForUser (in  'u'  uid,
+          Session interface.

uid:
POSIX User identification
sessions:
an array of Session IDs

GetSessionsForUser ()

GetSessionsForUser (in  'u'  uid,
                     out 'ao' sessions)

This gets a list of all the Sessions that are currently open for the specified user.

Each Session ID is an D-Bus object path for the object that implements the Session interface.

uid:
User identification
sessions:
an array of Session IDs

Warning

GetSessionsForUser is deprecated since version 0.1.3 and should not be used in newly-written code. Use GetSessionsForUnixUser -instead.

GetSystemIdleHint ()

GetSystemIdleHint (out 'b' idle_hint)

Returns TRUE if the idle-hint +instead.

GetSystemIdleHint ()

GetSystemIdleHint (out 'b' idle_hint)

Returns TRUE if the idle-hint property of every open session is TRUE or if there are no open sessions. -

idle_hint:
The value of the system-idle-hint

GetSystemIdleSinceHint ()

GetSystemIdleSinceHint (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to +

idle_hint:
The value of the system-idle-hint

GetSystemIdleSinceHint ()

GetSystemIdleSinceHint (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to the time of the last change of the system-idle-hint. -

iso8601_datetime:
An ISO 8601 format date-type string

Signal Details

The SeatAdded signal

SeatAdded ('o' sid)

Emitted when a Seat has been added to the system. -

sid:
The Seat ID for the added seat

The SeatRemoved signal

SeatRemoved ('o' sid)

Emitted when a Seat has been removed from the system. -

sid:
The Seat ID for the removed seat

The SystemIdleHintChanged signal

SystemIdleHintChanged ('b' hint)

Emitted when the value of the system-idle-hint has changed. -

hint:
The value of the system-idle-hint

Property Details


Name

org.freedesktop.ConsoleKit.Seat — Seat interface

Methods

GetId            (out 'o'  sid)
+          

iso8601_datetime:
An ISO 8601 format date-type string

Signal Details

The SeatAdded signal

SeatAdded ('o' sid)

Emitted when a Seat has been added to the system. +

sid:
The Seat ID for the added seat

The SeatRemoved signal

SeatRemoved ('o' sid)

Emitted when a Seat has been removed from the system. +

sid:
The Seat ID for the removed seat

The SystemIdleHintChanged signal

SystemIdleHintChanged ('b' hint)

Emitted when the value of the system-idle-hint has changed. +

hint:
The value of the system-idle-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' ssid)
+

Signals

ActiveSessionChanged ('o' ssid)
 SessionAdded         ('o' ssid)
 SessionRemoved       ('o' ssid)
-

Implemented Interfaces

org.freedesktop.ConsoleKit.Seat implements +

Implemented Interfaces

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

Properties

Description

+

Properties

Description

A seat is a collection of sessions and a set of hardware (usually at least a keyboard and mouse). Only one session may be active on a seat at a time.

-

Details

GetId ()

GetId (out 'o' sid)
Returns the ID for Seat. -
sid:
Seat ID

GetSessions ()

GetSessions (out 'ao' sessions)

This gets a list of all the Sessions +

Details

GetId ()

GetId (out 'o' sid)
Returns the ID for Seat. +
sid:
Seat ID

GetSessions ()

GetSessions (out 'ao' sessions)

This gets a list of all the Sessions that are currently attached to this seat.

Each Session ID is an D-Bus object path for the object that implements the - Session interface.

sessions:
an array of Session IDs

GetActiveSession ()

GetActiveSession (out 'o' ssid)

Gets the Session ID that is currently active on this Seat.

Returns NULL if there is no active session.

ssid:
Session ID

ActivateSession ()

ActivateSession (in  'o' ssid)

Attempt to activate the specified session. In most + Session interface.

sessions:
an array of Session IDs

GetActiveSession ()

GetActiveSession (out 'o' ssid)

Gets the Session ID that is currently active on this Seat.

Returns NULL if there is no active session.

ssid:
Session ID

ActivateSession ()

ActivateSession (in  'o' ssid)

Attempt to activate the specified session. In most cases, if successful, this will cause the session to become visible and take control of the hardware that is associated with this seat.

ssid:
Session ID

See also: -Activate()

Signal Details

The ActiveSessionChanged signal

ActiveSessionChanged ('o' ssid)

Emitted when the active session has changed.

ssid:
Session ID

The SessionAdded signal

SessionAdded ('o' ssid)

Emitted when a session has been added to the seat.

ssid:
Session ID

The SessionRemoved signal

SessionRemoved ('o' ssid)

Emitted when a session has been removed from the seat.

ssid:
Session ID

Property Details


Name

org.freedesktop.ConsoleKit.Session — Session interface

Methods

GetId               (out 'o' ssid)
+Activate()

Signal Details

The ActiveSessionChanged signal

ActiveSessionChanged ('o' ssid)

Emitted when the active session has changed.

ssid:
Session ID

The SessionAdded signal

SessionAdded ('o' ssid)

Emitted when a session has been added to the seat.

ssid:
Session ID

The SessionRemoved signal

SessionRemoved ('o' ssid)

Emitted when a session has been removed from the seat.

ssid:
Session ID

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)
@@ -179,14 +179,14 @@ See also:
 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

'unix-user'          readwrite 'u'
+    

Properties

'unix-user'          readwrite 'u'
 'user'               readwrite 'u'
 'session-type'       readwrite 's'
 'remote-host-name'   readwrite 's'
@@ -196,7 +196,7 @@ See also:
 'active'             readwrite 'b'
 'is-local'           readwrite 'b'
 'idle-hint'          readwrite 'b'
-

Description

+

Description

Session objects represent and store information related to a user session. @@ -205,103 +205,103 @@ See also: specifically refer to the properties of the "session leader".

-

Details

GetId ()

GetId (out 'o' ssid)

Returns the ID for Session.

ssid:
Session ID

GetSeatId ()

GetSeatId (out 'o' sid)

Returns the ID for the Seat the Session is +

Details

GetId ()

GetId (out 'o' ssid)

Returns the ID for Session.

ssid:
Session ID

GetSeatId ()

GetSeatId (out 'o' sid)

Returns the ID for the Seat the Session is attached to.

sid:
Seat ID

See also: -org.freedesktop.ConsoleKit.Seat

GetSessionType ()

GetSessionType (out 's' type)

Returns the type of the session.

Warning: we haven't yet defined the allowed values for this property. +org.freedesktop.ConsoleKit.Seat

GetSessionType ()

GetSessionType (out 's' type)

Returns the type of the session.

Warning: we haven't yet defined the allowed values for this property. It is probably best to avoid this until we do.

type:
Session type

See also: -session-type

GetUser ()

GetUser (out 'i' uid)

Returns the user that the session belongs to.

uid:
User ID

Warning

GetUser is deprecated since version 0.1.3 and should not be used in newly-written code. Use +session-type

GetUser ()

GetUser (out 'i' uid)

Returns the user that the session belongs to.

uid:
User ID

Warning

GetUser is deprecated since version 0.1.3 and should not be used in newly-written code. Use GetUnixUser instead.

See also: -user

GetUnixUser ()

GetUnixUser (out 'i' uid)

Returns the POSIX user ID that the session belongs to.

uid:
POSIX User ID

+user

GetUnixUser ()

GetUnixUser (out 'i' uid)

Returns the POSIX user ID that the session belongs to.

uid:
POSIX User ID

See also: -unix-user

GetX11Display ()

GetX11Display (out 's' display)

Returns the value of the X11 DISPLAY for this session +unix-user

GetX11Display ()

GetX11Display (out 's' display)

Returns the value of the X11 DISPLAY for this session if one is present.

display:
The value of the X11 display

See also: -x11-display

GetX11DisplayDevice ()

GetX11DisplayDevice (out 's' x11_display_device)

Returns the value of the display device (aka TTY) that the +x11-display

GetX11DisplayDevice ()

GetX11DisplayDevice (out 's' x11_display_device)

Returns the value of the display device (aka TTY) that the X11 display for the session is connected to. If there is no x11-display set then this value is undefined.

x11_display_device:
The value of the X11 display device

See also: -x11-display-device

GetDisplayDevice ()

GetDisplayDevice (out 's' display_device)

Returns the value of the display device (aka TTY) that the +x11-display-device

GetDisplayDevice ()

GetDisplayDevice (out 's' display_device)

Returns the value of the display device (aka TTY) that the session is connected to.

display_device:
The value of the display device

See also: -display-device

GetRemoteHostName ()

GetRemoteHostName (out 's' remote_host_name)

Returns the value of the remote host name for the session. +display-device

GetRemoteHostName ()

GetRemoteHostName (out 's' remote_host_name)

Returns the value of the remote host name for the session.

remote_host_name:
The remote host name

See also: -remote-host-name

IsActive ()

IsActive (out 'b' active)

Returns whether the session is active on the Seat that +remote-host-name

IsActive ()

IsActive (out 'b' active)

Returns whether the session is active on the Seat that it is attached to.

If the session is not attached to a seat this value is undefined.

active:
TRUE if the session is active, otherwise FALSE

See also: -active

IsLocal ()

IsLocal (out 'b' local)

Returns whether the session is local

FIXME: we need to come up with a concrete definition for this value. +active

IsLocal ()

IsLocal (out 'b' local)

Returns whether the session is local

FIXME: we need to come up with a concrete definition for this value. It was originally used as a way to identify XDMCP sessions that originate from a remote system.

local:
TRUE if the session is local, otherwise FALSE

See also: -is-local

GetCreationTime ()

GetCreationTime (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to +is-local

GetCreationTime ()

GetCreationTime (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to the time that the session was opened. -

iso8601_datetime:
An ISO 8601 format date-type string

Activate ()

Activate ()

Attempt to activate the this session. In most +

iso8601_datetime:
An ISO 8601 format date-type string

Activate ()

Activate ()

Attempt to activate the this session. In most cases, if successful, this will cause the session to become visible and become active on the seat that it is attached to.

See also: -Seat.ActivateSession()

Lock ()

Lock ()

This will cause a Lock +Seat.ActivateSession()

Lock ()

Lock ()

This will cause a Lock signal to be emitted for this session. -

+

This method is restricted to privileged users by D-Bus policy.

See also: -Lock signal

Unlock ()

Unlock ()

This will cause an Unlock +Lock signal

Unlock ()

Unlock ()

This will cause an Unlock signal to be emitted for this session.

This can be used by login managers to unlock a session before it is re-activated during fast-user-switching. -

+

This method is restricted to privileged users by D-Bus policy.

See also: -Unlock signal

GetIdleHint ()

GetIdleHint (out 'b' idle_hint)

Gets the value of the idle-hint +Unlock signal

GetIdleHint ()

GetIdleHint (out 'b' idle_hint)

Gets the value of the idle-hint property.

idle_hint:
The value of the idle-hint

See also: -idle-hint

GetIdleSinceHint ()

GetIdleSinceHint (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to +idle-hint

GetIdleSinceHint ()

GetIdleSinceHint (out 's' iso8601_datetime)

Returns an ISO 8601 date-time string that corresponds to the time of the last change of the idle-hint. -

iso8601_datetime:
An ISO 8601 format date-type string

SetIdleHint ()

SetIdleHint (in  'b' idle_hint)

This may be used by the session to indicate that +

iso8601_datetime:
An ISO 8601 format date-type string

SetIdleHint ()

SetIdleHint (in  'b' idle_hint)

This may be used by the session to indicate that it is idle.

Use of this method is restricted to the user - that owns the session.

idle_hint:
boolean value to set the idle-hint to

Signal Details

The ActiveChanged signal

ActiveChanged ('b' is_active)

Emitted when the active property has changed.

is_active:
TRUE if the session is active, otherwise FALSE

The IdleHintChanged signal

IdleHintChanged ('b' hint)

Emitted when the idle-hint property has changed.

hint:
the new value of idle-hint

The Lock signal

Lock ()

Emitted in response to a call to the Lock() method.

It is intended that the screensaver for the session should lock the screen in response to this signal.

The Unlock signal

Unlock ()

Emitted in response to a call to the Unlock() method.

It is intended that the screensaver for the session should unlock the screen in response to this signal.

Property Details

The "unix-user" property

'unix-user'  readwrite 'u'
-

The user assigned to the session.

The "user" property

'user'  readwrite 'u'
+          that owns the session.

idle_hint:
boolean value to set the idle-hint to

Signal Details

The ActiveChanged signal

ActiveChanged ('b' is_active)

Emitted when the active property has changed.

is_active:
TRUE if the session is active, otherwise FALSE

The IdleHintChanged signal

IdleHintChanged ('b' hint)

Emitted when the idle-hint property has changed.

hint:
the new value of idle-hint

The Lock signal

Lock ()

Emitted in response to a call to the Lock() method.

It is intended that the screensaver for the session should lock the screen in response to this signal.

The Unlock signal

Unlock ()

Emitted in response to a call to the Unlock() method.

It is intended that the screensaver for the session should unlock the screen in response to this signal.

Property Details

The "unix-user" property

'unix-user'  readwrite 'u'
+

The user assigned to the session.

The "user" property

'user'  readwrite 'u'
 

The user assigned to the session.

Warning

user is deprecated since version 0.1.3 and should not be used in newly-written code. Use unix-user -instead.

The "session-type" property

'session-type'  readwrite 's'
+instead.

The "session-type" property

'session-type'  readwrite 's'
 

The type of the session.

Warning: we haven't yet defined the allowed values for this property. It is probably best to avoid this until we do. -

The "remote-host-name" property

'remote-host-name'  readwrite 's'
+          

The "remote-host-name" property

'remote-host-name'  readwrite 's'
 

The remote host name for the session.

This will be set in situations where the session is opened and controlled from a remote system.

For example, this value will be set when the session is created from an SSH or XDMCP connection. -

The "display-device" property

'display-device'  readwrite 's'
+          

The "display-device" property

'display-device'  readwrite 's'
 

The display device (aka TTY) that the session is connected to. -

The "x11-display" property

'x11-display'  readwrite 's'
+          

The "x11-display" property

'x11-display'  readwrite 's'
 

Value of the X11 DISPLAY for this session if one is present. -

The "x11-display-device" property

'x11-display-device'  readwrite 's'
+          

The "x11-display-device" property

'x11-display-device'  readwrite 's'
 

The display device (aka TTY) that the X11 display for the session is connected to. If there is no x11-display set then this value is undefined. -

The "active" property

'active'  readwrite 'b'
+          

The "active" property

'active'  readwrite 'b'
 

Whether the session is active on the Seat that it is attached to.

If the session is not attached to a seat this value is undefined. -

The "is-local" property

'is-local'  readwrite 'b'
+          

The "is-local" property

'is-local'  readwrite 'b'
 

Whether the session is local

FIXME: we need to come up with a concrete definition for this value. It was originally used as a way to identify XDMCP sessions that originate from a remote system. -

The "idle-hint" property

'idle-hint'  readwrite 'b'
+          

The "idle-hint" property

'idle-hint'  readwrite 'b'
 

This is a hint used to indicate that the session may be idle.

@@ -314,4 +314,4 @@ instead.

Index

A

Activate
Session, Activate ()
ActivateSession
Seat, ActivateSession ()
active
Session, The "active" property
ActiveChanged
Session, The ActiveChanged signal
ActiveSessionChanged
Seat, The ActiveSessionChanged signal

C

CloseSession
Manager, CloseSession ()

D

display-device
Session, The "display-device" property

G

GetActiveSession
Seat, GetActiveSession ()
GetCreationTime
Session, GetCreationTime ()
GetCurrentSession
Manager, GetCurrentSession ()
GetDisplayDevice
Session, GetDisplayDevice ()
GetId
Seat, GetId ()
Session, GetId ()
GetIdleHint
Session, GetIdleHint ()
GetIdleSinceHint
Session, GetIdleSinceHint ()
GetRemoteHostName
Session, GetRemoteHostName ()
GetSeatId
Session, GetSeatId ()
GetSeats
Manager, GetSeats ()
GetSessionForCookie
Manager, GetSessionForCookie ()
GetSessionForUnixProcess
Manager, GetSessionForUnixProcess ()
GetSessions
Seat, GetSessions ()
GetSessionsForUnixUser
Manager, GetSessionsForUnixUser ()
GetSessionsForUser
Manager, GetSessionsForUser ()
GetSessionType
Session, GetSessionType ()
GetSystemIdleHint
Manager, GetSystemIdleHint ()
GetSystemIdleSinceHint
Manager, GetSystemIdleSinceHint ()
GetUnixUser
Session, GetUnixUser ()
GetUser
Session, GetUser ()
GetX11Display
Session, GetX11Display ()
GetX11DisplayDevice
Session, GetX11DisplayDevice ()

I

idle-hint
Session, The "idle-hint" property
IdleHintChanged
Session, The IdleHintChanged signal
is-local
Session, The "is-local" property
IsActive
Session, IsActive ()
IsLocal
Session, IsLocal ()

L

Lock
Session, Lock (), The Lock signal

O

OpenSession
Manager, OpenSession ()
OpenSessionWithParameters
Manager, OpenSessionWithParameters ()

R

remote-host-name
Session, The "remote-host-name" property

S

SeatAdded
Manager, The SeatAdded signal
SeatRemoved
Manager, The SeatRemoved signal
session-type
Session, The "session-type" property
SessionAdded
Seat, The SessionAdded signal
SessionRemoved
Seat, The SessionRemoved signal
SetIdleHint
Session, SetIdleHint ()
SystemIdleHintChanged
Manager, The SystemIdleHintChanged signal

U

unix-user
Session, The "unix-user" property
Unlock
Session, Unlock (), The Unlock signal
user
Session, The "user" property

X

x11-display
Session, The "x11-display" property
x11-display-device
Session, The "x11-display-device" property
+

Index

A

Activate
Session, Activate ()
ActivateSession
Seat, ActivateSession ()
active
Session, The "active" property
ActiveChanged
Session, The ActiveChanged signal
ActiveSessionChanged
Seat, The ActiveSessionChanged signal

C

CloseSession
Manager, CloseSession ()

D

display-device
Session, The "display-device" property

G

GetActiveSession
Seat, GetActiveSession ()
GetCreationTime
Session, GetCreationTime ()
GetCurrentSession
Manager, GetCurrentSession ()
GetDisplayDevice
Session, GetDisplayDevice ()
GetId
Seat, GetId ()
Session, GetId ()
GetIdleHint
Session, GetIdleHint ()
GetIdleSinceHint
Session, GetIdleSinceHint ()
GetRemoteHostName
Session, GetRemoteHostName ()
GetSeatId
Session, GetSeatId ()
GetSeats
Manager, GetSeats ()
GetSessionForCookie
Manager, GetSessionForCookie ()
GetSessionForUnixProcess
Manager, GetSessionForUnixProcess ()
GetSessions
Seat, GetSessions ()
GetSessionsForUnixUser
Manager, GetSessionsForUnixUser ()
GetSessionsForUser
Manager, GetSessionsForUser ()
GetSessionType
Session, GetSessionType ()
GetSystemIdleHint
Manager, GetSystemIdleHint ()
GetSystemIdleSinceHint
Manager, GetSystemIdleSinceHint ()
GetUnixUser
Session, GetUnixUser ()
GetUser
Session, GetUser ()
GetX11Display
Session, GetX11Display ()
GetX11DisplayDevice
Session, GetX11DisplayDevice ()

I

idle-hint
Session, The "idle-hint" property
IdleHintChanged
Session, The IdleHintChanged signal
is-local
Session, The "is-local" property
IsActive
Session, IsActive ()
IsLocal
Session, IsLocal ()

L

Lock
Session, Lock (), The Lock signal

O

OpenSession
Manager, OpenSession ()
OpenSessionWithParameters
Manager, OpenSessionWithParameters ()

R

remote-host-name
Session, The "remote-host-name" property

S

SeatAdded
Manager, The SeatAdded signal
SeatRemoved
Manager, The SeatRemoved signal
session-type
Session, The "session-type" property
SessionAdded
Seat, The SessionAdded signal
SessionRemoved
Seat, The SessionRemoved signal
SetIdleHint
Session, SetIdleHint ()
SystemIdleHintChanged
Manager, The SystemIdleHintChanged signal

U

unix-user
Session, The "unix-user" property
Unlock
Session, Unlock (), The Unlock signal
user
Session, The "user" property

X

x11-display
Session, The "x11-display" property
x11-display-device
Session, The "x11-display-device" property
diff --git a/doc/spec/ck-session.xml b/doc/spec/ck-session.xml index c927c8c..f531ead 100644 --- a/doc/spec/ck-session.xml +++ b/doc/spec/ck-session.xml @@ -196,7 +196,7 @@ signal to be emitted for this session. - This method is restricted to privileged users by D-Bus policy. + This method is restricted to privileged users by D-Bus policy. Lock signal @@ -211,7 +211,7 @@ re-activated during fast-user-switching. - This method is restricted to privileged users by D-Bus policy. + This method is restricted to privileged users by D-Bus policy. Unlock signal diff --git a/doc/xml/ref-ck-session.xml b/doc/xml/ref-ck-session.xml index 9b32318..2d58625 100644 --- a/doc/xml/ref-ck-session.xml +++ b/doc/xml/ref-ck-session.xml @@ -136,7 +136,7 @@ See also: This will cause a Lock signal to be emitted for this session. - + This method is restricted to privileged users by D-Bus policy. See also: Lock signal<anchor role="function" id="Session.Unlock"/>Unlock ()UnlockSessionUnlock () This will cause an Unlock @@ -145,7 +145,7 @@ See also: This can be used by login managers to unlock a session before it is re-activated during fast-user-switching. - + This method is restricted to privileged users by D-Bus policy. See also: Unlock signal<anchor role="function" id="Session.GetIdleHint"/>GetIdleHint ()GetIdleHintSessionGetIdleHint (out 'b' idle_hint) Gets the value of the idle-hint -- cgit