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

api: refine new API based on suggestions from Eric Shienbrood

Browse Source
This commit is contained in:
Dan Williams
2011-08-01 17:47:38 -05:00
parent e0eb7038af
commit 18231c9f8d
4 changed files with 80 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
new/org.freedesktop.ModemManager1.Modem.Bearer.xml
View File

@@ -20,7 +20,11 @@
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_bearer_connect"/>
<arg name="number" type="s" direction="in">
<tp:docstring>
The number to use for dialing.
The number to use for dialing (optional). Usually not required, in
which case it should be an empty (zero-length) string. Only required
for POTS connections or in certain special circumstances. If a number
is given for 3GPP (GSM/UMTS/LTE) based devices, it is always ignored,
as the number is generated internally if one is required at all.
</tp:docstring>
</arg>
</method>

45
new/org.freedesktop.ModemManager1.Modem.Contacts.xml
View File

@@ -3,6 +3,15 @@
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.ModemManager1.Modem.Contacts">
<tp:docstring>
This interface provides access to contacts stored in various locations,
including SIM cards, device storage, and other locations. Operations
generally operate on all contacts regardless of their actual storage
location. Contacts are referred to by index numbers, which are internal
to ModemManager and do not represent indexs of SIM cards or the device.
Indexes may not be contiguous.
</tp:docstring>
<method name="Add">
<tp:docstring>
Add a new contact.
@@ -50,7 +59,7 @@
<method name="Get">
<tp:docstring>
Retrieve a contact from the SIM card.
Retrieve a contact.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_get"/>
@@ -82,7 +91,7 @@
<method name="Find">
<tp:docstring>
Find a contact from the SIM card.
Find a contact.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_find"/>
@@ -101,7 +110,7 @@
<method name="GetCount">
<tp:docstring>
Get the number of contacts stored on the SIM card.
Get the number of contacts.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_contacts_count"/>
@@ -112,6 +121,36 @@
</arg>
</method>
<!-- SIGNALS -->
<signal name="Added">
<tp:docstring>
Emitted when a new contact is added.
</tp:docstring>
<arg name="index" type="u">
<tp:docstring>
The index number of the new contact.
</tp:docstring>
</arg>
<arg name="properties" type="a{sv}">
<tp:docstring>
The properties of the contact including those properties defined by
the Add method.
</tp:docstring>
</arg>
</signal>
<signal name="Deleted">
<tp:docstring>
Emitted when a contact has been deleted.
</tp:docstring>
<arg name="index" type="u">
<tp:docstring>
Index number of the now deleted contact.
</tp:docstring>
</arg>
</signal>
<!-- ENUMS -->
<tp:enum name="MM_MODEM_CONTACTS_STORAGE" type="u">

26
new/org.freedesktop.ModemManager1.Modem.xml
View File

@@ -60,6 +60,11 @@
** FIXME: how about QoS?
</tp:docstring>
</arg>
<arg name="path" type="o" direction="out">
<tp:docstring>
On success, the object path of the newly created bearer.
</tp:docstring>
</arg>
</method>
<method name="DeleteBearer">
@@ -252,28 +257,30 @@
<property name="AllowedMode" type="u" access="readwrite" tp:type="MM_MODEM_ALLOWED_MODE">
<tp:docstring>
The allowed access technologies (eg 2G/3G/4G preference) the device is
allowed to use when connecting to a network. For POTS devices, only
the "any" mode is supported.
currently allowed to use when connecting to a network. For POTS
devices, only the "any" mode is supported.
</tp:docstring>
</property>
<property name="SupportedModes" type="u" access="read" tp:type="MM_MODEM_ALLOWED_MODE">
<tp:docstring>
Access technology selection modes supported by the device.
Access technology selection modes supported by the device. For POTS
devices, only the "any" mode will be returned.
</tp:docstring>
</property>
<property name="AllowedBands" type="t" access="readwrite" tp:type="MM_MODEM_BAND">
<tp:docstring>
The allowed radio frequency and technology bands the device may use when
The allowed radio frequency and technology bands the device is currently
allowed to use when connecting to a network. For POTS devices, only
the "any" mode is supported.
the "any" value is supported.
</tp:docstring>
</property>
<property name="SupportedBands" type="t" access="read" tp:type="MM_MODEM_BAND">
<tp:docstring>
Radio frequency and technology bands supported by the device.
Radio frequency and technology bands supported by the device. For POTS
devices, only the "any" value will be returned.
</tp:docstring>
</property>
@@ -307,7 +314,12 @@
</tp:flag>
<tp:flag suffix="LTE" value="0x8">
<tp:docstring>
Modem has at LTE data capability.
Modem has LTE data capability.
</tp:docstring>
</tp:flag>
<tp:flag suffix="LTE_ADVANCED" value="0x10">
<tp:docstring>
Modem has LTE Advanced data capability.
</tp:docstring>
</tp:flag>
</tp:flags>

15
new/org.freedesktop.ModemManager1.Sim.xml
View File

@@ -27,13 +27,26 @@
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_sim_get_operator_id"/>
<arg name="imsi" type="s" direction="out">
<arg name="operator_id" type="s" direction="out">
<tp:docstring>
The operator ID formatted as an MCC/MNC code.
</tp:docstring>
</arg>
</method>
<method name="GetOperatorName">
<tp:docstring>
Returns the name of the operator as given by the SIM card, if known.
</tp:docstring>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_sim_get_operator_name"/>
<arg name="operator_name" type="s" direction="out">
<tp:docstring>
The operator name.
</tp:docstring>
</arg>
</method>
<method name="SendPuk">
<tp:docstring>
Send the PUK and a new PIN to unlock the SIM card.