MMSms: libmm-glib Reference Manual

MMSms

MMSms — The SMS interface

Functions

const gchar *	mm_sms_get_path ()
gchar *	mm_sms_dup_path ()
MMSmsState	mm_sms_get_state ()
MMSmsPduType	mm_sms_get_pdu_type ()
MMSmsStorage	mm_sms_get_storage ()
const gchar *	mm_sms_get_text ()
gchar *	mm_sms_dup_text ()
const guint8 *	mm_sms_get_data ()
guint8 *	mm_sms_dup_data ()
const gchar *	mm_sms_get_number ()
gchar *	mm_sms_dup_number ()
const gchar *	mm_sms_get_smsc ()
gchar *	mm_sms_dup_smsc ()
guint	mm_sms_get_message_reference ()
gint	mm_sms_get_class ()
MMSmsCdmaTeleserviceId	mm_sms_get_teleservice_id ()
MMSmsCdmaServiceCategory	mm_sms_get_service_category ()
MMSmsValidityType	mm_sms_get_validity_type ()
guint	mm_sms_get_validity_relative ()
const gchar *	mm_sms_get_timestamp ()
gchar *	mm_sms_dup_timestamp ()
const gchar *	mm_sms_get_discharge_timestamp ()
gchar *	mm_sms_dup_discharge_timestamp ()
guint	mm_sms_get_delivery_state ()
gboolean	mm_sms_get_delivery_report_request ()
void	mm_sms_send ()
gboolean	mm_sms_send_finish ()
gboolean	mm_sms_send_sync ()
void	mm_sms_store ()
gboolean	mm_sms_store_finish ()
gboolean	mm_sms_store_sync ()

Types and Values

struct

MMSms

Object Hierarchy

    GObject
    ╰── GDBusProxy
        ╰── MmGdbusSmsProxy
            ╰── MMSms

Implemented Interfaces

MMSms implements GDBusInterface, GInitable, GAsyncInitable and MmGdbusSms.

Description

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

When the SMS is exposed and available in the bus, it is ensured that at least this interface is also available.

Functions

mm_sms_get_path ()

const gchar *
mm_sms_get_path (MMSms *self);

Gets the DBus path of the MMSms object.

Parameters

self

A MMSms.

Returns

The DBus path of the MMSms object.

[transfer none]

Since: 1.0

mm_sms_dup_path ()

gchar *
mm_sms_dup_path (MMSms *self);

Gets a copy of the DBus path of the MMSms object.

Parameters

self

A MMSms.

Returns

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

[transfer full]

Since: 1.0

mm_sms_get_state ()

MMSmsState
mm_sms_get_state (MMSms *self);

Gets the state of this SMS.

Parameters

self

A MMSms.

Returns

A MMSmsState specifying the state.

Since: 1.0

mm_sms_get_pdu_type ()

MMSmsPduType
mm_sms_get_pdu_type (MMSms *self);

Gets the PDU type on which this SMS is based.

Parameters

self

A MMSms.

Returns

A MMSmsPduType specifying the PDU type.

Since: 1.0

mm_sms_get_storage ()

MMSmsStorage
mm_sms_get_storage (MMSms *self);

Gets the storage in which this SMS is kept.

Parameters

self

A MMSms.

Returns

A MMSmsStorage specifying the storage.

Since: 1.0

mm_sms_get_text ()

const gchar *
mm_sms_get_text (MMSms *self);

Gets the message text, in UTF-8.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_sms_dup_text() if on another thread.

Parameters

self

A MMSms.

Returns

The message text, or NULL if it doesn't contain any (e.g. contains data instead).

[transfer none]

Since: 1.0

mm_sms_dup_text ()

gchar *
mm_sms_dup_text (MMSms *self);

Gets the message text, in UTF-8.

Parameters

self

A MMSms.

Returns

The message text, or NULL if it doesn't contain any (e.g. contains data instead). The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_sms_get_data ()

const guint8 *
mm_sms_get_data (MMSms *self,
                 gsize *data_len);

Gets the message data.

Parameters

self	A MMSms.
data_len	Size of the output data, if any given.	[out]

Returns

The message data, or NULL if it doesn't contain any (e.g. contains text instead).

[transfer none][array length=data_len][element-type guint8]

Since: 1.0

mm_sms_dup_data ()

guint8 *
mm_sms_dup_data (MMSms *self,
                 gsize *data_len);

Gets the message data.

Parameters

self	A MMSms.
data_len	Size of the output data, if any given.	[out]

Returns

The message data, or NULL if it doesn't contain any (e.g. contains text instead). The returned value should be freed with g_free().

[transfer full][array length=data_len][element-type guint8]

Since: 1.0

mm_sms_get_number ()

const gchar *
mm_sms_get_number (MMSms *self);

Gets the number to which the message is addressed.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_sms_dup_number() if on another thread.

Parameters

self

A MMSms.

Returns

The number, or NULL if it couldn't be retrieved.

[transfer none]

Since: 1.0

mm_sms_dup_number ()

gchar *
mm_sms_dup_number (MMSms *self);

Gets the number to which the message is addressed.

Parameters

self

A MMSms.

Returns

The number, or NULL if it couldn't be retrieved. The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_sms_get_smsc ()

const gchar *
mm_sms_get_smsc (MMSms *self);

Gets the SMS service center number.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_sms_dup_smsc() if on another thread.

Parameters

self

A MMSms.

Returns

The number of the SMSC, or NULL if it couldn't be retrieved.

[transfer none]

Since: 1.0

mm_sms_dup_smsc ()

gchar *
mm_sms_dup_smsc (MMSms *self);

