← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution-data-server/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-09-19 12:15:29 UTC
  • mfrom: (1.1.93 upstream)
  • Revision ID: package-import@ubuntu.com-20110919121529-nsmfnges77ec7hux
Tags: 3.1.92-0ubuntu1
https://launchpad.net/bugs/852277
https://launchpad.net/bugs/853905
https://launchpad.net/bugs/660626
* New upstream release.
  - Cannot add more than one appointment per session (LP: #852277)
  - Contacts calendar backend doesn't show events (LP: #853905)
  - Set X-Evolution-Source header consistently (LP: #660626)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/tmpl/e-book-backend.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
EBookBackend
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
 
 
15
</para>
 
16
 
 
17
<!-- ##### SECTION Stability_Level ##### -->
 
18
 
 
19
 
 
20
<!-- ##### SECTION Image ##### -->
 
21
 
 
22
 
 
23
<!-- ##### STRUCT EBookBackend ##### -->
 
24
<para>
 
25
 
 
26
</para>
 
27
 
 
28
 
 
29
<!-- ##### SIGNAL EBookBackend::last-client-gone ##### -->
 
30
<para>
 
31
 
 
32
</para>
 
33
 
 
34
@ebookbackend: the object which received the signal.
 
35
 
 
36
<!-- ##### ARG EBookBackend:cache-dir ##### -->
 
37
<para>
 
38
 
 
39
</para>
 
40
 
 
41
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_OPENED ##### -->
 
42
<para>
 
43
 
 
44
</para>
 
45
 
 
46
 
 
47
 
 
48
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_OPENING ##### -->
 
49
<para>
 
50
 
 
51
</para>
 
52
 
 
53
 
 
54
 
 
55
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_ONLINE ##### -->
 
56
<para>
 
57
 
 
58
</para>
 
59
 
 
60
 
 
61
 
 
62
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_READONLY ##### -->
 
63
<para>
 
64
 
 
65
</para>
 
66
 
 
67
 
 
68
 
 
69
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_CACHE_DIR ##### -->
 
70
<para>
 
71
 
 
72
</para>
 
73
 
 
74
 
 
75
 
 
76
<!-- ##### MACRO CLIENT_BACKEND_PROPERTY_CAPABILITIES ##### -->
 
77
<para>
 
78
 
 
79
</para>
 
80
 
 
81
 
 
82
 
 
83
<!-- ##### MACRO BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS ##### -->
 
84
<para>
 
85
 
 
86
</para>
 
87
 
 
88
 
 
89
 
 
90
<!-- ##### MACRO BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS ##### -->
 
91
<para>
 
92
 
 
93
</para>
 
94
 
 
95
 
 
96
 
 
97
<!-- ##### MACRO BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS ##### -->
 
98
<para>
 
99
 
 
100
</para>
 
101
 
 
102
 
 
103
 
 
104
<!-- ##### FUNCTION e_book_backend_get_cache_dir ##### -->
 
105
<para>
 
106
 
 
107
</para>
 
108
 
 
109
@backend: 
 
110
@Returns: 
 
111
 
 
112
 
 
113
<!-- ##### FUNCTION e_book_backend_set_cache_dir ##### -->
 
114
<para>
 
115
 
 
116
</para>
 
117
 
 
118
@backend: 
 
119
@cache_dir: 
 
120
 
 
121
 
 
122
<!-- ##### FUNCTION e_book_backend_get_source ##### -->
 
123
<para>
 
124
 
 
125
</para>
 
126
 
 
127
@backend: 
 
128
@Returns: 
 
129
 
 
130
 
 
131
<!-- ##### FUNCTION e_book_backend_add_client ##### -->
 
132
<para>
 
133
 
 
134
</para>
 
135
 
 
136
@backend: 
 
137
@book: 
 
138
@Returns: 
 
139
 
 
140
 
 
141
<!-- ##### FUNCTION e_book_backend_remove_client ##### -->
 
142
<para>
 
143
 
 
144
</para>
 
145
 
 
146
@backend: 
 
147
@book: 
 
148
 
 
149
 
 
150
<!-- ##### FUNCTION e_book_backend_is_online ##### -->
 
151
<para>
 
152
 
 
153
</para>
 
154
 
 
155
@backend: 
 
156
@Returns: 
 
157
 
 
158
 
 
159
<!-- ##### FUNCTION e_book_backend_is_opened ##### -->
 
160
<para>
 
161
 
 
162
</para>
 
163
 
 
164
@backend: 
 
165
@Returns: 
 
166
 
 
167
 
 
168
<!-- ##### FUNCTION e_book_backend_is_opening ##### -->
 
169
<para>
 
170
 
 
171
</para>
 
172
 
 
173
@backend: 
 
174
@Returns: 
 
175
 
 
176
 
 
177
<!-- ##### FUNCTION e_book_backend_is_readonly ##### -->
 
178
<para>
 
179
 
 
180
</para>
 
181
 
 
182
@backend: 
 
183
@Returns: 
 
184
 
 
185
 
 
186
<!-- ##### FUNCTION e_book_backend_is_removed ##### -->
 
187
<para>
 
188
 
 
189
</para>
 
190
 
 
191
@backend: 
 
192
@Returns: 
 
193
 
 
194
 
 
195
<!-- ##### FUNCTION e_book_backend_set_online ##### -->
 
196
<para>
 
197
 
 
198
</para>
 
199
 
 
200
@backend: 
 
201
@is_online: 
 
202
 
 
203
 
 
204
<!-- ##### FUNCTION e_book_backend_authenticate_user ##### -->
 
205
<para>
 
206
 
 
207
</para>
 
208
 
 
209
@backend: 
 
210
@cancellable: 
 
211
@credentials: 
 
212
 
 
213
 
 
214
<!-- ##### FUNCTION e_book_backend_get_backend_property ##### -->
 
215
<para>
 
216
 
 
217
</para>
 
218
 
 
219
@backend: 
 
220
@book: 
 
221
@opid: 
 
222
@cancellable: 
 
223
@prop_name: 
 
224
 
 
225
 
 
226
<!-- ##### FUNCTION e_book_backend_set_backend_property ##### -->
 
227
<para>
 
228
 
 
229
</para>
 
230
 
 
231
@backend: 
 
232
@book: 
 
233
@opid: 
 
234
@cancellable: 
 
235
@prop_name: 
 
236
@prop_value: 
 
237
 
 
238
 
 
239
<!-- ##### FUNCTION e_book_backend_open ##### -->
 
240
<para>
 
241
 
 
242
</para>
 
243
 
 
244
@backend: 
 
245
@book: 
 
246
@opid: 
 
247
@cancellable: 
 
248
@only_if_exists: 
 
249
 
 
250
 
 
251
<!-- ##### FUNCTION e_book_backend_remove ##### -->
 
252
<para>
 
253
 
 
254
</para>
 
255
 
 
256
@backend: 
 
257
@book: 
 
258
@opid: 
 
259
@cancellable: 
 
260
 
 
261
 
 
262
<!-- ##### FUNCTION e_book_backend_refresh ##### -->
 
263
<para>
 
264
 
 
265
</para>
 
266
 
 
267
@backend: 
 
268
@book: 
 
269
@opid: 
 
270
@cancellable: 
 
271
 
 
272
 
 
273
<!-- ##### FUNCTION e_book_backend_create_contact ##### -->
 
274
<para>
 
275
 
 
276
</para>
 
277
 
 
278
@backend: 
 
279
@book: 
 
280
@opid: 
 
281
@cancellable: 
 
282
@vcard: 
 
283
 
 
284
 
 
285
<!-- ##### FUNCTION e_book_backend_remove_contacts ##### -->
 
286
<para>
 
287
 
 
288
</para>
 
289
 
 
290
@backend: 
 
291
@book: 
 
292
@opid: 
 
293
@cancellable: 
 
294
@id_list: 
 
295
 
 
296
 
 
297
<!-- ##### FUNCTION e_book_backend_modify_contact ##### -->
 
298
<para>
 
299
 
 
300
</para>
 
301
 
 
302
@backend: 
 
303
@book: 
 
304
@opid: 
 
305
@cancellable: 
 
306
@vcard: 
 
307
 
 
308
 
 
309
<!-- ##### FUNCTION e_book_backend_get_contact ##### -->
 
310
<para>
 
311
 
 
312
</para>
 
313
 
 
314
@backend: 
 
315
@book: 
 
316
@opid: 
 
317
@cancellable: 
 
318
@id: 
 
319
 
 
320
 
 
321
<!-- ##### FUNCTION e_book_backend_get_contact_list ##### -->
 
322
<para>
 
323
 
 
324
</para>
 
325
 
 
326
@backend: 
 
327
@book: 
 
328
@opid: 
 
329
@cancellable: 
 
330
@query: 
 
331
 
 
332
 
 
333
<!-- ##### FUNCTION e_book_backend_get_contact_list_uids ##### -->
 
334
<para>
 
335
 
 
336
</para>
 
337
 
 
338
@backend: 
 
339
@book: 
 
340
@opid: 
 
341
@cancellable: 
 
342
@query: 
 
343
 
 
344
 
 
345
<!-- ##### FUNCTION e_book_backend_authenticate_user ##### -->
 
346
<para>
 
347
 
 
348
</para>
 
349
 
 
350
@backend: 
 
351
@cancellable: 
 
352
@credentials: 
 
353
 
 
354
 
 
355
<!-- ##### FUNCTION e_book_backend_start_book_view ##### -->
 
356
<para>
 
357
 
 
358
</para>
 
359
 
 
360
@backend: 
 
361
@view: 
 
362
 
 
363
 
 
364
<!-- ##### FUNCTION e_book_backend_stop_book_view ##### -->
 
365
<para>
 
366
 
 
367
</para>
 
368
 
 
369
@backend: 
 
370
@view: 
 
371
 
 
372
 
 
373
<!-- ##### FUNCTION e_book_backend_add_book_view ##### -->
 
374
<para>
 
375
 
 
376
</para>
 
377
 
 
378
@backend: 
 
379
@view: 
 
380
 
 
381
 
 
382
<!-- ##### FUNCTION e_book_backend_remove_book_view ##### -->
 
383
<para>
 
384
 
 
385
</para>
 
386
 
 
387
@backend: 
 
388
@view: 
 
389
 
 
390
 
 
391
<!-- ##### FUNCTION e_book_backend_foreach_view ##### -->
 
392
<para>
 
393
 
 
394
</para>
 
395
 
 
396
@backend: 
 
397
@EDataBookView *view, gpointer user_data:
 
398
@EDataBookView *view, gpointer user_data:
 
399
@EDataBookView *view, gpointer user_data:
 
400
@EDataBookView *view, gpointer user_data:
 
401
@EDataBookView *view, gpointer user_data:
 
402
@EDataBookView *view, gpointer user_data:
 
403
@EDataBookView *view, gpointer user_data:
 
404
@EDataBookView *view, gpointer user_data:
 
405
@callback: 
 
406
@user_data: 
 
407
 
 
408
 
 
409
<!-- ##### FUNCTION e_book_backend_notify_update ##### -->
 
410
<para>
 
411
 
 
412
</para>
 
413
 
 
414
@backend: 
 
415
@contact: 
 
416
 
 
417
 
 
418
<!-- ##### FUNCTION e_book_backend_notify_remove ##### -->
 
419
<para>
 
420
 
 
421
</para>
 
422
 
 
423
@backend: 
 
424
@id: 
 
425
 
 
426
 
 
427
<!-- ##### FUNCTION e_book_backend_notify_complete ##### -->
 
428
<para>
 
429
 
 
430
</para>
 
431
 
 
432
@backend: 
 
433
 
 
434
 
 
435
<!-- ##### FUNCTION e_book_backend_notify_error ##### -->
 
436
<para>
 
437
 
 
438
</para>
 
439
 
 
440
@backend: 
 
441
@message: 
 
442
 
 
443
 
 
444
<!-- ##### FUNCTION e_book_backend_notify_readonly ##### -->
 
445
<para>
 
446
 
 
447
</para>
 
448
 
 
449
@backend: 
 
450
@is_readonly: 
 
451
 
 
452
 
 
453
<!-- ##### FUNCTION e_book_backend_notify_online ##### -->
 
454
<para>
 
455
 
 
456
</para>
 
457
 
 
458
@backend: 
 
459
@is_online: 
 
460
 
 
461
 
 
462
<!-- ##### FUNCTION e_book_backend_notify_auth_required ##### -->
 
463
<para>
 
464
 
 
465
</para>
 
466
 
 
467
@backend: 
 
468
@is_self: 
 
469
@credentials: 
 
470
 
 
471
 
 
472
<!-- ##### FUNCTION e_book_backend_notify_opened ##### -->
 
473
<para>
 
474
 
 
475
</para>
 
476
 
 
477
@backend: 
 
478
@error: 
 
479
 
 
480
 
 
481
<!-- ##### FUNCTION e_book_backend_notify_property_changed ##### -->
 
482
<para>
 
483
 
 
484
</para>
 
485
 
 
486
@backend: 
 
487
@prop_name: 
 
488
@prop_value: 
 
489
 
 
490
 
 
491
<!-- ##### FUNCTION e_book_backend_sync ##### -->
 
492
<para>
 
493
 
 
494
</para>
 
495
 
 
496
@backend: 
 
497
 
 
498
 
 
499
<!-- ##### FUNCTION e_book_backend_set_is_removed ##### -->
 
500
<para>
 
501
 
 
502
</para>
 
503
 
 
504
@backend: 
 
505
@is_removed: 
 
506
 
 
507
 
 
508
<!-- ##### FUNCTION e_book_backend_respond_opened ##### -->
 
509
<para>
 
510
 
 
511
</para>
 
512
 
 
513
@backend: 
 
514
@book: 
 
515
@opid: 
 
516
@error: 
 
517
 
 
518
 
 
519
<!-- ##### STRUCT EBookBackendClass ##### -->
 
520
<para>
 
521
 
 
522
</para>
 
523
 
 
524
@parent_class: 
 
525
@get_backend_property: 
 
526
@set_backend_property: 
 
527
@open: 
 
528
@remove: 
 
529
@set_online: 
 
530
@authenticate_user: 
 
531
@refresh: 
 
532
@create_contact: 
 
533
@remove_contacts: 
 
534
@modify_contact: 
 
535
@get_contact: 
 
536
@get_contact_list: 
 
537
@get_contact_list_uids: 
 
538
@start_book_view: 
 
539
@stop_book_view: 
 
540
@notify_update: 
 
541
@last_client_gone: 
 
542
@sync: 
 
543