MMModemMessaging: libmm-glib Reference Manual

MMModemMessaging

MMModemMessaging — The Messaging interface

Types and Values

struct

Object Hierarchy

    GObject
    ╰── GDBusProxy
        ╰── MmGdbusModemMessagingProxy
            ╰── MMModemMessaging

Implemented Interfaces

MMModemMessaging implements GDBusInterface, GInitable, GAsyncInitable and MmGdbusModemMessaging.

Description

The MMModemMessaging is an object providing access to the methods, signals and properties of the Messaging interface.

The Messaging interface is exposed whenever a modem has messaging capabilities.

Functions

mm_modem_messaging_get_path ()

const gchar *
mm_modem_messaging_get_path (MMModemMessaging *self);

Gets the DBus path of the MMObject which implements this interface.

Parameters

self

A MMModemMessaging.

Returns

The DBus path of the MMObject object.

[transfer none]

Since: 1.0

mm_modem_messaging_dup_path ()

gchar *
mm_modem_messaging_dup_path (MMModemMessaging *self);

Gets a copy of the DBus path of the MMObject object which implements this interface.

Parameters

self

A MMModemMessaging.

Returns

The DBus path of the MMObject. The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_modem_messaging_peek_supported_storages ()

gboolean
mm_modem_messaging_peek_supported_storages
                               (MMModemMessaging *self,
                                const MMSmsStorage **storages,
                                guint *n_storages);

Gets the list of SMS storages supported by the MMModem.

Parameters

self	A MMModem.
storages	Return location for the array of MMSmsStorage values. Do not free the returned array, it is owned by `self` .	[out]
n_storages	Return location for the number of values in `storages` .	[out]

Returns

TRUE if storages and n_storages are set, FALSE otherwise.

Since: 1.0

mm_modem_messaging_get_supported_storages ()

gboolean
mm_modem_messaging_get_supported_storages
                               (MMModemMessaging *self,
                                MMSmsStorage **storages,
                                guint *n_storages);

Gets the list of SMS storages supported by the MMModem.

Parameters

self	A MMModem.
storages	Return location for the array of MMSmsStorage values. The returned array should be freed with `g_free()` when no longer needed.	[out][array length=n_storages]
n_storages	Return location for the number of values in `storages` .	[out]

Returns

TRUE if storages and n_storages are set, FALSE otherwise.

Since: 1.0

mm_modem_messaging_get_default_storage ()

MMSmsStorage
mm_modem_messaging_get_default_storage
                               (MMModemMessaging *self);

Gets the default SMS storage used when storing or receiving SMS messages.

Parameters

self

A MMModem.

Returns

the default MMSmsStorage.

Since: 1.0

mm_modem_messaging_create ()

