org.freedesktop.ConsoleKit.Sessionorg.freedesktop.ConsoleKit.SessionSession interfaceMethodsGetId (out 'o' ssid)
GetSeatId (out 'o' sid)
GetSessionType (out 's' type)
GetUser (out 'u' uid)
GetUnixUser (out 'u' uid)
GetX11Display (out 's' display)
GetX11DisplayDevice (out 's' x11_display_device)
GetDisplayDevice (out 's' display_device)
GetRemoteHostName (out 's' remote_host_name)
GetLoginSessionId (out 's' login_session_id)
IsActive (out 'b' active)
IsLocal (out 'b' local)
GetCreationTime (out 's' iso8601_datetime)
Activate ()
Lock ()
Unlock ()
GetIdleHint (out 'b' idle_hint)
GetIdleSinceHint (out 's' iso8601_datetime)
SetIdleHint (in 'b' idle_hint)
SignalsActiveChanged ('b' is_active)
IdleHintChanged ('b' hint)
Lock ()
Unlock ()
Implemented Interfacesorg.freedesktop.ConsoleKit.Session implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
Properties'unix-user' readwrite 'u'
'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'
DescriptionSession objects represent and store information
related to a user session.
The properties associated with the Session
specifically refer to the properties of the "session leader".
Details<anchor role="function" id="Session.GetId"/>GetId ()GetIdSessionGetId (out 'o' ssid)Returns the ID for Session.ssid:Session ID<anchor role="function" id="Session.GetSeatId"/>GetSeatId ()GetSeatIdSessionGetSeatId (out 'o' sid)Returns the ID for the Seat the Session is
attached to.sid:Seat ID
See also:
org.freedesktop.ConsoleKit.Seat<anchor role="function" id="Session.GetSessionType"/>GetSessionType ()GetSessionTypeSessionGetSessionType (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<anchor role="function" id="Session.GetUser"/>GetUser ()GetUserSessionGetUser (out 'u' uid)Returns the user that the session belongs to.uid:User IDGetUser is deprecated since version 0.1.3 and should not be used in newly-written code. Use
GetUnixUser
instead.
See also:
user<anchor role="function" id="Session.GetUnixUser"/>GetUnixUser ()GetUnixUserSessionGetUnixUser (out 'u' uid)Returns the POSIX user ID that the session belongs to.uid:POSIX User ID
See also:
unix-user<anchor role="function" id="Session.GetX11Display"/>GetX11Display ()GetX11DisplaySessionGetX11Display (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<anchor role="function" id="Session.GetX11DisplayDevice"/>GetX11DisplayDevice ()GetX11DisplayDeviceSessionGetX11DisplayDevice (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<anchor role="function" id="Session.GetDisplayDevice"/>GetDisplayDevice ()GetDisplayDeviceSessionGetDisplayDevice (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<anchor role="function" id="Session.GetRemoteHostName"/>GetRemoteHostName ()GetRemoteHostNameSessionGetRemoteHostName (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<anchor role="function" id="Session.GetLoginSessionId"/>GetLoginSessionId ()GetLoginSessionIdSessionGetLoginSessionId (out 's' login_session_id)Returns the value of the login session ID that the
underlying system uses to enforce session boundaries. If there is no login session ID
set then this value is an empty string.login_session_id:The value of the native system login session ID<anchor role="function" id="Session.IsActive"/>IsActive ()IsActiveSessionIsActive (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<anchor role="function" id="Session.IsLocal"/>IsLocal ()IsLocalSessionIsLocal (out 'b' local)Returns whether the session is localFIXME: 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<anchor role="function" id="Session.GetCreationTime"/>GetCreationTime ()GetCreationTimeSessionGetCreationTime (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<anchor role="function" id="Session.Activate"/>Activate ()ActivateSessionActivate ()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()<anchor role="function" id="Session.Lock"/>Lock ()LockSessionLock ()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
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<anchor role="function" id="Session.GetIdleHint"/>GetIdleHint ()GetIdleHintSessionGetIdleHint (out 'b' idle_hint)Gets the value of the idle-hint
property.
idle_hint:The value of the idle-hint
See also:
idle-hint<anchor role="function" id="Session.GetIdleSinceHint"/>GetIdleSinceHint ()GetIdleSinceHintSessionGetIdleSinceHint (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<anchor role="function" id="Session.SetIdleHint"/>SetIdleHint ()SetIdleHintSessionSetIdleHint (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 toSignal Details<anchor role="function" id="Session::ActiveChanged"/>The ActiveChanged signalActiveChangedSessionActiveChanged ('b' is_active)Emitted when the active property has changed.is_active:TRUE if the session is active, otherwise FALSE<anchor role="function" id="Session::IdleHintChanged"/>The IdleHintChanged signalIdleHintChangedSessionIdleHintChanged ('b' hint)Emitted when the idle-hint property has changed.hint:the new value of idle-hint<anchor role="function" id="Session::Lock"/>The Lock signalLockSessionLock ()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.<anchor role="function" id="Session::Unlock"/>The Unlock signalUnlockSessionUnlock ()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<anchor role="function" id="Session:unix-user"/>The "unix-user" propertyunix-userSession'unix-user' readwrite 'u'
The user assigned to the session.<anchor role="function" id="Session:user"/>The "user" propertyuserSession'user' readwrite 'u'
The user assigned to the session.user is deprecated since version 0.1.3 and should not be used in newly-written code. Use
unix-user
instead.<anchor role="function" id="Session:session-type"/>The "session-type" propertysession-typeSession'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.
<anchor role="function" id="Session:remote-host-name"/>The "remote-host-name" propertyremote-host-nameSession'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.
<anchor role="function" id="Session:display-device"/>The "display-device" propertydisplay-deviceSession'display-device' readwrite 's'
The display device (aka TTY) that the
session is connected to.
<anchor role="function" id="Session:x11-display"/>The "x11-display" propertyx11-displaySession'x11-display' readwrite 's'
Value of the X11 DISPLAY for this session
if one is present.
<anchor role="function" id="Session:x11-display-device"/>The "x11-display-device" propertyx11-display-deviceSession'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.
<anchor role="function" id="Session:active"/>The "active" propertyactiveSession'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.
<anchor role="function" id="Session:is-local"/>The "is-local" propertyis-localSession'is-local' readwrite 'b'
Whether the session is localFIXME: 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.
<anchor role="function" id="Session:idle-hint"/>The "idle-hint" propertyidle-hintSession'idle-hint' readwrite 'b'
This is a hint used to indicate that the session may be idle.
For sessions with a x11-display set (ie. graphical
sessions), it is up to each session to delegate the
responsibility for updating this value. Typically, the
screensaver will set this.
However, for non-graphical sessions with a display-device set
the Session object itself will periodically update this value based
on the activity detected on the display-device itself.
This should not be considered authoritative.