aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2021-03-23 11:33:34 +0100
committerAleksander Morgado <aleksander@aleksander.es>2021-03-23 12:50:17 +0100
commit97ae345d9eeba4ceca5ce308a42c56cf783f27d2 (patch)
treeb3fa8e57445727a637f1456c5d2495d27594c26f
parentdd3cb6e774efcb4a18c0865e8482b0389bad19b3 (diff)
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.
-rw-r--r--introspection/org.freedesktop.ModemManager1.Bearer.xml35
-rw-r--r--introspection/org.freedesktop.ModemManager1.Call.xml32
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml6
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Location.xml27
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml16
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml12
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml28
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml18
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Oma.xml18
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Sar.xml8
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Signal.xml16
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Simple.xml6
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Time.xml6
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.Voice.xml26
-rw-r--r--introspection/org.freedesktop.ModemManager1.Modem.xml112
-rw-r--r--introspection/org.freedesktop.ModemManager1.Sim.xml26
-rw-r--r--introspection/org.freedesktop.ModemManager1.Sms.xml36
-rw-r--r--introspection/org.freedesktop.ModemManager1.xml10
18 files changed, 424 insertions, 14 deletions
diff --git a/introspection/org.freedesktop.ModemManager1.Bearer.xml b/introspection/org.freedesktop.ModemManager1.Bearer.xml
index d76f8a0c..ad621c19 100644
--- a/introspection/org.freedesktop.ModemManager1.Bearer.xml
+++ b/introspection/org.freedesktop.ModemManager1.Bearer.xml
@@ -33,6 +33,8 @@
#org.freedesktop.ModemManager1.Bearer:Ip6Config
properties become valid and may contain IP configuration information for
the data interface associated with this bearer.
+
+ Since: 1.0
-->
<method name="Connect" />
@@ -43,6 +45,8 @@
Any ongoing data session will be terminated and IP addresses become
invalid when this method is called.
+
+ Since: 1.0
-->
<method name="Disconnect" />
@@ -82,6 +86,8 @@
<link linkend="MM-BEARER-IP-METHOD-PPP:CAPS">MM_BEARER_IP_METHOD_PPP</link>
method is given, the interface
will be a serial TTY which must then have PPP run over it.
+
+ Since: 1.0
-->
<property name="Interface" type="s" access="read" />
@@ -90,6 +96,8 @@
Indicates whether or not the bearer is connected and thus whether
packet data communication using this bearer is possible.
+
+ Since: 1.0
-->
<property name="Connected" type="b" access="read" />
@@ -99,6 +107,8 @@
In some devices, packet data service will be suspended while the device
is handling other communication, like a voice call. If packet data
service is suspended (but not deactivated) this property will be %TRUE.
+
+ Since: 1.0
-->
<property name="Suspended" type="b" access="read" />
@@ -107,6 +117,8 @@
This property will be %TRUE if the bearer is connected through a
multiplexed network link.
+
+ Since: 1.18
-->
<property name="Multiplexed" type="b" access="read" />
@@ -174,6 +186,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="Ip4Config" type="a{sv}" access="read" />
@@ -242,10 +256,12 @@
<variablelist>
<varlistentry><term><literal>"mtu"</literal></term>
<listitem>
- Maximum transmission unit (MTU), given as an unsigned integer value (signature <literal>"u"</literal>).
+ Maximum transmission unit (MTU), given as an unsigned integer value (signature <literal>"u"</literal>). Since 1.4.
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="Ip6Config" type="a{sv}" access="read" />
@@ -289,37 +305,40 @@
<listitem>
Total number of connection attempts done with this bearer, given
as an unsigned integer value (signature <literal>"u"</literal>).
+ Since 1.14.
</listitem>
</varlistentry>
<varlistentry><term><literal>"failed-attempts"</literal></term>
<listitem>
Number of failed connection attempts done with this bearer,
given as an unsigned integer value (signature
- <literal>"u"</literal>).
+ <literal>"u"</literal>). Since 1.14.
</listitem>
</varlistentry>
<varlistentry><term><literal>"total-rx-bytes"</literal></term>
<listitem>
Total number of bytes received without error in all the successful
connection establishments, given as an unsigned 64-bit integer
- value (signature <literal>"t"</literal>).
+ value (signature <literal>"t"</literal>). Since 1.14.
</listitem>
</varlistentry>
<varlistentry><term><literal>"total-tx-bytes"</literal></term>
<listitem>
Total number of bytes transmitted without error in all the
successful connection establishments, given as an unsigned 64-bit
- integer value (signature <literal>"t"</literal>).
+ integer value (signature <literal>"t"</literal>). Since 1.14.
</listitem>
</varlistentry>
<varlistentry><term><literal>"total-duration"</literal></term>
<listitem>
Total duration of all the successful connection establishments, in
seconds, given as an unsigned integer value (signature
- <literal>"u"</literal>).
+ <literal>"u"</literal>). Since 1.14.
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.6
-->
<property name="Stats" type="a{sv}" access="read" />
@@ -327,6 +346,8 @@
IpTimeout:
Maximum time to wait for a successful IP establishment, when PPP is used.
+
+ Since: 1.0
-->
<property name="IpTimeout" type="u" access="read" />
@@ -334,6 +355,8 @@
BearerType:
A <link linkend="MMBearerType">MMBearerType</link>
+
+ Since: 1.10
-->
<property name="BearerType" type="u" access="read" />
@@ -429,6 +452,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="Properties" type="a{sv}" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Call.xml b/introspection/org.freedesktop.ModemManager1.Call.xml
index 659601b4..3aa6a643 100644
--- a/introspection/org.freedesktop.ModemManager1.Call.xml
+++ b/introspection/org.freedesktop.ModemManager1.Call.xml
@@ -25,6 +25,8 @@
Applicable only if state is <link linkend="MM-CALL-STATE-UNKNOWN:CAPS"><constant>MM_CALL_STATE_UNKNOWN</constant></link> and direction is
<link linkend="MM-CALL-DIRECTION-OUTGOING:CAPS"><constant>MM_CALL_DIRECTION_OUTGOING</constant></link>.
+
+ Since: 1.6
-->
<method name="Start" />
@@ -35,6 +37,8 @@
Applicable only if state is <link linkend="MM-CALL-STATE-RINGING-IN:CAPS"><constant>MM_CALL_STATE_RINGING_IN</constant></link> and direction is
<link linkend="MM-CALL-DIRECTION-INCOMING:CAPS"><constant>MM_CALL_DIRECTION_INCOMING</constant></link>.
+
+ Since: 1.6
-->
<method name="Accept" />
@@ -48,6 +52,8 @@
Applicable only if state is <link linkend="MM-CALL-STATE-RINGING-IN:CAPS"><constant>MM_CALL_STATE_RINGING_IN</constant></link> or
<link linkend="MM-CALL-STATE-WAITING:CAPS"><constant>MM_CALL_STATE_WAITING</constant></link> and direction is
<link linkend="MM-CALL-DIRECTION-INCOMING:CAPS"><constant>MM_CALL_DIRECTION_INCOMING</constant></link>.
+
+ Since: 1.12
-->
<method name="Deflect">
<arg name="number" type="s" />
@@ -64,6 +70,8 @@
property while they are part of the multiparty call.
Applicable only if state is <link linkend="MM-CALL-STATE-HELD:CAPS"><constant>MM_CALL_STATE_HELD</constant></link>.
+
+ Since: 1.12
-->
<method name="JoinMultiparty" />
@@ -77,6 +85,8 @@
Applicable only if state is <link linkend="MM-CALL-STATE-ACTIVE:CAPS"><constant>MM_CALL_STATE_ACTIVE</constant></link> or
<link linkend="MM-CALL-STATE-HELD:CAPS"><constant>MM_CALL_STATE_HELD</constant></link> and
the call is a multiparty call.
+
+ Since: 1.12
-->
<method name="LeaveMultiparty"/>
@@ -86,6 +96,8 @@
Hangup the active call.
Applicable only if state is <link linkend="MM-CALL-STATE-UNKNOWN:CAPS"><constant>MM_CALL_STATE_UNKNOWN</constant></link>.
+
+ Since: 1.6
-->
<method name="Hangup"/>
@@ -96,6 +108,8 @@
Send a DTMF tone (Dual Tone Multi-Frequency) (only on supported modem).
Applicable only if state is <link linkend="MM-CALL-STATE-ACTIVE:CAPS"><constant>MM_CALL_STATE_ACTIVE</constant></link>.
+
+ Since: 1.6
-->
<method name="SendDtmf">
<arg name="dtmf" type="s" direction="in"/>
@@ -106,6 +120,8 @@
@dtmf: DTMF tone identifier [0-9A-D*#].
Emitted when a DTMF tone is received (only on supported modem)
+
+ Since: 1.6
-->
<signal name="DtmfReceived">
<arg name="dtmf" type="s" />
@@ -118,6 +134,8 @@
@reason: A <link linkend="MMCallStateReason">MMCallStateReason</link> value, specifying the reason for this state change.
Emitted when call changes state
+
+ Since: 1.6
-->
<signal name="StateChanged">
<arg name="old" type="i" />
@@ -130,6 +148,8 @@
A <link linkend="MMCallState">MMCallState</link> value,
describing the state of the call.
+
+ Since: 1.6
-->
<property name="State" type="i" access="read" />
@@ -137,6 +157,8 @@
StateReason:
A <link linkend="MMCallStateReason">MMCallStateReason</link> value, describing why the state is changed.
+
+ Since: 1.6
-->
<property name="StateReason" type="i" access="read" />
@@ -145,6 +167,8 @@
A <link linkend="MMCallDirection">MMCallDirection</link> value,
describing the direction of the call.
+
+ Since: 1.6
-->
<property name="Direction" type="i" access="read" />
@@ -152,6 +176,8 @@
Number:
The remote phone number.
+
+ Since: 1.6
-->
<property name="Number" type="s" access="read" />
@@ -159,6 +185,8 @@
Multiparty:
Whether the call is currently part of a multiparty conference call.
+
+ Since: 1.12
-->
<property name="Multiparty" type="b" access="read" />
@@ -169,6 +197,8 @@
provides the audio. For example, with certain Huawei USB modems, this
property might be "ttyUSB2" indicating audio is available via ttyUSB2 in
the format described by the AudioFormat property.
+
+ Since: 1.10
-->
<property name="AudioPort" type="s" access="read" />
@@ -198,6 +228,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.10
-->
<property name="AudioFormat" type="a{sv}" access="read" />
</interface>
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml b/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml
index 848d55ca..d8464bf5 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml
@@ -95,6 +95,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<method name="List">
<arg name="selected" type="s" direction="out" />
@@ -114,6 +116,8 @@
or if the image could not be selected for some reason.
Installed images can be selected non-destructively.
+
+ Since: 1.0
-->
<method name="Select">
<arg name="uniqueid" type="s" direction="in" />
@@ -177,6 +181,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.10
-->
<property name="UpdateSettings" type="(ua{sv})" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Location.xml b/introspection/org.freedesktop.ModemManager1.Modem.Location.xml
index e0ac537d..5a7331ba 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Location.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Location.xml
@@ -69,6 +69,7 @@
<link linkend="MM-MODEM-LOCATION-SOURCE-AGPS-MSB:CAPS">MM_MODEM_LOCATION_SOURCE_AGPS_MSB</link>
cannot be given at the same time, and if none given, standalone GPS is assumed.
+ Since: 1.0
-->
<method name="Setup">
<arg name="sources" type="u" direction="in" />
@@ -85,6 +86,8 @@
for more information on the dictionary returned at @location.
This method may require the client to authenticate itself.
+
+ Since: 1.0
-->
<method name="GetLocation">
<arg name="Location" type="a{uv}" direction="out" />
@@ -95,6 +98,8 @@
@supl: SUPL server configuration, given either as IP:PORT or as FQDN:PORT.
Configure the SUPL server for A-GPS.
+
+ Since: 1.6
-->
<method name="SetSuplServer">
<arg name="supl" type="s" direction="in" />
@@ -117,6 +122,8 @@
itself, and therefore it cannot use any A-GPS server to improve the accuracy of the
position. In this case, the user can instead download the assistance data files using
a WiFi or LAN network, and inject them to the GNSS engine manually.
+
+ Since: 1.10
-->
<method name="InjectAssistanceData">
<arg name="data" type="ay" direction="in">
@@ -133,6 +140,8 @@
The refresh rate can be set to 0 to disable it, so that every update reported by
the modem is published in the interface.
+
+ Since: 1.6
-->
<method name="SetGpsRefreshRate">
<arg name="rate" type="u" direction="in" />
@@ -143,6 +152,8 @@
Bitmask of <link linkend="MMModemLocationSource">MMModemLocationSource</link>
values, specifying the supported location sources.
+
+ Since: 1.0
-->
<property name="Capabilities" type="u" access="read" />
@@ -151,6 +162,8 @@
Bitmask of <link linkend="MMModemLocationAssistanceDataType">MMModemLocationAssistanceDataType</link>
values, specifying the supported types of assistance data.
+
+ Since: 1.10
-->
<property name="SupportedAssistanceData" type="u" access="read" />
@@ -160,6 +173,8 @@
Bitmask specifying which of the supported
<link linkend="MMModemLocationSource">MMModemLocationSource</link>
location sources is currently enabled in the device.
+
+ Since: 1.0
-->
<property name="Enabled" type="u" access="read" />
@@ -172,6 +187,8 @@
See the
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Location.Setup">Setup()</link>
method for more information.
+
+ Since: 1.0
-->
<property name="SignalsLocation" type="b" access="read" />
@@ -242,7 +259,7 @@
This is the two-byte Location Area Code of the LTE base
station with which the mobile is registered, in upper-case
hexadecimal format without leading zeros, as specified in
- 3GPP TS 27.007. E.g. <literal>"6FFE"</literal>.
+ 3GPP TS 27.007. E.g. <literal>"6FFE"</literal>. Since 1.10.
</listitem>
</varlistentry>
</variablelist>
@@ -362,6 +379,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="Location" type="a{uv}" access="read" />
@@ -369,6 +388,8 @@
SuplServer:
SUPL server configuration for A-GPS, given either as IP:PORT or FQDN:PORT.
+
+ Since: 1.6
-->
<property name="SuplServer" type="s" access="read" />
@@ -377,6 +398,8 @@
URLs from where the user can download assistance data files to inject with
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Location.InjectAssistanceData">InjectAssistanceData()</link>.
+
+ Since: 1.10
-->
<property name="AssistanceDataServers" type="as" access="read" />
@@ -384,6 +407,8 @@
GpsRefreshRate:
Rate of refresh of the GPS information in the interface.
+
+ Since: 1.6
-->
<property name="GpsRefreshRate" type="u" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml b/introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml
index cf13cb9c..9117eb14 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Messaging.xml
@@ -35,6 +35,8 @@
retrieved either by listening for the
#org.freedesktop.ModemManager1.Modem.Messaging::Added signal,
or by querying the specific SMS object of interest.
+
+ Since: 1.0
-->
<method name="List">
<arg name="result" type="ao" direction="out" />
@@ -45,6 +47,8 @@
@path: The object path of the SMS to delete.
Delete an SMS message.
+
+ Since: 1.0
-->
<method name="Delete">
<arg name="path" type="o" direction="in" />
@@ -65,6 +69,8 @@
If the SMSC is not specified and one is required, the default SMSC is
used.
+
+ Since: 1.0
-->
<method name="Create">
<arg name="properties" type="a{sv}" direction="in" />
@@ -84,6 +90,8 @@
Check the
'<link linkend="gdbus-property-org-freedesktop-ModemManager1-Sms.State">State</link>'
property to determine if the message is complete.
+
+ Since: 1.0
-->
<signal name="Added">
<arg name="path" type="o" />
@@ -95,6 +103,8 @@
@path: Object path of the now deleted SMS.
Emitted when a message has been deleted.
+
+ Since: 1.0
-->
<signal name="Deleted">
<arg name="path" type="o" />
@@ -104,6 +114,8 @@
Messages:
The list of SMS object paths.
+
+ Since: 1.2
-->
<property name="Messages" type="ao" access="read" />
@@ -113,6 +125,8 @@
A list of <link linkend="MMSmsStorage">MMSmsStorage</link> values,
specifying the storages supported by this modem for storing and
receiving SMS.
+
+ Since: 1.0
-->
<property name="SupportedStorages" type="au" access="read" />
@@ -121,6 +135,8 @@
A <link linkend="MMSmsStorage">MMSmsStorage</link> value,
specifying the storage to be used when receiving or storing SMS.
+
+ Since: 1.0
-->
<property name="DefaultStorage" type="u" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml b/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml
index bc64d4a4..fc07bc03 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml
@@ -35,6 +35,8 @@
response or an appropriate error. The network may be awaiting further
response from the ME after returning from this method and no new command
can be initiated until this one is cancelled or ended.
+
+ Since: 1.0
-->
<method name="Initiate">
<arg name="command" type="s" direction="in" />
@@ -50,6 +52,8 @@
or that is awaiting further input after
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp-Ussd.Initiate">Initiate()</link>
was called.
+
+ Since: 1.0
-->
<method name="Respond">
<arg name="response" type="s" direction="in" />
@@ -60,6 +64,8 @@
Cancel:
Cancel an ongoing USSD session, either mobile or network initiated.
+
+ Since: 1.0
-->
<method name="Cancel" />
@@ -68,6 +74,8 @@
A <link linkend="MMModem3gppUssdSessionState">MMModem3gppUssdSessionState</link> value,
indicating the state of any ongoing USSD session.
+
+ Since: 1.0
-->
<property name="State" type="u" access="read" />
@@ -79,6 +87,8 @@
When no USSD session is active, or when there is no network-
initiated request, this property will be a zero-length string.
+
+ Since: 1.0
-->
<property name="NetworkNotification" type="s" access="read" />
@@ -92,6 +102,8 @@
When no USSD session is active, or when there is no pending
network-initiated request, this property will be a zero-length string.
+
+ Since: 1.0
-->
<property name="NetworkRequest" type="s" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml b/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml
index c2ef8b02..3fba396d 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml
@@ -30,6 +30,8 @@
@operator_id: The operator ID (ie, <literal>"MCCMNC"</literal>, like <literal>"310260"</literal>) to register. An empty string can be used to register to the home network.
Request registration with a given mobile network.
+
+ Since: 1.0
-->
<method name="Register">
<arg name="operator_id" type="s" direction="in" />
@@ -85,6 +87,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<method name="Scan">
<arg name="results" type="aa{sv}" direction="out" />
@@ -95,6 +99,8 @@
@mode: a <link linkend="MMModem3gppEpsUeModeOperation">MMModem3gppEpsUeModeOperation</link>.
Sets the UE mode of operation for EPS.
+
+ Since: 1.10
-->
<method name="SetEpsUeModeOperation">
<arg name="mode" type="u" direction="in" />
@@ -111,6 +117,8 @@
i.e.: <literal>"apn"</literal>, <literal>"ip-type"</literal>,
<literal>"allowed-auth"</literal>, <literal>"user"</literal>, and
<literal>"password"</literal>.
+
+ Since: 1.10
-->
<method name="SetInitialEpsBearerSettings">
<arg name="settings" type="a{sv}" direction="in" />
@@ -120,6 +128,8 @@
Imei:
The <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink> of the device.
+
+ Since: 1.0
-->
<property name="Imei" type="s" access="read" />
@@ -129,6 +139,8 @@
A <link linkend="MMModem3gppRegistrationState">MMModem3gppRegistrationState</link>
value specifying the mobile registration status as defined in 3GPP TS 27.007
section 10.1.19.
+
+ Since: 1.0
-->
<property name="RegistrationState" type="u" access="read" />
@@ -145,6 +157,8 @@
If the <literal>MCC</literal> and <literal>MNC</literal> are not known
or the mobile is not registered to a mobile network, this property will
be a zero-length (blank) string.
+
+ Since: 1.0
-->
<property name="OperatorCode" type="s" access="read" />
@@ -156,6 +170,8 @@
If the operator name is not known or the mobile is not
registered to a mobile network, this property will be a zero-length
(blank) string.
+
+ Since: 1.0
-->
<property name="OperatorName" type="s" access="read" />
@@ -164,6 +180,8 @@
Bitmask of <link linkend="MMModem3gppFacility">MMModem3gppFacility</link> values
for which PIN locking is enabled.
+
+ Since: 1.0
-->
<property name="EnabledFacilityLocks" type="u" access="read" />
@@ -174,6 +192,8 @@
value representing the subscription status of the account and whether there
is any data remaining, given as an unsigned integer (signature <literal>"u"</literal>).
+ Since: 1.2
+
Deprecated: 1.10.0. The value of this property can only be obtained with operator
specific logic (e.g. processing specific PCO info), and therefore it doesn't make sense
to expose it in the ModemManager interface.
@@ -186,6 +206,8 @@
A <link linkend="MMModem3gppEpsUeModeOperation">MMModem3gppEpsUeModeOperation</link>
value representing the UE mode of operation for EPS, given as an unsigned integer
(signature <literal>"u"</literal>).
+
+ Since: 1.10
-->
<property name="EpsUeModeOperation" type="u" access="read" />
@@ -211,6 +233,8 @@
<literal>"ay"</literal>).
</listitem>
</orderedlist>
+
+ Since: 1.10
-->
<property name="Pco" type="a(ubay)" access="read" />
@@ -218,6 +242,8 @@
InitialEpsBearer:
The object path for the initial default EPS bearer.
+
+ Since: 1.10
-->
<property name="InitialEpsBearer" type="o" access="read" />
@@ -236,6 +262,8 @@
This is a read-only property, updating these settings should be done using the
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Modem3gpp.SetInitialEpsBearerSettings">SetInitialEpsBearerSettings()</link>
method.
+
+ Since: 1.10
-->
<property name="InitialEpsBearerSettings" type="a{sv}" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml b/introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml
index 5c27f3f9..6d04cc5b 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml
@@ -34,6 +34,8 @@
activation functionality, if any.
Some modems will reboot after this call is made.
+
+ Since: 1.0
-->
<method name="Activate">
<arg name="carrier_code" type="s" direction="in" />
@@ -115,6 +117,8 @@
@status_changes: Properties that have changed as a result of this activation state change, including <literal>"mdn"</literal> and <literal>"min"</literal>. The dictionary may be empty if the changed properties are unknown.
The device activation state changed.
+
+ Since: 1.0
-->
<signal name="ActivationStateChanged">
<arg name="activation_state" type="u" />
@@ -127,6 +131,8 @@
A <link linkend="MMModemCdmaActivationState">MMModemCdmaActivationState</link>
value specifying the state of the activation in the 3GPP2 network.
+
+ Since: 1.0
-->
<property name="ActivationState" type="u" access="read" />
@@ -134,6 +140,8 @@
Meid:
The modem's <ulink url="http://en.wikipedia.org/wiki/MEID">Mobile Equipment Identifier</ulink>.
+
+ Since: 1.0
-->
<property name="Meid" type="s" access="read" />
@@ -144,6 +152,8 @@
The modem's
<ulink url="http://en.wikipedia.org/wiki/Electronic_serial_number">Electronic Serial Number</ulink>
(superceded by MEID but still used by older devices).
+
+ Since: 1.0
-->
<property name="Esn" type="s" access="read" />
@@ -157,6 +167,8 @@
See <ulink url="http://ifast.org">ifast.org</ulink> or the mobile
broadband provider database for mappings of SIDs to network providers.
+
+ Since: 1.0
-->
<property name="Sid" type="u" access="read" />
@@ -167,6 +179,8 @@
<ulink url="http://en.wikipedia.org/wiki/Network_Identification_Number">Network Identifier</ulink>
of the serving CDMA 1x network, if known, and
if the modem is registered with a CDMA 1x network.
+
+ Since: 1.0
-->
<property name="Nid" type="u" access="read" />
@@ -175,6 +189,8 @@
A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link>
value specifying the CDMA 1x registration state.
+
+ Since: 1.0
-->
<property name="Cdma1xRegistrationState" type="u" access="read" />
@@ -183,6 +199,8 @@
A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link>
value specifying the EVDO registration state.
+
+ Since: 1.0
-->
<property name="EvdoRegistrationState" type="u" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Oma.xml b/introspection/org.freedesktop.ModemManager1.Modem.Oma.xml
index cb0f8088..d697265e 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Oma.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Oma.xml
@@ -30,6 +30,8 @@
@features: Bitmask of <link linkend="MMModemOmaFeature">MMModemOmaFeature</link> flags, specifying which device management features should get enabled or disabled. <link linkend="MM-OMA-FEATURE-NONE:CAPS">MM_OMA_FEATURE_NONE</link> will disable all features.
Configures which OMA device management features should be enabled.
+
+ Since: 1.2
-->
<method name="Setup">
<arg name="features" type="u" direction="in" />
@@ -40,6 +42,8 @@
@session_type: Type of client-initiated device management session,given as a <link linkend="MMModemOmaSessionType">MMModemOmaSessionType</link>
Starts a client-initiated device management session.
+
+ Since: 1.2
-->
<method name="StartClientInitiatedSession">
<arg name="session_type" type="u" direction="in" />
@@ -51,6 +55,8 @@
@accept: Boolean specifying whether the session is accepted or rejected.
Accepts or rejects a network-initiated device management session.
+
+ Since: 1.2
-->
<method name="AcceptNetworkInitiatedSession">
<arg name="session_id" type="u" direction="in" />
@@ -61,6 +67,8 @@
CancelSession:
Cancels the current on-going device management session.
+
+ Since: 1.2
-->
<method name="CancelSession" />
@@ -70,6 +78,8 @@
Bitmask of <link linkend="MMModemOmaFeature">MMModemOmaFeature</link>
flags, specifying which device management features are enabled or
disabled.
+
+ Since: 1.2
-->
<property name="Features" type="u" access="read" />
@@ -91,6 +101,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="PendingNetworkInitiatedSessions" type="a(uu)" access="read" />
@@ -99,6 +111,8 @@
Type of the current on-going device management session, given as a
<link linkend="MMOmaSessionType">MMOmaSessionType</link>.
+
+ Since: 1.2
-->
<property name="SessionType" type="u" access="read" />
@@ -107,6 +121,8 @@
State of the current on-going device management session, given as a
<link linkend="MMOmaSessionState">MMOmaSessionState</link>.
+
+ Since: 1.2
-->
<property name="SessionState" type="i" access="read" />
@@ -117,6 +133,8 @@
@session_state_failed_reason: Reason of failure, given as a <link linkend="MMOmaSessionStateFailedReason">MMOmaSessionStateFailedReason</link>, if @session_state is <link linkend="MM-OMA-SESSION-STATE-FAILED:CAPS">MM_OMA_SESSION_STATE_FAILED</link>.
The session state changed.
+
+ Since: 1.2
-->
<signal name="SessionStateChanged">
<arg name="old_session_state" type="i" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Sar.xml b/introspection/org.freedesktop.ModemManager1.Modem.Sar.xml
index 5acffc5f..773cd571 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Sar.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Sar.xml
@@ -53,6 +53,8 @@
When disabled, the modem's output power level is dynamically updated
exclusively by the device.
+
+ Since: 1.18
-->
<method name="Enable">
<arg name="enable" type="b" direction="in" />
@@ -68,6 +70,8 @@
number of levels and corresponding power output for each level.
The index set here will apply to all antennas on the system.
+
+ Since: 1.18
-->
<method name="SetPowerLevel">
<arg name="level" type="u" direction="in" />
@@ -77,6 +81,8 @@
State:
Boolean indicating whether dynamic SAR is currently enabled.
+
+ Since: 1.18
-->
<property name="State" type="b" access="read" />
@@ -87,6 +93,8 @@
for setting the output power of all antennas on the system.
This value is only applicable when dynamic SAR is enabled.
+
+ Since: 1.18
-->
<property name="PowerLevel" type="u" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Signal.xml b/introspection/org.freedesktop.ModemManager1.Modem.Signal.xml
index 610c6db9..91a3c115 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Signal.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Signal.xml
@@ -26,6 +26,8 @@
@rate: refresh rate to set, in seconds. 0 to disable retrieval.
Setup extended signal quality information retrieval.
+
+ Since: 1.2
-->
<method name="Setup">
<arg name="rate" type="u" direction="in" />
@@ -36,6 +38,8 @@
Refresh rate for the extended signal quality information updates,
in seconds. A value of 0 disables the retrieval of the values.
+
+ Since: 1.2
-->
<property name="Rate" type="u" access="read" />
@@ -66,6 +70,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="Cdma" type="a{sv}" access="read" />
@@ -112,6 +118,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="Evdo" type="a{sv}" access="read" />
@@ -134,6 +142,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="Gsm" type="a{sv}" access="read" />
@@ -172,6 +182,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="Umts" type="a{sv}" access="read" />
@@ -218,6 +230,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.2
-->
<property name="Lte" type="a{sv}" access="read" />
@@ -256,6 +270,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.16
-->
<property name="Nr5g" type="a{sv}" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Simple.xml b/introspection/org.freedesktop.ModemManager1.Modem.Simple.xml
index 78f108dc..d40cb335 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Simple.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Simple.xml
@@ -65,6 +65,8 @@
There are no settings specific to this call that would apply to 3GPP2
(CDMA/EVDO) devices.
+
+ Since: 1.0
-->
<method name="Connect">
<arg name="properties" type="a{sv}" direction="in" />
@@ -78,6 +80,8 @@
disconnect all active packet data bearers.
Disconnect an active packet data connection.
+
+ Since: 1.0
-->
<method name="Disconnect">
<arg name="bearer" type="o" direction="in" />
@@ -168,6 +172,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<method name="GetStatus">
<arg name="properties" type="a{sv}" direction="out" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Time.xml b/introspection/org.freedesktop.ModemManager1.Modem.Time.xml
index 2659338e..7dc17e2e 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Time.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Time.xml
@@ -35,6 +35,8 @@
This method will only work if the modem tracks, or can request, the
current network time; it will not attempt to use previously-received
network time updates on the host to guess the current network time.
+
+ Since: 1.0
-->
<method name="GetNetworkTime">
<arg name="time" type="s" direction="out" />
@@ -66,6 +68,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="NetworkTimezone" type="a{sv}" access="read" />
@@ -74,6 +78,8 @@
@time: A string containing date and time in ISO 8601 format.
Sent when the network time is updated.
+
+ Since: 1.0
-->
<signal name="NetworkTimeChanged">
<arg name="time" type="s" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.Voice.xml b/introspection/org.freedesktop.ModemManager1.Modem.Voice.xml
index 87bc7d7d..74f755d9 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.Voice.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.Voice.xml
@@ -33,6 +33,8 @@
retrieved either by listening for the
#org.freedesktop.ModemManager1.Modem.Voice::Added signal,
or by querying the specific Call object of interest.
+
+ Since: 1.6
-->
<method name="ListCalls">
<arg name="result" type="ao" direction="out" />
@@ -45,6 +47,8 @@
Delete a Call from the list of calls.
The call will be hangup if it is still active.
+
+ Since: 1.6
-->
<method name="DeleteCall">
<arg name="path" type="o" direction="in" />
@@ -59,6 +63,8 @@
The '<link linkend="gdbus-property-org-freedesktop-ModemManager1-Call.Number">Number</link>' is the only
expected property to set by the user.
+
+ Since: 1.6
-->
<method name="CreateCall">
<arg name="properties" type="a{sv}" direction="in" />
@@ -79,6 +85,8 @@
calls to be reported of which one becomes active.
No error is returned if there are no waiting or held calls.
+
+ Since: 1.12
-->
<method name="HoldAndAccept" />
@@ -98,6 +106,8 @@
In this case, this method would be equivalent to calling
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Call.Hangup">Hangup()</link>
on the active call.
+
+ Since: 1.12
-->
<method name="HangupAndAccept" />
@@ -110,6 +120,8 @@
hold or in waiting state may also be terminated.
No error is returned if there are no ongoing calls.
+
+ Since: 1.12
-->
<method name="HangupAll" />
@@ -121,6 +133,8 @@
The affected calls will be considered terminated from the point of
view of the subscriber.
+
+ Since: 1.12
-->
<method name="Transfer" />
@@ -132,6 +146,8 @@
This operation requires communication with the network in order to
complete, so the modem must be successfully registered.
+
+ Since: 1.12
-->
<method name="CallWaitingSetup">
<arg name="enable" type="b" direction="in" />
@@ -145,6 +161,8 @@
This operation requires communication with the network in order to
complete, so the modem must be successfully registered.
+
+ Since: 1.12
-->
<method name="CallWaitingQuery">
<arg name="status" type="b" direction="out" />
@@ -155,6 +173,8 @@
@path: Object path of the new call.
Emitted when a call has been added.
+
+ Since: 1.6
-->
<signal name="CallAdded">
<arg name="path" type="o" />
@@ -165,6 +185,8 @@
@path: Object path of the now deleted Call.
Emitted when a call has been deleted.
+
+ Since: 1.6
-->
<signal name="CallDeleted">
<arg name="path" type="o" />
@@ -174,6 +196,8 @@
Calls:
The list of calls object paths.
+
+ Since: 1.6
-->
<property name="Calls" type="ao" access="read" />
@@ -184,6 +208,8 @@
If this flag is set, users should only attempt voice calls to
emergency numbers, as standard voice calls will likely fail.
+
+ Since: 1.12
-->
<property name="EmergencyOnly" type="b" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Modem.xml b/introspection/org.freedesktop.ModemManager1.Modem.xml
index 7d6e3603..80da06ed 100644
--- a/introspection/org.freedesktop.ModemManager1.Modem.xml
+++ b/introspection/org.freedesktop.ModemManager1.Modem.xml
@@ -34,6 +34,8 @@
When disabled, the modem enters low-power state and no network-related
operations are available.
+
+ Since: 1.0
-->
<method name="Enable">
<arg name="enable" type="b" direction="in" />
@@ -46,6 +48,8 @@
List configured packet data bearers (EPS Bearers, PDP Contexts, or
CDMA2000 Packet Data Sessions).
+ Since: 1.0
+
Deprecated: 1.10.0. Use #org.freedesktop.ModemManager1.Modem:Bearers
property instead.
-->
@@ -65,6 +69,8 @@
The properties allowed are any of the ones defined in the
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Bearer.Properties">bearer properties</link>.
+
+ Since: 1.0
-->
<method name="CreateBearer">
<arg name="properties" type="a{sv}" direction="in" />
@@ -79,6 +85,8 @@
If the bearer is currently active and providing packet data server, it
will be disconnected and that packet data service will terminate.
+
+ Since: 1.0
-->
<method name="DeleteBearer">
<arg name="bearer" type="o" direction="in" />
@@ -91,6 +99,8 @@
a newly-powered-on state.
This command may power-cycle the device.
+
+ Since: 1.0
-->
<method name="Reset" />
@@ -104,6 +114,8 @@
If not required by the modem, @code may be ignored.
This command may or may not power-cycle the device.
+
+ Since: 1.0
-->
<method name="FactoryReset">
<arg name="code" type="s" direction="in" />
@@ -116,6 +128,8 @@
Set the power state of the modem. This action can only be run when the
modem is in <link linkend="MM-MODEM-STATE-DISABLED:CAPS"><constant>MM_MODEM_STATE_DISABLED</constant></link>
state.
+
+ Since: 1.0
-->
<method name="SetPowerState">
<arg name="state" type="u" direction="in" />
@@ -131,6 +145,8 @@
#org.freedesktop.ModemManager1.Modem:SupportedCapabilities property.
This command may power-cycle the device.
+
+ Since: 1.0
-->
<method name="SetCurrentCapabilities">
<arg name="capabilities" type="u" direction="in" />
@@ -145,6 +161,8 @@
The given combination should be supported by the modem, as specified in the
#org.freedesktop.ModemManager1.Modem:SupportedModes property.
+
+ Since: 1.0
-->
<method name="SetCurrentModes">
<arg name="modes" type="(uu)" direction="in" />
@@ -156,6 +174,8 @@
Set the radio frequency and technology bands the device is currently
allowed to use when connecting to a network.
+
+ Since: 1.0
-->
<method name="SetCurrentBands">
<arg name="bands" type="au" direction="in" />
@@ -174,22 +194,26 @@
There is no limitation on which SIM slot to select, so the user may also set as
primary a slot that doesn't currently have any valid SIM card inserted.
+
+ Since: 1.16
-->
<method name="SetPrimarySimSlot">
<arg name="sim_slot" type="u" direction="in" />
</method>
<!--
- Command:
- @cmd: The command string, e.g. "AT+GCAP" or "+GCAP" (leading AT is inserted if necessary).
- @timeout: The number of seconds to wait for a response.
- @response: The modem's response.
+ Command:
+ @cmd: The command string, e.g. "AT+GCAP" or "+GCAP" (leading AT is inserted if necessary).
+ @timeout: The number of seconds to wait for a response.
+ @response: The modem's response.
+
+ Send an arbitrary AT command to a modem and get the response.
- Send an arbitrary AT command to a modem and get the response.
+ Note that using this interface call is only allowed when running
+ ModemManager in debug mode or if the project was built using
+ the <literal>with-at-command-via-dbus</literal> configure option.
- Note that using this interface call is only allowed when running
- ModemManager in debug mode or if the project was built using
- the <literal>with-at-command-via-dbus</literal> configure option.
+ Since: 1.0
-->
<method name="Command">
<arg name="cmd" type="s" direction="in" />
@@ -204,6 +228,8 @@
@reason: A <link linkend="MMModemStateChangeReason">MMModemStateChangeReason</link> value, specifying the reason for this state change.
The modem's state (see #org.freedesktop.ModemManager1.Modem:State) changed.
+
+ Since: 1.0
-->
<signal name="StateChanged">
<arg name="old" type="i" />
@@ -224,6 +250,8 @@
supported, the #org.freedesktop.ModemManager1.Modem.PrimarySimSlot
index value specifies which is the slot number where this SIM card
is available.
+
+ Since: 1.0
-->
<property name="Sim" type="o" access="read" />
@@ -241,6 +269,8 @@
This list includes the SIM object considered as primary active SIM slot
(#org.freedesktop.ModemManager1.Modem.Sim) at index
#org.freedesktop.ModemManager1.Modem.ActiveSimSlot.
+
+ Since: 1.16
-->
<property name="SimSlots" type="ao" access="read" />
@@ -260,6 +290,8 @@
In a Multi SIM Multi Standby setup, this index identifies the active SIM
that is considered primary, i.e. the one that will be used when a data
connection is setup.
+
+ Since: 1.16
-->
<property name="PrimarySimSlot" type="u" access="read" />
@@ -271,6 +303,8 @@
This list does not include the initial EPS bearer details (see
#org.freedesktop.ModemManager1.Modem.Modem3gpp:InitialEpsBearer).
+
+ Since: 1.2
-->
<property name="Bearers" type="ao" access="read" />
@@ -288,6 +322,8 @@
Only multimode devices implementing both 3GPP (GSM/UMTS/LTE/5GNR) and
3GPP2 (CDMA/EVDO) specs will report more than one combination of
capabilities.
+
+ Since: 1.0
-->
<property name="SupportedCapabilities" type="au" access="read" />
@@ -300,6 +336,8 @@
This bitmask will be one of the ones listed in
#org.freedesktop.ModemManager1.Modem:SupportedCapabilities.
+
+ Since: 1.0
-->
<property name="CurrentCapabilities" type="u" access="read" />
@@ -320,6 +358,8 @@
implementations is always equal to the value in
#org.freedesktop.ModemManager1.Modem:MaxActiveBearers, so there is no
point in using this property.
+
+ Since: 1.0
-->
<property name="MaxBearers" type="u" access="read" />
@@ -334,6 +374,8 @@
and LTE/5GNR capable devices (including 3GPP+3GPP3 multimode devices) may support
one or more active bearers, depending on the amount of physical ports exposed
by the device.
+
+ Since: 1.0
-->
<property name="MaxActiveBearers" type="u" access="read" />
@@ -347,6 +389,8 @@
If the modem doesn't support multiplexing of data sessiones, a value of 0 will
be reported.
+
+ Since: 1.18
-->
<property name="MaxActiveMultiplexedBearers" type="u" access="read" />
@@ -354,6 +398,8 @@
Manufacturer:
The equipment manufacturer, as reported by the modem.
+
+ Since: 1.0
-->
<property name="Manufacturer" type="s" access="read" />
@@ -361,6 +407,8 @@
Model:
The equipment model, as reported by the modem.
+
+ Since: 1.0
-->
<property name="Model" type="s" access="read" />
@@ -368,6 +416,8 @@
Revision:
The revision identification of the software, as reported by the modem.
+
+ Since: 1.0
-->
<property name="Revision" type="s" access="read" />
@@ -375,6 +425,8 @@
CarrierConfiguration:
The description of the carrier-specific configuration (MCFG) in use by the modem.
+
+ Since: 1.12
-->
<property name="CarrierConfiguration" type="s" access="read" />
@@ -382,6 +434,8 @@
CarrierConfigurationRevision:
The revision identification of the carrier-specific configuration (MCFG) in use by the modem.
+
+ Since: 1.12
-->
<property name="CarrierConfigurationRevision" type="s" access="read" />
@@ -389,6 +443,8 @@
HardwareRevision:
The revision identification of the hardware, as reported by the modem.
+
+ Since: 1.8
-->
<property name="HardwareRevision" type="s" access="read" />
@@ -405,6 +461,8 @@
This is not the device's IMEI or ESN since those may not be available
before unlocking the device via a PIN.
+
+ Since: 1.0
-->
<property name="DeviceIdentifier" type="s" access="read" />
@@ -419,6 +477,8 @@
This value may also be set by the user using the MM_ID_PHYSDEV_UID udev
tag (e.g. binding the tag to a specific sysfs path).
+
+ Since: 1.0
-->
<property name="Device" type="s" access="read" />
@@ -427,6 +487,8 @@
The Operating System device drivers handling communication with the modem
hardware.
+
+ Since: 1.0
-->
<property name="Drivers" type="as" access="read" />
@@ -434,6 +496,8 @@
Plugin:
The name of the plugin handling this modem.
+
+ Since: 1.0
-->
<property name="Plugin" type="s" access="read" />
@@ -441,6 +505,8 @@
PrimaryPort:
The name of the primary port using to control the modem.
+
+ Since: 1.0
-->
<property name="PrimaryPort" type="s" access="read" />
@@ -451,6 +517,8 @@
integer pairs. The string is the port name or path, and the integer is
the port type given as a
<link linkend="MMModemPortType">MMModemPortType</link> value.
+
+ Since: 1.0
-->
<property name="Ports" type="a(su)" access="read" />
@@ -461,6 +529,8 @@
This will be the IMEI number for GSM devices and the hex-format ESN/MEID
for CDMA devices.
+
+ Since: 1.0
-->
<property name="EquipmentIdentifier" type="s" access="read" />
@@ -469,6 +539,8 @@
Current lock state of the device, given as a
<link linkend="MMModemLock">MMModemLock</link> value.
+
+ Since: 1.0
-->
<property name="UnlockRequired" type="u" access="read" />
@@ -480,6 +552,8 @@
before the code becomes blocked (requiring a PUK) or permanently blocked. Dictionary
entries exist only for the codes for which the modem is able to report retry
counts.
+
+ Since: 1.0
-->
<property name="UnlockRetries" type="a{uu}" access="read" />
@@ -492,6 +566,8 @@
If the device's state cannot be determined,
<link linkend="MM-MODEM-STATE-UNKNOWN:CAPS"><constant>MM_MODEM_STATE_UNKNOWN</constant></link>
will be reported.
+
+ Since: 1.0
-->
<property name="State" type="i" access="read" />
@@ -502,6 +578,8 @@
<link linkend="MM-MODEM-STATE-FAILED:CAPS"><constant>MM_MODEM_STATE_FAILED</constant></link>
state, given as a
<link linkend="MMModemStateFailedReason">MMModemStateFailedReason</link> value.
+
+ Since: 1.0
-->
<property name="StateFailedReason" type="u" access="read" />
@@ -515,6 +593,8 @@
If the device's access technology cannot be determined,
<link linkend="MM-MODEM-ACCESS-TECHNOLOGY-UNKNOWN:CAPS"><constant>MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN</constant></link>
will be reported.
+
+ Since: 1.0
-->
<property name="AccessTechnologies" type="u" access="read" />
@@ -527,6 +607,8 @@
The additional boolean value indicates if the quality value given was
recently taken.
+
+ Since: 1.0
-->
<property name="SignalQuality" type="(ub)" access="read" />
@@ -535,6 +617,8 @@
List of numbers (e.g. MSISDN in 3GPP) being currently handled by this
modem.
+
+ Since: 1.0
-->
<property name="OwnNumbers" type="as" access="read" />
@@ -543,6 +627,8 @@
A <link linkend="MMModemPowerState">MMModemPowerState</link> value
specifying the current power state of the modem.
+
+ Since: 1.0
-->
<property name="PowerState" type="u" access="read" />
@@ -566,6 +652,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.0
-->
<property name="SupportedModes" type="a(uu)" access="read" />
@@ -579,6 +667,8 @@
The pair must be one of those specified in
#org.freedesktop.ModemManager1.Modem:SupportedModes.
+
+ Since: 1.0
-->
<property name="CurrentModes" type="(uu)" access="read" />
@@ -592,6 +682,8 @@
For POTS devices, only the
<link linkend="MM-MODEM-BAND-ANY:CAPS"><constant>MM_MODEM_BAND_ANY</constant></link>
mode will be returned.
+
+ Since: 1.0
-->
<property name="SupportedBands" type="au" access="read" />
@@ -603,6 +695,8 @@
currently using when connecting to a network.
It must be a subset of #org.freedesktop.ModemManager1.Modem:SupportedBands.
+
+ Since: 1.0
-->
<property name="CurrentBands" type="au" access="read" />
@@ -611,6 +705,8 @@
Bitmask of <link linkend="MMBearerIpFamily">MMBearerIpFamily</link> values,
specifying the IP families supported by the device.
+
+ Since: 1.0
-->
<property name="SupportedIpFamilies" type="u" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Sim.xml b/introspection/org.freedesktop.ModemManager1.Sim.xml
index d4943b04..3008aaf2 100644
--- a/introspection/org.freedesktop.ModemManager1.Sim.xml
+++ b/introspection/org.freedesktop.ModemManager1.Sim.xml
@@ -24,6 +24,8 @@
@pin: A string containing the PIN code.
Send the PIN to unlock the SIM card.
+
+ Since: 1.0
-->
<method name="SendPin">
<arg name="pin" type="s" direction="in" />
@@ -35,6 +37,8 @@
@pin: A string containing the PIN code.
Send the PUK and a new PIN to unlock the SIM card.
+
+ Since: 1.0
-->
<method name="SendPuk">
<arg name="puk" type="s" direction="in" />
@@ -47,6 +51,8 @@
@enabled: %TRUE to enable PIN checking, %FALSE otherwise.
Enable or disable the PIN checking.
+
+ Since: 1.0
-->
<method name="EnablePin">
<arg name="pin" type="s" direction="in" />
@@ -59,6 +65,8 @@
@new_pin: A string containing the new PIN code.
Change the PIN code.
+
+ Since: 1.0
-->
<method name="ChangePin">
<arg name="old_pin" type="s" direction="in" />
@@ -78,6 +86,8 @@
that even if this operation fails, the preferred network list on the SIM card may
have changed. Read the <link linkend="gdbus-property-org-freedesktop-ModemManager1-Sim.PreferredNetworks">
PreferredNetworks</link> property to get the up-to-date list.
+
+ Since: 1.18
-->
<method name="SetPreferredNetworks">
<arg name="preferred_networks" type="a(su)" direction="in" />
@@ -93,6 +103,8 @@
On systems that support Multi SIM Multi Standby, more than one SIM may
be active at any given time, but only one of them is considered primary.
+
+ Since: 1.16
-->
<property name="Active" type="b" access="read" />
@@ -103,6 +115,8 @@
This may be available before the PIN has been entered depending
on the device itself.
+
+ Since: 1.0
-->
<property name="SimIdentifier" type="s" access="read" />
@@ -110,6 +124,8 @@
Imsi:
The IMSI of the SIM card, if any.
+
+ Since: 1.0
-->
<property name="Imsi" type="s" access="read" />
@@ -117,6 +133,8 @@
Eid:
The EID of the SIM card, if any.
+
+ Since: 1.16
-->
<property name="Eid" type="s" access="read" />
@@ -125,6 +143,8 @@
The ID of the network operator that issued the SIM card,
formatted as a 5 or 6-digit MCC/MNC code (e.g. <literal>"310410"</literal>).
+
+ Since: 1.0
-->
<property name="OperatorIdentifier" type="s" access="read" />
@@ -132,6 +152,8 @@
OperatorName:
The name of the network operator, as given by the SIM card, if known.
+
+ Since: 1.0
-->
<property name="OperatorName" type="s" access="read" />
@@ -142,6 +164,8 @@
These numbers should be treated as numbers for emergency calls in
addition to 112 and 911.
+
+ Since: 1.12
-->
<property name="EmergencyNumbers" type="as" access="read" />
@@ -156,6 +180,8 @@
If the SIM card does not support access technology storage, the mask will be
set to <link linkend="MM-MODEM-ACCESS-TECHNOLOGY-UNKNOWN:CAPS">
MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN</link>.
+
+ Since: 1.18
-->
<property name="PreferredNetworks" type="a(su)" access="read" />
diff --git a/introspection/org.freedesktop.ModemManager1.Sms.xml b/introspection/org.freedesktop.ModemManager1.Sms.xml
index 91df019d..c615d566 100644
--- a/introspection/org.freedesktop.ModemManager1.Sms.xml
+++ b/introspection/org.freedesktop.ModemManager1.Sms.xml
@@ -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" />
diff --git a/introspection/org.freedesktop.ModemManager1.xml b/introspection/org.freedesktop.ModemManager1.xml
index e9ec032d..e80e0cd3 100644
--- a/introspection/org.freedesktop.ModemManager1.xml
+++ b/introspection/org.freedesktop.ModemManager1.xml
@@ -24,6 +24,8 @@
ScanDevices:
Start a new scan for connected modem devices.
+
+ Since: 1.0
-->
<method name="ScanDevices" />
@@ -32,6 +34,8 @@
@level: One of <literal>"ERR"</literal>, <literal>"WARN"</literal>, <literal>"INFO"</literal>, <literal>"DEBUG"</literal>.
Set logging verbosity.
+
+ Since: 1.0
-->
<method name="SetLogging">
<arg name="level" type="s" direction="in" />
@@ -101,6 +105,8 @@
</listitem>
</varlistentry>
</variablelist>
+
+ Since: 1.8
-->
<method name="ReportKernelEvent">
<arg name="properties" type="a{sv}" direction="in" />
@@ -121,6 +127,8 @@
This operation binds the inhibition request to the existence of the
caller in the DBus bus. If the caller disappears from the bus, the
inhibition will automatically removed.
+
+ Since: 1.10
-->
<method name="InhibitDevice">
<arg name="uid" type="s" direction="in" />
@@ -131,6 +139,8 @@
Version:
The runtime version of the ModemManager daemon.
+
+ Since: 1.10
-->
<property name="Version" type="s" access="read" />