### Interface

# Phosh DBusScreenSaver

#### Description [src]

    interface Phosh.DBusScreenSaver : GObject.Object

Abstract interface type for the D-Bus interface org.gnome.ScreenSaver.

#### Prerequisite

In order to implement DBusScreenSaver, your type must inherit from`GObject`.

#### Implementations

- PhoshDBusScreenSaverProxy
- PhoshDBusScreenSaverSkeleton
- PhoshScreenSaverManager

#### Functions

###### phosh_dbus_screen_saver_interface_info

Gets a machine-readable description of the org.gnome.ScreenSaver D-Bus interface.

###### phosh_dbus_screen_saver_override_properties

Overrides all `GObject` properties in the `PhoshDBusScreenSaver` interface for a concrete class. The properties are overridden in the order they are defined.

#### Instance methods

###### phosh_dbus_screen_saver_call_get_active

Asynchronously invokes the GetActive() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_screen_saver_call_get_active_finish()` to get the result of the operation.

###### phosh_dbus_screen_saver_call_get_active_finish

Finishes an operation started with phosh_dbus_screen_saver_call_get_active().

###### phosh_dbus_screen_saver_call_get_active_sync

Synchronously invokes the GetActive() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_screen_saver_call_get_active_time

Asynchronously invokes the GetActiveTime() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_screen_saver_call_get_active_time_finish()` to get the result of the operation.

###### phosh_dbus_screen_saver_call_get_active_time_finish

Finishes an operation started with phosh_dbus_screen_saver_call_get_active_time().

###### phosh_dbus_screen_saver_call_get_active_time_sync

Synchronously invokes the GetActiveTime() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_screen_saver_call_lock

Asynchronously invokes the Lock() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_screen_saver_call_lock_finish()` to get the result of the operation.

###### phosh_dbus_screen_saver_call_lock_finish

Finishes an operation started with phosh_dbus_screen_saver_call_lock().

###### phosh_dbus_screen_saver_call_lock_sync

Synchronously invokes the Lock() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_screen_saver_call_set_active

Asynchronously invokes the SetActive() D-Bus method on `proxy`. 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 g_main_context_push_thread_default()). You can then call `phosh_dbus_screen_saver_call_set_active_finish()` to get the result of the operation.

###### phosh_dbus_screen_saver_call_set_active_finish

Finishes an operation started with phosh_dbus_screen_saver_call_set_active().

###### phosh_dbus_screen_saver_call_set_active_sync

Synchronously invokes the SetActive() D-Bus method on `proxy`. The calling thread is blocked until a reply is received.

###### phosh_dbus_screen_saver_complete_get_active

Helper function used in service implementations to finish handling invocations of the 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.

###### phosh_dbus_screen_saver_complete_get_active_time

Helper function used in service implementations to finish handling invocations of the 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.

###### phosh_dbus_screen_saver_complete_lock

Helper function used in service implementations to finish handling invocations of the 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.

###### phosh_dbus_screen_saver_complete_set_active

Helper function used in service implementations to finish handling invocations of the 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.

###### phosh_dbus_screen_saver_emit_active_changed

Emits the “ActiveChanged” D-Bus signal.

###### phosh_dbus_screen_saver_emit_wake_up_screen

Emits the “WakeUpScreen” D-Bus signal.

#### Signals

###### Phosh.DBusScreenSaver::active-changed

On the client-side, this signal is emitted whenever the D-Bus signal “ActiveChanged” is received.

###### Phosh.DBusScreenSaver::handle-get-active

Signal emitted when a remote caller is invoking the GetActive() D-Bus method.

###### Phosh.DBusScreenSaver::handle-get-active-time

Signal emitted when a remote caller is invoking the GetActiveTime() D-Bus method.

###### Phosh.DBusScreenSaver::handle-lock

Signal emitted when a remote caller is invoking the Lock() D-Bus method.

###### Phosh.DBusScreenSaver::handle-set-active

Signal emitted when a remote caller is invoking the SetActive() D-Bus method.

###### Phosh.DBusScreenSaver::wake-up-screen

On the client-side, this signal is emitted whenever the D-Bus signal “WakeUpScreen” is received.

#### Interface structure

    struct PhoshDBusScreenSaverIface {
      GTypeInterface parent_iface;
      gboolean (* handle_get_active) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_get_active_time) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_lock) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_set_active) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_value
      );
      void (* active_changed) (
        PhoshDBusScreenSaver* object,
        gboolean arg_new_value
      );
      void (* wake_up_screen) (
        PhoshDBusScreenSaver* object
      );

    }

Virtual table for the D-Bus interface org.gnome.ScreenSaver.

###### Interface members

`parent_iface` |
    GTypeInterface
| The parent interface.
`handle_get_active` |
    gboolean (* handle_get_active) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshDBusScreenSaver::handle-get-active` signal.
`handle_get_active_time` |
    gboolean (* handle_get_active_time) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshDBusScreenSaver::handle-get-active-time` signal.
`handle_lock` |
    gboolean (* handle_lock) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshDBusScreenSaver::handle-lock` signal.
`handle_set_active` |
    gboolean (* handle_set_active) (
        PhoshDBusScreenSaver* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_value
      )
| Handler for the `PhoshDBusScreenSaver::handle-set-active` signal.
`active_changed` |
    void (* active_changed) (
        PhoshDBusScreenSaver* object,
        gboolean arg_new_value
      )
| Handler for the `PhoshDBusScreenSaver::active-changed` signal.
`wake_up_screen` |
    void (* wake_up_screen) (
        PhoshDBusScreenSaver* object
      )
| Handler for the `PhoshDBusScreenSaver::wake-up-screen` signal.

#### Virtual methods

###### Phosh.DBusScreenSaver.active_changed

Handler for the `PhoshDBusScreenSaver::active-changed` signal.

###### Phosh.DBusScreenSaver.handle_get_active

Handler for the `PhoshDBusScreenSaver::handle-get-active` signal.

###### Phosh.DBusScreenSaver.handle_get_active_time

Handler for the `PhoshDBusScreenSaver::handle-get-active-time` signal.

###### Phosh.DBusScreenSaver.handle_lock

Handler for the `PhoshDBusScreenSaver::handle-lock` signal.

###### Phosh.DBusScreenSaver.handle_set_active

Handler for the `PhoshDBusScreenSaver::handle-set-active` signal.

###### Phosh.DBusScreenSaver.wake_up_screen

Handler for the `PhoshDBusScreenSaver::wake-up-screen` signal.