UDisksSwapspace

## UDisksSwapspace UDisksSwapspace — Generated C code for the org.freedesktop.UDisks2.Swapspace D-Bus interface |

## Synopsis

                        UDisksSwapspace;
    struct              UDisksSwapspaceIface;
    GDBusInterfaceInfo * udisks_swapspace_interface_info    (void);
    guint               udisks_swapspace_override_properties
                                                            (GObjectClass *klass,
                                                             guint property_id_begin);
    void                udisks_swapspace_call_start         (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            udisks_swapspace_call_start_finish  (UDisksSwapspace *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            udisks_swapspace_call_start_sync    (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GError **error);
    void                udisks_swapspace_complete_start     (UDisksSwapspace *object,
                                                             GDBusMethodInvocation *invocation);
    void                udisks_swapspace_call_stop          (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            udisks_swapspace_call_stop_finish   (UDisksSwapspace *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            udisks_swapspace_call_stop_sync     (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GError **error);
    void                udisks_swapspace_complete_stop      (UDisksSwapspace *object,
                                                             GDBusMethodInvocation *invocation);
    gboolean            udisks_swapspace_get_active         (UDisksSwapspace *object);
    void                udisks_swapspace_set_active         (UDisksSwapspace *object,
                                                             gboolean value);
    struct              UDisksSwapspaceProxy;
    struct              UDisksSwapspaceProxyClass;
    void                udisks_swapspace_proxy_new          (GDBusConnection *connection,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    UDisksSwapspace *   udisks_swapspace_proxy_new_finish   (GAsyncResult *res,
                                                             GError **error);
    UDisksSwapspace *   udisks_swapspace_proxy_new_sync     (GDBusConnection *connection,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GError **error);
    void                udisks_swapspace_proxy_new_for_bus  (GBusType bus_type,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    UDisksSwapspace *   udisks_swapspace_proxy_new_for_bus_finish
                                                            (GAsyncResult *res,
                                                             GError **error);
    UDisksSwapspace *   udisks_swapspace_proxy_new_for_bus_sync
                                                            (GBusType bus_type,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GError **error);
    struct              UDisksSwapspaceSkeleton;
    struct              UDisksSwapspaceSkeletonClass;
    UDisksSwapspace *   udisks_swapspace_skeleton_new       (void);

## Object Hierarchy

      GInterface
       +----UDisksSwapspace

      GObject
       +----GDBusProxy
             +----UDisksSwapspaceProxy

      GObject
       +----GDBusInterfaceSkeleton
             +----UDisksSwapspaceSkeleton
                   +----UDisksLinuxSwapspace

## Prerequisites

UDisksSwapspace requires GObject.

## Implemented Interfaces

UDisksSwapspaceProxy implements GDBusInterface, GInitable, GAsyncInitable and UDisksSwapspace.

UDisksSwapspaceSkeleton implements GDBusInterface and UDisksSwapspace.

## Known Implementations

UDisksSwapspace is implemented by UDisksLinuxSwapspace, UDisksSwapspaceProxy and UDisksSwapspaceSkeleton.

## Properties

      "active"                   gboolean              : Read / Write

## Signals

      "handle-start"                                   : Run Last
      "handle-stop"                                    : Run Last

## Description

This section contains code for working with the org.freedesktop.UDisks2.Swapspace D-Bus interface in C.

## Details

### UDisksSwapspace

    typedef struct _UDisksSwapspace UDisksSwapspace;

Abstract interface type for the D-Bus interface org.freedesktop.UDisks2.Swapspace.

### struct UDisksSwapspaceIface

    struct UDisksSwapspaceIface {
      GTypeInterface parent_iface;

      gboolean (*handle_start) (
        UDisksSwapspace *object,
        GDBusMethodInvocation *invocation,
        GVariant *arg_options);

      gboolean (*handle_stop) (
        UDisksSwapspace *object,
        GDBusMethodInvocation *invocation,
        GVariant *arg_options);

      gboolean  (*get_active) (UDisksSwapspace *object);
    };

Virtual table for the D-Bus interface org.freedesktop.UDisks2.Swapspace.

GTypeInterface `parent_iface`; | The parent interface.
`handle_start` () | Handler for the "handle-start" signal.
`handle_stop` () | Handler for the "handle-stop" signal.
`get_active` () | Getter for the "active" property.

### udisks_swapspace_interface_info ()

    GDBusInterfaceInfo * udisks_swapspace_interface_info    (void);

Gets a machine-readable description of the org.freedesktop.UDisks2.Swapspace D-Bus interface.

Returns : | A GDBusInterfaceInfo. Do not free. [transfer none]

### udisks_swapspace_override_properties ()

    guint               udisks_swapspace_override_properties
                                                            (GObjectClass *klass,
                                                             guint property_id_begin);

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

`klass` : | The class structure for a GObject-derived class.
`property_id_begin` : | The property id to assign to the first overridden property.
Returns : | The last property id.

### udisks_swapspace_call_start ()

    void                udisks_swapspace_call_start         (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

Asynchronously invokes the `Start()` 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. You can then call `udisks_swapspace_call_start_finish()` to get the result of the operation.

See `udisks_swapspace_call_start_sync()` for the synchronous, blocking version of this method.

`proxy` : | A UDisksSwapspaceProxy.
`arg_options` : | Argument to pass with the method invocation.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`callback` : | A GAsyncReadyCallback to call when the request is satisfied or `NULL`.
`user_data` : | User data to pass to `callback`.

### udisks_swapspace_call_start_finish ()

    gboolean            udisks_swapspace_call_start_finish  (UDisksSwapspace *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `udisks_swapspace_call_start()`.

`proxy` : | A UDisksSwapspaceProxy.
`res` : | The GAsyncResult obtained from the GAsyncReadyCallback passed to `udisks_swapspace_call_start()`.
`error` : | Return location for error or `NULL`.
Returns : | `TRUE` if the call succeded, `FALSE` if `error` is set. [skip]

### udisks_swapspace_call_start_sync ()

    gboolean            udisks_swapspace_call_start_sync    (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

See `udisks_swapspace_call_start()` for the asynchronous version of this method.

`proxy` : | A UDisksSwapspaceProxy.
`arg_options` : | Argument to pass with the method invocation.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`error` : | Return location for error or `NULL`.
Returns : | `TRUE` if the call succeded, `FALSE` if `error` is set. [skip]

### udisks_swapspace_complete_start ()

    void                udisks_swapspace_complete_start     (UDisksSwapspace *object,
                                                             GDBusMethodInvocation *invocation);

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

`object` : | A UDisksSwapspace.
`invocation` : | A GDBusMethodInvocation. [transfer full]

### udisks_swapspace_call_stop ()

    void                udisks_swapspace_call_stop          (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

Asynchronously invokes the `Stop()` 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. You can then call `udisks_swapspace_call_stop_finish()` to get the result of the operation.

See `udisks_swapspace_call_stop_sync()` for the synchronous, blocking version of this method.

`proxy` : | A UDisksSwapspaceProxy.
`arg_options` : | Argument to pass with the method invocation.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`callback` : | A GAsyncReadyCallback to call when the request is satisfied or `NULL`.
`user_data` : | User data to pass to `callback`.

### udisks_swapspace_call_stop_finish ()

    gboolean            udisks_swapspace_call_stop_finish   (UDisksSwapspace *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `udisks_swapspace_call_stop()`.

`proxy` : | A UDisksSwapspaceProxy.
`res` : | The GAsyncResult obtained from the GAsyncReadyCallback passed to `udisks_swapspace_call_stop()`.
`error` : | Return location for error or `NULL`.
Returns : | `TRUE` if the call succeded, `FALSE` if `error` is set. [skip]

### udisks_swapspace_call_stop_sync ()

    gboolean            udisks_swapspace_call_stop_sync     (UDisksSwapspace *proxy,
                                                             GVariant *arg_options,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

See `udisks_swapspace_call_stop()` for the asynchronous version of this method.

`proxy` : | A UDisksSwapspaceProxy.
`arg_options` : | Argument to pass with the method invocation.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`error` : | Return location for error or `NULL`.
Returns : | `TRUE` if the call succeded, `FALSE` if `error` is set. [skip]

### udisks_swapspace_complete_stop ()

    void                udisks_swapspace_complete_stop      (UDisksSwapspace *object,
                                                             GDBusMethodInvocation *invocation);

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

`object` : | A UDisksSwapspace.
`invocation` : | A GDBusMethodInvocation. [transfer full]

### udisks_swapspace_get_active ()

    gboolean            udisks_swapspace_get_active         (UDisksSwapspace *object);

Gets the value of the "Active" D-Bus property.

Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side.

`object` : | A UDisksSwapspace.
Returns : | The property value.

### udisks_swapspace_set_active ()

    void                udisks_swapspace_set_active         (UDisksSwapspace *object,
                                                             gboolean value);

Sets the "Active" D-Bus property to `value`.

Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side.

`object` : | A UDisksSwapspace.
`value` : | The value to set.

### struct UDisksSwapspaceProxy

    struct UDisksSwapspaceProxy;

The UDisksSwapspaceProxy structure contains only private data and should only be accessed using the provided API.

### struct UDisksSwapspaceProxyClass

    struct UDisksSwapspaceProxyClass {
      GDBusProxyClass parent_class;
    };

Class structure for UDisksSwapspaceProxy.

GDBusProxyClass `parent_class`; | The parent class.

### udisks_swapspace_proxy_new ()

    void                udisks_swapspace_proxy_new          (GDBusConnection *connection,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

Asynchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Swapspace. See `g_dbus_proxy_new()` for more details.

When the operation is finished, `callback` will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call `udisks_swapspace_proxy_new_finish()` to get the result of the operation.

See `udisks_swapspace_proxy_new_sync()` for the synchronous, blocking version of this constructor.

`connection` : | A GDBusConnection.
`flags` : | Flags from the GDBusProxyFlags enumeration.
`name` : | A bus name (well-known or unique) or `NULL` if `connection` is not a message bus connection. [allow-none]
`object_path` : | An object path.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`callback` : | A GAsyncReadyCallback to call when the request is satisfied.
`user_data` : | User data to pass to `callback`.

### udisks_swapspace_proxy_new_finish ()

    UDisksSwapspace *   udisks_swapspace_proxy_new_finish   (GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `udisks_swapspace_proxy_new()`.

`res` : | The GAsyncResult obtained from the GAsyncReadyCallback passed to `udisks_swapspace_proxy_new()`.
`error` : | Return location for error or `NULL`
Returns : | The constructed proxy object or `NULL` if `error` is set. [transfer full][type UDisksSwapspaceProxy]

### udisks_swapspace_proxy_new_sync ()

    UDisksSwapspace *   udisks_swapspace_proxy_new_sync     (GDBusConnection *connection,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GError **error);

Synchronously creates a proxy for the D-Bus interface org.freedesktop.UDisks2.Swapspace. See `g_dbus_proxy_new_sync()` for more details.

The calling thread is blocked until a reply is received.

See `udisks_swapspace_proxy_new()` for the asynchronous version of this constructor.

`connection` : | A GDBusConnection.
`flags` : | Flags from the GDBusProxyFlags enumeration.
`name` : | A bus name (well-known or unique) or `NULL` if `connection` is not a message bus connection. [allow-none]
`object_path` : | An object path.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`error` : | Return location for error or `NULL`
Returns : | The constructed proxy object or `NULL` if `error` is set. [transfer full][type UDisksSwapspaceProxy]

### udisks_swapspace_proxy_new_for_bus ()

    void                udisks_swapspace_proxy_new_for_bus  (GBusType bus_type,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

Like `udisks_swapspace_proxy_new()` but takes a GBusType instead of a GDBusConnection.

When the operation is finished, `callback` will be invoked in the thread-default main loop of the thread you are calling this method from. You can then call `udisks_swapspace_proxy_new_for_bus_finish()` to get the result of the operation.

See `udisks_swapspace_proxy_new_for_bus_sync()` for the synchronous, blocking version of this constructor.

`bus_type` : | A GBusType.
`flags` : | Flags from the GDBusProxyFlags enumeration.
`name` : | A bus name (well-known or unique).
`object_path` : | An object path.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`callback` : | A GAsyncReadyCallback to call when the request is satisfied.
`user_data` : | User data to pass to `callback`.

### udisks_swapspace_proxy_new_for_bus_finish ()

    UDisksSwapspace *   udisks_swapspace_proxy_new_for_bus_finish
                                                            (GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `udisks_swapspace_proxy_new_for_bus()`.

`res` : | The GAsyncResult obtained from the GAsyncReadyCallback passed to `udisks_swapspace_proxy_new_for_bus()`.
`error` : | Return location for error or `NULL`
Returns : | The constructed proxy object or `NULL` if `error` is set. [transfer full][type UDisksSwapspaceProxy]

### udisks_swapspace_proxy_new_for_bus_sync ()

    UDisksSwapspace *   udisks_swapspace_proxy_new_for_bus_sync
                                                            (GBusType bus_type,
                                                             GDBusProxyFlags flags,
                                                             const gchar *name,
                                                             const gchar *object_path,
                                                             GCancellable *cancellable,
                                                             GError **error);

Like `udisks_swapspace_proxy_new_sync()` but takes a GBusType instead of a GDBusConnection.

The calling thread is blocked until a reply is received.

See `udisks_swapspace_proxy_new_for_bus()` for the asynchronous version of this constructor.

`bus_type` : | A GBusType.
`flags` : | Flags from the GDBusProxyFlags enumeration.
`name` : | A bus name (well-known or unique).
`object_path` : | An object path.
`cancellable` : | A GCancellable or `NULL`. [allow-none]
`error` : | Return location for error or `NULL`
Returns : | The constructed proxy object or `NULL` if `error` is set. [transfer full][type UDisksSwapspaceProxy]

### struct UDisksSwapspaceSkeleton

    struct UDisksSwapspaceSkeleton;

The UDisksSwapspaceSkeleton structure contains only private data and should only be accessed using the provided API.

### struct UDisksSwapspaceSkeletonClass

    struct UDisksSwapspaceSkeletonClass {
      GDBusInterfaceSkeletonClass parent_class;
    };

Class structure for UDisksSwapspaceSkeleton.

GDBusInterfaceSkeletonClass `parent_class`; | The parent class.

### udisks_swapspace_skeleton_new ()

    UDisksSwapspace *   udisks_swapspace_skeleton_new       (void);

Creates a skeleton object for the D-Bus interface org.freedesktop.UDisks2.Swapspace.

Returns : | The skeleton object. [transfer full][type UDisksSwapspaceSkeleton]

## Property Details

### The `"active"` property

      "active"                   gboolean              : Read / Write

Represents the D-Bus property "Active".

Since the D-Bus property for this GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

Default value: FALSE

## Signal Details

### The `"handle-start"` signal

    gboolean            user_function                      (UDisksSwapspace       *object,
                                                            GDBusMethodInvocation *invocation,
                                                            GVariant              *arg_options,
                                                            gpointer               user_data)        : Run Last

Signal emitted when a remote caller is invoking the `Start()` 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 `udisks_swapspace_complete_start()` or e.g. `g_dbus_method_invocation_return_error()` on it) and no order signal handlers will run. If no signal handler handles the invocation, the `G_DBUS_ERROR_UNKNOWN_METHOD` error is returned.

`object` : | A UDisksSwapspace.
`invocation` : | A GDBusMethodInvocation.
`arg_options` : | Argument passed by remote caller.
`user_data` : | user data set when the signal handler was connected.
Returns : | `TRUE` if the invocation was handled, `FALSE` to let other signal handlers run.

### The `"handle-stop"` signal

    gboolean            user_function                      (UDisksSwapspace       *object,
                                                            GDBusMethodInvocation *invocation,
                                                            GVariant              *arg_options,
                                                            gpointer               user_data)        : Run Last

Signal emitted when a remote caller is invoking the `Stop()` 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 `udisks_swapspace_complete_stop()` or e.g. `g_dbus_method_invocation_return_error()` on it) and no order signal handlers will run. If no signal handler handles the invocation, the `G_DBUS_ERROR_UNKNOWN_METHOD` error is returned.

`object` : | A UDisksSwapspace.
`invocation` : | A GDBusMethodInvocation.
`arg_options` : | Argument passed by remote caller.
`user_data` : | user data set when the signal handler was connected.
Returns : | `TRUE` if the invocation was handled, `FALSE` to let other signal handlers run.