aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/libmm-glib/libmm-glib-docs.xml
blob: c9f498ca0450ee638e9dfb3d7fc8c03e91e8cc8d (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="libmm-glib"  xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>libmm-glib Reference Manual</title>
    <subtitle>
      <inlinemediaobject>
        <imageobject>
          <imagedata fileref="ModemManager-logo-wide.png" format="PNG" align="center"/>
        </imageobject>
      </inlinemediaobject>
    </subtitle>
    <releaseinfo>
      For libmm-glib version &version;
    </releaseinfo>

    <authorgroup>
      <author>
	    <firstname>Aleksander</firstname>
	    <surname>Morgado</surname>
	    <affiliation>
	      <address>
	        <email>aleksander@lanedo.com</email>
	      </address>
	    </affiliation>
      </author>
    </authorgroup>

    <copyright>
      <year>2011</year>
      <year>2012</year>
      <holder>The ModemManager Authors</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this
        document under the terms of the <citetitle>GNU Free
        Documentation License</citetitle>, Version 1.3 or any later
        version published by the Free Software Foundation with no
        Invariant Sections, no Front-Cover Texts, and no Back-Cover
        Texts. You may obtain a copy of the <citetitle>GNU Free
        Documentation License</citetitle> from the Free Software
        Foundation by visiting <ulink type="http"
        url="http://www.fsf.org">their Web site</ulink> or by writing
        to:
        <address>
          The Free Software Foundation, Inc.
          <street>51 Franklin Street</street>, Suite 500
          <city>Boston</city>, <state>MA</state> <postcode>02110-1335</postcode>
          <country>USA</country>
        </address>
      </para>
    </legalnotice>
  </bookinfo>

  <part>
    <title>High level API</title>

    <chapter>
      <title>Common enums and flags helpers</title>
      <xi:include href="xml/mm-enums-types.xml"/>
    </chapter>

    <chapter>
      <title>The Manager object</title>
      <xi:include href="xml/mm-manager.xml"/>
    </chapter>

    <chapter>
      <title>The Modem object</title>
      <xi:include href="xml/mm-object.xml"/>
      <section>
        <title>Generic interfaces</title>
        <xi:include href="xml/mm-modem.xml"/>
        <xi:include href="xml/mm-modem-3gpp.xml"/>
        <xi:include href="xml/mm-modem-3gpp-ussd.xml"/>
        <xi:include href="xml/mm-modem-cdma.xml"/>
        <xi:include href="xml/mm-unlock-retries.xml"/>
      </section>
      <section>
        <title>Simple interface support</title>
        <xi:include href="xml/mm-modem-simple.xml"/>
        <xi:include href="xml/mm-simple-connect-properties.xml"/>
        <xi:include href="xml/mm-simple-status.xml"/>
      </section>
      <section>
        <title>Location support</title>
        <xi:include href="xml/mm-modem-location.xml"/>
        <xi:include href="xml/mm-location-3gpp.xml"/>
        <xi:include href="xml/mm-location-gps-nmea.xml"/>
        <xi:include href="xml/mm-location-gps-raw.xml"/>
        <xi:include href="xml/mm-location-cdma-bs.xml"/>
      </section>
      <section>
        <title>Messaging support</title>
        <xi:include href="xml/mm-modem-messaging.xml"/>
      </section>
      <section>
        <title>Time support</title>
        <xi:include href="xml/mm-modem-time.xml"/>
        <xi:include href="xml/mm-network-timezone.xml"/>
      </section>
      <section>
        <title>Firmware support</title>
        <xi:include href="xml/mm-modem-firmware.xml"/>
        <xi:include href="xml/mm-firmware-properties.xml"/>
      </section>
    </chapter>

    <chapter>
      <title>The Bearer object</title>
      <xi:include href="xml/mm-bearer.xml"/>
      <xi:include href="xml/mm-bearer-properties.xml"/>
      <xi:include href="xml/mm-bearer-ip-config.xml"/>
    </chapter>

    <chapter>
      <title>The SIM object</title>
      <xi:include href="xml/mm-sim.xml"/>
    </chapter>

    <chapter>
      <title>The SMS object</title>
      <xi:include href="xml/mm-sms.xml"/>
      <xi:include href="xml/mm-sms-properties.xml"/>
    </chapter>

  </part>

  <part>
    <title>Low level API</title>
    <xi:include href="xml/MmGdbusOrgFreedesktopModemManager1.xml"/>
    <xi:include href="xml/MmGdbusOrgFreedesktopModemManager1Proxy.xml"/>
    <xi:include href="xml/MmGdbusOrgFreedesktopModemManager1Skeleton.xml"/>
    <xi:include href="xml/MmGdbusObjectManagerClient.xml"/>

    <xi:include href="xml/MmGdbusObject.xml"/>
    <xi:include href="xml/MmGdbusObjectProxy.xml"/>
    <xi:include href="xml/MmGdbusObjectSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModem.xml"/>
    <xi:include href="xml/MmGdbusModemProxy.xml"/>
    <xi:include href="xml/MmGdbusModemSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModem3gpp.xml"/>
    <xi:include href="xml/MmGdbusModem3gppProxy.xml"/>
    <xi:include href="xml/MmGdbusModem3gppSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModem3gppUssd.xml"/>
    <xi:include href="xml/MmGdbusModem3gppUssdProxy.xml"/>
    <xi:include href="xml/MmGdbusModem3gppUssdSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemCdma.xml"/>
    <xi:include href="xml/MmGdbusModemCdmaProxy.xml"/>
    <xi:include href="xml/MmGdbusModemCdmaSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemLocation.xml"/>
    <xi:include href="xml/MmGdbusModemLocationProxy.xml"/>
    <xi:include href="xml/MmGdbusModemLocationSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemMessaging.xml"/>
    <xi:include href="xml/MmGdbusModemMessagingProxy.xml"/>
    <xi:include href="xml/MmGdbusModemMessagingSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemTime.xml"/>
    <xi:include href="xml/MmGdbusModemTimeProxy.xml"/>
    <xi:include href="xml/MmGdbusModemTimeSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemFirmware.xml"/>
    <xi:include href="xml/MmGdbusModemFirmwareProxy.xml"/>
    <xi:include href="xml/MmGdbusModemFirmwareSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemContacts.xml"/>
    <xi:include href="xml/MmGdbusModemContactsProxy.xml"/>
    <xi:include href="xml/MmGdbusModemContactsSkeleton.xml"/>

    <xi:include href="xml/MmGdbusModemSimple.xml"/>
    <xi:include href="xml/MmGdbusModemSimpleProxy.xml"/>
    <xi:include href="xml/MmGdbusModemSimpleSkeleton.xml"/>

    <xi:include href="xml/MmGdbusBearer.xml"/>
    <xi:include href="xml/MmGdbusBearerProxy.xml"/>
    <xi:include href="xml/MmGdbusBearerSkeleton.xml"/>

    <xi:include href="xml/MmGdbusSim.xml"/>
    <xi:include href="xml/MmGdbusSimProxy.xml"/>
    <xi:include href="xml/MmGdbusSimSkeleton.xml"/>

    <xi:include href="xml/MmGdbusSms.xml"/>
    <xi:include href="xml/MmGdbusSmsProxy.xml"/>
    <xi:include href="xml/MmGdbusSmsSkeleton.xml"/>

  </part>

  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <index id="deprecated-api-index" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>