### Interface

# Phosh IdleDBusIdleMonitor

#### Description [src]

    interface Phosh.IdleDBusIdleMonitor : GObject.Object

Abstract interface type for the D-Bus interface org.gnome.Mutter.IdleMonitor.

#### Prerequisite

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

#### Implementations

- PhoshIdleDBusIdleMonitorProxy
- PhoshIdleDBusIdleMonitorSkeleton

#### Functions

###### phosh_idle_dbus_idle_monitor_interface_info

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

###### phosh_idle_dbus_idle_monitor_override_properties

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

#### Instance methods

###### phosh_idle_dbus_idle_monitor_call_add_idle_watch

Asynchronously invokes the AddIdleWatch() 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_idle_dbus_idle_monitor_call_add_idle_watch_finish()` to get the result of the operation.

###### phosh_idle_dbus_idle_monitor_call_add_idle_watch_finish

Finishes an operation started with phosh_idle_dbus_idle_monitor_call_add_idle_watch().

###### phosh_idle_dbus_idle_monitor_call_add_idle_watch_sync

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

###### phosh_idle_dbus_idle_monitor_call_add_user_active_watch

Asynchronously invokes the AddUserActiveWatch() 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_idle_dbus_idle_monitor_call_add_user_active_watch_finish()` to get the result of the operation.

###### phosh_idle_dbus_idle_monitor_call_add_user_active_watch_finish

Finishes an operation started with phosh_idle_dbus_idle_monitor_call_add_user_active_watch().

###### phosh_idle_dbus_idle_monitor_call_add_user_active_watch_sync

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

###### phosh_idle_dbus_idle_monitor_call_get_idletime

Asynchronously invokes the GetIdletime() 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_idle_dbus_idle_monitor_call_get_idletime_finish()` to get the result of the operation.

###### phosh_idle_dbus_idle_monitor_call_get_idletime_finish

Finishes an operation started with phosh_idle_dbus_idle_monitor_call_get_idletime().

###### phosh_idle_dbus_idle_monitor_call_get_idletime_sync

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

###### phosh_idle_dbus_idle_monitor_call_remove_watch

Asynchronously invokes the RemoveWatch() 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_idle_dbus_idle_monitor_call_remove_watch_finish()` to get the result of the operation.

###### phosh_idle_dbus_idle_monitor_call_remove_watch_finish

Finishes an operation started with phosh_idle_dbus_idle_monitor_call_remove_watch().

###### phosh_idle_dbus_idle_monitor_call_remove_watch_sync

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

###### phosh_idle_dbus_idle_monitor_complete_add_idle_watch

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

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

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

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

Emits the “WatchFired” D-Bus signal.

#### Signals

###### Phosh.IdleDBusIdleMonitor::handle-add-idle-watch

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

###### Phosh.IdleDBusIdleMonitor::handle-add-user-active-watch

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

###### Phosh.IdleDBusIdleMonitor::handle-get-idletime

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

###### Phosh.IdleDBusIdleMonitor::handle-remove-watch

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

###### Phosh.IdleDBusIdleMonitor::watch-fired

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

#### Interface structure

    struct PhoshIdleDBusIdleMonitorIface {
      GTypeInterface parent_iface;
      gboolean (* handle_add_idle_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation,
        guint64 arg_interval
      );
      gboolean (* handle_add_user_active_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_get_idletime) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation
      );
      gboolean (* handle_remove_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation,
        guint arg_id
      );
      void (* watch_fired) (
        PhoshIdleDBusIdleMonitor* object,
        guint arg_id
      );

    }

Virtual table for the D-Bus interface org.gnome.Mutter.IdleMonitor.

###### Interface members

`parent_iface` |
    GTypeInterface
| The parent interface.
`handle_add_idle_watch` |
    gboolean (* handle_add_idle_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation,
        guint64 arg_interval
      )
| Handler for the `PhoshIdleDBusIdleMonitor::handle-add-idle-watch` signal.
`handle_add_user_active_watch` |
    gboolean (* handle_add_user_active_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshIdleDBusIdleMonitor::handle-add-user-active-watch` signal.
`handle_get_idletime` |
    gboolean (* handle_get_idletime) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation
      )
| Handler for the `PhoshIdleDBusIdleMonitor::handle-get-idletime` signal.
`handle_remove_watch` |
    gboolean (* handle_remove_watch) (
        PhoshIdleDBusIdleMonitor* object,
        GDBusMethodInvocation* invocation,
        guint arg_id
      )
| Handler for the `PhoshIdleDBusIdleMonitor::handle-remove-watch` signal.
`watch_fired` |
    void (* watch_fired) (
        PhoshIdleDBusIdleMonitor* object,
        guint arg_id
      )
| Handler for the `PhoshIdleDBusIdleMonitor::watch-fired` signal.

#### Virtual methods

###### Phosh.IdleDBusIdleMonitor.handle_add_idle_watch

Handler for the `PhoshIdleDBusIdleMonitor::handle-add-idle-watch` signal.

###### Phosh.IdleDBusIdleMonitor.handle_add_user_active_watch

Handler for the `PhoshIdleDBusIdleMonitor::handle-add-user-active-watch` signal.

###### Phosh.IdleDBusIdleMonitor.handle_get_idletime

Handler for the `PhoshIdleDBusIdleMonitor::handle-get-idletime` signal.

###### Phosh.IdleDBusIdleMonitor.handle_remove_watch

Handler for the `PhoshIdleDBusIdleMonitor::handle-remove-watch` signal.

###### Phosh.IdleDBusIdleMonitor.watch_fired

Handler for the `PhoshIdleDBusIdleMonitor::watch-fired` signal.