WikiStart: spec.html

File spec.html, 32.7 kB (added by pmarti@…, 2 years ago)

ModemManager? DBus API v0.1

Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>ModemManager D-Bus Interface Specification version 0.1</title><style type="text/css">
3
4          body {
5            font-family: sans-serif;
6            margin: 2em;
7            height: 100%;
8            font-size: 1.2em;
9          }
10          h1 {
11            padding-top: 5px;
12            padding-bottom: 5px;
13            font-size: 1.6em;
14            background: #dadae2;
15          }
16          h2 {
17            font-size: 1.3em;
18          }
19          h3 {
20            font-size: 1.2em;
21          }
22          a:link, a:visited, a:link:hover, a:visited:hover {
23            font-weight: bold;
24          }
25          .topbox {
26            padding-top: 10px;
27            padding-left: 10px;
28            border-bottom: black solid 1px;
29            padding-bottom: 10px;
30            background: #dadae2;
31            font-size: 2em;
32            font-weight: bold;
33            color: #5c5c5c;
34          }
35          .topnavbox {
36            padding-left: 10px;
37            padding-top: 5px;
38            padding-bottom: 5px;
39            background: #abacba;
40            border-bottom: black solid 1px;
41            font-size: 1.2em;
42          }
43          .topnavbox a{
44            color: black;
45            font-weight: normal;
46          }
47          .sidebar {
48            float: left;
49            /* width:9em;
50            border-right:#abacba solid 1px;
51            border-left: #abacba solid 1px;
52            height:100%; */
53            border: #abacba solid 1px;
54            padding-left: 10px;
55            margin-left: 10px;
56            padding-right: 10px;
57            margin-right: 10px;
58            color: #5d5d5d;
59            background: #dadae2;
60          }
61          .sidebar a {
62            text-decoration: none;
63            border-bottom: #e29625 dotted 1px;
64            color: #e29625;
65            font-weight: normal;
66          }
67          .sidebar h1 {
68            font-size: 1.2em;
69            color: black;
70          }
71          .sidebar ul {
72            padding-left: 25px;
73            padding-bottom: 10px;
74            border-bottom: #abacba solid 1px;
75          }
76          .sidebar li {
77            padding-top: 2px;
78            padding-bottom: 2px;
79          }
80          .sidebar h2 {
81            font-style:italic;
82            font-size: 0.81em;
83            padding-left: 5px;
84            padding-right: 5px;
85            font-weight: normal;
86          }
87          .date {
88            font-size: 0.6em;
89            float: right;
90            font-style: italic;
91          }
92          .method {
93            margin-left: 1em;
94            margin-right: 4em;
95          }
96          .signal {
97            margin-left: 1em;
98            margin-right: 4em;
99          }
100
101        </style></head><body><h1 class="topbox">ModemManager D-Bus Interface Specification</h1><h2>Version 0.1</h2><div>Copyright (C) 2008 Novell, Inc.</div><div class="license">
102    <p>This program is free software; you can redistribute it and/or modify
103      it under the terms of the GNU General Public License as published by
104      the Free Software Foundation; either version 2 of the License, or
105      (at your option) any later version.</p>
106
107    <p>This program is distributed in the hope that it will be useful,
108      but WITHOUT ANY WARRANTY; without even the implied warranty of
109      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
110      General Public License for more details.</p>
111
112    <p>You should have received a copy of the GNU Lesser General Public
113      License along with this library; if not, write to the Free Software
114      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
115  </div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.ModemManager">org.freedesktop.ModemManager</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem">org.freedesktop.ModemManager.Modem</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Cdma">org.freedesktop.ModemManager.Modem.Cdma</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Card">org.freedesktop.ModemManager.Modem.Gsm.Card</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Contacts">org.freedesktop.ModemManager.Modem.Gsm.Contacts</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Network">org.freedesktop.ModemManager.Modem.Gsm.Network</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.SMS">org.freedesktop.ModemManager.Modem.Gsm.SMS</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Hso">org.freedesktop.ModemManager.Modem.Gsm.Hso</a></code></li></ul>
116  <h1><a name="org.freedesktop.ModemManager" id="org.freedesktop.ModemManager"></a>org.freedesktop.ModemManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.EnumerateDevices" id="org.freedesktop.ModemManager.EnumerateDevices">EnumerateDevices</a> (
117       
118        ) &#8594;
119        ao</h3><div class="docstring">
120        Get the list of modem devices.
121      </div><div><h4>Returns</h4><dl><dt><code>devices</code> -
122      <code>ao</code></dt><dd>
123          List of object paths of modem devices known to the system.
124        </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.ModemManager.DeviceAdded" id="org.freedesktop.ModemManager.DeviceAdded">DeviceAdded</a> (
125        o: device
126        )</h3><div class="docstring">
127        A device was added to the system.
128      </div><div><h4>Parameters</h4><dl><dt><code>device</code> -
129      <code>o</code></dt><dd>
130          The object path of the newly added device.
131        </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.ModemManager.DeviceRemoved" id="org.freedesktop.ModemManager.DeviceRemoved">DeviceRemoved</a> (
132        o: device
133        )</h3><div class="docstring">
134        A device was removed from the system, and is no longer available.
135      </div><div><h4>Parameters</h4><dl><dt><code>device</code> -
136      <code>o</code></dt><dd>
137          The object path of the device that was just removed.
138        </dd></dl></div></div><p>Interface has no properties.</p>
139
140  <h1><a name="org.freedesktop.ModemManager.Modem" id="org.freedesktop.ModemManager.Modem"></a>org.freedesktop.ModemManager.Modem</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Enable" id="org.freedesktop.ModemManager.Modem.Enable">Enable</a> (
141        b: enable
142        ) &#8594;
143        nothing</h3><div class="docstring">
144        Enable the device. Initializes the modem.
145      </div><div><h4>Parameters</h4><dl><dt><code>enable</code> -
146      <code>b</code></dt><dd>
147          True to enable the device, False to disable.
148        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Connect" id="org.freedesktop.ModemManager.Modem.Connect">Connect</a> (
149        s: number
150        ) &#8594;
151        nothing</h3><div class="docstring">
152        Dial in.
153      </div><div><h4>Parameters</h4><dl><dt><code>number</code> -
154      <code>s</code></dt><dd>
155          The number to use for dialing.
156      </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Disconnect" id="org.freedesktop.ModemManager.Modem.Disconnect">Disconnect</a> (
157       
158        ) &#8594;
159        nothing</h3><div class="docstring">
160        Disconnect modem.
161      </div></div><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>DataDevice</code> -
162      <code>s</code> -
163      <code>(read)</code></dt><dd>
164        The serial device which can be used to start pppd.
165      </dd><dt><code>Driver</code> -
166      <code>s</code> -
167      <code>(read)</code></dt><dd>
168        The driver handling the device.
169      </dd><dt><code>Type</code> -
170      <code>u</code> -
171      <code>(read)</code>
172      (<a xmlns="" href="#type-MM_MODEM_TYPE">MM_MODEM_TYPE</a>)
173    </dt><dd>
174        The modem type.
175      </dd></dl><h2>Enumerated types:</h2><h3><a name="type-MM_MODEM_TYPE" id="type-MM_MODEM_TYPE">MM_MODEM_TYPE</a></h3><dl><dt><code>MM_MODEM_TYPE_GSM = 1</code></dt><dd>
176          A GSM device.
177        </dd><dt><code>MM_MODEM_TYPE_CDMA = 2</code></dt><dd>
178          A CDMA device.
179        </dd></dl>
180
181  <h1><a name="org.freedesktop.ModemManager.Modem.Cdma" id="org.freedesktop.ModemManager.Modem.Cdma"></a>org.freedesktop.ModemManager.Modem.Cdma</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Cdma.GetSignalQuality" id="org.freedesktop.ModemManager.Modem.Cdma.GetSignalQuality">GetSignalQuality</a> (
182       
183        ) &#8594;
184        u</h3><div class="docstring">
185        Get the current signal quality.
186      </div><div><h4>Returns</h4><dl><dt><code>quality</code> -
187      <code>u</code></dt><dd>
188          Signal quality (percent).
189        </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.ModemManager.Modem.Cdma.SignalQuality" id="org.freedesktop.ModemManager.Modem.Cdma.SignalQuality">SignalQuality</a> (
190        u: quality
191        )</h3><div class="docstring">
192        The signal quality changed.
193      </div><div><h4>Parameters</h4><dl><dt><code>quality</code> -
194      <code>u</code></dt><dd>
195          The new quality in percent, 0..100.
196        </dd></dl></div></div><p>Interface has no properties.</p>
197
198  <h1><a name="org.freedesktop.ModemManager.Modem.Gsm.Card" id="org.freedesktop.ModemManager.Modem.Gsm.Card"></a>org.freedesktop.ModemManager.Modem.Gsm.Card</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.GetImei" id="org.freedesktop.ModemManager.Modem.Gsm.Card.GetImei">GetImei</a> (
199       
200        ) &#8594;
201        s</h3><div class="docstring">
202        Get the IMEI of the SIM card.
203      </div><div><h4>Returns</h4><dl><dt><code>imei</code> -
204      <code>s</code></dt><dd>
205          The IMEI.
206        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.GetImsi" id="org.freedesktop.ModemManager.Modem.Gsm.Card.GetImsi">GetImsi</a> (
207       
208        ) &#8594;
209        s</h3><div class="docstring">
210        Get the IMSI of the SIM card.
211      </div><div><h4>Returns</h4><dl><dt><code>imsi</code> -
212      <code>s</code></dt><dd>
213          The IMSI.
214        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.GetInfo" id="org.freedesktop.ModemManager.Modem.Gsm.Card.GetInfo">GetInfo</a> (
215       
216        ) &#8594;
217        s, s, s</h3><div class="docstring">
218        Get the card information (manufacturer, modem, version).
219      </div><div><h4>Returns</h4><dl><dt><code>manufacturer</code> -
220      <code>s</code></dt><dd>
221          The manufacturer of the card.
222        </dd><dt><code>modem</code> -
223      <code>s</code></dt><dd>
224          The model of the card.
225        </dd><dt><code>version</code> -
226      <code>s</code></dt><dd>
227          The version (revision) of the card.
228        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.SendPin" id="org.freedesktop.ModemManager.Modem.Gsm.Card.SendPin">SendPin</a> (
229        s: pin
230        ) &#8594;
231        nothing</h3><div class="docstring">
232        Send the PIN (or PUK) to unlock the SIM card.
233      </div><div><h4>Parameters</h4><dl><dt><code>pin</code> -
234      <code>s</code></dt><dd>
235          The PIN code.
236        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.EnablePin" id="org.freedesktop.ModemManager.Modem.Gsm.Card.EnablePin">EnablePin</a> (
237        s: pin, b: enabled
238        ) &#8594;
239        nothing</h3><div class="docstring">
240        Enable or disable the PIN checking.
241      </div><div><h4>Parameters</h4><dl><dt><code>pin</code> -
242      <code>s</code></dt><dd>
243          The PIN code.
244        </dd><dt><code>enabled</code> -
245      <code>b</code></dt><dd>
246          True to enable PIN checking.
247        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Card.ChangePin" id="org.freedesktop.ModemManager.Modem.Gsm.Card.ChangePin">ChangePin</a> (
248        s: old_pin, s: new_pin
249        ) &#8594;
250        nothing</h3><div class="docstring">
251        Change the PIN code.
252      </div><div><h4>Parameters</h4><dl><dt><code>old_pin</code> -
253      <code>s</code></dt><dd>
254          The current PIN code.
255        </dd><dt><code>new_pin</code> -
256      <code>s</code></dt><dd>
257          The new PIN code.
258        </dd></dl></div></div><p>Interface has no signals.</p><p>Interface has no properties.</p>
259
260  <h1><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts"></a>org.freedesktop.ModemManager.Modem.Gsm.Contacts</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Add" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Add">Add</a> (
261        s: name, s: number
262        ) &#8594;
263        u</h3><div class="docstring">
264        Add a new contact to the SIM card.
265      </div><div><h4>Parameters</h4><dl><dt><code>name</code> -
266      <code>s</code></dt><dd>
267          The name of the contact.
268        </dd><dt><code>number</code> -
269      <code>s</code></dt><dd>
270          The phone number of the contact.
271        </dd></dl></div><div><h4>Returns</h4><dl><dt><code>index</code> -
272      <code>u</code></dt><dd>
273          The index of the new contact.
274        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Delete" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Delete">Delete</a> (
275        u: index
276        ) &#8594;
277        nothing</h3><div class="docstring">
278        Delete a contact from the SIM card.
279      </div><div><h4>Parameters</h4><dl><dt><code>index</code> -
280      <code>u</code></dt><dd>
281          The index of the contact.
282        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Get" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Get">Get</a> (
283        u: index
284        ) &#8594;
285        u, s, s</h3><div class="docstring">
286        Retrieve a contact from the SIM card.
287      </div><div><h4>Parameters</h4><dl><dt><code>index</code> -
288      <code>u</code></dt><dd>
289          The index of the contact.
290        </dd></dl></div><div><h4>Returns</h4><dl><dt><code>found_index</code> -
291      <code>u</code></dt><dd>
292          The index of the contact (same as the passed index).
293        </dd><dt><code>name</code> -
294      <code>s</code></dt><dd>
295          The name of the contact.
296        </dd><dt><code>number</code> -
297      <code>s</code></dt><dd>
298          The number of the contact.
299        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.List" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.List">List</a> (
300       
301        ) &#8594;
302        a(uss)</h3><div class="docstring">
303        List all contacts on the SIM card.
304      </div><div><h4>Returns</h4><dl><dt><code>results</code> -
305      <code>a(uss)</code></dt><dd>
306          The list of contacts where each contact has an index, name, and number.
307        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Find" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.Find">Find</a> (
308        s: pattern
309        ) &#8594;
310        a(uss)</h3><div class="docstring">
311        Find a contact from the SIM card.
312      </div><div><h4>Parameters</h4><dl><dt><code>pattern</code> -
313      <code>s</code></dt><dd>
314          The pattern to search for.
315        </dd></dl></div><div><h4>Returns</h4><dl><dt><code>results</code> -
316      <code>a(uss)</code></dt><dd>
317          The list of matching contacts where a contact has an index, name, and number.
318        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Contacts.GetCount" id="org.freedesktop.ModemManager.Modem.Gsm.Contacts.GetCount">GetCount</a> (
319       
320        ) &#8594;
321        u</h3><div class="docstring">
322        Get the number of contacts stored on the SIM card.
323      </div><div><h4>Returns</h4><dl><dt><code>count</code> -
324      <code>u</code></dt><dd>
325          The number of contacts.
326        </dd></dl></div></div><p>Interface has no signals.</p><p>Interface has no properties.</p>
327
328  <h1><a name="org.freedesktop.ModemManager.Modem.Gsm.Network" id="org.freedesktop.ModemManager.Modem.Gsm.Network"></a>org.freedesktop.ModemManager.Modem.Gsm.Network</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.Register" id="org.freedesktop.ModemManager.Modem.Gsm.Network.Register">Register</a> (
329        s: network_id
330        ) &#8594;
331        nothing</h3><div class="docstring">
332        Register the device to network.
333      </div><div><h4>Parameters</h4><dl><dt><code>network_id</code> -
334      <code>s</code></dt><dd>
335          The network ID to register. An empty string can be used to register to the home network.
336        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.Scan" id="org.freedesktop.ModemManager.Modem.Gsm.Network.Scan">Scan</a> (
337       
338        ) &#8594;
339        aa{ss}</h3><div class="docstring">
340        Scan for available networks.
341      </div><div><h4>Returns</h4><dl><dt><code>results</code> -
342      <code>aa{ss}</code></dt><dd>
343          Found networks. It's an array of dictionaries (strings for keys and values), the list of known keys is the following: status, operator-long, operator-short, operator-num.
344        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.SetApn" id="org.freedesktop.ModemManager.Modem.Gsm.Network.SetApn">SetApn</a> (
345        s: apn
346        ) &#8594;
347        nothing</h3><div class="docstring">
348        Set the APN.
349      </div><div><h4>Parameters</h4><dl><dt><code>apn</code> -
350      <code>s</code></dt><dd>
351          The APN.
352        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.GetSignalQuality" id="org.freedesktop.ModemManager.Modem.Gsm.Network.GetSignalQuality">GetSignalQuality</a> (
353       
354        ) &#8594;
355        u</h3><div class="docstring">
356        Get the current signal quality.
357      </div><div><h4>Returns</h4><dl><dt><code>quality</code> -
358      <code>u</code></dt><dd>
359          Signal quality (percent).
360        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.SetBand" id="org.freedesktop.ModemManager.Modem.Gsm.Network.SetBand">SetBand</a> (
361        u: band
362        ) &#8594;
363        nothing</h3><div class="docstring">
364        Set the GSM band.
365      </div><div><h4>Parameters</h4><dl><dt><code>band</code> -
366      <code>u</code>
367      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_BAND">MM_MODEM_GSM_NETWORK_BAND</a>)
368    </dt><dd>
369          The band.
370        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.GetBand" id="org.freedesktop.ModemManager.Modem.Gsm.Network.GetBand">GetBand</a> (
371       
372        ) &#8594;
373        u</h3><div class="docstring">
374        Get the current band.
375      </div><div><h4>Returns</h4><dl><dt><code>band</code> -
376      <code>u</code>
377      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_BAND">MM_MODEM_GSM_NETWORK_BAND</a>)
378    </dt><dd>
379          The current band.
380        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.SetNetworkMode" id="org.freedesktop.ModemManager.Modem.Gsm.Network.SetNetworkMode">SetNetworkMode</a> (
381        u: mode
382        ) &#8594;
383        nothing</h3><div class="docstring">
384        Set the GSM network mode.
385      </div><div><h4>Parameters</h4><dl><dt><code>mode</code> -
386      <code>u</code>
387      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_MODE">MM_MODEM_GSM_NETWORK_MODE</a>)
388    </dt><dd>
389          The GSM network mode.
390        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.GetNetworkMode" id="org.freedesktop.ModemManager.Modem.Gsm.Network.GetNetworkMode">GetNetworkMode</a> (
391       
392        ) &#8594;
393        u</h3><div class="docstring">
394        Get the network mode.
395      </div><div><h4>Returns</h4><dl><dt><code>mode</code> -
396      <code>u</code>
397      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_MODE">MM_MODEM_GSM_NETWORK_MODE</a>)
398    </dt><dd>
399          The current network mode.
400        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.GetRegistrationInfo" id="org.freedesktop.ModemManager.Modem.Gsm.Network.GetRegistrationInfo">GetRegistrationInfo</a> (
401       
402        ) &#8594;
403        u, s, s</h3><div class="docstring">
404        Get the registration status and the current operator (if registered).
405      </div><div><h4>Returns</h4><dl><dt><code>status</code> -
406      <code>u</code>
407      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_REG_STATUS">MM_MODEM_GSM_NETWORK_REG_STATUS</a>)
408    </dt><dd>
409          The network status.
410        </dd><dt><code>operator_code</code> -
411      <code>s</code></dt><dd>
412          The current operator code.
413        </dd><dt><code>operator_name</code> -
414      <code>s</code></dt><dd>
415          The current operator name.
416        </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.SignalQuality" id="org.freedesktop.ModemManager.Modem.Gsm.Network.SignalQuality">SignalQuality</a> (
417        u: quality
418        )</h3><div class="docstring">
419        The signal quality changed.
420      </div><div><h4>Parameters</h4><dl><dt><code>quality</code> -
421      <code>u</code></dt><dd>
422          The new quality in percent, 0..100.
423        </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.RegistrationInfo" id="org.freedesktop.ModemManager.Modem.Gsm.Network.RegistrationInfo">RegistrationInfo</a> (
424        u: status, s: operator_code, s: operator_name
425        )</h3><div class="docstring">
426        The registration status changed.
427      </div><div><h4>Parameters</h4><dl><dt><code>status</code> -
428      <code>u</code>
429      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_REG_STATUS">MM_MODEM_GSM_NETWORK_REG_STATUS</a>)
430    </dt><dd>
431          The network status.
432        </dd><dt><code>operator_code</code> -
433      <code>s</code></dt><dd>
434          The current operator code.
435        </dd><dt><code>operator_name</code> -
436      <code>s</code></dt><dd>
437          The current operator name.
438        </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Network.NetworkMode" id="org.freedesktop.ModemManager.Modem.Gsm.Network.NetworkMode">NetworkMode</a> (
439        u: mode
440        )</h3><div class="docstring">
441        The network mode changed.
442      </div><div><h4>Parameters</h4><dl><dt><code>mode</code> -
443      <code>u</code>
444      (<a xmlns="" href="#type-MM_MODEM_GSM_NETWORK_MODE">MM_MODEM_GSM_NETWORK_MODE</a>)
445    </dt><dd>
446          The new network mode.
447        </dd></dl></div></div><p>Interface has no properties.</p><h2>Enumerated types:</h2><h3><a name="type-MM_MODEM_GSM_NETWORK_MODE" id="type-MM_MODEM_GSM_NETWORK_MODE">MM_MODEM_GSM_NETWORK_MODE</a></h3><dl><dt><code>MM_MODEM_GSM_NETWORK_MODE_ANY = 0</code></dt><dd>
448          Any network mode can be used.
449        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_GPRS = 1</code></dt><dd>
450          GPRS
451        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_EDGE = 2</code></dt><dd>
452          EDGE
453        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_3G = 3</code></dt><dd>
454          3G
455        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_HSDPA = 4</code></dt><dd>
456          HSDPA
457        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_PREFER_2G = 5</code></dt><dd>
458          Prefer 2G (GPRS or EDGE).
459        </dd><dt><code>MM_MODEM_GSM_NETWORK_MODE_PREFER_3G = 6</code></dt><dd>
460          Prefer 3G (3G or HSDPA).
461        </dd></dl><h3><a name="type-MM_MODEM_GSM_NETWORK_BAND" id="type-MM_MODEM_GSM_NETWORK_BAND">MM_MODEM_GSM_NETWORK_BAND</a></h3><dl><dt><code>MM_MODEM_GSM_NETWORK_BAND_ANY = 0</code></dt><dd>
462          Any band can be used.
463        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_EGSM = 1</code></dt><dd>
464          EGSM (900 MHz).
465        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_DCS = 2</code></dt><dd>
466          DCS (1800 MHz).
467        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_PCS = 4</code></dt><dd>
468          PCS (1900 MHz).
469        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_G850 = 8</code></dt><dd>
470          G850 (850 MHz).
471        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U2100 = 16</code></dt><dd>
472          U2100 (WCDMA 2100 MHz).
473        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U1700 = 32</code></dt><dd>
474          U1700 (WCDMA 3GPP UMTS1800 MHz).
475        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_17IV = 64</code></dt><dd>
476          17IV (WCDMA 3GPP AWS 1700/2100 MHz).
477        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U800 = 128</code></dt><dd>
478          U800 (WCDMA 3GPP UMTS800 MHz).
479        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U850 = 256</code></dt><dd>
480          U850 (WCDMA 3GPP UMTS850 MHz).
481        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U900 = 512</code></dt><dd>
482          U900 (WCDMA 3GPP UMTS900 MHz).
483        </dd><dt><code>MM_MODEM_GSM_NETWORK_BAND_U17IX = 1024</code></dt><dd>
484          U17IX (WCDMA 3GPP UMTS MHz).
485        </dd></dl><h3><a name="type-MM_MODEM_GSM_NETWORK_REG_STATUS" id="type-MM_MODEM_GSM_NETWORK_REG_STATUS">MM_MODEM_GSM_NETWORK_REG_STATUS</a></h3><dl><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_IDLE = 0</code></dt><dd>
486          Not registered, not searching for new operator to register.
487        </dd><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_HOME = 1</code></dt><dd>
488          Registered on home network.
489        </dd><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_SEARCHING = 2</code></dt><dd>
490          Not registered, searching for new operator to register with.
491        </dd><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_DENIED = 3</code></dt><dd>
492          Registration denied.
493        </dd><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_UNKNOWN = 4</code></dt><dd>
494          Unknown registration status.
495        </dd><dt><code>MM_MODEM_GSM_NETWORK_REG_STATUS_ROAMING = 5</code></dt><dd>
496          Registered on a roaming network.
497        </dd></dl>
498
499  <h1><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS" id="org.freedesktop.ModemManager.Modem.Gsm.SMS"></a>org.freedesktop.ModemManager.Modem.Gsm.SMS</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.Delete" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.Delete">Delete</a> (
500        u: index
501        ) &#8594;
502        nothing</h3><div class="docstring">
503        Delete an SMS message.
504      </div><div><h4>Parameters</h4><dl><dt><code>index</code> -
505      <code>u</code></dt><dd>
506          The index of the SMS.
507        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.Get" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.Get">Get</a> (
508        u: index
509        ) &#8594;
510        u, s, s, d</h3><div class="docstring">
511        Retrieve an SMS from the SIM card.
512      </div><div><h4>Parameters</h4><dl><dt><code>index</code> -
513      <code>u</code></dt><dd>
514          The index of the SMS.
515        </dd></dl></div><div><h4>Returns</h4><dl><dt><code>found_index</code> -
516      <code>u</code></dt><dd>
517          The index of the SMS (same as the passed index).
518        </dd><dt><code>number</code> -
519      <code>s</code></dt><dd>
520          The number the SMS was received from.
521        </dd><dt><code>contents</code> -
522      <code>s</code></dt><dd>
523          The contents of the SMS.
524        </dd><dt><code>time</code> -
525      <code>d</code></dt><dd>
526          The timestamp.
527        </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.GetFormat" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.GetFormat">GetFormat</a> (
528       
529        ) &#8594;
530        u</h3><div class="docstring"></div><div><h4>Returns</h4><dl><dt><code>result</code> -
531      <code>u</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetFormat" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetFormat">SetFormat</a> (
532        u: format
533        ) &#8594;
534        nothing</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>format</code> -
535      <code>u</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.GetSmsc" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.GetSmsc">GetSmsc</a> (
536       
537        ) &#8594;
538        s</h3><div class="docstring"></div><div><h4>Returns</h4><dl><dt><code>result</code> -
539      <code>s</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetSmsc" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetSmsc">SetSmsc</a> (
540        s: smsc
541        ) &#8594;
542        nothing</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>smsc</code> -
543      <code>s</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.List" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.List">List</a> (
544       
545        ) &#8594;
546        a(ussd)</h3><div class="docstring"></div><div><h4>Returns</h4><dl><dt><code>result</code> -
547      <code>a(ussd)</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.Save" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.Save">Save</a> (
548        s: number, s: contents
549        ) &#8594;
550        u</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>number</code> -
551      <code>s</code></dt><dd></dd><dt><code>contents</code> -
552      <code>s</code></dt><dd></dd></dl></div><div><h4>Returns</h4><dl><dt><code>index</code> -
553      <code>u</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.Send" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.Send">Send</a> (
554       
555        ) &#8594;
556        u</h3><div class="docstring"></div><div><h4>Returns</h4><dl><dt><code>result</code> -
557      <code>u</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.SendFromStorage" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.SendFromStorage">SendFromStorage</a> (
558        u: index
559        ) &#8594;
560        nothing</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>index</code> -
561      <code>u</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetIndication" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.SetIndication">SetIndication</a> (
562        u: mode, u: mt, u: bm, u: ds, u: bfr
563        ) &#8594;
564        nothing</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>mode</code> -
565      <code>u</code></dt><dd></dd><dt><code>mt</code> -
566      <code>u</code></dt><dd></dd><dt><code>bm</code> -
567      <code>u</code></dt><dd></dd><dt><code>ds</code> -
568      <code>u</code></dt><dd></dd><dt><code>bfr</code> -
569      <code>u</code></dt><dd></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.SMS.SmsReceived" id="org.freedesktop.ModemManager.Modem.Gsm.SMS.SmsReceived">SmsReceived</a> (
570        u: index
571        )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>index</code> -
572      <code>u</code></dt><dd></dd></dl></div></div><p>Interface has no properties.</p>
573
574  <h1><a name="org.freedesktop.ModemManager.Modem.Gsm.Hso" id="org.freedesktop.ModemManager.Modem.Gsm.Hso"></a>org.freedesktop.ModemManager.Modem.Gsm.Hso</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Hso.Authenticate" id="org.freedesktop.ModemManager.Modem.Gsm.Hso.Authenticate">Authenticate</a> (
575        s: username, s: password
576        ) &#8594;
577        nothing</h3><div class="docstring">
578        Authenticate using the passed user name and password.
579      </div><div><h4>Parameters</h4><dl><dt><code>username</code> -
580      <code>s</code></dt><dd></dd><dt><code>password</code> -
581      <code>s</code></dt><dd></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ModemManager.Modem.Gsm.Hso.GetIP4Config" id="org.freedesktop.ModemManager.Modem.Gsm.Hso.GetIP4Config">GetIP4Config</a> (
582       
583        ) &#8594;
584        u, au</h3><div class="docstring">
585        Request the IP4 configuration from the device.
586      </div><div><h4>Returns</h4><dl><dt><code>address</code> -
587      <code>u</code></dt><dd></dd><dt><code>dns</code> -
588      <code>au</code></dt><dd></dd></dl></div></div><p>Interface has no signals.</p><h2>Properties:</h2><dl><dt><code>NetworkDevice</code> -
589      <code>s</code> -
590      <code>(read)</code></dt><dd>
591        The network device.
592      </dd></dl>
593<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.ModemManager">org.freedesktop.ModemManager</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem">org.freedesktop.ModemManager.Modem</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Cdma">org.freedesktop.ModemManager.Modem.Cdma</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Card">org.freedesktop.ModemManager.Modem.Gsm.Card</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Contacts">org.freedesktop.ModemManager.Modem.Gsm.Contacts</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Network">org.freedesktop.ModemManager.Modem.Gsm.Network</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.SMS">org.freedesktop.ModemManager.Modem.Gsm.SMS</a></code></li><li><code><a href="#org.freedesktop.ModemManager.Modem.Gsm.Hso">org.freedesktop.ModemManager.Modem.Gsm.Hso</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-MM_MODEM_GSM_NETWORK_BAND">MM_MODEM_GSM_NETWORK_BAND</a></code>
594    - u</li><li><code><a href="#type-MM_MODEM_GSM_NETWORK_MODE">MM_MODEM_GSM_NETWORK_MODE</a></code>
595    - u</li><li><code><a href="#type-MM_MODEM_GSM_NETWORK_REG_STATUS">MM_MODEM_GSM_NETWORK_REG_STATUS</a></code>
596    - u</li><li><code><a href="#type-MM_MODEM_TYPE">MM_MODEM_TYPE</a></code>
597    - u</li></ul></body></html>