dbus/introspection/org.freedesktop.ModemManager1.Sms.xml

0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004  ModemManager 1.0 Interface Specification
0005
0006    Copyright (C) 2011-2013 Red Hat, Inc.
0007    Copyright (C) 2011-2013 Google, Inc.
0008    Copyright (C) 2011-2013 Lanedo GmbH
0009 -->
0010
0011 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0012
0013   <!--
0014       org.freedesktop.ModemManager1.Sms:
0015       @short_description: The ModemManager SMS interface.
0016
0017       The SMS interface Defines operations and properties of a single SMS message.
0018   -->
0019   <interface name="org.freedesktop.ModemManager1.Sms">
0020
0021     <!--
0022         Send:
0023
0024         If the message has not yet been sent, queue it for delivery.
0025     -->
0026     <method name="Send" />
0027
0028     <!--
0029         Store:
0030
0031         Store the message in the device if not already done.
0032
0033         This method requires a <link linkend="MMSmsStorage">MMSmsStorage</link>
0034         value, describing the storage where this message is to be kept; or
0035         <link linkend="MM-SMS-STORAGE-UNKNOWN:CAPS"><constant>MM_SMS_STORAGE_UNKNOWN</constant></link>
0036         if the default storage should be used.
0037     -->
0038     <method name="Store">
0039       <arg name="storage" type="u" direction="in" />
0040     </method>
0041
0042     <!--
0043         State:
0044
0045         A <link linkend="MMSmsState">MMSmsState</link> value,
0046         describing the state of the message.
0047     -->
0048     <property name="State" type="u" access="read" />
0049
0050     <!--
0051         PduType:
0052
0053         A <link linkend="MMSmsPduType">MMSmsPduType</link> value,
0054         describing the type of PDUs used in the SMS message.
0055     -->
0056     <property name="PduType" type="u" access="read" />
0057
0058     <!--
0059         Number:
0060
0061         Number to which the message is addressed.
0062     -->
0063     <property name="Number" type="s" access="read" />
0064
0065     <!--
0066         Text:
0067
0068         Message text, in UTF-8.
0069
0070         When sending, if the text is larger than the limit of the technology or
0071         modem, the message will be broken into multiple parts or messages.
0072
0073         Note that Text and Data are never given at the same time.
0074     -->
0075     <property name="Text" type="s" access="read" />
0076
0077     <!--
0078         Data:
0079
0080         Message data.
0081
0082         When sending, if the data is larger than the limit of the technology or
0083         modem, the message will be broken into multiple parts or messages.
0084
0085         Note that Text and Data are never given at the same time.
0086     -->
0087     <property name="Data" type="ay" access="read" />
0088
0089     <!--
0090         SMSC:
0091
0092         Indicates the SMS service center number.
0093
0094         Always empty for 3GPP2/CDMA.
0095     -->
0096     <property name="SMSC" type="s" access="read" />
0097
0098     <!--
0099         Validity:
0100
0101         Indicates when the SMS expires in the SMSC.
0102
0103         This value is composed of a
0104         <link linkend="MMSmsValidityType">MMSmsValidityType</link>
0105         key, with an associated data which contains type-specific validity
0106         information:
0107
0108             <variablelist>
0109              <varlistentry><term><link linkend="MM-SMS-VALIDITY-TYPE-RELATIVE:CAPS">MM_SMS_VALIDITY_TYPE_RELATIVE</link></term>
0110           <listitem>
0111            <para>
0112                 The value is the length of the validity period in minutes, given
0113                 as an unsigned integer (D-Bus signature <literal>'u'</literal>).
0114             </para>
0115           </listitem>
0116          </varlistentry>
0117         </variablelist>
0118     -->
0119     <property name="Validity" type="(uv)" access="read">
0120     <annotation name="org.qtproject.QtDBus.QtTypeName" value="ValidityPair"/>
0121     </property>
0122
0123     <!--
0124         Class:
0125
0126         3GPP message class (-1..3).  -1 means class is not available or
0127         is not used for this message, otherwise the 3GPP SMS message class.
0128
0129         Always -1 for 3GPP2/CDMA.
0130     -->
0131     <property name="Class" type="i" access="read" />
0132
0133     <!--
0134         TeleserviceId:
0135
0136         A <link linkend="MMSmsCdmaTeleserviceId">MMSmsCdmaTeleserviceId</link> value.
0137
0138         Always <link linkend="MM-SMS-CDMA-TELESERVICE-ID-UNKNOWN:CAPS">MM_SMS_CDMA_TELESERVICE_ID_UNKNOWN</link> for 3GPP.
0139     -->
0140     <property name="TeleserviceId" type="u" access="read" />
0141
0142     <!--
0143         ServiceCategory:
0144
0145         A <link linkend="MMSmsCdmaServiceCategory">MMSmsCdmaServiceCategory</link> value.
0146
0147         Always <link linkend="MM-SMS-CDMA-SERVICE-CATEGORY-UNKNOWN:CAPS">MM_SMS_CDMA_SERVICE_CATEGORY_UNKNOWN</link> for 3GPP.
0148     -->
0149     <property name="ServiceCategory" type="u" access="read" />
0150
0151     <!--
0152         DeliveryReportRequest:
0153
0154         #TRUE if delivery report request is required, #FALSE otherwise.
0155     -->
0156     <property name="DeliveryReportRequest" type="b" access="read" />
0157
0158     <!--
0159         MessageReference:
0160
0161         Message Reference of the last PDU sent/received within this SMS.
0162
0163         If the PDU type is
0164         <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>,
0165         this field identifies the Message Reference of the PDU associated to the status report.
0166     -->
0167     <property name="MessageReference" type="u" access="read" />
0168
0169     <!--
0170         Timestamp:
0171
0172         Time when the first PDU of the SMS message arrived the SMSC, in
0173         <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink>
0174         format.
0175         This field is only applicable if the PDU type is
0176         <link linkend="MM-SMS-PDU-TYPE-DELIVER:CAPS"><constant>MM_SMS_PDU_TYPE_DELIVER</constant></link>.
0177         or
0178         <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>.
0179     -->
0180     <property name="Timestamp" type="s" access="read" />
0181
0182     <!--
0183         DischargeTimestamp:
0184
0185         Time when the first PDU of the SMS message left the SMSC, in
0186         <ulink url="http://en.wikipedia.org/wiki/ISO_8601">ISO8601</ulink>
0187         format.
0188
0189         This field is only applicable if the PDU type is
0190         <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>.
0191     -->
0192     <property name="DischargeTimestamp" type="s" access="read" />
0193
0194     <!--
0195         DeliveryState:
0196
0197         A <link linkend="MMSmsDeliveryState">MMSmsDeliveryState</link> value,
0198         describing the state of the delivery reported in the Status Report message.
0199
0200         This field is only applicable if the PDU type is
0201         <link linkend="MM-SMS-PDU-TYPE-STATUS-REPORT:CAPS"><constant>MM_SMS_PDU_TYPE_STATUS_REPORT</constant></link>.
0202     -->
0203     <property name="DeliveryState" type="u" access="read" />
0204
0205     <!--
0206         Storage:
0207
0208         A <link linkend="MMSmsStorage">MMSmsStorage</link> value,
0209         describing the storage where this message is kept.
0210     -->
0211     <property name="Storage" type="u" access="read" />
0212
0213   </interface>
0214 </node>