← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to solid/modemmanager-0.4/dbus/introspection/mm-modem.xml

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
solid/modemmanager-0.4/dbus/introspection/mm-modem.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
 
 
3
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
 
4
 
 
5
  <interface name="org.freedesktop.ModemManager.Modem">
 
6
    <method name="Enable">
 
7
      <tp:docstring>
 
8
        Enable the device. Initializes the modem.
 
9
      </tp:docstring>
 
10
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
11
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_enable"/>
 
12
      <arg name="enable" type="b" direction="in">
 
13
        <tp:docstring>
 
14
          True to enable the device, False to disable.
 
15
        </tp:docstring>
 
16
      </arg>
 
17
    </method>
 
18
 
 
19
    <method name="Connect">
 
20
      <tp:docstring>
 
21
        Dial in.
 
22
      </tp:docstring>
 
23
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
24
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_connect"/>
 
25
      <arg name="number" type="s" direction="in">
 
26
        <tp:docstring>
 
27
          The number to use for dialing.
 
28
      </tp:docstring>
 
29
      </arg>
 
30
    </method>
 
31
 
 
32
    <method name="Disconnect">
 
33
      <tp:docstring>
 
34
        Disconnect modem.
 
35
      </tp:docstring>
 
36
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
37
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_disconnect"/>
 
38
    </method>
 
39
 
 
40
    <method name="GetIP4Config">
 
41
      <tp:docstring>
 
42
        Request the IP4 configuration from the device.
 
43
        Note that it'll only be supported for IPMethod Static.
 
44
      </tp:docstring>
 
45
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
46
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_ip4_config"/>
 
47
      <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="Ip4ConfigType"/>
 
48
      <arg name="address" type="(uuuu)" direction="out" tp:type="Ip4ConfigType">
 
49
        Structure containing IP4 address, DNS1, DNS2, DNS3.
 
50
        The DNS list is padded with 0's if there's less than 3 DNS servers.
 
51
      </arg>
 
52
    </method>
 
53
 
 
54
    <method name="GetInfo">
 
55
      <tp:docstring>
 
56
        Get the card information (manufacturer, modem, version).
 
57
      </tp:docstring>
 
58
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
 
59
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_info"/>
 
60
      <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="InfoType"/>
 
61
      <arg name="info" type="(sss)" direction="out">
 
62
        <tp:docstring>
 
63
          Structure containing manufacturer, model, and version (revision) of the card.
 
64
        </tp:docstring>
 
65
      </arg>
 
66
    </method>
 
67
 
 
68
    <property name="Device" type="s" access="read">
 
69
      <tp:docstring>
 
70
        The modem port to use for IP configuration and traffic.
 
71
      </tp:docstring>
 
72
    </property>
 
73
 
 
74
    <property name="MasterDevice" type="s" access="read">
 
75
      <tp:docstring>
 
76
        The physical modem device reference (ie, USB, PCI, PCMCIA device), which
 
77
        may be dependent upon the operating system.  In Linux for example, this
 
78
        points to a sysfs path of the usb_device object.
 
79
      </tp:docstring>
 
80
    </property>
 
81
 
 
82
    <property name="Driver" type="s" access="read">
 
83
      <tp:docstring>
 
84
        The driver handling the device.
 
85
      </tp:docstring>
 
86
    </property>
 
87
 
 
88
    <property name="Type" type="u" access="read" tp:type="Type">
 
89
      <tp:docstring>
 
90
        The modem type.
 
91
      </tp:docstring>
 
92
    </property>
 
93
 
 
94
    <property name="Enabled" type="b" access="read">
 
95
      <tp:docstring>
 
96
        TRUE if the modem is enabled (ie, powered and usable), FALSE if it is disabled.
 
97
      </tp:docstring>
 
98
    </property>
 
99
 
 
100
    <property name="UnlockRequired" type="s" access="read">
 
101
      <tp:docstring>
 
102
        Empty if the device is usable without an unlock code or has already
 
103
        been unlocked. If the device needs to be unlocked before becoming usable this
 
104
        property contains the specific unlock code required.  Valid unlock code values
 
105
        are "" (blank), "sim-pin", "sim-puk", "ph-sim-pin", "ph-fsim-pin",
 
106
        "ph-fsim-puk", "sim-pin2", "sim-puk2", "ph-net-pin", "ph-net-puk",
 
107
        "ph-netsub-pin", "ph-netsub-puk", "ph-sp-pin", "ph-sp-puk", "ph-corp-pin", and
 
108
        "ph-corp-puk".
 
109
      </tp:docstring>
 
110
    </property>
 
111
 
 
112
    <property name="IpMethod" type="u" access="read" tp:type="Method">
 
113
      <tp:docstring>
 
114
        The IP configuration method.
 
115
      </tp:docstring>
 
116
    </property>
 
117
 
 
118
    <tp:enum name="Type" type="u">
 
119
      <tp:enumvalue suffix="GSM" value="1">
 
120
        <tp:docstring>
 
121
          A GSM device.
 
122
        </tp:docstring>
 
123
      </tp:enumvalue>
 
124
      <tp:enumvalue suffix="CDMA" value="2">
 
125
        <tp:docstring>
 
126
          A CDMA device.
 
127
        </tp:docstring>
 
128
      </tp:enumvalue>
 
129
    </tp:enum>
 
130
 
 
131
    <tp:enum name="Method" type="u">
 
132
      <tp:enumvalue suffix="PPP" value="0">
 
133
        <tp:docstring>
 
134
          Use PPP to get the address.
 
135
        </tp:docstring>
 
136
      </tp:enumvalue>
 
137
      <tp:enumvalue suffix="STATIC" value="1">
 
138
        <tp:docstring>
 
139
          Static configuration, the modem will provide IP information.
 
140
        </tp:docstring>
 
141
      </tp:enumvalue>
 
142
      <tp:enumvalue suffix="DHCP" value="2">
 
143
        <tp:docstring>
 
144
          Use DHCP
 
145
        </tp:docstring>
 
146
      </tp:enumvalue>
 
147
    </tp:enum>
 
148
 
 
149
  </interface>
 
150
</node>