forked from google/gdata-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgdata.html
More file actions
1504 lines (1329 loc) · 103 KB
/
gdata.html
File metadata and controls
1504 lines (1329 loc) · 103 KB
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package gdata</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>gdata</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/__init__.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/__init__.py</a></font></td></tr></table>
<p><tt>Contains classes representing Google Data elements.<br>
<br>
Extends Atom classes to add Google Data specific elements.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gdata.acl.html"><strong>acl</strong> (package)</a><br>
<a href="gdata.alt.html"><strong>alt</strong> (package)</a><br>
<a href="gdata.analytics.html"><strong>analytics</strong> (package)</a><br>
<a href="gdata.apps.html"><strong>apps</strong> (package)</a><br>
<a href="gdata.apps_property.html">apps_property</a><br>
<a href="gdata.auth.html">auth</a><br>
<a href="gdata.blogger.html"><strong>blogger</strong> (package)</a><br>
<a href="gdata.books.html"><strong>books</strong> (package)</a><br>
<a href="gdata.calendar.html"><strong>calendar</strong> (package)</a><br>
<a href="gdata.calendar_resource.html"><strong>calendar_resource</strong> (package)</a><br>
</td><td width="25%" valign=top><a href="gdata.client.html">client</a><br>
<a href="gdata.codesearch.html"><strong>codesearch</strong> (package)</a><br>
<a href="gdata.contacts.html"><strong>contacts</strong> (package)</a><br>
<a href="gdata.contentforshopping.html"><strong>contentforshopping</strong> (package)</a><br>
<a href="gdata.core.html">core</a><br>
<a href="gdata.data.html">data</a><br>
<a href="gdata.docs.html"><strong>docs</strong> (package)</a><br>
<a href="gdata.dublincore.html"><strong>dublincore</strong> (package)</a><br>
<a href="gdata.exif.html"><strong>exif</strong> (package)</a><br>
<a href="gdata.finance.html"><strong>finance</strong> (package)</a><br>
<a href="gdata.gauth.html">gauth</a><br>
</td><td width="25%" valign=top><a href="gdata.geo.html"><strong>geo</strong> (package)</a><br>
<a href="gdata.health.html"><strong>health</strong> (package)</a><br>
<a href="gdata.marketplace.html"><strong>marketplace</strong> (package)</a><br>
<a href="gdata.media.html"><strong>media</strong> (package)</a><br>
<a href="gdata.notebook.html"><strong>notebook</strong> (package)</a><br>
<a href="gdata.oauth.html"><strong>oauth</strong> (package)</a><br>
<a href="gdata.opensearch.html"><strong>opensearch</strong> (package)</a><br>
<a href="gdata.photos.html"><strong>photos</strong> (package)</a><br>
<a href="gdata.projecthosting.html"><strong>projecthosting</strong> (package)</a><br>
<a href="gdata.sample_util.html">sample_util</a><br>
<a href="gdata.service.html">service</a><br>
</td><td width="25%" valign=top><a href="gdata.sites.html"><strong>sites</strong> (package)</a><br>
<a href="gdata.spreadsheet.html"><strong>spreadsheet</strong> (package)</a><br>
<a href="gdata.spreadsheets.html"><strong>spreadsheets</strong> (package)</a><br>
<a href="gdata.test_config.html">test_config</a><br>
<a href="gdata.test_data.html">test_data</a><br>
<a href="gdata.urlfetch.html">urlfetch</a><br>
<a href="gdata.webmastertools.html"><strong>webmastertools</strong> (package)</a><br>
<a href="gdata.youtube.html"><strong>youtube</strong> (package)</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#MediaSource">MediaSource</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#AtomBase">atom.AtomBase</a>(<a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchId">BatchId</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchInterrupted">BatchInterrupted</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchOperation">BatchOperation</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#BatchStatus">BatchStatus</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#EntryLink">EntryLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#ExtendedProperty">ExtendedProperty</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#FeedLink">FeedLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#ItemsPerPage">ItemsPerPage</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#StartIndex">StartIndex</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.html#TotalResults">TotalResults</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#Entry">atom.Entry</a>(<a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchEntry">BatchEntry</a>
</font></dt></dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#Feed">atom.Feed</a>(<a href="atom.html#Source">atom.Source</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataFeed">GDataFeed</a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchFeed">BatchFeed</a>
</font></dt></dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#LinkFinder">atom.LinkFinder</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#LinkFinder">LinkFinder</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchEntry">BatchEntry</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataFeed">GDataFeed</a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#BatchFeed">BatchFeed</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#Error">Error</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.html#MissingRequiredParameters">MissingRequiredParameters</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchEntry">class <strong>BatchEntry</strong></a>(<a href="gdata.html#GDataEntry">GDataEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>An atom:entry for use in batch requests.<br>
<br>
The <a href="#BatchEntry">BatchEntry</a> contains additional members to specify the operation to be<br>
performed on this entry and a batch ID so that the server can reference<br>
individual operations in the response feed. For more information, see:<br>
<a href="http://code.google.com/apis/gdata/batch.html">http://code.google.com/apis/gdata/batch.html</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchEntry">BatchEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchEntry-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, content<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, published<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, source<font color="#909090">=None</font>, summary<font color="#909090">=None</font>, control<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, batch_operation<font color="#909090">=None</font>, batch_id<font color="#909090">=None</font>, batch_status<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#GDataEntry">GDataEntry</a>:<br>
<dl><dt><a name="BatchEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="BatchEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataEntry">GDataEntry</a>:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="BatchEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchFeed">class <strong>BatchFeed</strong></a>(<a href="gdata.html#GDataFeed">GDataFeed</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A feed containing a list of batch request entries.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchFeed">BatchFeed</a></dd>
<dd><a href="gdata.html#GDataFeed">GDataFeed</a></dd>
<dd><a href="atom.html#Feed">atom.Feed</a></dd>
<dd><a href="atom.html#Source">atom.Source</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchFeed-AddBatchEntry"><strong>AddBatchEntry</strong></a>(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a <a href="#BatchEntry">BatchEntry</a> and adding to the feed.<br>
<br>
<br>
If the entry is not a <a href="#BatchEntry">BatchEntry</a>, it is converted to a <a href="#BatchEntry">BatchEntry</a> so<br>
that the batch specific members will be present.<br>
<br>
The id_url_string can be used in place of an entry if the batch operation<br>
applies to a URL. For example query and delete operations require just<br>
the URL of an entry, no body is sent in the HTTP request. If an<br>
id_url_string is sent instead of an entry, a <a href="#BatchEntry">BatchEntry</a> is created and<br>
added to the feed.<br>
<br>
This method also assigns the desired batch id to the entry so that it<br>
can be referenced in the server's response. If the batch_id_string is<br>
None, this method will assign a batch_id to be the index at which this<br>
entry will be in the feed's entry list.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a>, atom.<a href="atom.html#Entry">Entry</a>, or another <a href="atom.html#Entry">Entry</a> flavor (optional) The<br>
entry which will be sent to the server as part of the batch request.<br>
The item must have a valid atom id so that the server knows which<br>
entry this request references.<br>
id_url_string: str (optional) The URL of the entry to be acted on. You<br>
can find this URL in the text member of the atom id for an entry.<br>
If an entry is not sent, this id will be used to construct a new<br>
<a href="#BatchEntry">BatchEntry</a> which will be added to the request feed.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.<br>
operation_string: str (optional) The desired batch operation which will<br>
set the batch_operation.type member of the entry. Options are<br>
'insert', 'update', 'delete', and 'query'<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a>: Raised if neither an id_ url_string nor an<br>
entry are provided in the request.<br>
<br>
Returns:<br>
The added entry.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddDelete"><strong>AddDelete</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br>
<br>
This method takes either the url_string which is the atom id of the item<br>
to be deleted, or the entry itself. The atom id of the entry must be<br>
present so that the server knows which entry should be deleted.<br>
<br>
Args:<br>
url_string: str (optional) The URL of the entry to be deleted. You can<br>
find this URL in the text member of the atom id for an entry.<br>
entry: <a href="#BatchEntry">BatchEntry</a> (optional) The entry to be deleted.<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a>: Raised if neither a url_string nor an entry<br>
are provided in the request.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddInsert"><strong>AddInsert</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br>
<br>
If the entry doesn't yet have an operation or a batch id, these will<br>
be set to the insert operation and a batch_id specified as a parameter.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a> The entry which will be sent in the batch feed as an<br>
insert request.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. Note that batch_ids should either always be specified or<br>
never, mixing could potentially result in duplicate batch ids.</tt></dd></dl>
<dl><dt><a name="BatchFeed-AddQuery"><strong>AddQuery</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br>
<br>
This method takes either the url_string which is the query URL<br>
whose results will be added to the result feed. The query URL will<br>
be encapsulated in a <a href="#BatchEntry">BatchEntry</a>, and you may pass in the <a href="#BatchEntry">BatchEntry</a><br>
with a query URL instead of sending a url_string.<br>
<br>
Args:<br>
url_string: str (optional)<br>
entry: <a href="#BatchEntry">BatchEntry</a> (optional)<br>
batch_id_string: str (optional)<br>
<br>
Raises:<br>
<a href="#MissingRequiredParameters">MissingRequiredParameters</a></tt></dd></dl>
<dl><dt><a name="BatchFeed-AddUpdate"><strong>AddUpdate</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br>
<br>
Sets the operation type of the entry to insert if it is not already set<br>
and assigns the desired batch id to the entry so that it can be<br>
referenced in the server's response.<br>
<br>
Args:<br>
entry: <a href="#BatchEntry">BatchEntry</a> The entry which will be sent to the server as an<br>
update (HTTP PUT) request. The item must have a valid atom id<br>
so that the server knows which entry to replace.<br>
batch_id_string: str (optional) The batch ID to be used to reference<br>
this batch operation in the results feed. If this parameter is None,<br>
the current length of the feed's entry array will be used as a<br>
count. See also comments for AddInsert.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetBatchLink"><strong>GetBatchLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-__init__"><strong>__init__</strong></a>(self, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, contributor<font color="#909090">=None</font>, generator<font color="#909090">=None</font>, icon<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, logo<font color="#909090">=None</font>, rights<font color="#909090">=None</font>, subtitle<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, total_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, items_per_page<font color="#909090">=None</font>, interrupted<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataFeed">GDataFeed</a>:<br>
<dl><dt><strong>generator</strong></dt>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchFeed-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="BatchFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="BatchFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetSelfLink"><strong>GetSelfLink</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br>
<br>
Returns:<br>
An atom.Link or none if none of the links had rel equal to 'self'</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#LinkFinder">atom.LinkFinder</a>:<br>
<dl><dt><a name="BatchFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="BatchFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a>(self)</dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchId">class <strong>BatchId</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchId">BatchId</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchId-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchId-__init__"><strong>__init__</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl>
<dl><dt><a name="BatchId-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchId-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchInterrupted">class <strong>BatchInterrupted</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The batch:interrupted element sent if batch request was interrupted.<br>
<br>
Only appears in a feed if some of the batch entries could not be processed.<br>
See: <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchInterrupted">BatchInterrupted</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchInterrupted-__init__"><strong>__init__</strong></a>(self, reason<font color="#909090">=None</font>, success<font color="#909090">=None</font>, failures<font color="#909090">=None</font>, parsed<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchInterrupted-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchInterrupted-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchInterrupted-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchOperation">class <strong>BatchOperation</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchOperation">BatchOperation</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchOperation-__init__"><strong>__init__</strong></a>(self, op_type<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchOperation-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchOperation-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchOperation-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BatchStatus">class <strong>BatchStatus</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The batch:status element present in a batch response entry.<br>
<br>
A status element contains the code (HTTP response code) and<br>
reason as elements. In a single request these fields would<br>
be part of the HTTP response, but in a batch request each<br>
<a href="atom.html#Entry">Entry</a> operation has a corresponding <a href="atom.html#Entry">Entry</a> in the response<br>
feed which includes status information.<br>
<br>
See <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a><br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#BatchStatus">BatchStatus</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BatchStatus-__init__"><strong>__init__</strong></a>(self, code<font color="#909090">=None</font>, reason<font color="#909090">=None</font>, content_type<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="BatchStatus-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="BatchStatus-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="BatchStatus-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="EntryLink">class <strong>EntryLink</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The gd:entryLink element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#EntryLink">EntryLink</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="EntryLink-__init__"><strong>__init__</strong></a>(self, href<font color="#909090">=None</font>, read_only<font color="#909090">=None</font>, rel<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="EntryLink-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="EntryLink-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="EntryLink-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#Error">Error</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
<br>
Use of negative indices is not supported.</tt></dd></dl>
<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ExtendedProperty">class <strong>ExtendedProperty</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Google Data extendedProperty element.<br>
<br>
Used to store arbitrary key-value information specific to your<br>
application. The value can either be a text string stored as an XML<br>
attribute (.value), or an XML node (XmlBlob) as a child element.<br>
<br>
This element is used in the Google Calendar data API and the Google<br>
Contacts data API.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#ExtendedProperty">ExtendedProperty</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ExtendedProperty-GetXmlBlobExtensionElement"><strong>GetXmlBlobExtensionElement</strong></a>(self)</dt><dd><tt>Returns the XML blob as an atom.ExtensionElement.<br>
<br>
Returns:<br>
An atom.ExtensionElement representing the blob's XML, or None if no<br>
blob was set.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-GetXmlBlobString"><strong>GetXmlBlobString</strong></a>(self)</dt><dd><tt>Returns the XML blob as a string.<br>
<br>
Returns:<br>
A string containing the blob's XML, or None if no blob was set.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-SetXmlBlob"><strong>SetXmlBlob</strong></a>(self, blob)</dt><dd><tt>Sets the contents of the extendedProperty to XML as a child node.<br>
<br>
Since the extendedProperty is only allowed one child element as an XML<br>
blob, setting the XML blob will erase any preexisting extension elements<br>
in this <a href="__builtin__.html#object">object</a>.<br>
<br>
Args:<br>
blob: str, ElementTree Element or atom.ExtensionElement representing<br>
the XML blob stored in the extendedProperty.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-__init__"><strong>__init__</strong></a>(self, name<font color="#909090">=None</font>, value<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="ExtendedProperty-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="ExtendedProperty-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="ExtendedProperty-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="FeedLink">class <strong>FeedLink</strong></a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The gd:feedLink element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#FeedLink">FeedLink</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FeedLink-__init__"><strong>__init__</strong></a>(self, count_hint<font color="#909090">=None</font>, href<font color="#909090">=None</font>, read_only<font color="#909090">=None</font>, rel<font color="#909090">=None</font>, feed<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="FeedLink-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="FeedLink-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="FeedLink-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="GDataEntry">class <strong>GDataEntry</strong></a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">LinkFinder</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Extends Atom <a href="atom.html#Entry">Entry</a> to provide data processing<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.html#GDataEntry">GDataEntry</a></dd>
<dd><a href="atom.html#Entry">atom.Entry</a></dd>
<dd><a href="atom.html#FeedEntryParent">atom.FeedEntryParent</a></dd>
<dd><a href="atom.html#AtomBase">atom.AtomBase</a></dd>
<dd><a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a></dd>
<dd><a href="gdata.html#LinkFinder">LinkFinder</a></dd>
<dd><a href="atom.html#LinkFinder">atom.LinkFinder</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="GDataEntry-GetMediaURL"><strong>GetMediaURL</strong></a>(self)</dt><dd><tt>Returns the URL to the media content, if the entry is a media entry.<br>
Otherwise returns None.</tt></dd></dl>
<dl><dt><a name="GDataEntry-IsMedia"><strong>IsMedia</strong></a>(self)</dt><dd><tt>Determines whether or not an entry is a GData Media entry.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>id</strong></dt>
</dl>
<hr>
Methods inherited from <a href="atom.html#Entry">atom.Entry</a>:<br>
<dl><dt><a name="GDataEntry-__init__"><strong>__init__</strong></a>(*args, **kwargs)</dt><dd><tt># The deprecated_function wraps the actual call to f.</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="GDataEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom <a href="__builtin__.html#object">object</a> to a string containing XML.</tt></dd></dl>
<dl><dt><a name="GDataEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><a name="GDataEntry-FindExtensions"><strong>FindExtensions</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>)</dt><dd><tt>Searches extension elements for child nodes with the desired name.<br>
<br>
Returns a list of extension elements within this <a href="__builtin__.html#object">object</a> whose tag<br>
and/or namespace match those passed in. To find all extensions in<br>
a particular namespace, specify the namespace but not the tag name.<br>
If you specify only the tag, the result list may contain extension<br>
elements in multiple namespaces.<br>
<br>
Args:<br>
tag: str (optional) The desired tag<br>
namespace: str (optional) The desired namespace<br>
<br>
Returns:<br>
A list of elements whose tag and/or namespace match the parameters<br>
values</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.html#ExtensionContainer">atom.ExtensionContainer</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.html#LinkFinder">LinkFinder</a>:<br>
<dl><dt><a name="GDataEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a>(self)</dt><dd><tt>The Picasa API mistakenly returns media-edit rather than edit-media, but<br>
this may change soon.</tt></dd></dl>
<dl><dt><a name="GDataEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a>(self)</dt><dd><tt>Find the first link with rel of alternate and type of text/html<br>
<br>
Returns:<br>
An atom.Link or None if no links matched</tt></dd></dl>
<dl><dt><a name="GDataEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="GDataEntry-GetPostLink"><strong>GetPostLink</strong></a>(self)</dt><dd><tt>Get a link containing the POST target URL.<br>
<br>
The POST target URL is used to insert new entries.<br>
<br>
Returns:<br>
A link <a href="__builtin__.html#object">object</a> with a rel matching the POST type.</tt></dd></dl>