Setenv ()

Setenv (in  's' variable,
        in  's' value)

Adds the variable name to the application launch environment with the specified value. May only be used during the Session Manager initialization phase.

GetLocale ()

GetLocale (in  'i' category,
           out 's' value)

Reads the current state of the specific locale category.

InitializationError ()

InitializationError (in  's' message,
                     in  'b' fatal)

May be used by applications launched during the Session Manager initialization phase to indicate there was a problem.

Initialized ()

Initialized ()

Run from systemd to signal that gnome-session-initialized.target has been reached.

RegisterClient ()

RegisterClient (in  's' app_id,
                in  's' client_startup_id,
                out 'o' client_id)

Register the caller as a Session Management client.

UnregisterClient ()

UnregisterClient (in  'o' client_id)

Unregister the specified client from Session Management.

Inhibit ()

Inhibit (in  's' app_id,
         in  'u' toplevel_xid,
         in  's' reason,
         in  'u' flags,
         out 'u' inhibit_cookie)

Applications should invoke this method when they begin an operation that should not be interrupted, such as creating a CD or DVD. The types of actions that may be blocked are specified by the flags parameter. When the application completes the operation it should call Uninhibit() or disconnect from the session bus.

Applications should not expect that they will always be able to block the action. In most cases, users will be given the option to force the action to take place.

Reasons should be short and to the point.

The flags parameter must include at least one of the following:

Values for flags may be bitwise or'ed together.

The returned cookie is used to uniquely identify this request. It should be used as an argument to Uninhibit() in order to remove the request.

Uninhibit ()

Uninhibit (in  'u' inhibit_cookie)

Cancel a previous call to Inhibit() identified by the cookie.

IsInhibited ()

IsInhibited (in  'u' flags,
             out 'b' is_inhibited)

Determine if operation(s) specified by the flags are currently inhibited. Flags are same as those accepted by the Inhibit() method.

GetClients ()

GetClients (out 'ao' clients)

This gets a list of all the Clients that are currently known to the session manager.

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

See also: org.gnome.SessionManager.Client

GetInhibitors ()

GetInhibitors (out 'ao' inhibitors)

This gets a list of all the Inhibitors that are currently known to the session manager.

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

See also: org.gnome.SessionManager.Inhibitor

IsAutostartConditionHandled ()

IsAutostartConditionHandled (in  's' condition,
                             out 'b' handled)

Allows the caller to determine whether the session manager is handling changes to the specified autostart condition.

Shutdown ()

Shutdown ()

Request a shutdown dialog.

Reboot ()

Reboot ()

Request a reboot dialog.

CanShutdown ()

CanShutdown (out 'b' is_available)

Allows the caller to determine whether or not it's okay to show a shutdown option in the UI

SetRebootToFirmwareSetup ()

SetRebootToFirmwareSetup (in  'b' enable)

Allows the caller to indicate to the system's firmware to boot into setup mode

CanRebootToFirmwareSetup ()

CanRebootToFirmwareSetup (out 'b' is_available)

Allows the caller to determine whether or not it's okay to show a reboot to firmware option in the UI

Logout ()

Logout (in  'u' mode)

Request a logout dialog

Allowed values for the mode parameter are:

Values for flags may be bitwise or'ed together.

IsSessionRunning ()

IsSessionRunning (out 'b' running)

Allows the caller to determine whether the session manager has entered the Running phase, in case the client missed the SessionRunning signal.

The ClientAdded signal

ClientAdded ('o' id)

Emitted when a client has been added to the session manager.

The ClientRemoved signal

ClientRemoved ('o' id)

Emitted when a client has been removed from the session manager.

The InhibitorAdded signal

InhibitorAdded ('o' id)

Emitted when an inhibitor has been added to the session manager.

The InhibitorRemoved signal

InhibitorRemoved ('o' id)

Emitted when an inhibitor has been removed from the session manager.

The SessionRunning signal

SessionRunning ()

Indicates the session has entered the Running phase.

The SessionOver signal

SessionOver ()

Indicates the session is about to end.

The "SessionName" property

'SessionName'  read      's'

The name of the session that has been loaded.

The "Renderer" property

'Renderer'  read      's'

The renderer for the session that has been loaded. At the moment this supports GL and GLES, and is only used for the X session.

The "SessionIsActive" property

'SessionIsActive'  read      'b'

If true, the session is currently in the foreground and available for user input.

The "InhibitedActions" property

'InhibitedActions'  read      'u'

A bitmask of flags to indicate which actions are inhibited. See the Inhibit() function's description for a list of possible values.

GetAppId ()

GetAppId (out 's' app_id)

Return the application ID associated with this client.

GetStartupId ()

GetStartupId (out 's' startup_id)

Return the startup ID associated with this client.

GetRestartStyleHint ()

GetRestartStyleHint (out 'u' hint)

Return the restart style hint for this client.

GetUnixProcessId ()

GetUnixProcessId (out 'u' pid)

Return the Unix process identifier for this client.

GetStatus ()

GetStatus (out 'u' status)

Return the status of this client.

Stop ()

Stop ()

Initiate a request to terminate this application via XSMP.

EndSessionResponse ()

EndSessionResponse (in  'b' is_ok,
                    in  's' reason)

This method should be used by the client in response to the QueryEndSession and EndSession signals.

The Stop signal

Stop ()

The client should stop and remove itself from the session in response to this signal.

The QueryEndSession signal

QueryEndSession ('u' flags)

This signal is used to inform the client that the session is about to end. The client must respond by calling EndSessionResponse within one second of the signal emission.

The flags may include:

If the client responds with an EndSessionResponse is-ok argument equal to FALSE and a reason then this reason may be displayed to the user.

The client must not attempt to perform any actions or interact with the user in response to this signal. Any actions required for a clean shutdown should take place in response to the EndSession signal.

The client should limit operations until either a EndSession CancelEndSession signal is received.

The EndSession signal

EndSession ('u' flags)

This signal is used to inform the client that the session is about to end. The client must respond by calling EndSessionResponse within ten seconds of the signal emission.

The client must not attempt to interact with the user in response to this signal. The application will be given a maxium of ten seconds to perform any actions required for a clean shutdown.

The CancelEndSession signal

CancelEndSession ()

This signal indicates to the client that a previous emission of QueryEndSession has been cancelled. The client should resume normal operations.

GetAppId ()

GetAppId (out 's' app_id)

Return the application ID associated with this inhibit.

GetClientId ()

GetClientId (out 'o' client_id)

Return the client object path associated with this inhibit.

GetReason ()

GetReason (out 's' reason)

Return the reason for the inhibit

GetFlags ()

GetFlags (out 'u' flags)

Return the flags that determine the scope of the inhibit

GetToplevelXid ()

GetToplevelXid (out 'u' xid)

Return the X11 toplevel window identifier associated with this inhibit. Zero if not set.

SetStatus ()

SetStatus (in  'u' status)

Set the status value of the session.

SetStatusText ()

SetStatusText (in  's' status_text)

Set the descriptive status text for the session.

The StatusChanged signal

StatusChanged ('u' status)

Indicates that the session status value has changed.

The StatusTextChanged signal

StatusTextChanged ('s' status_text)

Indicates that the descriptive session status text has changed.

The "status" property

'status'  readwrite 'u'

The status of the session.

The status parameter must be one of the following:

The "status-text" property

'status-text'  readwrite 's'

The descriptive status for the session.