diff options
Diffstat (limited to 'libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml')
| -rw-r--r-- | libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml | 264 |
1 files changed, 264 insertions, 0 deletions
diff --git a/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml b/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml new file mode 100644 index 000000000..497f99697 --- /dev/null +++ b/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Sms.xml @@ -0,0 +1,264 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +]> +<refentry id="gdbus-org.freedesktop.ModemManager1.Sms"> + <refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-ModemManager1-Sms.top_of_page">org.freedesktop.ModemManager1.Sms</refentrytitle> + <indexterm zone="gdbus-interface-org-freedesktop-ModemManager1-Sms.top_of_page"><primary sortas="Sms">org.freedesktop.ModemManager1.Sms</primary></indexterm> + </refmeta> <refnamediv> <refname>org.freedesktop.ModemManager1.Sms</refname> <refpurpose>The ModemManager SMS interface.</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> + <title role="synopsis.title">Methods</title> + <synopsis> +<link linkend="gdbus-method-org-freedesktop-ModemManager1-Sms.Send">Send</link> (); +<link linkend="gdbus-method-org-freedesktop-ModemManager1-Sms.Store">Store</link> (IN u storage); +</synopsis> + </refsynopsisdiv> + <refsect1 role="properties"> + <title role="properties.title">Properties</title> + <synopsis> +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.State">State</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.PduType">PduType</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Number">Number</link> readable s +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Text">Text</link> readable s +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Data">Data</link> readable ay +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.SMSC">SMSC</link> readable s +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Validity">Validity</link> readable (uv) +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Class">Class</link> readable i +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.TeleserviceId">TeleserviceId</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.ServiceCategory">ServiceCategory</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryReportRequest">DeliveryReportRequest</link> readable b +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.MessageReference">MessageReference</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Timestamp">Timestamp</link> readable s +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.DischargeTimestamp">DischargeTimestamp</link> readable s +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryState">DeliveryState</link> readable u +<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.Storage">Storage</link> readable u +</synopsis> + </refsect1> +<refsect1 role="desc" id="gdbus-interface-org-freedesktop-ModemManager1-Sms"> + <title role="desc.title">Description</title> + <para> The SMS interface Defines operations and properties of a single SMS message. +</para> +</refsect1> +<refsect1 role="details" id="gdbus-methods-org.freedesktop.ModemManager1.Sms"> + <title role="details.title">Method Details</title> +<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Sms.Send"> + <title>The Send() method</title> + <indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Sms.Send"><primary sortas="Sms.Send">org.freedesktop.ModemManager1.Sms.Send()</primary></indexterm> +<programlisting> +Send (); +</programlisting> +<para> If the message has not yet been sent, queue it for delivery. +</para> +</refsect2> +<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Sms.Store"> + <title>The Store() method</title> + <indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Sms.Store"><primary sortas="Sms.Store">org.freedesktop.ModemManager1.Sms.Store()</primary></indexterm> +<programlisting> +Store (IN u storage); +</programlisting> +<para> Store the message in the device if not already done. +</para><para> This method requires a <link linkend="MMSmsStorage">MMSmsStorage</link> + value, describing the storage where this message is to be kept; or + <link linkend="MM-SMS-STORAGE-UNKNOWN:CAPS"><constant>MM_SMS_STORAGE_UNKNOWN</constant></link> + if the default storage should be used. +</para> +<variablelist role="params"> +<varlistentry> + <term><literal>IN u <parameter>storage</parameter></literal>:</term> + <listitem><para></para></listitem> +</varlistentry> +</variablelist> +</refsect2> +</refsect1> +<refsect1 role="details" id="gdbus-properties-org.freedesktop.ModemManager1.Sms"> + <title role="details.title">Property Details</title> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.State"> + <title>The "State" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.State"><primary sortas="Sms:State">org.freedesktop.ModemManager1.Sms:State</primary></indexterm> +<programlisting> +State readable u +</programlisting> +<para> A <link linkend="MMSmsState">MMSmsState</link> value, + describing the state of the message. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.PduType"> + <title>The "PduType" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.PduType"><primary sortas="Sms:PduType">org.freedesktop.ModemManager1.Sms:PduType</primary></indexterm> +<programlisting> +PduType readable u +</programlisting> +<para> A <link linkend="MMSmsPduType">MMSmsPduType</link> value, + describing the type of PDUs used in the SMS message. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Number"> + <title>The "Number" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Number"><primary sortas="Sms:Number">org.freedesktop.ModemManager1.Sms:Number</primary></indexterm> +<programlisting> +Number readable s +</programlisting> +<para> Number to which the message is addressed. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Text"> + <title>The "Text" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Text"><primary sortas="Sms:Text">org.freedesktop.ModemManager1.Sms:Text</primary></indexterm> +<programlisting> +Text readable s +</programlisting> +<para> Message text, in UTF-8. +</para><para> When sending, if the text is larger than the limit of the technology or + modem, the message will be broken into multiple parts or messages. +</para><para> Note that Text and Data are never given at the same time. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Data"> + <title>The "Data" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Data"><primary sortas="Sms:Data">org.freedesktop.ModemManager1.Sms:Data</primary></indexterm> +<programlisting> +Data readable ay +</programlisting> +<para> Message data. +</para><para> When sending, if the data is larger than the limit of the technology or + modem, the message will be broken into multiple parts or messages. +</para><para> Note that Text and Data are never given at the same time. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.SMSC"> + <title>The "SMSC" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.SMSC"><primary sortas="Sms:SMSC">org.freedesktop.ModemManager1.Sms:SMSC</primary></indexterm> +<programlisting> +SMSC readable s +</programlisting> +<para> Indicates the SMS service center number. +</para><para> Always empty for 3GPP2/CDMA. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Validity"> + <title>The "Validity" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Validity"><primary sortas="Sms:Validity">org.freedesktop.ModemManager1.Sms:Validity</primary></indexterm> +<programlisting> +Validity readable (uv) +</programlisting> +<para> Indicates when the SMS expires in the SMSC. +</para><para> This value is composed of a + <link linkend="MMSmsValidityType">MMSmsValidityType</link> + key, with an associated data which contains type-specific validity + information: +</para><para> <variablelist> + <varlistentry><term><link linkend="MM-SMS-VALIDITY-TYPE-RELATIVE:CAPS">MM_SMS_VALIDITY_TYPE_RELATIVE</link></term> + <listitem> + <para> + The value is the length of the validity period in minutes, given + as an unsigned integer (D-Bus signature <literal>'u'</literal>). + </para> + </listitem> + </varlistentry> + </variablelist> +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Class"> + <title>The "Class" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Class"><primary sortas="Sms:Class">org.freedesktop.ModemManager1.Sms:Class</primary></indexterm> +<programlisting> +Class readable i +</programlisting> +<para> 3GPP message class (-1..3). -1 means class is not available or + is not used for this message, otherwise the 3GPP SMS message class. +</para><para> Always -1 for 3GPP2/CDMA. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.TeleserviceId"> + <title>The "TeleserviceId" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.TeleserviceId"><primary sortas="Sms:TeleserviceId">org.freedesktop.ModemManager1.Sms:TeleserviceId</primary></indexterm> +<programlisting> +TeleserviceId readable u +</programlisting> +<para> A <link linkend="MMSmsCdmaTeleserviceId">MMSmsCdmaTeleserviceId</link> value. +</para><para> Always <link linkend="MM-SMS-CDMA-TELESERVICE-ID-UNKNOWN:CAPS">MM_SMS_CDMA_TELESERVICE_ID_UNKNOWN</link> for 3GPP. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.ServiceCategory"> + <title>The "ServiceCategory" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.ServiceCategory"><primary sortas="Sms:ServiceCategory">org.freedesktop.ModemManager1.Sms:ServiceCategory</primary></indexterm> +<programlisting> +ServiceCategory readable u +</programlisting> +<para> A <link linkend="MMSmsCdmaServiceCategory">MMSmsCdmaServiceCategory</link> value. +</para><para> Always <link linkend="MM-SMS-CDMA-SERVICE-CATEGORY-UNKNOWN:CAPS">MM_SMS_CDMA_SERVICE_CATEGORY_UNKNOWN</link> for 3GPP. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryReportRequest"> + <title>The "DeliveryReportRequest" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryReportRequest"><primary sortas="Sms:DeliveryReportRequest">org.freedesktop.ModemManager1.Sms:DeliveryReportRequest</primary></indexterm> +<programlisting> +DeliveryReportRequest readable b +</programlisting> +<para> #TRUE if delivery report request is required, #FALSE otherwise. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.MessageReference"> + <title>The "MessageReference" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.MessageReference"><primary sortas="Sms:MessageReference">org.freedesktop.ModemManager1.Sms:MessageReference</primary></indexterm> +<programlisting> +MessageReference readable u +</programlisting> +<para> Message Reference of the last PDU sent/received within this SMS. +</para><para> If the PDU type is + <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>, + this field identifies the Message Reference of the PDU associated to the status report. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Timestamp"> + <title>The "Timestamp" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Timestamp"><primary sortas="Sms:Timestamp">org.freedesktop.ModemManager1.Sms:Timestamp</primary></indexterm> +<programlisting> +Timestamp readable s +</programlisting> +<para> Time when the first PDU of the SMS message arrived the SMSC, in + <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink> + format. + This field is only applicable if the PDU type is + <link linkend="MM-SMS-PDU-TYPE-DELIVER:CAPS"><constant>MM_SMS_PDU_TYPE_DELIVER</constant></link>. + or + <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.DischargeTimestamp"> + <title>The "DischargeTimestamp" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.DischargeTimestamp"><primary sortas="Sms:DischargeTimestamp">org.freedesktop.ModemManager1.Sms:DischargeTimestamp</primary></indexterm> +<programlisting> +DischargeTimestamp readable s +</programlisting> +<para> Time when the first PDU of the SMS message left the SMSC, in + <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink> + format. +</para><para> This field is only applicable if the PDU type is + <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryState"> + <title>The "DeliveryState" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.DeliveryState"><primary sortas="Sms:DeliveryState">org.freedesktop.ModemManager1.Sms:DeliveryState</primary></indexterm> +<programlisting> +DeliveryState readable u +</programlisting> +<para> A <link linkend="MMSmsDeliveryState">MMSmsDeliveryState</link> value, + describing the state of the delivery reported in the Status Report message. +</para><para> This field is only applicable if the PDU type is + <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>. +</para> +</refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Sms.Storage"> + <title>The "Storage" property</title> + <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Sms.Storage"><primary sortas="Sms:Storage">org.freedesktop.ModemManager1.Sms:Storage</primary></indexterm> +<programlisting> +Storage readable u +</programlisting> +<para> A <link linkend="MMSmsStorage">MMSmsStorage</link> value, + describing the storage where this message is kept. +</para> +</refsect2> +</refsect1> +</refentry> + |