MmGdbusModem3gpp

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

## Synopsis

                        MmGdbusModem3gpp;
    struct              MmGdbusModem3gppIface;

    guint               mm_gdbus_modem3gpp_get_registration_state
                                                            (MmGdbusModem3gpp *object);
    const gchar *       mm_gdbus_modem3gpp_get_imei         (MmGdbusModem3gpp *object);
    gchar *             mm_gdbus_modem3gpp_dup_imei         (MmGdbusModem3gpp *object);
    const gchar *       mm_gdbus_modem3gpp_get_operator_code
                                                            (MmGdbusModem3gpp *object);
    gchar *             mm_gdbus_modem3gpp_dup_operator_code
                                                            (MmGdbusModem3gpp *object);
    const gchar *       mm_gdbus_modem3gpp_get_operator_name
                                                            (MmGdbusModem3gpp *object);
    gchar *             mm_gdbus_modem3gpp_dup_operator_name
                                                            (MmGdbusModem3gpp *object);
    guint               mm_gdbus_modem3gpp_get_enabled_facility_locks
                                                            (MmGdbusModem3gpp *object);

    void                mm_gdbus_modem3gpp_call_register    (MmGdbusModem3gpp *proxy,
                                                             const gchar *arg_operator_id,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            mm_gdbus_modem3gpp_call_register_finish
                                                            (MmGdbusModem3gpp *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            mm_gdbus_modem3gpp_call_register_sync
                                                            (MmGdbusModem3gpp *proxy,
                                                             const gchar *arg_operator_id,
                                                             GCancellable *cancellable,
                                                             GError **error);
    void                mm_gdbus_modem3gpp_call_scan        (MmGdbusModem3gpp *proxy,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);
    gboolean            mm_gdbus_modem3gpp_call_scan_finish (MmGdbusModem3gpp *proxy,
                                                             GVariant **out_results,
                                                             GAsyncResult *res,
                                                             GError **error);
    gboolean            mm_gdbus_modem3gpp_call_scan_sync   (MmGdbusModem3gpp *proxy,
                                                             GVariant **out_results,
                                                             GCancellable *cancellable,
                                                             GError **error);

## Object Hierarchy

      GInterface
       +----MmGdbusModem3gpp

## Prerequisites

MmGdbusModem3gpp requires GObject.

## Known Implementations

MmGdbusModem3gpp is implemented by MMModem3gpp, MmGdbusModem3gppProxy and MmGdbusModem3gppSkeleton.

## Properties

      "enabled-facility-locks"   guint                 : Read / Write
      "imei"                     gchar*                : Read / Write
      "operator-code"            gchar*                : Read / Write
      "operator-name"            gchar*                : Read / Write
      "registration-state"       guint                 : Read / Write

## Signals

      "handle-register"                                : Run Last
      "handle-scan"                                    : Run Last

## Description

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

## Details

### MmGdbusModem3gpp

    typedef struct _MmGdbusModem3gpp MmGdbusModem3gpp;

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

### struct MmGdbusModem3gppIface

    struct MmGdbusModem3gppIface {
      GTypeInterface parent_iface;

      gboolean (*handle_register) (
        MmGdbusModem3gpp *object,
        GDBusMethodInvocation *invocation,
        const gchar *arg_operator_id);

      gboolean (*handle_scan) (
        MmGdbusModem3gpp *object,
        GDBusMethodInvocation *invocation);

      guint  (*get_enabled_facility_locks) (MmGdbusModem3gpp *object);

      const gchar * (*get_imei) (MmGdbusModem3gpp *object);

      const gchar * (*get_operator_code) (MmGdbusModem3gpp *object);

      const gchar * (*get_operator_name) (MmGdbusModem3gpp *object);

      guint  (*get_registration_state) (MmGdbusModem3gpp *object);
    };

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

GTypeInterface `parent_iface`; | The parent interface.
`handle_register` () | Handler for the "handle-register" signal.
`handle_scan` () | Handler for the "handle-scan" signal.
`get_enabled_facility_locks` () | Getter for the "enabled-facility-locks" property.
`get_imei` () | Getter for the "imei" property.
`get_operator_code` () | Getter for the "operator-code" property.
`get_operator_name` () | Getter for the "operator-name" property.
`get_registration_state` () | Getter for the "registration-state" property.

### mm_gdbus_modem3gpp_get_registration_state ()

    guint               mm_gdbus_modem3gpp_get_registration_state
                                                            (MmGdbusModem3gpp *object);

Gets the value of the "RegistrationState" 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 MmGdbusModem3gpp.
Returns : | The property value.

### mm_gdbus_modem3gpp_get_imei ()

    const gchar *       mm_gdbus_modem3gpp_get_imei         (MmGdbusModem3gpp *object);

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

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

### Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where `object` was constructed. Use `mm_gdbus_modem3gpp_dup_imei()` if on another thread.

`object` : | A MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. Do not free the returned value, it belongs to `object`. [transfer none]

### mm_gdbus_modem3gpp_dup_imei ()

    gchar *             mm_gdbus_modem3gpp_dup_imei         (MmGdbusModem3gpp *object);

Gets a copy of the "Imei" 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 MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. The returned value should be freed with `g_free()`. [transfer full]

### mm_gdbus_modem3gpp_get_operator_code ()

    const gchar *       mm_gdbus_modem3gpp_get_operator_code
                                                            (MmGdbusModem3gpp *object);

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

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

### Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where `object` was constructed. Use `mm_gdbus_modem3gpp_dup_operator_code()` if on another thread.

`object` : | A MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. Do not free the returned value, it belongs to `object`. [transfer none]

### mm_gdbus_modem3gpp_dup_operator_code ()

    gchar *             mm_gdbus_modem3gpp_dup_operator_code
                                                            (MmGdbusModem3gpp *object);

Gets a copy of the "OperatorCode" 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 MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. The returned value should be freed with `g_free()`. [transfer full]

### mm_gdbus_modem3gpp_get_operator_name ()

    const gchar *       mm_gdbus_modem3gpp_get_operator_name
                                                            (MmGdbusModem3gpp *object);

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

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

### Warning

The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where `object` was constructed. Use `mm_gdbus_modem3gpp_dup_operator_name()` if on another thread.

`object` : | A MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. Do not free the returned value, it belongs to `object`. [transfer none]

### mm_gdbus_modem3gpp_dup_operator_name ()

    gchar *             mm_gdbus_modem3gpp_dup_operator_name
                                                            (MmGdbusModem3gpp *object);

Gets a copy of the "OperatorName" 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 MmGdbusModem3gpp.
Returns : | The property value or `NULL` if the property is not set. The returned value should be freed with `g_free()`. [transfer full]

### mm_gdbus_modem3gpp_get_enabled_facility_locks ()

    guint               mm_gdbus_modem3gpp_get_enabled_facility_locks
                                                            (MmGdbusModem3gpp *object);

Gets the value of the "EnabledFacilityLocks" 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 MmGdbusModem3gpp.
Returns : | The property value.

### mm_gdbus_modem3gpp_call_register ()

    void                mm_gdbus_modem3gpp_call_register    (MmGdbusModem3gpp *proxy,
                                                             const gchar *arg_operator_id,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

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

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

`proxy` : | A MmGdbusModem3gppProxy.
`arg_operator_id` : | 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_modem3gpp_call_register_finish ()

    gboolean            mm_gdbus_modem3gpp_call_register_finish
                                                            (MmGdbusModem3gpp *proxy,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `mm_gdbus_modem3gpp_call_register()`.

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

### mm_gdbus_modem3gpp_call_register_sync ()

    gboolean            mm_gdbus_modem3gpp_call_register_sync
                                                            (MmGdbusModem3gpp *proxy,
                                                             const gchar *arg_operator_id,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

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

`proxy` : | A MmGdbusModem3gppProxy.
`arg_operator_id` : | 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]

### mm_gdbus_modem3gpp_call_scan ()

    void                mm_gdbus_modem3gpp_call_scan        (MmGdbusModem3gpp *proxy,
                                                             GCancellable *cancellable,
                                                             GAsyncReadyCallback callback,
                                                             gpointer user_data);

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

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

`proxy` : | A MmGdbusModem3gppProxy.
`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_modem3gpp_call_scan_finish ()

    gboolean            mm_gdbus_modem3gpp_call_scan_finish (MmGdbusModem3gpp *proxy,
                                                             GVariant **out_results,
                                                             GAsyncResult *res,
                                                             GError **error);

Finishes an operation started with `mm_gdbus_modem3gpp_call_scan()`.

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

### mm_gdbus_modem3gpp_call_scan_sync ()

    gboolean            mm_gdbus_modem3gpp_call_scan_sync   (MmGdbusModem3gpp *proxy,
                                                             GVariant **out_results,
                                                             GCancellable *cancellable,
                                                             GError **error);

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

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

`proxy` : | A MmGdbusModem3gppProxy.
`out_results` : | 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]

## Property Details

### The `"enabled-facility-locks"` property

      "enabled-facility-locks"   guint                 : Read / Write

Represents the D-Bus property "EnabledFacilityLocks".

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: 0

### The `"imei"` property

      "imei"                     gchar*                : Read / Write

Represents the D-Bus property "Imei".

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: NULL

### The `"operator-code"` property

      "operator-code"            gchar*                : Read / Write

Represents the D-Bus property "OperatorCode".

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: NULL

### The `"operator-name"` property

      "operator-name"            gchar*                : Read / Write

Represents the D-Bus property "OperatorName".

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: NULL

### The `"registration-state"` property

      "registration-state"       guint                 : Read / Write

Represents the D-Bus property "RegistrationState".

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: 0

## Signal Details

### The `"handle-register"` signal

    gboolean            user_function                      (MmGdbusModem3gpp      *object,
                                                            GDBusMethodInvocation *invocation,
                                                            gchar                 *arg_operator_id,
                                                            gpointer               user_data)            : Run Last

Signal emitted when a remote caller is invoking the `Register()` 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_modem3gpp_complete_register()` 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 MmGdbusModem3gpp.
`invocation` : | A GDBusMethodInvocation.
`arg_operator_id` : | 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-scan"` signal

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

Signal emitted when a remote caller is invoking the `Scan()` 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_modem3gpp_complete_scan()` 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 MmGdbusModem3gpp.
`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.