SymbX/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api,dbus: rewrite Methods, Properties and Signals for gdbus-codegen

Browse Source
This commit is contained in:
Aleksander Morgado
2012-03-15 14:14:17 +01:00
parent 793c65705f
commit 8763576a34
13 changed files with 1749 additions and 1231 deletions
Download Patch File Download Diff File Expand all files Collapse all files
new/org.freedesktop.ModemManager1.Modem.3gpp.xml
+123 -82
View File
@@ -1,101 +1,142 @@
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<!--
ModemManager 0.6 Interface Specification
Copyright (C) 2008 Novell, Inc.
Copyright (C) 2008-2011 Red Hat, Inc.
Copyright (C) 2011 The Chromium OS Authors
Copyright (C) 2011 Google, Inc.
-->
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.freedesktop.ModemManager1.Modem.3gpp:
@short_description: The ModemManager 3GPP interface.
This interface provides access to specific actions that may be performed
in modems with 3GPP capabilities.
-->
<interface name="org.freedesktop.ModemManager1.Modem.3gpp">
<!-- METHODS -->
<!--
Register:
@network_id: The network 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.
-->
<method name="Register">
<tp:docstring>
Request registration with a given mobile network.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_3gpp_modem_register"/>
<arg name="network_id" type="s" direction="in">
<tp:docstring>
The network ID (ie, MCC-MNC, like "310260") to register. An empty
string can be used to register to the home network.
</tp:docstring>
</arg>
<arg name="network_id" type="s" direction="in" />
</method>
<method name="Scan">
<tp:docstring>
Scan for available networks.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_3gpp_modem_scan"/>
<arg name="results" type="aa{sv}" direction="out">
<tp:docstring>
<p>Found networks. It's an array of dictionaries (strings for both
keys and values) with each array element describing a mobile network
found in the scan. Each dict may include one or more of the following
keys:</p>
<ul>
<li>
"status": a number representing network availability status as
defined in 3GPP TS 27.007 section 7.3. e.g. "0" (unknown), "1"
(available), "2" (current), or "3" (forbidden). This key will
<!--
Scan:
@results: Array of dictionaries wih the found networks.
Scan for available networks.
@results is an array of dictionaries with each array element describing
a mobile network found in the scan. Each dictionary may include one or
more of the following keys:
<variablelist>
<varlistentry><term><literal>"status"</literal></term>
<listitem>
A <link linkend="MMModem3gppNetworkAvailability">MMModem3gppNetworkAvailability</link>
value representing network availability status, given as an
unsigned integer (signature <literal>"u"</literal>). This key will
always be present.
</li>
<li>
"operator-long": long-format name of operator. If the name is
unknown, this field should not be present.
</li>
<li>
"operator-short": short-format name of operator. If the name is
unknown, this field should not be present.
</li>
<li>
"operator-num": mobile code of the operator. Returned in the
format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile
Country Code and MNC is the two- or three-digit GSM Mobile
Network Code. e.g. "31026" or "310260".
</li>
<li>
"access-tech": a number representing the generic access technology
used by this mobile network, defined by the MM_MODEM_ACCESS_TECH
enum.
</li>
</ul>
</tp:docstring>
</arg>
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-long"</literal></term>
<listitem>
Long-format name of operator, given as a string value (signature
<literal>"s"</literal>). If the name is unknown, this field
should not be present.
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-short"</literal></term>
<listitem>
Short-format name of operator, given as a string value (signature
<literal>"s"</literal>). If the name is unknown, this field
should not be present.
</listitem>
</varlistentry>
<varlistentry><term><literal>"operator-num"</literal></term>
<listitem>
Mobile code of the operator, given as a string value (signature
<literal>"s"</literal>). Returned in the format
<literal>"MCCMNC"</literal>, where <literal>MCC</literal> is the
three-digit ITU E.212 Mobile Country Code and <literal>MNC</literal>
is the two- or three-digit GSM Mobile Network Code. e.g.
<literal>"31026"</literal> or <literal>"310260"</literal>.
</listitem>
</varlistentry>
<varlistentry><term><literal>"access-tech"</literal></term>
<listitem>
A <link linkend="MMModemAccessTech">MMModemAccessTech</link> value
representing the generic access technology used by this mobile network,
given as an unsigned integer (signature <literal>"u"</literal>).
</listitem>
</varlistentry>
</variablelist>
-->
<method name="Scan">
<arg name="results" type="aa{sv}" direction="out" />
</method>
<!-- PROPERTIES -->
<!--
Imei:
<property name="Imei" type="s" access="read">
<tp:docstring>
The IMEI of the device.
</tp:docstring>
</property>
The <ulink url="http://en.wikipedia.org/wiki/Imei">IMEI</ulink> of the device.
-->
<property name="Imei" type="s" access="read" />
<property name="RegistrationState" type="u" access="read" tp:type="MM_MODEM_3GPP_REGISTRATION_STATE">
<tp:docstring>
Mobile registration status as defined in 3GPP TS 27.007 section
10.1.19.
</tp:docstring>
</property>
<!--
RegistrationState:
<property name="OperatorCode" type="s" access="read">
<tp:docstring>
Current operator code of the operator to which the mobile is
currently registered. Returned in the format "MCCMNC", where MCC
is the three-digit ITU E.212 Mobile Country Code and MNC is the
two- or three-digit GSM Mobile Network Code (e.g. "31026" or "310260").
If the MCC and MNC are not known or the mobile is not registered to a
mobile network, this property will be a zero-length (blank) string.
</tp:docstring>
</property>
A <link linkend="MMModem3gppRegistrationState">MMModem3gppRegistrationState</link>
value specifying the mobile registration status as defined in 3GPP TS 27.007
section 10.1.19.
-->
<property name="RegistrationState" type="u" access="read" />
<property name="OperatorName" type="s" access="read">
<tp:docstring>
Current operator name of the operator to which the mobile is
currently registered. If the operator name is not knowon or the
mobile is not registered to a mobile network, this property will
<!--
OperatorCode:
Current operator code of the operator to which the mobile is currently
registered.
Returned in the format <literal>"MCCMNC"</literal>, where
<literal>MCC</literal> is the three-digit ITU E.212 Mobile Country Code
and <literal>MNC</literal> is the two- or three-digit GSM Mobile Network
Code. e.g. e<literal>"31026"</literal> or <literal>"310260"</literal>.
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.
</tp:docstring>
</property>
-->
<property name="OperatorCode" type="s" access="read" />
<!--
OperatorName:
Current operator name of the operator to which the mobile is
currently registered.
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.
-->
<property name="OperatorName" type="s" access="read" />
<!--
EnabledFacilityLocks:
Bitmask of <link linkend="MMModem3gppFacility">MMModem3gppFacility</link> values
for which PIN locking is enabled.
-->
<property name="EnabledFacilityLocks" type="u" access="read" />
<!-- ENUMS -->