summaryrefslogtreecommitdiff
path: root/docs/reference/libqmi-glib/libqmi-glib-docs.xml
blob: b907e7d2b3b140ee2fc177d97ef64305f6358589 (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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<?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 % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY version SYSTEM "version.xml">
]>
<book id="libqmi-glib">
  <bookinfo>
    <title>libqmi-glib Reference Manual</title>
    <releaseinfo>for libqmi-glib &version;</releaseinfo>

    <copyright>
      <year>2012</year>
      <holder>The libqmi-glib 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>

  <chapter>
    <title>Core</title>
    <xi:include href="xml/qmi-version.xml"/>
    <xi:include href="xml/qmi-message.xml"/>
    <xi:include href="xml/qmi-device.xml"/>
    <xi:include href="xml/qmi-client.xml"/>
    <xi:include href="xml/qmi-proxy.xml"/>
    <xi:include href="xml/qmi-enums.xml"/>
    <xi:include href="xml/qmi-errors.xml"/>
    <xi:include href="xml/qmi-utils.xml"/>
  </chapter>

  <chapter>
    <title>Device Management Service (DMS)</title>
    <xi:include href="xml/qmi-client-dms.xml"/>
    <xi:include href="xml/qmi-enums-dms.xml"/>
    <section>
      <title>DMS Indications</title>
      <xi:include href="xml/qmi-indication-dms-event-report.xml"/>
    </section>
    <section>
      <title>DMS Requests</title>
      <xi:include href="xml/qmi-message-dms-reset.xml"/>
      <xi:include href="xml/qmi-message-dms-set-event-report.xml"/>
      <xi:include href="xml/qmi-message-dms-get-capabilities.xml"/>
      <xi:include href="xml/qmi-message-dms-get-manufacturer.xml"/>
      <xi:include href="xml/qmi-message-dms-get-model.xml"/>
      <xi:include href="xml/qmi-message-dms-get-revision.xml"/>
      <xi:include href="xml/qmi-message-dms-get-msisdn.xml"/>
      <xi:include href="xml/qmi-message-dms-get-ids.xml"/>
      <xi:include href="xml/qmi-message-dms-get-power-state.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-set-pin-protection.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-verify-pin.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-unblock-pin.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-change-pin.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-get-pin-status.xml"/>
      <xi:include href="xml/qmi-message-dms-get-hardware-revision.xml"/>
      <xi:include href="xml/qmi-message-dms-get-operating-mode.xml"/>
      <xi:include href="xml/qmi-message-dms-set-operating-mode.xml"/>
      <xi:include href="xml/qmi-message-dms-get-time.xml"/>
      <xi:include href="xml/qmi-message-dms-get-prl-version.xml"/>
      <xi:include href="xml/qmi-message-dms-get-activation-state.xml"/>
      <xi:include href="xml/qmi-message-dms-activate-automatic.xml"/>
      <xi:include href="xml/qmi-message-dms-activate-manual.xml"/>
      <xi:include href="xml/qmi-message-dms-get-user-lock-state.xml"/>
      <xi:include href="xml/qmi-message-dms-set-user-lock-state.xml"/>
      <xi:include href="xml/qmi-message-dms-set-user-lock-code.xml"/>
      <xi:include href="xml/qmi-message-dms-read-user-data.xml"/>
      <xi:include href="xml/qmi-message-dms-write-user-data.xml"/>
      <xi:include href="xml/qmi-message-dms-read-eri-file.xml"/>
      <xi:include href="xml/qmi-message-dms-restore-factory-defaults.xml"/>
      <xi:include href="xml/qmi-message-dms-validate-service-programming-code.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-get-iccid.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-get-ck-status.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-set-ck-protection.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-unblock-ck.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-get-imsi.xml"/>
      <xi:include href="xml/qmi-message-dms-uim-get-state.xml"/>
      <xi:include href="xml/qmi-message-dms-get-band-capabilities.xml"/>
      <xi:include href="xml/qmi-message-dms-get-factory-sku.xml"/>
      <xi:include href="xml/qmi-message-dms-get-firmware-preference.xml"/>
      <xi:include href="xml/qmi-message-dms-set-firmware-preference.xml"/>
      <xi:include href="xml/qmi-message-dms-list-stored-images.xml"/>
      <xi:include href="xml/qmi-message-dms-delete-stored-image.xml"/>
      <xi:include href="xml/qmi-message-dms-set-time.xml"/>
      <xi:include href="xml/qmi-message-dms-get-stored-image-info.xml"/>
      <xi:include href="xml/qmi-message-dms-get-alt-net-config.xml"/>
      <xi:include href="xml/qmi-message-dms-set-alt-net-config.xml"/>
      <xi:include href="xml/qmi-message-dms-get-software-version.xml"/>
      <xi:include href="xml/qmi-message-dms-set-service-programming-code.xml"/>
      <xi:include href="xml/qmi-message-dms-set-fcc-authentication.xml"/>
      <xi:include href="xml/qmi-message-dms-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Network Access Service (NAS)</title>
    <xi:include href="xml/qmi-client-nas.xml"/>
    <xi:include href="xml/qmi-enums-nas.xml"/>
    <section>
      <title>NAS Indications</title>
      <xi:include href="xml/qmi-indication-nas-event-report.xml"/>
      <xi:include href="xml/qmi-indication-nas-network-time.xml"/>
      <xi:include href="xml/qmi-indication-nas-serving-system.xml"/>
      <xi:include href="xml/qmi-indication-nas-system-info.xml"/>
      <xi:include href="xml/qmi-indication-nas-signal-info.xml"/>
    </section>
    <section>
      <title>NAS Requests</title>
      <xi:include href="xml/qmi-message-nas-reset.xml"/>
      <xi:include href="xml/qmi-message-nas-set-event-report.xml"/>
      <xi:include href="xml/qmi-message-nas-register-indications.xml"/>
      <xi:include href="xml/qmi-message-nas-get-signal-strength.xml"/>
      <xi:include href="xml/qmi-message-nas-network-scan.xml"/>
      <xi:include href="xml/qmi-message-nas-initiate-network-register.xml"/>
      <xi:include href="xml/qmi-message-nas-get-serving-system.xml"/>
      <xi:include href="xml/qmi-message-nas-get-home-network.xml"/>
      <xi:include href="xml/qmi-message-nas-set-technology-preference.xml"/>
      <xi:include href="xml/qmi-message-nas-get-technology-preference.xml"/>
      <xi:include href="xml/qmi-message-nas-get-rf-band-information.xml"/>
      <xi:include href="xml/qmi-message-nas-set-system-selection-preference.xml"/>
      <xi:include href="xml/qmi-message-nas-get-system-selection-preference.xml"/>
      <xi:include href="xml/qmi-message-nas-get-system-info.xml"/>
      <xi:include href="xml/qmi-message-nas-get-signal-info.xml"/>
      <xi:include href="xml/qmi-message-nas-config-signal-info.xml"/>
      <xi:include href="xml/qmi-message-nas-get-cdma-position-info.xml"/>
      <xi:include href="xml/qmi-message-nas-get-tx-rx-info.xml"/>
      <xi:include href="xml/qmi-message-nas-get-cell-location-info.xml"/>
      <xi:include href="xml/qmi-message-nas-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Wireless Data Service (WDS)</title>
    <xi:include href="xml/qmi-client-wds.xml"/>
    <xi:include href="xml/qmi-enums-wds.xml"/>
    <section>
      <title>WDS Indications</title>
      <xi:include href="xml/qmi-indication-wds-packet-service-status.xml"/>
    </section>
    <section>
      <title>WDS Requests</title>
      <xi:include href="xml/qmi-message-wds-reset.xml"/>
      <xi:include href="xml/qmi-message-wds-start-network.xml"/>
      <xi:include href="xml/qmi-message-wds-stop-network.xml"/>
      <xi:include href="xml/qmi-message-wds-get-packet-service-status.xml"/>
      <xi:include href="xml/qmi-message-wds-get-packet-statistics.xml"/>
      <xi:include href="xml/qmi-message-wds-get-profile-list.xml"/>
      <xi:include href="xml/qmi-message-wds-get-profile-settings.xml"/>
      <xi:include href="xml/qmi-message-wds-get-default-settings.xml"/>
      <xi:include href="xml/qmi-message-wds-get-current-settings.xml"/>
      <xi:include href="xml/qmi-message-wds-get-autoconnect-settings.xml"/>
      <xi:include href="xml/qmi-message-wds-set-autoconnect-settings.xml"/>
      <xi:include href="xml/qmi-message-wds-get-data-bearer-technology.xml"/>
      <xi:include href="xml/qmi-message-wds-get-current-data-bearer-technology.xml"/>
      <xi:include href="xml/qmi-message-wds-set-ip-family.xml"/>
      <xi:include href="xml/qmi-message-wds-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Wireless Messaging Service (WMS)</title>
    <xi:include href="xml/qmi-client-wms.xml"/>
    <xi:include href="xml/qmi-enums-wms.xml"/>
    <section>
      <title>WMS Indications</title>
      <xi:include href="xml/qmi-indication-wms-event-report.xml"/>
      <xi:include href="xml/qmi-indication-wms-smsc-address.xml"/>
    </section>
    <section>
      <title>WMS Requests</title>
      <xi:include href="xml/qmi-message-wms-reset.xml"/>
      <xi:include href="xml/qmi-message-wms-set-event-report.xml"/>
      <xi:include href="xml/qmi-message-wms-raw-send.xml"/>
      <xi:include href="xml/qmi-message-wms-raw-write.xml"/>
      <xi:include href="xml/qmi-message-wms-raw-read.xml"/>
      <xi:include href="xml/qmi-message-wms-modify-tag.xml"/>
      <xi:include href="xml/qmi-message-wms-delete.xml"/>
      <xi:include href="xml/qmi-message-wms-get-message-protocol.xml"/>
      <xi:include href="xml/qmi-message-wms-list-messages.xml"/>
      <xi:include href="xml/qmi-message-wms-set-routes.xml"/>
      <xi:include href="xml/qmi-message-wms-get-routes.xml"/>
      <xi:include href="xml/qmi-message-wms-send-from-memory-storage.xml"/>
      <xi:include href="xml/qmi-message-wms-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Position Determination Service (PDS)</title>
    <xi:include href="xml/qmi-client-pds.xml"/>
    <xi:include href="xml/qmi-enums-pds.xml"/>
    <section>
      <title>PDS Indications</title>
      <xi:include href="xml/qmi-indication-pds-event-report.xml"/>
    </section>
    <section>
      <title>PDS Requests</title>
      <xi:include href="xml/qmi-message-pds-reset.xml"/>
      <xi:include href="xml/qmi-message-pds-set-event-report.xml"/>
      <xi:include href="xml/qmi-message-pds-get-gps-service-state.xml"/>
      <xi:include href="xml/qmi-message-pds-set-gps-service-state.xml"/>
      <xi:include href="xml/qmi-message-pds-get-auto-tracking-state.xml"/>
      <xi:include href="xml/qmi-message-pds-set-auto-tracking-state.xml"/>
      <xi:include href="xml/qmi-message-pds-get-default-tracking-session.xml"/>
      <xi:include href="xml/qmi-message-pds-set-default-tracking-session.xml"/>
      <xi:include href="xml/qmi-message-pds-get-agps-config.xml"/>
      <xi:include href="xml/qmi-message-pds-set-agps-config.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Phonebook Management Service (PBM)</title>
    <xi:include href="xml/qmi-client-pbm.xml"/>
    <xi:include href="xml/qmi-enums-pbm.xml"/>
    <section>
      <title>PBM Requests</title>
      <xi:include href="xml/qmi-message-pbm-indication-register.xml"/>
      <xi:include href="xml/qmi-message-pbm-get-capabilities.xml"/>
      <xi:include href="xml/qmi-message-pbm-get-all-capabilities.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>User Identity Module (UIM) service</title>
    <xi:include href="xml/qmi-client-uim.xml"/>
    <xi:include href="xml/qmi-enums-uim.xml"/>
    <section>
      <title>UIM Requests</title>
      <xi:include href="xml/qmi-message-uim-reset.xml"/>
      <xi:include href="xml/qmi-message-uim-read-transparent.xml"/>
      <xi:include href="xml/qmi-message-uim-read-record.xml"/>
      <xi:include href="xml/qmi-message-uim-get-file-attributes.xml"/>
      <xi:include href="xml/qmi-message-uim-get-card-status.xml"/>
      <xi:include href="xml/qmi-message-uim-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Open Mobile Alliance Service (OMA)</title>
    <xi:include href="xml/qmi-client-oma.xml"/>
    <xi:include href="xml/qmi-enums-oma.xml"/>
    <section>
      <title>OMA Indications</title>
      <xi:include href="xml/qmi-indication-oma-event-report.xml"/>
    </section>
    <section>
      <title>OMA Requests</title>
      <xi:include href="xml/qmi-message-oma-reset.xml"/>
      <xi:include href="xml/qmi-message-oma-set-event-report.xml"/>
      <xi:include href="xml/qmi-message-oma-start-session.xml"/>
      <xi:include href="xml/qmi-message-oma-cancel-session.xml"/>
      <xi:include href="xml/qmi-message-oma-get-session-info.xml"/>
      <xi:include href="xml/qmi-message-oma-send-selection.xml"/>
      <xi:include href="xml/qmi-message-oma-get-feature-setting.xml"/>
      <xi:include href="xml/qmi-message-oma-set-feature-setting.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Wireless Data Administrative Service (WDA)</title>
    <xi:include href="xml/qmi-client-wda.xml"/>
    <xi:include href="xml/qmi-enums-wda.xml"/>
    <section>
      <title>WDA Requests</title>
      <xi:include href="xml/qmi-message-wda-set-data-format.xml"/>
      <xi:include href="xml/qmi-message-wda-get-data-format.xml"/>
      <xi:include href="xml/qmi-message-wda-get-supported-messages.xml"/>
    </section>
  </chapter>

  <chapter>
    <title>Voice</title>
    <xi:include href="xml/qmi-client-voice.xml"/>
    <xi:include href="xml/qmi-enums-voice.xml"/>
    <section>
      <title>Voice Indications</title>
      <xi:include href="xml/qmi-indication-voice-all-call-status.xml"/>
    </section>
    <section>
      <title>Voice Requests</title>
      <xi:include href="xml/qmi-message-voice-dial-call.xml"/>
      <xi:include href="xml/qmi-message-voice-end-call.xml"/>
      <xi:include href="xml/qmi-message-voice-answer-call.xml"/>
      <xi:include href="xml/qmi-message-voice-get-config.xml"/>
      <xi:include href="xml/qmi-message-voice-get-supported-messages.xml"/>
    </section>
  </chapter>

  <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>