api: add 'Since' tags
These are not actively used by gdbus-codegen or gtk-doc, but they're helpful anyway so that users know when a given API method was introduced.
This commit is contained in:
@@ -22,6 +22,8 @@
|
||||
Send:
|
||||
|
||||
If the message has not yet been sent, queue it for delivery.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<method name="Send" />
|
||||
|
||||
@@ -34,6 +36,8 @@
|
||||
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.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<method name="Store">
|
||||
<arg name="storage" type="u" direction="in" />
|
||||
@@ -44,6 +48,8 @@
|
||||
|
||||
A <link linkend="MMSmsState">MMSmsState</link> value,
|
||||
describing the state of the message.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="State" type="u" access="read" />
|
||||
|
||||
@@ -52,6 +58,8 @@
|
||||
|
||||
A <link linkend="MMSmsPduType">MMSmsPduType</link> value,
|
||||
describing the type of PDUs used in the SMS message.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="PduType" type="u" access="read" />
|
||||
|
||||
@@ -59,6 +67,8 @@
|
||||
Number:
|
||||
|
||||
Number to which the message is addressed.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Number" type="s" access="read" />
|
||||
|
||||
@@ -71,6 +81,8 @@
|
||||
modem, the message will be broken into multiple parts or messages.
|
||||
|
||||
Note that Text and Data are never given at the same time.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Text" type="s" access="read" />
|
||||
|
||||
@@ -83,6 +95,8 @@
|
||||
modem, the message will be broken into multiple parts or messages.
|
||||
|
||||
Note that Text and Data are never given at the same time.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Data" type="ay" access="read" />
|
||||
|
||||
@@ -92,6 +106,8 @@
|
||||
Indicates the SMS service center number.
|
||||
|
||||
Always empty for 3GPP2/CDMA.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="SMSC" type="s" access="read" />
|
||||
|
||||
@@ -115,6 +131,8 @@
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Validity" type="(uv)" access="read" />
|
||||
|
||||
@@ -125,6 +143,8 @@
|
||||
is not used for this message, otherwise the 3GPP SMS message class.
|
||||
|
||||
Always -1 for 3GPP2/CDMA.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Class" type="i" access="read" />
|
||||
|
||||
@@ -134,6 +154,8 @@
|
||||
A <link linkend="MMSmsCdmaTeleserviceId">MMSmsCdmaTeleserviceId</link> value.
|
||||
|
||||
Always <link linkend="MM-SMS-CDMA-TELESERVICE-ID-UNKNOWN:CAPS">MM_SMS_CDMA_TELESERVICE_ID_UNKNOWN</link> for 3GPP.
|
||||
|
||||
Since: 1.2
|
||||
-->
|
||||
<property name="TeleserviceId" type="u" access="read" />
|
||||
|
||||
@@ -143,6 +165,8 @@
|
||||
A <link linkend="MMSmsCdmaServiceCategory">MMSmsCdmaServiceCategory</link> value.
|
||||
|
||||
Always <link linkend="MM-SMS-CDMA-SERVICE-CATEGORY-UNKNOWN:CAPS">MM_SMS_CDMA_SERVICE_CATEGORY_UNKNOWN</link> for 3GPP.
|
||||
|
||||
Since: 1.2
|
||||
-->
|
||||
<property name="ServiceCategory" type="u" access="read" />
|
||||
|
||||
@@ -150,6 +174,8 @@
|
||||
DeliveryReportRequest:
|
||||
|
||||
#TRUE if delivery report request is required, #FALSE otherwise.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="DeliveryReportRequest" type="b" access="read" />
|
||||
|
||||
@@ -161,6 +187,8 @@
|
||||
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.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="MessageReference" type="u" access="read" />
|
||||
|
||||
@@ -174,6 +202,8 @@
|
||||
<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>.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Timestamp" type="s" access="read" />
|
||||
|
||||
@@ -186,6 +216,8 @@
|
||||
|
||||
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>.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="DischargeTimestamp" type="s" access="read" />
|
||||
|
||||
@@ -197,6 +229,8 @@
|
||||
|
||||
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>.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="DeliveryState" type="u" access="read" />
|
||||
|
||||
@@ -205,6 +239,8 @@
|
||||
|
||||
A <link linkend="MMSmsStorage">MMSmsStorage</link> value,
|
||||
describing the storage where this message is kept.
|
||||
|
||||
Since: 1.0
|
||||
-->
|
||||
<property name="Storage" type="u" access="read" />
|
||||
|
||||
|
||||
Reference in New Issue
Block a user