| |
| <!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/google/home/afshar/src/external-gdata-release/google3/src/gdata/docs/__init__.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/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> |
