CScreensaver.ScreenSaver

Implementations:

CScreensaver.ScreenSaverProxy, CScreensaver.ScreenSaverSkeleton

Methods

class	interface_info ()
class	override_properties (klass, property_id_begin)
	call_get_active (cancellable, callback, *user_data)
	call_get_active_finish (res)
	call_get_active_sync (cancellable)
	call_get_active_time (cancellable, callback, *user_data)
	call_get_active_time_finish (res)
	call_get_active_time_sync (cancellable)
	call_get_session_idle_time (cancellable, callback, *user_data)
	call_get_session_idle_time_finish (res)
	call_get_session_idle_time_sync (cancellable)
	call_lock (arg_message, cancellable, callback, *user_data)
	call_lock_finish (res)
	call_lock_sync (arg_message, cancellable)
	call_quit (cancellable, callback, *user_data)
	call_quit_finish (res)
	call_quit_sync (cancellable)
	call_set_active (arg_e, cancellable, callback, *user_data)
	call_set_active_finish (res)
	call_set_active_sync (arg_e, cancellable)
	call_simulate_user_activity (cancellable, callback, *user_data)
	call_simulate_user_activity_finish (res)
	call_simulate_user_activity_sync (cancellable)
	complete_get_active (invocation, arg_0)
	complete_get_active_time (invocation, seconds)
	complete_get_session_idle_time (invocation, seconds)
	complete_lock (invocation)
	complete_quit (invocation)
	complete_set_active (invocation)
	complete_simulate_user_activity (invocation)
	emit_active_changed (arg_arg_0)

Virtual Methods

	do_active_changed (arg_arg_0)
	do_handle_get_active (invocation)
	do_handle_get_active_time (invocation)
	do_handle_get_session_idle_time (invocation)
	do_handle_lock (invocation, arg_message)
	do_handle_quit (invocation)
	do_handle_set_active (invocation, arg_e)
	do_handle_simulate_user_activity (invocation)

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-cinnamon-ScreenSaver.ActiveChanged]’ is received.
handle-get-active	Signal emitted when a remote caller is invoking the ‘GetActive() [gdbus-method-org-cinnamon-ScreenSaver.GetActive]’ D-Bus method.
handle-get-active-time	Signal emitted when a remote caller is invoking the ‘GetActiveTime() [gdbus-method-org-cinnamon-ScreenSaver.GetActiveTime]’ D-Bus method.
handle-get-session-idle-time	Signal emitted when a remote caller is invoking the ‘GetSessionIdleTime() [gdbus-method-org-cinnamon-ScreenSaver.GetSessionIdleTime]’ D-Bus method.
handle-lock	Signal emitted when a remote caller is invoking the ‘Lock() [gdbus-method-org-cinnamon-ScreenSaver.Lock]’ D-Bus method.
handle-quit	Signal emitted when a remote caller is invoking the ‘Quit() [gdbus-method-org-cinnamon-ScreenSaver.Quit]’ D-Bus method.
handle-set-active	Signal emitted when a remote caller is invoking the ‘SetActive() [gdbus-method-org-cinnamon-ScreenSaver.SetActive]’ D-Bus method.
handle-simulate-user-activity	Signal emitted when a remote caller is invoking the ‘SimulateUserActivity() [gdbus-method-org-cinnamon-ScreenSaver.SimulateUserActivity]’ D-Bus method.

Fields

None

Class Details

class CScreensaver.ScreenSaver

Bases:

GObject.GInterface

Structure:

CScreensaver.ScreenSaverIface

