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
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package gdata.docs</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><a href="gdata.html"><font color="#ffffff">gdata</font></a>.docs</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/svn/gdata-python-client/src/gdata/docs/__init__.py">/usr/local/svn/gdata-python-client/src/gdata/docs/__init__.py</a></font></td></tr></table>
<p><tt>Contains extensions to Atom objects used with Google Documents.</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.docs.client.html">client</a><br>
</td><td width="25%" valign=top><a href="gdata.docs.data.html">data</a><br>
</td><td width="25%" valign=top><a href="gdata.docs.service.html">service</a><br>
</td><td width="25%" valign=top></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="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.docs.html#FeedLink">FeedLink</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#ResourceId">ResourceId</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#Role">Role</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#Scope">Scope</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#WritersCanInvite">WritersCanInvite</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="atom.html#Person">atom.Person</a>(<a href="atom.html#AtomBase">atom.AtomBase</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.docs.html#LastModifiedBy">LastModifiedBy</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#LastViewed">LastViewed</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataEntry">gdata.GDataEntry</a>(<a href="atom.html#Entry">atom.Entry</a>, <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.docs.html#DocumentListAclEntry">DocumentListAclEntry</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#DocumentListEntry">DocumentListEntry</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.html#GDataFeed">gdata.GDataFeed</a>(<a href="atom.html#Feed">atom.Feed</a>, <a href="gdata.html#LinkFinder">gdata.LinkFinder</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.docs.html#DocumentListAclFeed">DocumentListAclFeed</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.docs.html#DocumentListFeed">DocumentListFeed</a>
</font></dt></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="DocumentListAclEntry">class <strong>DocumentListAclEntry</strong></a>(<a href="gdata.html#GDataEntry">gdata.GDataEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A DocList ACL Entry flavor of an Atom Entry<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#DocumentListAclEntry">DocumentListAclEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">gdata.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">gdata.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="DocumentListAclEntry-__init__"><strong>__init__</strong></a>(self, category<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, scope<font color="#909090">=None</font>, role<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">gdata.GDataEntry</a>:<br>
<dl><dt><a name="DocumentListAclEntry-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="DocumentListAclEntry-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">gdata.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="DocumentListAclEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="DocumentListAclEntry-__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="DocumentListAclEntry-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 object 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">gdata.LinkFinder</a>:<br>
<dl><dt><a name="DocumentListAclEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-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="DocumentListAclEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-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="DocumentListAclEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-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 object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="DocumentListAclEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-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="DocumentListAclEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclEntry-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="DocumentListAclFeed">class <strong>DocumentListAclFeed</strong></a>(<a href="gdata.html#GDataFeed">gdata.GDataFeed</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A DocList ACL feed flavor of a Atom feed<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#DocumentListAclFeed">DocumentListAclFeed</a></dd>
<dd><a href="gdata.html#GDataFeed">gdata.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">gdata.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 inherited from <a href="gdata.html#GDataFeed">gdata.GDataFeed</a>:<br>
<dl><dt><a name="DocumentListAclFeed-__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>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt><dd><tt>Constructor for Source<br>
<br>
Args:<br>
author: list (optional) A list of Author instances which belong to this<br>
class.<br>
category: list (optional) A list of Category instances<br>
contributor: list (optional) A list on Contributor instances<br>
generator: Generator (optional)<br>
icon: Icon (optional)<br>
id: Id (optional) The entry's Id element<br>
link: list (optional) A list of Link instances<br>
logo: Logo (optional)<br>
rights: Rights (optional) The entry's Rights element<br>
subtitle: Subtitle (optional) The entry's subtitle element<br>
title: Title (optional) the entry's title element<br>
updated: Updated (optional) the entry's updated element<br>
entry: list (optional) A list of the Entry instances contained in the<br>
feed.<br>
text: String (optional) The text contents of the element. This is the<br>
contents of the Entry's XML text node.<br>
(Example: <foo>This is the text</foo>)<br>
extension_elements: list (optional) A list of ExtensionElement instances<br>
which are children of this element.<br>
extension_attributes: dict (optional) A dictionary of strings which are<br>
the values for additional XML attributes of this element.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataFeed">gdata.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="DocumentListAclFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="DocumentListAclFeed-__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="DocumentListAclFeed-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 object 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">gdata.LinkFinder</a>:<br>
<dl><dt><a name="DocumentListAclFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-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="DocumentListAclFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-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="DocumentListAclFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-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 object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="DocumentListAclFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-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="DocumentListAclFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListAclFeed-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="DocumentListEntry">class <strong>DocumentListEntry</strong></a>(<a href="gdata.html#GDataEntry">gdata.GDataEntry</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Google Documents version of an Atom Entry<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#DocumentListEntry">DocumentListEntry</a></dd>
<dd><a href="gdata.html#GDataEntry">gdata.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">gdata.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="DocumentListEntry-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt><dd><tt>Extracts the DocListEntry's <gd:feedLink>.<br>
<br>
Returns:<br>
A <a href="#FeedLink">FeedLink</a> object.</tt></dd></dl>
<dl><dt><a name="DocumentListEntry-GetDocumentType"><strong>GetDocumentType</strong></a>(self)</dt><dd><tt>Extracts the type of document from the DocListEntry.<br>
<br>
This method returns the type of document the DocListEntry<br>
represents. Possible values are document, presentation,<br>
spreadsheet, folder, or pdf.<br>
<br>
Returns:<br>
A string representing the type of document.</tt></dd></dl>
<dl><dt><a name="DocumentListEntry-__init__"><strong>__init__</strong></a>(self, resourceId<font color="#909090">=None</font>, feedLink<font color="#909090">=None</font>, lastViewed<font color="#909090">=None</font>, lastModifiedBy<font color="#909090">=None</font>, writersCanInvite<font color="#909090">=None</font>, author<font color="#909090">=None</font>, category<font color="#909090">=None</font>, content<font color="#909090">=None</font>, atom_id<font color="#909090">=None</font>, link<font color="#909090">=None</font>, published<font color="#909090">=None</font>, title<font color="#909090">=None</font>, updated<font color="#909090">=None</font>, text<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="gdata.html#GDataEntry">gdata.GDataEntry</a>:<br>
<dl><dt><a name="DocumentListEntry-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="DocumentListEntry-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">gdata.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="DocumentListEntry-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="DocumentListEntry-__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="DocumentListEntry-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 object 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">gdata.LinkFinder</a>:<br>
<dl><dt><a name="DocumentListEntry-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListEntry-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="DocumentListEntry-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListEntry-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="DocumentListEntry-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListEntry-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 object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="DocumentListEntry-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListEntry-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="DocumentListEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListEntry-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="DocumentListFeed">class <strong>DocumentListFeed</strong></a>(<a href="gdata.html#GDataFeed">gdata.GDataFeed</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A feed containing a list of Google Documents Items<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#DocumentListFeed">DocumentListFeed</a></dd>
<dd><a href="gdata.html#GDataFeed">gdata.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">gdata.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 inherited from <a href="gdata.html#GDataFeed">gdata.GDataFeed</a>:<br>
<dl><dt><a name="DocumentListFeed-__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>, extension_elements<font color="#909090">=None</font>, extension_attributes<font color="#909090">=None</font>, text<font color="#909090">=None</font>)</dt><dd><tt>Constructor for Source<br>
<br>
Args:<br>
author: list (optional) A list of Author instances which belong to this<br>
class.<br>
category: list (optional) A list of Category instances<br>
contributor: list (optional) A list on Contributor instances<br>
generator: Generator (optional)<br>
icon: Icon (optional)<br>
id: Id (optional) The entry's Id element<br>
link: list (optional) A list of Link instances<br>
logo: Logo (optional)<br>
rights: Rights (optional) The entry's Rights element<br>
subtitle: Subtitle (optional) The entry's subtitle element<br>
title: Title (optional) the entry's title element<br>
updated: Updated (optional) the entry's updated element<br>
entry: list (optional) A list of the Entry instances contained in the<br>
feed.<br>
text: String (optional) The text contents of the element. This is the<br>
contents of the Entry's XML text node.<br>
(Example: <foo>This is the text</foo>)<br>
extension_elements: list (optional) A list of ExtensionElement instances<br>
which are children of this element.<br>
extension_attributes: dict (optional) A dictionary of strings which are<br>
the values for additional XML attributes of this element.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="gdata.html#GDataFeed">gdata.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="DocumentListFeed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="DocumentListFeed-__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="DocumentListFeed-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 object 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">gdata.LinkFinder</a>:<br>
<dl><dt><a name="DocumentListFeed-GetAclLink"><strong>GetAclLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-GetEditLink"><strong>GetEditLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-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="DocumentListFeed-GetFeedLink"><strong>GetFeedLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-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="DocumentListFeed-GetNextLink"><strong>GetNextLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-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 object with a rel matching the POST type.</tt></dd></dl>
<dl><dt><a name="DocumentListFeed-GetPrevLink"><strong>GetPrevLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-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="DocumentListFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a>(self)</dt></dl>
<dl><dt><a name="DocumentListFeed-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="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 DocList gd:feedLink element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.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, href<font color="#909090">=None</font>, rel<font color="#909090">=None</font>, text<font color="#909090">=None</font>, extension_elements<font color="#909090">=None</font>, extension_attributes<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 object 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 object 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="LastModifiedBy">class <strong>LastModifiedBy</strong></a>(<a href="atom.html#Person">atom.Person</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The DocList gd:lastModifiedBy element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#LastModifiedBy">LastModifiedBy</a></dd>
<dd><a href="atom.html#Person">atom.Person</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#Person">atom.Person</a>:<br>
<dl><dt><a name="LastModifiedBy-__init__"><strong>__init__</strong></a>(self, name<font color="#909090">=None</font>, email<font color="#909090">=None</font>, uri<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><dd><tt>Foundation from which author and contributor are derived.<br>
<br>
The constructor is provided for illustrative purposes, you should not<br>
need to instantiate a <a href="atom.html#Person">Person</a>.<br>
<br>
Args:<br>
name: Name The person's name<br>
email: Email The person's email address<br>
uri: Uri The URI of the person's webpage<br>
extension_elements: list A list of ExtensionElement instances which are<br>
children of this element.<br>
extension_attributes: dict A dictionary of strings which are the values<br>
for additional XML attributes of this element.<br>
text: String The text contents of the element. This is the contents<br>
of the Entry's XML text node. (Example: <foo>This is the text</foo>)</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="LastModifiedBy-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="LastModifiedBy-__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="LastModifiedBy-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 object 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="LastViewed">class <strong>LastViewed</strong></a>(<a href="atom.html#Person">atom.Person</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The DocList gd:lastViewed element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#LastViewed">LastViewed</a></dd>
<dd><a href="atom.html#Person">atom.Person</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#Person">atom.Person</a>:<br>
<dl><dt><a name="LastViewed-__init__"><strong>__init__</strong></a>(self, name<font color="#909090">=None</font>, email<font color="#909090">=None</font>, uri<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><dd><tt>Foundation from which author and contributor are derived.<br>
<br>
The constructor is provided for illustrative purposes, you should not<br>
need to instantiate a <a href="atom.html#Person">Person</a>.<br>
<br>
Args:<br>
name: Name The person's name<br>
email: Email The person's email address<br>
uri: Uri The URI of the person's webpage<br>
extension_elements: list A list of ExtensionElement instances which are<br>
children of this element.<br>
extension_attributes: dict A dictionary of strings which are the values<br>
for additional XML attributes of this element.<br>
text: String The text contents of the element. This is the contents<br>
of the Entry's XML text node. (Example: <foo>This is the text</foo>)</tt></dd></dl>
<hr>
Methods inherited from <a href="atom.html#AtomBase">atom.AtomBase</a>:<br>
<dl><dt><a name="LastViewed-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="LastViewed-__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="LastViewed-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 object 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="ResourceId">class <strong>ResourceId</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 DocList gd:resourceId element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#ResourceId">ResourceId</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="ResourceId-__init__"><strong>__init__</strong></a>(self, 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="ResourceId-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="ResourceId-__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="ResourceId-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 object 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="Role">class <strong>Role</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 DocList ACL role element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#Role">Role</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="Role-__init__"><strong>__init__</strong></a>(self, 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="Role-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="Role-__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="Role-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 object 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="Scope">class <strong>Scope</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 DocList ACL scope element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#Scope">Scope</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="Scope-__init__"><strong>__init__</strong></a>(self, value<font color="#909090">=None</font>, 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="Scope-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="Scope-__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="Scope-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 object 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="WritersCanInvite">class <strong>WritersCanInvite</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 DocList docs:writersCanInvite element<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.docs.html#WritersCanInvite">WritersCanInvite</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="WritersCanInvite-ToString"><strong>ToString</strong></a>(self, string_encoding<font color="#909090">='UTF-8'</font>)</dt><dd><tt>Converts the Atom object to a string containing XML.</tt></dd></dl>
<dl><dt><a name="WritersCanInvite-__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="WritersCanInvite-__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="WritersCanInvite-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 object 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></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-DocumentListAclEntryFromString"><strong>DocumentListAclEntryFromString</strong></a>(xml_string)</dt><dd><tt>Converts an XML string into a <a href="#DocumentListAclEntry">DocumentListAclEntry</a> object.<br>
<br>
Args:<br>
xml_string: string The XML describing a Document List ACL feed entry.<br>
<br>
Returns:<br>
A <a href="#DocumentListAclEntry">DocumentListAclEntry</a> object corresponding to the given XML.</tt></dd></dl>
<dl><dt><a name="-DocumentListAclFeedFromString"><strong>DocumentListAclFeedFromString</strong></a>(xml_string)</dt><dd><tt>Converts an XML string into a <a href="#DocumentListAclFeed">DocumentListAclFeed</a> object.<br>
<br>
Args:<br>
xml_string: string The XML describing a DocumentList feed.<br>
<br>
Returns:<br>
A <a href="#DocumentListFeed">DocumentListFeed</a> object corresponding to the given XML.</tt></dd></dl>
<dl><dt><a name="-DocumentListEntryFromString"><strong>DocumentListEntryFromString</strong></a>(xml_string)</dt><dd><tt>Converts an XML string into a <a href="#DocumentListEntry">DocumentListEntry</a> object.<br>
<br>
Args:<br>
xml_string: string The XML describing a Document List feed entry.<br>
<br>
Returns:<br>
A <a href="#DocumentListEntry">DocumentListEntry</a> object corresponding to the given XML.</tt></dd></dl>
<dl><dt><a name="-DocumentListFeedFromString"><strong>DocumentListFeedFromString</strong></a>(xml_string)</dt><dd><tt>Converts an XML string into a <a href="#DocumentListFeed">DocumentListFeed</a> object.<br>
<br>
Args:<br>
xml_string: string The XML describing a DocumentList feed.<br>
<br>
Returns:<br>
A <a href="#DocumentListFeed">DocumentListFeed</a> object corresponding to the given XML.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>DOCUMENTS_NAMESPACE</strong> = 'http://schemas.google.com/docs/2007'<br>
<strong>__author__</strong> = 'api.jfisher (Jeff Fisher), api.eric@google.com (Eric Bidelman)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">api.jfisher (Jeff Fisher), api.eric@google.com (Eric Bidelman)</td></tr></table>
</body></html>
|