CScreensaver.ConsoleKitSession¶

Implementations:: CScreensaver.ConsoleKitSessionProxy, CScreensaver.ConsoleKitSessionSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_lock` (cancellable, callback, *user_data)
	`call_lock_finish` (res)
	`call_lock_sync` (cancellable)
	`call_unlock` (cancellable, callback, *user_data)
	`call_unlock_finish` (res)
	`call_unlock_sync` (cancellable)
	`complete_lock` (invocation)
	`complete_unlock` (invocation)
	`emit_active_changed` (arg_is_active)
	`emit_lock` ()
	`emit_unlock` ()

Virtual Methods¶

	`do_active_changed` (arg_is_active)
	`do_handle_lock` (invocation)
	`do_handle_unlock` (invocation)
	`do_lock` ()
	`do_unlock` ()

Properties¶

None

Signals¶

Name	Short Description
`active-changed`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“ActiveChanged” [gdbus-signal-org-freedesktop-ConsoleKit-Session.ActiveChanged]’ is received.
`handle-lock`	Signal emitted when a remote caller is invoking the ‘Lock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus method.
`handle-unlock`	Signal emitted when a remote caller is invoking the ‘Unlock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus method.
`lock`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“Lock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Lock]’ is received.
`unlock`	On the client-side, this signal is emitted whenever the D-Bus signal ‘“Unlock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Unlock]’ is received.

Fields¶

None

Class Details¶

class CScreensaver.ConsoleKitSession¶

Bases:: GObject.GInterface
Structure:: CScreensaver.ConsoleKitSessionIface

Abstract interface type for the D-Bus interface ‘org.freedesktop.ConsoleKit.Session [gdbus-interface-org-freedesktop-ConsoleKit-Session.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.freedesktop.ConsoleKit.Session [gdbus-interface-org-freedesktop-ConsoleKit-Session.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the CScreensaver.ConsoleKitSession interface for a concrete class. The properties are overridden in the order they are defined.

call_lock(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Lock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.ConsoleKitSession.call_lock_finish() to get the result of the operation.

See CScreensaver.ConsoleKitSession.call_lock_sync() for the synchronous, blocking version of this method.

call_lock_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ConsoleKitSession.call_lock().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.ConsoleKitSession.call_lock().

call_lock_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Lock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ConsoleKitSession.call_lock() for the asynchronous version of this method.

call_unlock(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Unlock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call CScreensaver.ConsoleKitSession.call_unlock_finish() to get the result of the operation.

See CScreensaver.ConsoleKitSession.call_unlock_sync() for the synchronous, blocking version of this method.

call_unlock_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ConsoleKitSession.call_unlock().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with CScreensaver.ConsoleKitSession.call_unlock().

call_unlock_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously invokes the ‘Unlock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ConsoleKitSession.call_unlock() for the asynchronous version of this method.

complete_lock(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Lock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_unlock(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Unlock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

emit_active_changed(arg_is_active)¶

Parameters:: arg_is_active (bool) – Argument to pass with the signal.

Emits the ‘“ActiveChanged” [gdbus-signal-org-freedesktop-ConsoleKit-Session.ActiveChanged]’ D-Bus signal.

emit_lock()¶: Emits the ‘“Lock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus signal.

emit_unlock()¶: Emits the ‘“Unlock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus signal.

do_active_changed(arg_is_active) virtual¶

Parameters:: arg_is_active (bool) –

do_handle_lock(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_handle_unlock(invocation) virtual¶

Parameters:: invocation (Gio.DBusMethodInvocation) –
Return type:: bool

do_lock() virtual¶

do_unlock() virtual¶

Signal Details¶

CScreensaver.ConsoleKitSession.signals.active_changed(console_kit_session, arg_is_active)¶

Signal Name:

active-changed

Flags:

RUN_LAST

Parameters:

console_kit_session (CScreensaver.ConsoleKitSession) – The object which received the signal
arg_is_active (bool) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“ActiveChanged” [gdbus-signal-org-freedesktop-ConsoleKit-Session.ActiveChanged]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

CScreensaver.ConsoleKitSession.signals.handle_lock(console_kit_session, invocation)¶

Signal Name:

handle-lock

Flags:

RUN_LAST

Parameters:

console_kit_session (CScreensaver.ConsoleKitSession) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Lock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Lock]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.ConsoleKitSession.complete_lock() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.ConsoleKitSession.signals.handle_unlock(console_kit_session, invocation)¶

Signal Name:

handle-unlock

Flags:

RUN_LAST

Parameters:

console_kit_session (CScreensaver.ConsoleKitSession) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Unlock() [gdbus-method-org-freedesktop-ConsoleKit-Session.Unlock]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call CScreensaver.ConsoleKitSession.complete_unlock() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

CScreensaver.ConsoleKitSession.signals.lock(console_kit_session)¶

Signal Name:: lock
Flags:: RUN_LAST
Parameters:: console_kit_session (CScreensaver.ConsoleKitSession) – The object which received the signal

On the client-side, this signal is emitted whenever the D-Bus signal ‘“Lock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Lock]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

CScreensaver.ConsoleKitSession.signals.unlock(console_kit_session)¶

Signal Name:: unlock
Flags:: RUN_LAST
Parameters:: console_kit_session (CScreensaver.ConsoleKitSession) – The object which received the signal

On the client-side, this signal is emitted whenever the D-Bus signal ‘“Unlock” [gdbus-signal-org-freedesktop-ConsoleKit-Session.Unlock]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.