### Interface

# Phosh DBusLoginSession

since: 0

#### Description [src]

    interface Phosh.DBusLoginSession : GObject.Object

Abstract interface type for the D-Bus interface org.freedesktop.login1.Session.

Available since: 0

#### Prerequisite

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

#### Implementations

- PhoshDBusLoginSessionProxy
- PhoshDBusLoginSessionSkeleton

#### Functions

###### phosh_dbus_login_session_interface_info

Gets a machine-readable description of the org.freedesktop.login1.Session D-Bus interface.

since: 0

###### phosh_dbus_login_session_override_properties

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

since: 0

#### Instance methods

###### phosh_dbus_login_session_call_set_brightness

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

since: 0

###### phosh_dbus_login_session_call_set_brightness_finish

Finishes an operation started with phosh_dbus_login_session_call_set_brightness().

since: 0

###### phosh_dbus_login_session_call_set_brightness_sync

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

since: 0

###### phosh_dbus_login_session_call_set_locked_hint

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

since: 0

###### phosh_dbus_login_session_call_set_locked_hint_finish

Finishes an operation started with phosh_dbus_login_session_call_set_locked_hint().

since: 0

###### phosh_dbus_login_session_call_set_locked_hint_sync

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

since: 0

###### phosh_dbus_login_session_complete_set_brightness

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

since: 0

###### phosh_dbus_login_session_complete_set_locked_hint

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

since: 0

###### phosh_dbus_login_session_emit_lock

Emits the “Lock” D-Bus signal.

since: 0

###### phosh_dbus_login_session_emit_unlock

Emits the “Unlock” D-Bus signal.

since: 0

###### phosh_dbus_login_session_get_active

Gets the value of the “Active” D-Bus property.

since: 0

###### phosh_dbus_login_session_get_locked_hint

Gets the value of the “LockedHint” D-Bus property.

since: 0

###### phosh_dbus_login_session_set_active

Sets the “Active” D-Bus property to `value`.

since: 0

###### phosh_dbus_login_session_set_locked_hint

Sets the “LockedHint” D-Bus property to `value`.

since: 0

#### Properties

###### Phosh.DBusLoginSession:active

Represents the D-Bus property “Active”.

since: 0

###### Phosh.DBusLoginSession:locked-hint

Represents the D-Bus property “LockedHint”.

since: 0

#### Signals

###### Phosh.DBusLoginSession::handle-set-brightness

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

since: 0

###### Phosh.DBusLoginSession::handle-set-locked-hint

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

since: 0

###### Phosh.DBusLoginSession::lock

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

since: 0

###### Phosh.DBusLoginSession::unlock

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

since: 0

#### Interface structure

    struct PhoshDBusLoginSessionIface {
      GTypeInterface parent_iface;
      gboolean (* handle_set_brightness) (
        PhoshDBusLoginSession* object,
        GDBusMethodInvocation* invocation,
        const gchar* arg_subsystem,
        const gchar* arg_name,
        guint arg_brightness
      );
      gboolean (* handle_set_locked_hint) (
        PhoshDBusLoginSession* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_unnamed_arg0
      );
      gboolean (* get_active) (
        PhoshDBusLoginSession* object
      );
      gboolean (* get_locked_hint) (
        PhoshDBusLoginSession* object
      );
      void (* lock) (
        PhoshDBusLoginSession* object
      );
      void (* unlock) (
        PhoshDBusLoginSession* object
      );

    }

Virtual table for the D-Bus interface org.freedesktop.login1.Session.

###### Interface members

`parent_iface`

    GTypeInterface

| The parent interface.

`handle_set_brightness`

    gboolean (* handle_set_brightness) (
        PhoshDBusLoginSession* object,
        GDBusMethodInvocation* invocation,
        const gchar* arg_subsystem,
        const gchar* arg_name,
        guint arg_brightness
      )

| Handler for the `PhoshDBusLoginSession::handle-set-brightness` signal.

`handle_set_locked_hint`

    gboolean (* handle_set_locked_hint) (
        PhoshDBusLoginSession* object,
        GDBusMethodInvocation* invocation,
        gboolean arg_unnamed_arg0
      )

| Handler for the `PhoshDBusLoginSession::handle-set-locked-hint` signal.

`get_active`

    gboolean (* get_active) (
        PhoshDBusLoginSession* object
      )

| Getter for the `PhoshDBusLoginSession:active` property.

`get_locked_hint`

    gboolean (* get_locked_hint) (
        PhoshDBusLoginSession* object
      )

| Getter for the `PhoshDBusLoginSession:locked-hint` property.

`lock`

    void (* lock) (
        PhoshDBusLoginSession* object
      )

| Handler for the `PhoshDBusLoginSession::lock` signal.

`unlock`

    void (* unlock) (
        PhoshDBusLoginSession* object
      )

| Handler for the `PhoshDBusLoginSession::unlock` signal.

#### Virtual methods

###### Phosh.DBusLoginSession.get_active

Gets the value of the “Active” D-Bus property.

since: 0

###### Phosh.DBusLoginSession.get_locked_hint

Gets the value of the “LockedHint” D-Bus property.

since: 0

###### Phosh.DBusLoginSession.handle_set_brightness

Handler for the `PhoshDBusLoginSession::handle-set-brightness` signal.

since: 0

###### Phosh.DBusLoginSession.handle_set_locked_hint

Handler for the `PhoshDBusLoginSession::handle-set-locked-hint` signal.

since: 0

###### Phosh.DBusLoginSession.lock

Handler for the `PhoshDBusLoginSession::lock` signal.

since: 0

###### Phosh.DBusLoginSession.unlock

Handler for the `PhoshDBusLoginSession::unlock` signal.

since: 0