|  |  |  | libmm-glib Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct MMSmsProperties; MMSmsProperties * mm_sms_properties_new (void); const gchar * mm_sms_properties_get_text (MMSmsProperties *self); void mm_sms_properties_set_text (MMSmsProperties *self,const gchar *text); const guint8 * mm_sms_properties_get_data (MMSmsProperties *self,gsize *data_len); void mm_sms_properties_set_data (MMSmsProperties *self,const guint8 *data,gsize data_length); GByteArray * mm_sms_properties_peek_data_bytearray (MMSmsProperties *self); GByteArray * mm_sms_properties_get_data_bytearray (MMSmsProperties *self); void mm_sms_properties_set_data_bytearray (MMSmsProperties *self,GByteArray *data); const gchar * mm_sms_properties_get_number (MMSmsProperties *self); void mm_sms_properties_set_number (MMSmsProperties *self,const gchar *number); const gchar * mm_sms_properties_get_smsc (MMSmsProperties *self); void mm_sms_properties_set_smsc (MMSmsProperties *self,const gchar *smsc); MMSmsValidityType mm_sms_properties_get_validity_type (MMSmsProperties *self); guint mm_sms_properties_get_validity_relative (MMSmsProperties *self); void mm_sms_properties_set_validity_relative (MMSmsProperties *self,guint validity); gint mm_sms_properties_get_class (MMSmsProperties *self); void mm_sms_properties_set_class (MMSmsProperties *self,gint class); gboolean mm_sms_properties_get_delivery_report_request (MMSmsProperties *self); void mm_sms_properties_set_delivery_report_request (MMSmsProperties *self,gboolean request);
The MMSmsProperties is an object handling the properties to be set in newly created SMS objects.
This object is created by the user and passed to ModemManager with either
mm_modem_messaging_create() or mm_modem_messaging_create_sync().
struct MMSmsProperties;
The MMSmsProperties structure contains private data and should only be accessed using the provided API.
MMSmsProperties *   mm_sms_properties_new               (void);
Creates a new empty MMSmsProperties.
| Returns : | a MMSmsProperties. The returned value should be freed with g_object_unref(). [transfer full] | 
const gchar *       mm_sms_properties_get_text          (MMSmsProperties *self);
Gets the message text, in UTF-8.
| 
 | A MMSmsProperties. | 
| Returns : | The message text, or NULLif it doesn't contain any (e.g. contains data instead). Do not free the returned value, it is owned byself. [transfer none] | 
void mm_sms_properties_set_text (MMSmsProperties *self,const gchar *text);
Sets the message text.
| 
 | A MMSmsProperties. | 
| 
 | The text to set, in UTF-8. | 
const guint8 * mm_sms_properties_get_data (MMSmsProperties *self,gsize *data_len);
Gets the message data.
| 
 | A MMSmsProperties. | 
| 
 | Size of the output data, if any given. [out] | 
| Returns : | The message data, or NULLif it doesn't contain any (e.g. contains text instead). [transfer none] | 
void mm_sms_properties_set_data (MMSmsProperties *self,const guint8 *data,gsize data_length);
Sets the message data.
| 
 | A MMSmsProperties. | 
| 
 | The data to set. | 
| 
 | Length of data. | 
GByteArray *        mm_sms_properties_peek_data_bytearray
                                                        (MMSmsProperties *self);
Gets the message data.
| 
 | A MMSmsProperties. | 
| Returns : | A GByteArray with the message data, or NULLif it doesn't contain any (e.g. contains text instead). Do not free the returned value, it is owned byself. [transfer none] | 
GByteArray *        mm_sms_properties_get_data_bytearray
                                                        (MMSmsProperties *self);
Gets the message data.
| 
 | A MMSmsProperties. | 
| Returns : | A GByteArray with the message data, or NULLif it doesn't contain any (e.g. contains text instead). The returned value should be freed withg_byte_array_unref(). [transfer full] | 
void mm_sms_properties_set_data_bytearray (MMSmsProperties *self,GByteArray *data);
Sets the message data.
| 
 | A MMSmsProperties. | 
| 
 | A GByteArray with the data to set. This method takes a new reference of data. | 
const gchar *       mm_sms_properties_get_number        (MMSmsProperties *self);
Gets the number to which the message is addressed.
| 
 | A MMSmsProperties. | 
| Returns : | The number, or NULLif it couldn't be retrieved. Do not free the returned value, it is owned byself. [transfer none] | 
void mm_sms_properties_set_number (MMSmsProperties *self,const gchar *number);
Sets the number to which the message is addressed.
| 
 | A MMSmsProperties. | 
| 
 | The number. | 
const gchar *       mm_sms_properties_get_smsc          (MMSmsProperties *self);
Gets the SMS service center number.
| 
 | A MMSmsProperties. | 
| Returns : | The number of the SMSC, or NULLif it couldn't be retrieved. Do not free the returned value, it is owned byself. [transfer none] | 
void mm_sms_properties_set_smsc (MMSmsProperties *self,const gchar *smsc);
Sets the SMS service center number.
| 
 | A MMSmsProperties. | 
| 
 | The SMSC number. | 
MMSmsValidityType   mm_sms_properties_get_validity_type (MMSmsProperties *self);
Gets the relative validity type the SMS.
| 
 | A MMSmsProperties. | 
| Returns : | a MMSmsValidityType. | 
guint               mm_sms_properties_get_validity_relative
                                                        (MMSmsProperties *self);
Gets the relative validity time of the SMS.
| 
 | A MMSmsProperties. | 
| Returns : | the validity time or 0 if unknown. | 
void mm_sms_properties_set_validity_relative (MMSmsProperties *self,guint validity);
Sets the relative validity time of the SMS.
| 
 | A MMSmsProperties. | 
| 
 | The validity of MM_SMS_VALIDITY_TYPE_RELATIVEtype. | 
gint                mm_sms_properties_get_class         (MMSmsProperties *self);
Gets the 3GPP message class of the SMS.
| 
 | A MMSmsProperties. | 
| Returns : | the message class, or -1 for invalid/unset class. | 
void mm_sms_properties_set_class (MMSmsProperties *self,gint class);
Sets the 3GPP message class of the SMS.
| 
 | A MMSmsProperties. | 
| 
 | The message class (0..3), or -1 for invalid/unset class. | 
gboolean            mm_sms_properties_get_delivery_report_request
                                                        (MMSmsProperties *self);
Checks whether delivery report is requested for the SMS.
| 
 | A MMSmsProperties. | 
| Returns : | TRUEif delivery report is requested,FALSEotherwise. | 
void mm_sms_properties_set_delivery_report_request (MMSmsProperties *self,gboolean request);
Sets whether delivery report is requested for the SMS.
| 
 | A MMSmsProperties. | 
| 
 | TRUEif delivery report is requested,FALSEotherwise. |