MmGdbusModemFirmware

## MmGdbusModemFirmware MmGdbusModemFirmware — Generated C code for the org.freedesktop.ModemManager1.Modem.Firmware D-Bus interface |

## Synopsis

                        MmGdbusModemFirmware;
    struct              MmGdbusModemFirmwareIface;

    void                mm_gdbus_modem_firmware_call_list   (MmGdbusModemFirmware *proxy,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            mm_gdbus_modem_firmware_call_list_finish
                                                            (MmGdbusModemFirmware *proxy,
                                                             gchar **out_selected,
                                                             GVariant **out_installed,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            mm_gdbus_modem_firmware_call_list_sync
                                                            (MmGdbusModemFirmware *proxy,
                                                             gchar **out_selected,
                                                             GVariant **out_installed,
                                                             GCancellable *cancellable,
                                                             GError **error);
    void                mm_gdbus_modem_firmware_call_select (MmGdbusModemFirmware *proxy,
                                                             const gchar *arg_uniqueid,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            mm_gdbus_modem_firmware_call_select_finish
                                                            (MmGdbusModemFirmware *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            mm_gdbus_modem_firmware_call_select_sync
                                                            (MmGdbusModemFirmware *proxy,
                                                             const gchar *arg_uniqueid,
                                                             GCancellable *cancellable,
                                                             GError **error);

## Object Hierarchy

      GInterface
       +----MmGdbusModemFirmware

## Prerequisites

MmGdbusModemFirmware requires GObject.

## Known Implementations

MmGdbusModemFirmware is implemented by MMModemFirmware, MmGdbusModemFirmwareProxy and MmGdbusModemFirmwareSkeleton.

## Signals

      "handle-list"                                    : Run Last
      "handle-select"                                  : Run Last

## Description

This section contains code for working with the org.freedesktop.ModemManager1.Modem.Firmware D-Bus interface in C.

## Details

### MmGdbusModemFirmware

    typedef struct _MmGdbusModemFirmware MmGdbusModemFirmware;

Abstract interface type for the D-Bus interface org.freedesktop.ModemManager1.Modem.Firmware.

### struct MmGdbusModemFirmwareIface

    struct MmGdbusModemFirmwareIface {
      GTypeInterface parent_iface;

      gboolean (*handle_list) (
        MmGdbusModemFirmware *object,
        GDBusMethodInvocation *invocation);

      gboolean (*handle_select) (
        MmGdbusModemFirmware *object,
        GDBusMethodInvocation *invocation,
        const gchar *arg_uniqueid);
    };

Virtual table for the D-Bus interface org.freedesktop.ModemManager1.Modem.Firmware.

GTypeInterface `parent_iface`; | The parent interface.
`handle_list` () | Handler for the "handle-list" signal.
`handle_select` () | Handler for the "handle-select" signal.

### mm_gdbus_modem_firmware_call_list ()

    void                mm_gdbus_modem_firmware_call_list   (MmGdbusModemFirmware *proxy,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

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

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

`proxy` : | A MmGdbusModemFirmwareProxy.
`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`.

### mm_gdbus_modem_firmware_call_list_finish ()

    gboolean            mm_gdbus_modem_firmware_call_list_finish
                                                            (MmGdbusModemFirmware *proxy,
                                                             gchar **out_selected,
                                                             GVariant **out_installed,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `mm_gdbus_modem_firmware_call_list()`.

`proxy` : | A MmGdbusModemFirmwareProxy.
`out_selected` : | Return location for return parameter or `NULL` to ignore. [out]
`out_installed` : | Return location for return parameter or `NULL` to ignore. [out]
`res` : | The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_gdbus_modem_firmware_call_list()`.
`error` : | Return location for error or `NULL`.
Returns : | `TRUE` if the call succeded, `FALSE` if `error` is set. [skip]

### mm_gdbus_modem_firmware_call_list_sync ()

    gboolean            mm_gdbus_modem_firmware_call_list_sync
                                                            (MmGdbusModemFirmware *proxy,
                                                             gchar **out_selected,
                                                             GVariant **out_installed,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

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

`proxy` : | A MmGdbusModemFirmwareProxy.
`out_selected` : | Return location for return parameter or `NULL` to ignore. [out]
`out_installed` : | Return location for return parameter or `NULL` to ignore. [out]
`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]

### mm_gdbus_modem_firmware_call_select ()

    void                mm_gdbus_modem_firmware_call_select (MmGdbusModemFirmware *proxy,
                                                             const gchar *arg_uniqueid,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

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

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

`proxy` : | A MmGdbusModemFirmwareProxy.
`arg_uniqueid` : | 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`.

### mm_gdbus_modem_firmware_call_select_finish ()

    gboolean            mm_gdbus_modem_firmware_call_select_finish
                                                            (MmGdbusModemFirmware *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `mm_gdbus_modem_firmware_call_select()`.

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

### mm_gdbus_modem_firmware_call_select_sync ()

    gboolean            mm_gdbus_modem_firmware_call_select_sync
                                                            (MmGdbusModemFirmware *proxy,
                                                             const gchar *arg_uniqueid,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

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

`proxy` : | A MmGdbusModemFirmwareProxy.
`arg_uniqueid` : | 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]

## Signal Details

### The `"handle-list"` signal

    gboolean            user_function                      (MmGdbusModemFirmware  *object,
                                                            GDBusMethodInvocation *invocation,
                                                            gpointer               user_data)       : Run Last

Signal emitted when a remote caller is invoking the `List()` 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 `mm_gdbus_modem_firmware_complete_list()` 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 MmGdbusModemFirmware.
`invocation` : | A GDBusMethodInvocation.
`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-select"` signal

    gboolean            user_function                      (MmGdbusModemFirmware  *object,
                                                            GDBusMethodInvocation *invocation,
                                                            gchar                 *arg_uniqueid,
                                                            gpointer               user_data)         : Run Last

Signal emitted when a remote caller is invoking the `Select()` 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 `mm_gdbus_modem_firmware_complete_select()` 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 MmGdbusModemFirmware.
`invocation` : | A GDBusMethodInvocation.
`arg_uniqueid` : | 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.