aboutsummaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.ModemManager.Modem.Simple.xml
blob: 6c17c0d0432244df2c1cf0d8938f1102db512028 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.ModemManager.Modem.Simple">

    <method name="Connect">
      <tp:docstring>
        Do everything needed to connect the modem.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_connect"/>
      <arg name="properties" type="a{sv}" direction="in">
        <tp:docstring>
          Dictionary of properties needed to get the modem connected.
          Each implementation is free to add it's own specific key-value pairs. The predefined
          common ones are:

          'pin'          : string
          'network_id'   : string (GSM/HSPA only)
          'band'         : uint
          'network_mode' : uint
          'apn'          : string (GSM/HSPA only)
          'number'       : string
          'rm-protocol'  : uint (CDMA/EVDO only) (1 - Relay, 2 - Network PPP)
        </tp:docstring>
      </arg>
    </method>
    <!--
       <method name="Disconnect">
         <tp:docstring>
           Disconnect modem.
         </tp:docstring>
         <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
         <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_disconnect"/>
       </method>
       -->
    <method name="GetStatus">
      <tp:docstring>
        Get the modem status.
      </tp:docstring>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_simple_get_status"/>
      <arg name="properties" type="a{sv}" direction="out">
        <tp:docstring>
          Dictionary of properties.
          Each implementation is free to add it's own specific key-value pairs. The predefined
          common ones are:

          'state'          : uint (always)
          'signal_quality' : uint  (state >= registered)
          'operator_code'  : string (state >= registered)
          'operator_name'  : string (state >= registered)
          'band'           : uint (state >= registered)
          'network_mode'   : uint (state >= registered)
        </tp:docstring>
      </arg>
    </method>
  </interface>
</node>