Gets the SMS service center number.

Parameters

self

A MMSms.

Returns

The number of the SMSC, or NULL if it couldn't be retrieved. The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_sms_get_message_reference ()

guint
mm_sms_get_message_reference (MMSms *self);

guint
mm_sms_get_validity_relative (MMSms *self);

Gets the length of the validity period, in minutes.

Only applicable if the type of validity is MM_SMS_VALIDITY_TYPE_RELATIVE.

Parameters

self

A MMSms.

Returns

the length of the validity period, or 0 if unknown.

Since: 1.0

mm_sms_get_timestamp ()

const gchar *
mm_sms_get_timestamp (MMSms *self);

Gets the time when the first PDU of the SMS message arrived the SMSC, in

ISO8601

format.

This field is only applicable if the PDU type is MM_SMS_PDU_TYPE_DELIVER or MM_SMS_PDU_TYPE_STATUS_REPORT.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_sms_dup_timestamp() if on another thread.

Parameters

self

A MMSms.

Returns

The timestamp, or NULL if it couldn't be retrieved.

[transfer none]

Since: 1.0

mm_sms_dup_timestamp ()

gchar *
mm_sms_dup_timestamp (MMSms *self);

Gets the time when the first PDU of the SMS message arrived the SMSC, in

ISO8601

format.

This field is only applicable if the PDU type is MM_SMS_PDU_TYPE_DELIVER or MM_SMS_PDU_TYPE_STATUS_REPORT.

Parameters

self

A MMSms.

Returns

The timestamp, or NULL if it couldn't be retrieved. The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_sms_get_discharge_timestamp ()

const gchar *
mm_sms_get_discharge_timestamp (MMSms *self);

Gets the time when the first PDU of the SMS message left the SMSC, in

ISO8601

format.

This field is only applicable if the PDU type is MM_SMS_PDU_TYPE_STATUS_REPORT.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use mm_sms_dup_discharge_timestamp() if on another thread.

Parameters

self

A MMSms.

Returns

The timestamp, or NULL if it couldn't be retrieved.

[transfer none]

Since: 1.0

mm_sms_dup_discharge_timestamp ()

gchar *
mm_sms_dup_discharge_timestamp (MMSms *self);

Gets the time when the first PDU of the SMS message left the SMSC, in

ISO8601

format.

This field is only applicable if the PDU type is MM_SMS_PDU_TYPE_STATUS_REPORT.

Parameters

self

A MMSms.

Returns

The timestamp, or NULL if it couldn't be retrieved. The returned value should be freed with g_free().

[transfer full]

Since: 1.0

mm_sms_get_delivery_state ()

guint
mm_sms_get_delivery_state (MMSms *self);

Gets the delivery state of this SMS.

This field is only applicable if the PDU type is MM_SMS_PDU_TYPE_STATUS_REPORT.

Parameters

self

A MMSms.

Returns

A MMSmsDeliveryState specifying the delivery state.

Since: 1.0

mm_sms_get_delivery_report_request ()

gboolean
mm_sms_get_delivery_report_request (MMSms *self);

Checks whether delivery report is requested for this SMS.

Parameters

self

A MMSms.

Returns

TRUE if delivery report is requested, FALSE otherwise.

Since: 1.0

mm_sms_send ()

void
mm_sms_send (MMSms *self,
             GCancellable *cancellable,
             GAsyncReadyCallback callback,
             gpointer user_data);

Asynchronously requests to queue the message for delivery.

SMS objects can only be sent once.

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

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

Parameters

self	A MMSms.
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_sms_send_finish ()

gboolean
mm_sms_send_finish (MMSms *self,
                    GAsyncResult *res,
                    GError **error);

Finishes an operation started with mm_sms_send().

Parameters

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

Returns

TRUE if the operation succeeded, FALSE if error is set.

Since: 1.0

mm_sms_send_sync ()

gboolean
mm_sms_send_sync (MMSms *self,
                  GCancellable *cancellable,
                  GError **error);

Synchronously requests to queue the message for delivery.

SMS objects can only be sent once.

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

Parameters

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

Returns

TRUE if the operation succeeded, FALSE if error is set.

Since: 1.0

mm_sms_store ()

void
mm_sms_store (MMSms *self,
              MMSmsStorage storage,
              GCancellable *cancellable,
              GAsyncReadyCallback callback,
              gpointer user_data);

Asynchronoulsy requests to store the message in the device if not already done.

SMS objects can only be stored once.

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

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

Parameters

self	A MMSms.
storage	A MMSmsStorage specifying where to store the SMS, or `MM_SMS_STORAGE_UNKNOWN` to use the default.
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_sms_store_finish ()

gboolean
mm_sms_store_finish (MMSms *self,
                     GAsyncResult *res,
                     GError **error);

Finishes an operation started with mm_sms_store().

Parameters

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

Returns

TRUE if the operation succeeded, FALSE if error is set.

Since: 1.0

mm_sms_store_sync ()

gboolean
mm_sms_store_sync (MMSms *self,
                   MMSmsStorage storage,
                   GCancellable *cancellable,
                   GError **error);

Synchronoulsy requests to store the message in the device if not already done.

SMS objects can only be stored once.

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

Parameters

self	A MMSms.
storage	A MMSmsStorage specifying where to store the SMS, or `MM_SMS_STORAGE_UNKNOWN` to use the default.
cancellable	A GCancellable or `NULL`.	[allow-none]
error	Return location for error or `NULL`.

Returns

TRUE if the operation succeeded, FALSE if error is set.

Since: 1.0

Types and Values

struct MMSms

struct MMSms;

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