MmGdbusModemVoice: libmm-glib Reference Manual

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

## Functions

const gchar *const * | mm_gdbus_modem_voice_get_calls ()
gchar ** | mm_gdbus_modem_voice_dup_calls ()
void | mm_gdbus_modem_voice_call_create_call ()
gboolean | mm_gdbus_modem_voice_call_create_call_finish ()
gboolean | mm_gdbus_modem_voice_call_create_call_sync ()
void | mm_gdbus_modem_voice_call_delete_call ()
gboolean | mm_gdbus_modem_voice_call_delete_call_finish ()
gboolean | mm_gdbus_modem_voice_call_delete_call_sync ()
void | mm_gdbus_modem_voice_call_list_calls ()
gboolean | mm_gdbus_modem_voice_call_list_calls_finish ()
gboolean | mm_gdbus_modem_voice_call_list_calls_sync ()

## Properties

GStrv | calls | Read / Write

## Signals

void | call-added | Run Last
void | call-deleted | Run Last
gboolean | handle-create-call | Run Last
gboolean | handle-delete-call | Run Last
gboolean | handle-list-calls | Run Last

## Types and Values

| MmGdbusModemVoice
struct | MmGdbusModemVoiceIface

## Object Hierarchy

        GInterface
        ╰── MmGdbusModemVoice

## Prerequisites

MmGdbusModemVoice requires GObject.

## Known Implementations

MmGdbusModemVoice is implemented by MMModemVoice, MmGdbusModemVoiceProxy and MmGdbusModemVoiceSkeleton.

## Description

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

## Functions

### mm_gdbus_modem_voice_get_calls ()

    const gchar *const *
    mm_gdbus_modem_voice_get_calls (MmGdbusModemVoice *object);

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

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

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_modem_voice_dup_calls()` if on another thread.

[skip]

#### Parameters

object | A MmGdbusModemVoice. |

#### 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_modem_voice_dup_calls ()

    gchar **
    mm_gdbus_modem_voice_dup_calls (MmGdbusModemVoice *object);

Gets a copy of the "Calls" D-Bus property.

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

[skip]

#### Parameters

object | A MmGdbusModemVoice. |

#### Returns

The property value or `NULL` if the property is not set. The returned value should be freed with `g_strfreev()`.

[transfer full]

### mm_gdbus_modem_voice_call_create_call ()

    void
    mm_gdbus_modem_voice_call_create_call (MmGdbusModemVoice *proxy,
                                           GVariant *arg_properties,
                                           GCancellable *cancellable,
                                           GAsyncReadyCallback callback,
                                           gpointer user_data);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
arg_properties | Argument to pass with the method invocation. |
cancellable | A GCancellable or `NULL`. | [nullable]
callback | A GAsyncReadyCallback to call when the request is satisfied or `NULL`. |
user_data | User data to pass to `callback` . |

### mm_gdbus_modem_voice_call_create_call_finish ()

    gboolean
    mm_gdbus_modem_voice_call_create_call_finish
                                   (MmGdbusModemVoice *proxy,
                                    gchar **out_path,
                                    GAsyncResult *res,
                                    GError **error);

Finishes an operation started with `mm_gdbus_modem_voice_call_create_call()`.

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
out_path | Return location for return parameter or `NULL` to ignore. | [out]
res | The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_gdbus_modem_voice_call_create_call()`. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

### mm_gdbus_modem_voice_call_create_call_sync ()

    gboolean
    mm_gdbus_modem_voice_call_create_call_sync
                                   (MmGdbusModemVoice *proxy,
                                    GVariant *arg_properties,
                                    gchar **out_path,
                                    GCancellable *cancellable,
                                    GError **error);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
arg_properties | Argument to pass with the method invocation. |
out_path | Return location for return parameter or `NULL` to ignore. | [out]
cancellable | A GCancellable or `NULL`. | [nullable]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

### mm_gdbus_modem_voice_call_delete_call ()

    void
    mm_gdbus_modem_voice_call_delete_call (MmGdbusModemVoice *proxy,
                                           const gchar *arg_path,
                                           GCancellable *cancellable,
                                           GAsyncReadyCallback callback,
                                           gpointer user_data);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
arg_path | Argument to pass with the method invocation. |
cancellable | A GCancellable or `NULL`. | [nullable]
callback | A GAsyncReadyCallback to call when the request is satisfied or `NULL`. |
user_data | User data to pass to `callback` . |

### mm_gdbus_modem_voice_call_delete_call_finish ()

    gboolean
    mm_gdbus_modem_voice_call_delete_call_finish
                                   (MmGdbusModemVoice *proxy,
                                    GAsyncResult *res,
                                    GError **error);

