api,dbus: improve GetStatus() documentation in the Simple interface

* We will also return 'registration-state' in 3GPP networks
* Specified that 'operator-code' and 'operator-name' are only set if
  registered in a 3GPP network.
This commit is contained in:
Aleksander Morgado
2011-12-28 13:58:16 +01:00
parent 111cd56a2b
commit ba1a448717

View File

@@ -139,15 +139,23 @@
(signature <literal>"u"</literal>). (signature <literal>"u"</literal>).
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term><literal>"registration-state"</literal></term>
<listitem>
A <link linkend="MMModem3gppRegistrationState">MMModem3gppRegistrationState</link> value
specifying the state of the registration,given only when registered
in a 3GPP network, as an unsigned integer value (signature
<literal>"u"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-code"</literal></term> <varlistentry><term><literal>"operator-code"</literal></term>
<listitem> <listitem>
Operator <literal>MCC-MNC</literal>, given only when registered, Operator <literal>MCC-MNC</literal>, given only when registered
as a string value (signature <literal>"s"</literal>). in a 3GPP network, as a string value (signature <literal>"s"</literal>).
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term><literal>"operator-name"</literal></term> <varlistentry><term><literal>"operator-name"</literal></term>
<listitem> <listitem>
Operator name, given only when registered, Operator name, given only when registered in a 3GPP network,
as a string value (signature <literal>"s"</literal>). as a string value (signature <literal>"s"</literal>).
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -155,7 +163,7 @@
<listitem> <listitem>
List of <link linkend="MMModemBand">MMModemBand</link> values, List of <link linkend="MMModemBand">MMModemBand</link> values,
given only when registered, as a list of given only when registered, as a list of
unsigned integer value (signature <literal>"au"</literal>). unsigned integer values (signature <literal>"au"</literal>).
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry><term><literal>"access-technology"</literal></term> <varlistentry><term><literal>"access-technology"</literal></term>
@@ -166,12 +174,6 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
FIXME:
Either convert this to properties (which duplicate properties
of the base modem object already) or expand the returned property
list to include "registration" and add a StatusChanged signal so
clients can monitor changes without having to poll.
--> -->
<method name="GetStatus"> <method name="GetStatus">
<arg name="properties" type="a{sv}" direction="out" /> <arg name="properties" type="a{sv}" direction="out" />