void
mm_modem_messaging_create (MMModemMessaging *self,
                           MMSmsProperties *properties,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

Asynchronously creates a new MMSms in the modem.

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_modem_messaging_create_finish() to get the result of the operation.

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

Parameters

self	A MMModemMessaging.
properties	A #MMSmsProperties object with the properties to use.
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` .

Since: 1.0

mm_modem_messaging_create_finish ()

MMSms *
mm_modem_messaging_create_finish (MMModemMessaging *self,
                                  GAsyncResult *res,
                                  GError **error);

Finishes an operation started with mm_modem_messaging_create().

Parameters

self	A MMModemMessaging.
res	The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_modem_messaging_create()`.
error	Return location for error or `NULL`.

Returns

A newly created MMSms, or NULL if error is set. The returned value should be freed with g_object_unref().

[transfer full]

Since: 1.0

mm_modem_messaging_create_sync ()

MMSms *
mm_modem_messaging_create_sync (MMModemMessaging *self,
                                MMSmsProperties *properties,
                                GCancellable *cancellable,
                                GError **error);

Synchronously creates a new MMSms in the modem.

The calling thread is blocked until a reply is received. See mm_modem_messaging_create() for the asynchronous version of this method.

Parameters

self	A MMModemMessaging.
properties	A #MMSmsProperties object with the properties to use.
cancellable	A GCancellable or `NULL`.	[allow-none]
error	Return location for error or `NULL`.

Returns

A newly created MMSms, or NULL if error is set. The returned value should be freed with g_object_unref().

[transfer full]

Since: 1.0

mm_modem_messaging_delete ()

void
mm_modem_messaging_delete (MMModemMessaging *self,
                           const gchar *sms,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

Asynchronously deletes a given MMSms from the modem.

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_modem_messaging_delete_finish() to get the result of the operation.

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

Parameters

self	A MMModemMessaging.
sms	Path of the MMSms to delete.
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` .

Since: 1.0

mm_modem_messaging_delete_finish ()

gboolean
mm_modem_messaging_delete_finish (MMModemMessaging *self,
                                  GAsyncResult *res,
                                  GError **error);

Finishes an operation started with mm_modem_messaging_delete().

Parameters

self	A MMModemMessaging.
res	The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_modem_messaging_delete()`.
error	Return location for error or `NULL`.

Returns

TRUE if the sms was deleted, FALSE if error is set.

Since: 1.0

mm_modem_messaging_delete_sync ()

gboolean
mm_modem_messaging_delete_sync (MMModemMessaging *self,
                                const gchar *sms,
                                GCancellable *cancellable,
                                GError **error);

Synchronously deletes a given MMSms from the modem.

The calling thread is blocked until a reply is received. See mm_modem_messaging_delete() for the asynchronous version of this method.

Parameters

self	A MMModemMessaging.
sms	Path of the MMSms to delete.
cancellable	A GCancellable or `NULL`.	[allow-none]
error	Return location for error or `NULL`.

Returns

TRUE if the SMS was deleted, FALSE if error is set.

Since: 1.0

mm_modem_messaging_list ()

void
mm_modem_messaging_list (MMModemMessaging *self,
                         GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data);

Asynchronously lists the MMSms objects in the modem.

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_modem_messaging_list_finish() to get the result of the operation.

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

Parameters

self	A MMModemMessaging.
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` .

Since: 1.0

mm_modem_messaging_list_finish ()

GList *
mm_modem_messaging_list_finish (MMModemMessaging *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an operation started with mm_modem_messaging_list().

Parameters

self	A MMModem.
res	The GAsyncResult obtained from the GAsyncReadyCallback passed to `mm_modem_messaging_list()`.
error	Return location for error or `NULL`.

Returns

A list of MMSms objects, or NULL if either not found or error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as GDestroyNotify function.

[element-type ModemManager.Sms][transfer full]

Since: 1.0

mm_modem_messaging_list_sync ()

GList *
mm_modem_messaging_list_sync (MMModemMessaging *self,
                              GCancellable *cancellable,
                              GError **error);

Synchronously lists the MMSms objects in the modem.

The calling thread is blocked until a reply is received. See mm_modem_messaging_list() for the asynchronous version of this method.

Parameters

self	A MMModemMessaging.
cancellable	A GCancellable or `NULL`.	[allow-none]
error	Return location for error or `NULL`.

Returns

A list of MMSms objects, or NULL if either not found or error is set. The returned value should be freed with g_list_free_full() using g_object_unref() as GDestroyNotify function.

[element-type ModemManager.Sms][transfer full]

Since: 1.0

Types and Values

struct MMModemMessaging

struct MMModemMessaging;

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

const gchar *	mm_modem_messaging_get_path ()
gchar *	mm_modem_messaging_dup_path ()
gboolean	mm_modem_messaging_peek_supported_storages ()
gboolean	mm_modem_messaging_get_supported_storages ()
MMSmsStorage	mm_modem_messaging_get_default_storage ()
void	mm_modem_messaging_create ()
MMSms *	mm_modem_messaging_create_finish ()
MMSms *	mm_modem_messaging_create_sync ()
void	mm_modem_messaging_delete ()
gboolean	mm_modem_messaging_delete_finish ()
gboolean	mm_modem_messaging_delete_sync ()
void	mm_modem_messaging_list ()
GList *	mm_modem_messaging_list_finish ()
GList *	mm_modem_messaging_list_sync ()