Abstract interface type for the D-Bus interface ‘org.cinnamon.ScreenSaver [gdbus-interface-org-cinnamon-ScreenSaver.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.cinnamon.ScreenSaver [gdbus-interface-org-cinnamon-ScreenSaver.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.ScreenSaver interface for a concrete class. The properties are overridden in the order they are defined.

call_get_active(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 ‘GetActive() [gdbus-method-org-cinnamon-ScreenSaver.GetActive]’ 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.ScreenSaver.call_get_active_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_get_active_sync() for the synchronous, blocking version of this method.

call_get_active_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_get_active().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_arg_0:

Return location for return parameter or None to ignore.

Return type:

(bool, out_arg_0: bool)

Finishes an operation started with CScreensaver.ScreenSaver.call_get_active().

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

out_arg_0:

Return location for return parameter or None to ignore.

Return type:

(bool, out_arg_0: bool)

Synchronously invokes the ‘GetActive() [gdbus-method-org-cinnamon-ScreenSaver.GetActive]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_get_active() for the asynchronous version of this method.

call_get_active_time(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 ‘GetActiveTime() [gdbus-method-org-cinnamon-ScreenSaver.GetActiveTime]’ 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.ScreenSaver.call_get_active_time_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_get_active_time_sync() for the synchronous, blocking version of this method.

call_get_active_time_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_get_active_time().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_seconds:

Return location for return parameter or None to ignore.

Return type:

(bool, out_seconds: int)

Finishes an operation started with CScreensaver.ScreenSaver.call_get_active_time().

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

out_seconds:

Return location for return parameter or None to ignore.

Return type:

(bool, out_seconds: int)

Synchronously invokes the ‘GetActiveTime() [gdbus-method-org-cinnamon-ScreenSaver.GetActiveTime]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_get_active_time() for the asynchronous version of this method.

call_get_session_idle_time(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 ‘GetSessionIdleTime() [gdbus-method-org-cinnamon-ScreenSaver.GetSessionIdleTime]’ 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.ScreenSaver.call_get_session_idle_time_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_get_session_idle_time_sync() for the synchronous, blocking version of this method.

call_get_session_idle_time_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_get_session_idle_time().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_seconds:

Return location for return parameter or None to ignore.

Return type:

(bool, out_seconds: int)

Finishes an operation started with CScreensaver.ScreenSaver.call_get_session_idle_time().

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

out_seconds:

Return location for return parameter or None to ignore.

Return type:

(bool, out_seconds: int)

Synchronously invokes the ‘GetSessionIdleTime() [gdbus-method-org-cinnamon-ScreenSaver.GetSessionIdleTime]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_get_session_idle_time() for the asynchronous version of this method.

call_lock(arg_message, cancellable, callback, *user_data)

Parameters:

• arg_message (str) – Argument to pass with the method invocation.

• 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-cinnamon-ScreenSaver.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.ScreenSaver.call_lock_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.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.ScreenSaver.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.ScreenSaver.call_lock().

call_lock_sync(arg_message, cancellable)

Parameters:

• arg_message (str) – Argument to pass with the method invocation.

• 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-cinnamon-ScreenSaver.Lock]’ D-Bus method on self. The calling thread is blocked until a reply is received.

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

call_quit(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 ‘Quit() [gdbus-method-org-cinnamon-ScreenSaver.Quit]’ 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.ScreenSaver.call_quit_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_quit_sync() for the synchronous, blocking version of this method.

call_quit_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_quit().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Finishes an operation started with CScreensaver.ScreenSaver.call_quit().

call_quit_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 ‘Quit() [gdbus-method-org-cinnamon-ScreenSaver.Quit]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_quit() for the asynchronous version of this method.

call_set_active(arg_e, cancellable, callback, *user_data)

Parameters:

• arg_e (bool) – Argument to pass with the method invocation.

• 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 ‘SetActive() [gdbus-method-org-cinnamon-ScreenSaver.SetActive]’ 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.ScreenSaver.call_set_active_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_set_active_sync() for the synchronous, blocking version of this method.

call_set_active_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_set_active().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Finishes an operation started with CScreensaver.ScreenSaver.call_set_active().

call_set_active_sync(arg_e, cancellable)

Parameters:

• arg_e (bool) – Argument to pass with the method invocation.

• 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 ‘SetActive() [gdbus-method-org-cinnamon-ScreenSaver.SetActive]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_set_active() for the asynchronous version of this method.

call_simulate_user_activity(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 ‘SimulateUserActivity() [gdbus-method-org-cinnamon-ScreenSaver.SimulateUserActivity]’ 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.ScreenSaver.call_simulate_user_activity_finish() to get the result of the operation.

See CScreensaver.ScreenSaver.call_simulate_user_activity_sync() for the synchronous, blocking version of this method.

call_simulate_user_activity_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to CScreensaver.ScreenSaver.call_simulate_user_activity().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Finishes an operation started with CScreensaver.ScreenSaver.call_simulate_user_activity().

call_simulate_user_activity_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 ‘SimulateUserActivity() [gdbus-method-org-cinnamon-ScreenSaver.SimulateUserActivity]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See CScreensaver.ScreenSaver.call_simulate_user_activity() for the asynchronous version of this method.

complete_get_active(invocation, arg_0)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• arg_0 (bool) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘GetActive() [gdbus-method-org-cinnamon-ScreenSaver.GetActive]’ 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_get_active_time(invocation, seconds)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• seconds (int) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘GetActiveTime() [gdbus-method-org-cinnamon-ScreenSaver.GetActiveTime]’ 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_get_session_idle_time(invocation, seconds)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• seconds (int) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘GetSessionIdleTime() [gdbus-method-org-cinnamon-ScreenSaver.GetSessionIdleTime]’ 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_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-cinnamon-ScreenSaver.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_quit(invocation)

Parameters:

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

Helper function used in service implementations to finish handling invocations of the ‘Quit() [gdbus-method-org-cinnamon-ScreenSaver.Quit]’ 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_set_active(invocation)

Parameters:

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

Helper function used in service implementations to finish handling invocations of the ‘SetActive() [gdbus-method-org-cinnamon-ScreenSaver.SetActive]’ 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_simulate_user_activity(invocation)

Parameters:

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

Helper function used in service implementations to finish handling invocations of the ‘SimulateUserActivity() [gdbus-method-org-cinnamon-ScreenSaver.SimulateUserActivity]’ 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_arg_0)

Parameters:

arg_arg_0 (bool) – Argument to pass with the signal.

Emits the ‘“ActiveChanged” [gdbus-signal-org-cinnamon-ScreenSaver.ActiveChanged]’ D-Bus signal.

do_active_changed(arg_arg_0) virtual

Parameters:

arg_arg_0 (bool) –

do_handle_get_active(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

do_handle_get_active_time(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

do_handle_get_session_idle_time(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

do_handle_lock(invocation, arg_message) virtual

Parameters:

• invocation (Gio.DBusMethodInvocation) –

• arg_message (str) –

Return type:

bool

do_handle_quit(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

do_handle_set_active(invocation, arg_e) virtual

Parameters:

• invocation (Gio.DBusMethodInvocation) –

• arg_e (bool) –

Return type:

bool

do_handle_simulate_user_activity(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

Signal Details

CScreensaver.ScreenSaver.signals.active_changed(screen_saver, arg_arg_0)

Signal Name:

active-changed

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – The object which received the signal

• arg_arg_0 (bool) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“ActiveChanged” [gdbus-signal-org-cinnamon-ScreenSaver.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.ScreenSaver.signals.handle_get_active(screen_saver, invocation)

Signal Name:

handle-get-active

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – 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 ‘GetActive() [gdbus-method-org-cinnamon-ScreenSaver.GetActive]’ 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.ScreenSaver.complete_get_active() 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.ScreenSaver.signals.handle_get_active_time(screen_saver, invocation)

Signal Name:

handle-get-active-time

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – 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 ‘GetActiveTime() [gdbus-method-org-cinnamon-ScreenSaver.GetActiveTime]’ 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.ScreenSaver.complete_get_active_time() 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.ScreenSaver.signals.handle_get_session_idle_time(screen_saver, invocation)

Signal Name:

handle-get-session-idle-time

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – 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 ‘GetSessionIdleTime() [gdbus-method-org-cinnamon-ScreenSaver.GetSessionIdleTime]’ 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.ScreenSaver.complete_get_session_idle_time() 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.ScreenSaver.signals.handle_lock(screen_saver, invocation, arg_message)

Signal Name:

handle-lock

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• arg_message (str) – Argument passed by remote caller.

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-cinnamon-ScreenSaver.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.ScreenSaver.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.ScreenSaver.signals.handle_quit(screen_saver, invocation)

Signal Name:

handle-quit

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – 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 ‘Quit() [gdbus-method-org-cinnamon-ScreenSaver.Quit]’ 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.ScreenSaver.complete_quit() 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.ScreenSaver.signals.handle_set_active(screen_saver, invocation, arg_e)

Signal Name:

handle-set-active

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• arg_e (bool) – Argument passed by remote caller.

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 ‘SetActive() [gdbus-method-org-cinnamon-ScreenSaver.SetActive]’ 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.ScreenSaver.complete_set_active() 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.ScreenSaver.signals.handle_simulate_user_activity(screen_saver, invocation)

Signal Name:

handle-simulate-user-activity

Flags:

RUN_LAST

Parameters:

• screen_saver (CScreensaver.ScreenSaver) – 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 ‘SimulateUserActivity() [gdbus-method-org-cinnamon-ScreenSaver.SimulateUserActivity]’ 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.ScreenSaver.complete_simulate_user_activity() 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.