org.freedesktop.ConsoleKit.Session

# org.freedesktop.ConsoleKit.Session

Session interface

## Methods

    GetId(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)

## Signals

    ActiveChanged('b'is_active)
    IdleHintChanged('b'hint)
    Lock()
    Unlock()

## Implemented Interfaces

Objects implementing org.freedesktop.ConsoleKit.Session also 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'

## Description

Session 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

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

May fail with CK_SESSION_ERROR_FAILED if the session isn't attached to a seat

`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. It is probably best to avoid this until we do.

`type`:

  Session type

See also: `session-type`

### GetUser ()

    GetUser (out'u'uid)

Returns the user that the session belongs to.

`uid`:

  User ID

`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'u'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 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 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 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.

`remote_host_name`:

  The remote host name

See also: `remote-host-name`

### GetLoginSessionId ()

    GetLoginSessionId (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

### 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. 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 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 cases, if successful, this will cause the session to become visible and become active on the seat that it is attached to.

May fail with: CK_SESSION_ERROR_ALREADY_ACTIVE, CK_SESSION_ERROR_NOT_SUPPORTED, CK_SESSION_ERROR_GENERAL

See also: `Seat.ActivateSession()`

### Lock ()

    Lock ()

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

#### Permissions

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

See also: `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.

#### Permissions

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` 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 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 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'

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.

### 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 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 (aka TTY) that the session is connected to.

### 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 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'

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'

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'

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.