Finishes an operation started with `mm_gdbus_modem_voice_call_delete_call()`.

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
res | The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_gdbus_modem_voice_call_delete_call()`. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

### mm_gdbus_modem_voice_call_delete_call_sync ()

    gboolean
    mm_gdbus_modem_voice_call_delete_call_sync
                                   (MmGdbusModemVoice *proxy,
                                    const gchar *arg_path,
                                    GCancellable *cancellable,
                                    GError **error);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
arg_path | Argument to pass with the method invocation. |
cancellable | A GCancellable or `NULL`. | [nullable]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

### mm_gdbus_modem_voice_call_list_calls ()

    void
    mm_gdbus_modem_voice_call_list_calls (MmGdbusModemVoice *proxy,
                                          GCancellable *cancellable,
                                          GAsyncReadyCallback callback,
                                          gpointer user_data);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
cancellable | A GCancellable or `NULL`. | [nullable]
callback | A GAsyncReadyCallback to call when the request is satisfied or `NULL`. |
user_data | User data to pass to `callback` . |

### mm_gdbus_modem_voice_call_list_calls_finish ()

    gboolean
    mm_gdbus_modem_voice_call_list_calls_finish
                                   (MmGdbusModemVoice *proxy,
                                    gchar ***out_result,
                                    GAsyncResult *res,
                                    GError **error);

Finishes an operation started with `mm_gdbus_modem_voice_call_list_calls()`.

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
out_result | Return location for return parameter or `NULL` to ignore. | [out][array zero-terminated=1]
res | The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_gdbus_modem_voice_call_list_calls()`. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

### mm_gdbus_modem_voice_call_list_calls_sync ()

    gboolean
    mm_gdbus_modem_voice_call_list_calls_sync
                                   (MmGdbusModemVoice *proxy,
                                    gchar ***out_result,
                                    GCancellable *cancellable,
                                    GError **error);

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

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

#### Parameters

proxy | A MmGdbusModemVoiceProxy. |
out_result | Return location for return parameter or `NULL` to ignore. | [out][array zero-terminated=1]
cancellable | A GCancellable or `NULL`. | [nullable]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the call succeded, `FALSE` if `error` is set.

[skip]

## Types and Values

### MmGdbusModemVoice

    typedef struct _MmGdbusModemVoice MmGdbusModemVoice;

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

### struct MmGdbusModemVoiceIface

    struct MmGdbusModemVoiceIface {
      GTypeInterface parent_iface;

      gboolean (*handle_create_call) (
        MmGdbusModemVoice *object,
        GDBusMethodInvocation *invocation,
        GVariant *arg_properties);

      gboolean (*handle_delete_call) (
        MmGdbusModemVoice *object,
        GDBusMethodInvocation *invocation,
        const gchar *arg_path);

      gboolean (*handle_list_calls) (
        MmGdbusModemVoice *object,
        GDBusMethodInvocation *invocation);

      const gchar *const * (*get_calls) (MmGdbusModemVoice *object);

      void (*call_added) (
        MmGdbusModemVoice *object,
        const gchar *arg_path);

      void (*call_deleted) (
        MmGdbusModemVoice *object,
        const gchar *arg_path);
    };

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

#### Members

GTypeInterface `parent_iface`; | The parent interface. |
`handle_create_call` () | Handler for the “handle-create-call” signal. |
`handle_delete_call` () | Handler for the “handle-delete-call” signal. |
`handle_list_calls` () | Handler for the “handle-list-calls” signal. |
`get_calls` () | Getter for the “calls” property. |
`call_added` () | Handler for the “call-added” signal. |
`call_deleted` () | Handler for the “call-deleted” signal. |

## Property Details

### The `“calls”` property

      “calls”                    GStrv

Represents the D-Bus property "Calls".

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.

Flags: Read / Write

## Signal Details

### The `“call-added”` signal

    void
    user_function (MmGdbusModemVoice *object,
                   gchar             *arg_path,
                   gpointer           user_data)

On the client-side, this signal is emitted whenever the D-Bus signal "CallAdded" is received.

On the service-side, this signal can be used with e.g. `g_signal_emit_by_name()` to make the object emit the D-Bus signal.

#### Parameters

object | A MmGdbusModemVoice. |
arg_path | Argument. |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“call-deleted”` signal

    void
    user_function (MmGdbusModemVoice *object,
                   gchar             *arg_path,
                   gpointer           user_data)

On the client-side, this signal is emitted whenever the D-Bus signal "CallDeleted" is received.

On the service-side, this signal can be used with e.g. `g_signal_emit_by_name()` to make the object emit the D-Bus signal.

#### Parameters

object | A MmGdbusModemVoice. |
arg_path | Argument. |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“handle-create-call”` signal

    gboolean
    user_function (MmGdbusModemVoice     *object,
                   GDBusMethodInvocation *invocation,
                   GVariant              *arg_properties,
                   gpointer               user_data)

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

#### Parameters

object | A MmGdbusModemVoice. |
invocation | A GDBusMethodInvocation. |
arg_properties | 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.

Flags: Run Last

### The `“handle-delete-call”` signal

    gboolean
    user_function (MmGdbusModemVoice     *object,
                   GDBusMethodInvocation *invocation,
                   gchar                 *arg_path,
                   gpointer               user_data)

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

#### Parameters

object | A MmGdbusModemVoice. |
invocation | A GDBusMethodInvocation. |
arg_path | 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.

Flags: Run Last

### The `“handle-list-calls”` signal

    gboolean
    user_function (MmGdbusModemVoice     *object,
                   GDBusMethodInvocation *invocation,
                   gpointer               user_data)

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

#### Parameters

object | A MmGdbusModemVoice. |
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.

Flags: Run Last