| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.books.data</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>.<a href="gdata.books.html"><font color="#ffffff">books</font></a>.data</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/books/data.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/books/data.py</a></font></td></tr></table> |
| <p><tt>Contains the data classes of the Google Book Search Data API</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>Modules</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="atom.html">atom</a><br> |
| </td><td width="25%" valign=top><a href="gdata.html">gdata</a><br> |
| </td><td width="25%" valign=top></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.core.html#XmlElement">atom.core.XmlElement</a>(<a href="__builtin__.html#object">__builtin__.object</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.books.data.html#Embeddability">Embeddability</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.books.data.html#OpenAccess">OpenAccess</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.books.data.html#Review">Review</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.books.data.html#Viewability">Viewability</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>(<a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.books.data.html#CollectionFeed">CollectionFeed</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.books.data.html#VolumeFeed">VolumeFeed</a> |
| </font></dt></dl> |
| </dd> |
| <dt><font face="helvetica, arial"><a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>(<a href="atom.data.html#Entry">atom.data.Entry</a>, <a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.books.data.html#CollectionEntry">CollectionEntry</a> |
| </font></dt><dt><font face="helvetica, arial"><a href="gdata.books.data.html#VolumeEntry">VolumeEntry</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="CollectionEntry">class <strong>CollectionEntry</strong></a>(<a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes an entry in a feed of collections.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#CollectionEntry">CollectionEntry</a></dd> |
| <dd><a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a></dd> |
| <dd><a href="atom.data.html#Entry">atom.data.Entry</a></dd> |
| <dd><a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a></dd> |
| <dd><a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods inherited from <a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>:<br> |
| <dl><dt><a name="CollectionEntry-FindMediaLink"><strong>FindMediaLink</strong></a> = find_media_link(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="CollectionEntry-GetId"><strong>GetId</strong></a> = get_id(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-IsMedia"><strong>IsMedia</strong></a> = is_media(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_media_link"><strong>find_media_link</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="CollectionEntry-get_id"><strong>get_id</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-is_media"><strong>is_media</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>:<br> |
| <dl><dt><strong>etag</strong> = '{http://schemas.google.com/g/2005}etag'</dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#Entry">atom.data.Entry</a>:<br> |
| <dl><dt><strong>content</strong> = <class 'atom.data.Content'><dd><tt>The atom:content element.</tt></dl> |
| |
| <dl><dt><strong>control</strong> = <class 'atom.data.Control'><dd><tt>The app:control element indicating restrictions on publication.<br> |
| <br> |
| The APP control element may contain a draft element indicating whether or<br> |
| not this entry should be publicly available.</tt></dl> |
| |
| <dl><dt><strong>published</strong> = <class 'atom.data.Published'><dd><tt>The atom:published element.</tt></dl> |
| |
| <dl><dt><strong>source</strong> = <class 'atom.data.Source'><dd><tt>The atom:source element.</tt></dl> |
| |
| <dl><dt><strong>summary</strong> = <class 'atom.data.Summary'><dd><tt>The atom:summary element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><a name="CollectionEntry-__init__"><strong>__init__</strong></a>(self, atom_id<font color="#909090">=None</font>, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><strong>author</strong> = [<class 'atom.data.Author'>]</dl> |
| |
| <dl><dt><strong>category</strong> = [<class 'atom.data.Category'>]</dl> |
| |
| <dl><dt><strong>contributor</strong> = [<class 'atom.data.Contributor'>]</dl> |
| |
| <dl><dt><strong>id</strong> = <class 'atom.data.Id'><dd><tt>The atom:id element.</tt></dl> |
| |
| <dl><dt><strong>link</strong> = [<class 'atom.data.Link'>]</dl> |
| |
| <dl><dt><strong>rights</strong> = <class 'atom.data.Rights'><dd><tt>The atom:rights element.</tt></dl> |
| |
| <dl><dt><strong>title</strong> = <class 'atom.data.Title'><dd><tt>The atom:title element.</tt></dl> |
| |
| <dl><dt><strong>updated</strong> = <class 'atom.data.Updated'><dd><tt>The atom:updated element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="CollectionEntry-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a>:<br> |
| <dl><dt><a name="CollectionEntry-FindAclLink"><strong>FindAclLink</strong></a> = find_acl_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindFeedLink"><strong>FindFeedLink</strong></a> = find_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindHtmlLink"><strong>FindHtmlLink</strong></a> = find_html_link(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindPostLink"><strong>FindPostLink</strong></a> = find_post_link(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindPreviousLink"><strong>FindPreviousLink</strong></a> = find_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetAclLink"><strong>GetAclLink</strong></a> = get_acl_link(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetFeedLink"><strong>GetFeedLink</strong></a> = get_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a> = get_html_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetPostLink"><strong>GetPostLink</strong></a> = get_post_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetPreviousLink"><strong>GetPreviousLink</strong></a> = get_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_acl_link"><strong>find_acl_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_feed_link"><strong>find_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_html_link"><strong>find_html_link</strong></a>(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_post_link"><strong>find_post_link</strong></a>(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_previous_link"><strong>find_previous_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_acl_link"><strong>get_acl_link</strong></a>(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_feed_link"><strong>get_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_html_link"><strong>get_html_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_post_link"><strong>get_post_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_previous_link"><strong>get_previous_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a>:<br> |
| <dl><dt><a name="CollectionEntry-FindAlternateLink"><strong>FindAlternateLink</strong></a> = find_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindEditLink"><strong>FindEditLink</strong></a> = find_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindEditMediaLink"><strong>FindEditMediaLink</strong></a> = find_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindLicenseLink"><strong>FindLicenseLink</strong></a> = find_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindNextLink"><strong>FindNextLink</strong></a> = find_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindSelfLink"><strong>FindSelfLink</strong></a> = find_self_link(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-FindUrl"><strong>FindUrl</strong></a> = find_url(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a> = get_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetEditLink"><strong>GetEditLink</strong></a> = get_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a> = get_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a> = get_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetLink"><strong>GetLink</strong></a> = get_link(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetNextLink"><strong>GetNextLink</strong></a> = get_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-GetSelfLink"><strong>GetSelfLink</strong></a> = get_self_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_alternate_link"><strong>find_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_edit_link"><strong>find_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_edit_media_link"><strong>find_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_license_link"><strong>find_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_next_link"><strong>find_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_self_link"><strong>find_self_link</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-find_url"><strong>find_url</strong></a>(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_alternate_link"><strong>get_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_edit_link"><strong>get_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_edit_media_link"><strong>get_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_license_link"><strong>get_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_link"><strong>get_link</strong></a>(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_next_link"><strong>get_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionEntry-get_self_link"><strong>get_self_link</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="CollectionFeed">class <strong>CollectionFeed</strong></a>(<a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes a Book Search collection feed.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#CollectionFeed">CollectionFeed</a></dd> |
| <dd><a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a></dd> |
| <dd><a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a></dd> |
| <dd><a href="atom.data.html#Feed">atom.data.Feed</a></dd> |
| <dd><a href="atom.data.html#Source">atom.data.Source</a></dd> |
| <dd><a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a></dd> |
| <dd><a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>entry</strong> = [<class 'gdata.books.data.CollectionEntry'>]</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>:<br> |
| <dl><dt><a name="CollectionFeed-AddBatchEntry"><strong>AddBatchEntry</strong></a> = add_batch_entry(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a BatchEntry and adding to the feed.<br> |
| <br> |
| If the entry is not a BatchEntry, it is converted to a BatchEntry so<br> |
| that the batch specific members will be present.<br> |
| <br> |
| The id_url_string can be used in place of an entry if the batch operation<br> |
| applies to a URL. For example query and delete operations require just<br> |
| the URL of an entry, no body is sent in the HTTP request. If an<br> |
| id_url_string is sent instead of an entry, a BatchEntry is created and<br> |
| added to the feed.<br> |
| <br> |
| This method also assigns the desired batch id to the entry so that it<br> |
| can be referenced in the server's response. If the batch_id_string is<br> |
| None, this method will assign a batch_id to be the index at which this<br> |
| entry will be in the feed's entry list.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)<br> |
| The entry which will be sent to the server as part of the batch<br> |
| request. The item must have a valid atom id so that the server<br> |
| knows which entry this request references.<br> |
| id_url_string: str (optional) The URL of the entry to be acted on. You<br> |
| can find this URL in the text member of the atom id for an entry.<br> |
| If an entry is not sent, this id will be used to construct a new<br> |
| BatchEntry which will be added to the request feed.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.<br> |
| operation_string: str (optional) The desired batch operation which will<br> |
| set the batch_operation.type member of the entry. Options are<br> |
| 'insert', 'update', 'delete', and 'query'<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither an id_ url_string nor an<br> |
| entry are provided in the request.<br> |
| <br> |
| Returns:<br> |
| The added entry.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-AddDelete"><strong>AddDelete</strong></a> = add_delete(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the atom id of the item<br> |
| to be deleted, or the entry itself. The atom id of the entry must be<br> |
| present so that the server knows which entry should be deleted.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional) The URL of the entry to be deleted. You can<br> |
| find this URL in the text member of the atom id for an entry.<br> |
| entry: BatchEntry (optional) The entry to be deleted.<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither a url_string nor an entry<br> |
| are provided in the request.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-AddInsert"><strong>AddInsert</strong></a> = add_insert(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br> |
| <br> |
| If the entry doesn't yet have an operation or a batch id, these will<br> |
| be set to the insert operation and a batch_id specified as a parameter.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent in the batch feed as an<br> |
| insert request.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-AddQuery"><strong>AddQuery</strong></a> = add_query(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the query URL<br> |
| whose results will be added to the result feed. The query URL will<br> |
| be encapsulated in a BatchEntry, and you may pass in the BatchEntry<br> |
| with a query URL instead of sending a url_string.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional)<br> |
| entry: BatchEntry (optional)<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-AddUpdate"><strong>AddUpdate</strong></a> = add_update(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br> |
| <br> |
| Sets the operation type of the entry to insert if it is not already set<br> |
| and assigns the desired batch id to the entry so that it can be<br> |
| referenced in the server's response.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent to the server as an<br> |
| update (HTTP PUT) request. The item must have a valid atom id<br> |
| so that the server knows which entry to replace.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. See also comments for AddInsert.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindBatchLink"><strong>FindBatchLink</strong></a> = find_batch_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-add_batch_entry"><strong>add_batch_entry</strong></a>(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a BatchEntry and adding to the feed.<br> |
| <br> |
| If the entry is not a BatchEntry, it is converted to a BatchEntry so<br> |
| that the batch specific members will be present.<br> |
| <br> |
| The id_url_string can be used in place of an entry if the batch operation<br> |
| applies to a URL. For example query and delete operations require just<br> |
| the URL of an entry, no body is sent in the HTTP request. If an<br> |
| id_url_string is sent instead of an entry, a BatchEntry is created and<br> |
| added to the feed.<br> |
| <br> |
| This method also assigns the desired batch id to the entry so that it<br> |
| can be referenced in the server's response. If the batch_id_string is<br> |
| None, this method will assign a batch_id to be the index at which this<br> |
| entry will be in the feed's entry list.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)<br> |
| The entry which will be sent to the server as part of the batch<br> |
| request. The item must have a valid atom id so that the server<br> |
| knows which entry this request references.<br> |
| id_url_string: str (optional) The URL of the entry to be acted on. You<br> |
| can find this URL in the text member of the atom id for an entry.<br> |
| If an entry is not sent, this id will be used to construct a new<br> |
| BatchEntry which will be added to the request feed.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.<br> |
| operation_string: str (optional) The desired batch operation which will<br> |
| set the batch_operation.type member of the entry. Options are<br> |
| 'insert', 'update', 'delete', and 'query'<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither an id_ url_string nor an<br> |
| entry are provided in the request.<br> |
| <br> |
| Returns:<br> |
| The added entry.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-add_delete"><strong>add_delete</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the atom id of the item<br> |
| to be deleted, or the entry itself. The atom id of the entry must be<br> |
| present so that the server knows which entry should be deleted.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional) The URL of the entry to be deleted. You can<br> |
| find this URL in the text member of the atom id for an entry.<br> |
| entry: BatchEntry (optional) The entry to be deleted.<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither a url_string nor an entry<br> |
| are provided in the request.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-add_insert"><strong>add_insert</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br> |
| <br> |
| If the entry doesn't yet have an operation or a batch id, these will<br> |
| be set to the insert operation and a batch_id specified as a parameter.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent in the batch feed as an<br> |
| insert request.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-add_query"><strong>add_query</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the query URL<br> |
| whose results will be added to the result feed. The query URL will<br> |
| be encapsulated in a BatchEntry, and you may pass in the BatchEntry<br> |
| with a query URL instead of sending a url_string.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional)<br> |
| entry: BatchEntry (optional)<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-add_update"><strong>add_update</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br> |
| <br> |
| Sets the operation type of the entry to insert if it is not already set<br> |
| and assigns the desired batch id to the entry so that it can be<br> |
| referenced in the server's response.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent to the server as an<br> |
| update (HTTP PUT) request. The item must have a valid atom id<br> |
| so that the server knows which entry to replace.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. See also comments for AddInsert.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_batch_link"><strong>find_batch_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>:<br> |
| <dl><dt><strong>interrupted</strong> = <class 'gdata.data.BatchInterrupted'><dd><tt>The batch:interrupted element sent if batch request was interrupted.<br> |
| <br> |
| Only appears in a feed if some of the batch entries could not be processed.<br> |
| See: <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a></tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a>:<br> |
| <dl><dt><a name="CollectionFeed-GetId"><strong>GetId</strong></a> = get_id(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_generator"><strong>get_generator</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_id"><strong>get_id</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a>:<br> |
| <dl><dt><strong>etag</strong> = '{http://schemas.google.com/g/2005}etag'</dl> |
| |
| <dl><dt><strong>items_per_page</strong> = <class 'gdata.data.ItemsPerPage'><dd><tt>The opensearch:itemsPerPage element in GData feed.</tt></dl> |
| |
| <dl><dt><strong>start_index</strong> = <class 'gdata.data.StartIndex'><dd><tt>The opensearch:startIndex element in GData feed.</tt></dl> |
| |
| <dl><dt><strong>total_results</strong> = <class 'gdata.data.TotalResults'><dd><tt>opensearch:TotalResults for a GData feed.</tt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#Source">atom.data.Source</a>:<br> |
| <dl><dt><strong>generator</strong> = <class 'atom.data.Generator'><dd><tt>The atom:generator element.</tt></dl> |
| |
| <dl><dt><strong>icon</strong> = <class 'atom.data.Icon'><dd><tt>The atom:icon element.</tt></dl> |
| |
| <dl><dt><strong>logo</strong> = <class 'atom.data.Logo'><dd><tt>The atom:logo element.</tt></dl> |
| |
| <dl><dt><strong>subtitle</strong> = <class 'atom.data.Subtitle'><dd><tt>The atom:subtitle element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><a name="CollectionFeed-__init__"><strong>__init__</strong></a>(self, atom_id<font color="#909090">=None</font>, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><strong>author</strong> = [<class 'atom.data.Author'>]</dl> |
| |
| <dl><dt><strong>category</strong> = [<class 'atom.data.Category'>]</dl> |
| |
| <dl><dt><strong>contributor</strong> = [<class 'atom.data.Contributor'>]</dl> |
| |
| <dl><dt><strong>id</strong> = <class 'atom.data.Id'><dd><tt>The atom:id element.</tt></dl> |
| |
| <dl><dt><strong>link</strong> = [<class 'atom.data.Link'>]</dl> |
| |
| <dl><dt><strong>rights</strong> = <class 'atom.data.Rights'><dd><tt>The atom:rights element.</tt></dl> |
| |
| <dl><dt><strong>title</strong> = <class 'atom.data.Title'><dd><tt>The atom:title element.</tt></dl> |
| |
| <dl><dt><strong>updated</strong> = <class 'atom.data.Updated'><dd><tt>The atom:updated element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="CollectionFeed-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a>:<br> |
| <dl><dt><a name="CollectionFeed-FindAclLink"><strong>FindAclLink</strong></a> = find_acl_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindFeedLink"><strong>FindFeedLink</strong></a> = find_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindHtmlLink"><strong>FindHtmlLink</strong></a> = find_html_link(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindPostLink"><strong>FindPostLink</strong></a> = find_post_link(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindPreviousLink"><strong>FindPreviousLink</strong></a> = find_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetAclLink"><strong>GetAclLink</strong></a> = get_acl_link(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetFeedLink"><strong>GetFeedLink</strong></a> = get_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a> = get_html_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetPostLink"><strong>GetPostLink</strong></a> = get_post_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetPreviousLink"><strong>GetPreviousLink</strong></a> = get_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_acl_link"><strong>find_acl_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_feed_link"><strong>find_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_html_link"><strong>find_html_link</strong></a>(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_post_link"><strong>find_post_link</strong></a>(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_previous_link"><strong>find_previous_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_acl_link"><strong>get_acl_link</strong></a>(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_feed_link"><strong>get_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_html_link"><strong>get_html_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_post_link"><strong>get_post_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_previous_link"><strong>get_previous_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a>:<br> |
| <dl><dt><a name="CollectionFeed-FindAlternateLink"><strong>FindAlternateLink</strong></a> = find_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindEditLink"><strong>FindEditLink</strong></a> = find_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindEditMediaLink"><strong>FindEditMediaLink</strong></a> = find_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindLicenseLink"><strong>FindLicenseLink</strong></a> = find_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindNextLink"><strong>FindNextLink</strong></a> = find_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindSelfLink"><strong>FindSelfLink</strong></a> = find_self_link(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-FindUrl"><strong>FindUrl</strong></a> = find_url(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a> = get_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetEditLink"><strong>GetEditLink</strong></a> = get_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a> = get_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a> = get_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetLink"><strong>GetLink</strong></a> = get_link(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetNextLink"><strong>GetNextLink</strong></a> = get_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-GetSelfLink"><strong>GetSelfLink</strong></a> = get_self_link(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_alternate_link"><strong>find_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_edit_link"><strong>find_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_edit_media_link"><strong>find_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_license_link"><strong>find_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_next_link"><strong>find_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_self_link"><strong>find_self_link</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-find_url"><strong>find_url</strong></a>(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_alternate_link"><strong>get_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_edit_link"><strong>get_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_edit_media_link"><strong>get_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_license_link"><strong>get_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_link"><strong>get_link</strong></a>(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_next_link"><strong>get_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="CollectionFeed-get_self_link"><strong>get_self_link</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="Embeddability">class <strong>Embeddability</strong></a>(<a href="atom.core.html#XmlElement">atom.core.XmlElement</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes an embeddability.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#Embeddability">Embeddability</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>value</strong> = 'value'</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="Embeddability-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="Embeddability-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Embeddability-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Embeddability-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</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="OpenAccess">class <strong>OpenAccess</strong></a>(<a href="atom.core.html#XmlElement">atom.core.XmlElement</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes an open access.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#OpenAccess">OpenAccess</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>value</strong> = 'value'</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="OpenAccess-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="OpenAccess-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="OpenAccess-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="OpenAccess-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</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="Review">class <strong>Review</strong></a>(<a href="atom.core.html#XmlElement">atom.core.XmlElement</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>User-provided review.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#Review">Review</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>lang</strong> = 'lang'</dl> |
| |
| <dl><dt><strong>type</strong> = 'type'</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="Review-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="Review-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Review-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Review-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</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="Viewability">class <strong>Viewability</strong></a>(<a href="atom.core.html#XmlElement">atom.core.XmlElement</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes a viewability.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#Viewability">Viewability</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>value</strong> = 'value'</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="Viewability-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-__init__"><strong>__init__</strong></a>(self, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="Viewability-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Viewability-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="Viewability-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</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="VolumeEntry">class <strong>VolumeEntry</strong></a>(<a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes an entry in a feed of Book Search volumes.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#VolumeEntry">VolumeEntry</a></dd> |
| <dd><a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a></dd> |
| <dd><a href="atom.data.html#Entry">atom.data.Entry</a></dd> |
| <dd><a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a></dd> |
| <dd><a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>comments</strong> = <class 'gdata.data.Comments'><dd><tt>The gd:comments element.<br> |
| <br> |
| Contains a comments feed for the enclosing entry (such as a calendar event).</tt></dl> |
| |
| <dl><dt><strong>creator</strong> = [<class 'gdata.dublincore.data.Creator'>]</dl> |
| |
| <dl><dt><strong>date</strong> = [<class 'gdata.dublincore.data.Date'>]</dl> |
| |
| <dl><dt><strong>dc_title</strong> = [<class 'gdata.dublincore.data.Title'>]</dl> |
| |
| <dl><dt><strong>description</strong> = [<class 'gdata.dublincore.data.Description'>]</dl> |
| |
| <dl><dt><strong>embeddability</strong> = <class 'gdata.books.data.Embeddability'><dd><tt>Describes an embeddability.</tt></dl> |
| |
| <dl><dt><strong>format</strong> = [<class 'gdata.dublincore.data.Format'>]</dl> |
| |
| <dl><dt><strong>identifier</strong> = [<class 'gdata.dublincore.data.Identifier'>]</dl> |
| |
| <dl><dt><strong>language</strong> = [<class 'gdata.dublincore.data.Language'>]</dl> |
| |
| <dl><dt><strong>open_access</strong> = <class 'gdata.books.data.OpenAccess'><dd><tt>Describes an open access.</tt></dl> |
| |
| <dl><dt><strong>publisher</strong> = [<class 'gdata.dublincore.data.Publisher'>]</dl> |
| |
| <dl><dt><strong>rating</strong> = <class 'gdata.data.Rating'><dd><tt>The gd:rating element.<br> |
| <br> |
| Represents a numeric rating of the enclosing entity, such as a<br> |
| comment. Each rating supplies its own scale, although it may be<br> |
| normalized by a service; for example, some services might convert all<br> |
| ratings to a scale from 1 to 5.</tt></dl> |
| |
| <dl><dt><strong>review</strong> = <class 'gdata.books.data.Review'><dd><tt>User-provided review.</tt></dl> |
| |
| <dl><dt><strong>subject</strong> = [<class 'gdata.dublincore.data.Subject'>]</dl> |
| |
| <dl><dt><strong>viewability</strong> = <class 'gdata.books.data.Viewability'><dd><tt>Describes a viewability.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>:<br> |
| <dl><dt><a name="VolumeEntry-FindMediaLink"><strong>FindMediaLink</strong></a> = find_media_link(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="VolumeEntry-GetId"><strong>GetId</strong></a> = get_id(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-IsMedia"><strong>IsMedia</strong></a> = is_media(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_media_link"><strong>find_media_link</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="VolumeEntry-get_id"><strong>get_id</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-is_media"><strong>is_media</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#GDEntry">gdata.data.GDEntry</a>:<br> |
| <dl><dt><strong>etag</strong> = '{http://schemas.google.com/g/2005}etag'</dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#Entry">atom.data.Entry</a>:<br> |
| <dl><dt><strong>content</strong> = <class 'atom.data.Content'><dd><tt>The atom:content element.</tt></dl> |
| |
| <dl><dt><strong>control</strong> = <class 'atom.data.Control'><dd><tt>The app:control element indicating restrictions on publication.<br> |
| <br> |
| The APP control element may contain a draft element indicating whether or<br> |
| not this entry should be publicly available.</tt></dl> |
| |
| <dl><dt><strong>published</strong> = <class 'atom.data.Published'><dd><tt>The atom:published element.</tt></dl> |
| |
| <dl><dt><strong>source</strong> = <class 'atom.data.Source'><dd><tt>The atom:source element.</tt></dl> |
| |
| <dl><dt><strong>summary</strong> = <class 'atom.data.Summary'><dd><tt>The atom:summary element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><a name="VolumeEntry-__init__"><strong>__init__</strong></a>(self, atom_id<font color="#909090">=None</font>, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><strong>author</strong> = [<class 'atom.data.Author'>]</dl> |
| |
| <dl><dt><strong>category</strong> = [<class 'atom.data.Category'>]</dl> |
| |
| <dl><dt><strong>contributor</strong> = [<class 'atom.data.Contributor'>]</dl> |
| |
| <dl><dt><strong>id</strong> = <class 'atom.data.Id'><dd><tt>The atom:id element.</tt></dl> |
| |
| <dl><dt><strong>link</strong> = [<class 'atom.data.Link'>]</dl> |
| |
| <dl><dt><strong>rights</strong> = <class 'atom.data.Rights'><dd><tt>The atom:rights element.</tt></dl> |
| |
| <dl><dt><strong>title</strong> = <class 'atom.data.Title'><dd><tt>The atom:title element.</tt></dl> |
| |
| <dl><dt><strong>updated</strong> = <class 'atom.data.Updated'><dd><tt>The atom:updated element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="VolumeEntry-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a>:<br> |
| <dl><dt><a name="VolumeEntry-FindAclLink"><strong>FindAclLink</strong></a> = find_acl_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindFeedLink"><strong>FindFeedLink</strong></a> = find_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindHtmlLink"><strong>FindHtmlLink</strong></a> = find_html_link(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindPostLink"><strong>FindPostLink</strong></a> = find_post_link(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindPreviousLink"><strong>FindPreviousLink</strong></a> = find_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetAclLink"><strong>GetAclLink</strong></a> = get_acl_link(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetFeedLink"><strong>GetFeedLink</strong></a> = get_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetHtmlLink"><strong>GetHtmlLink</strong></a> = get_html_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetPostLink"><strong>GetPostLink</strong></a> = get_post_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetPreviousLink"><strong>GetPreviousLink</strong></a> = get_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_acl_link"><strong>find_acl_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_feed_link"><strong>find_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_html_link"><strong>find_html_link</strong></a>(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_post_link"><strong>find_post_link</strong></a>(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_previous_link"><strong>find_previous_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_acl_link"><strong>get_acl_link</strong></a>(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_feed_link"><strong>get_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_html_link"><strong>get_html_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_post_link"><strong>get_post_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_previous_link"><strong>get_previous_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a>:<br> |
| <dl><dt><a name="VolumeEntry-FindAlternateLink"><strong>FindAlternateLink</strong></a> = find_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindEditLink"><strong>FindEditLink</strong></a> = find_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindEditMediaLink"><strong>FindEditMediaLink</strong></a> = find_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindLicenseLink"><strong>FindLicenseLink</strong></a> = find_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindNextLink"><strong>FindNextLink</strong></a> = find_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindSelfLink"><strong>FindSelfLink</strong></a> = find_self_link(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-FindUrl"><strong>FindUrl</strong></a> = find_url(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetAlternateLink"><strong>GetAlternateLink</strong></a> = get_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetEditLink"><strong>GetEditLink</strong></a> = get_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetEditMediaLink"><strong>GetEditMediaLink</strong></a> = get_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetLicenseLink"><strong>GetLicenseLink</strong></a> = get_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetLink"><strong>GetLink</strong></a> = get_link(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetNextLink"><strong>GetNextLink</strong></a> = get_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-GetSelfLink"><strong>GetSelfLink</strong></a> = get_self_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_alternate_link"><strong>find_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_edit_link"><strong>find_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_edit_media_link"><strong>find_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_license_link"><strong>find_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_next_link"><strong>find_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_self_link"><strong>find_self_link</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-find_url"><strong>find_url</strong></a>(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_alternate_link"><strong>get_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_edit_link"><strong>get_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_edit_media_link"><strong>get_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_license_link"><strong>get_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_link"><strong>get_link</strong></a>(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_next_link"><strong>get_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeEntry-get_self_link"><strong>get_self_link</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="VolumeFeed">class <strong>VolumeFeed</strong></a>(<a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Describes a Book Search volume feed.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.books.data.html#VolumeFeed">VolumeFeed</a></dd> |
| <dd><a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a></dd> |
| <dd><a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a></dd> |
| <dd><a href="atom.data.html#Feed">atom.data.Feed</a></dd> |
| <dd><a href="atom.data.html#Source">atom.data.Source</a></dd> |
| <dd><a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a></dd> |
| <dd><a href="atom.core.html#XmlElement">atom.core.XmlElement</a></dd> |
| <dd><a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a></dd> |
| <dd><a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>entry</strong> = [<class 'gdata.books.data.VolumeEntry'>]</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>:<br> |
| <dl><dt><a name="VolumeFeed-AddBatchEntry"><strong>AddBatchEntry</strong></a> = add_batch_entry(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a BatchEntry and adding to the feed.<br> |
| <br> |
| If the entry is not a BatchEntry, it is converted to a BatchEntry so<br> |
| that the batch specific members will be present.<br> |
| <br> |
| The id_url_string can be used in place of an entry if the batch operation<br> |
| applies to a URL. For example query and delete operations require just<br> |
| the URL of an entry, no body is sent in the HTTP request. If an<br> |
| id_url_string is sent instead of an entry, a BatchEntry is created and<br> |
| added to the feed.<br> |
| <br> |
| This method also assigns the desired batch id to the entry so that it<br> |
| can be referenced in the server's response. If the batch_id_string is<br> |
| None, this method will assign a batch_id to be the index at which this<br> |
| entry will be in the feed's entry list.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)<br> |
| The entry which will be sent to the server as part of the batch<br> |
| request. The item must have a valid atom id so that the server<br> |
| knows which entry this request references.<br> |
| id_url_string: str (optional) The URL of the entry to be acted on. You<br> |
| can find this URL in the text member of the atom id for an entry.<br> |
| If an entry is not sent, this id will be used to construct a new<br> |
| BatchEntry which will be added to the request feed.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.<br> |
| operation_string: str (optional) The desired batch operation which will<br> |
| set the batch_operation.type member of the entry. Options are<br> |
| 'insert', 'update', 'delete', and 'query'<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither an id_ url_string nor an<br> |
| entry are provided in the request.<br> |
| <br> |
| Returns:<br> |
| The added entry.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-AddDelete"><strong>AddDelete</strong></a> = add_delete(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the atom id of the item<br> |
| to be deleted, or the entry itself. The atom id of the entry must be<br> |
| present so that the server knows which entry should be deleted.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional) The URL of the entry to be deleted. You can<br> |
| find this URL in the text member of the atom id for an entry.<br> |
| entry: BatchEntry (optional) The entry to be deleted.<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither a url_string nor an entry<br> |
| are provided in the request.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-AddInsert"><strong>AddInsert</strong></a> = add_insert(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br> |
| <br> |
| If the entry doesn't yet have an operation or a batch id, these will<br> |
| be set to the insert operation and a batch_id specified as a parameter.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent in the batch feed as an<br> |
| insert request.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-AddQuery"><strong>AddQuery</strong></a> = add_query(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the query URL<br> |
| whose results will be added to the result feed. The query URL will<br> |
| be encapsulated in a BatchEntry, and you may pass in the BatchEntry<br> |
| with a query URL instead of sending a url_string.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional)<br> |
| entry: BatchEntry (optional)<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-AddUpdate"><strong>AddUpdate</strong></a> = add_update(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br> |
| <br> |
| Sets the operation type of the entry to insert if it is not already set<br> |
| and assigns the desired batch id to the entry so that it can be<br> |
| referenced in the server's response.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent to the server as an<br> |
| update (HTTP PUT) request. The item must have a valid atom id<br> |
| so that the server knows which entry to replace.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. See also comments for AddInsert.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindBatchLink"><strong>FindBatchLink</strong></a> = find_batch_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-add_batch_entry"><strong>add_batch_entry</strong></a>(self, entry<font color="#909090">=None</font>, id_url_string<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>, operation_string<font color="#909090">=None</font>)</dt><dd><tt>Logic for populating members of a BatchEntry and adding to the feed.<br> |
| <br> |
| If the entry is not a BatchEntry, it is converted to a BatchEntry so<br> |
| that the batch specific members will be present.<br> |
| <br> |
| The id_url_string can be used in place of an entry if the batch operation<br> |
| applies to a URL. For example query and delete operations require just<br> |
| the URL of an entry, no body is sent in the HTTP request. If an<br> |
| id_url_string is sent instead of an entry, a BatchEntry is created and<br> |
| added to the feed.<br> |
| <br> |
| This method also assigns the desired batch id to the entry so that it<br> |
| can be referenced in the server's response. If the batch_id_string is<br> |
| None, this method will assign a batch_id to be the index at which this<br> |
| entry will be in the feed's entry list.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry, atom.data.Entry, or another Entry flavor (optional)<br> |
| The entry which will be sent to the server as part of the batch<br> |
| request. The item must have a valid atom id so that the server<br> |
| knows which entry this request references.<br> |
| id_url_string: str (optional) The URL of the entry to be acted on. You<br> |
| can find this URL in the text member of the atom id for an entry.<br> |
| If an entry is not sent, this id will be used to construct a new<br> |
| BatchEntry which will be added to the request feed.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.<br> |
| operation_string: str (optional) The desired batch operation which will<br> |
| set the batch_operation.type member of the entry. Options are<br> |
| 'insert', 'update', 'delete', and 'query'<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither an id_ url_string nor an<br> |
| entry are provided in the request.<br> |
| <br> |
| Returns:<br> |
| The added entry.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-add_delete"><strong>add_delete</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a delete request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the atom id of the item<br> |
| to be deleted, or the entry itself. The atom id of the entry must be<br> |
| present so that the server knows which entry should be deleted.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional) The URL of the entry to be deleted. You can<br> |
| find this URL in the text member of the atom id for an entry.<br> |
| entry: BatchEntry (optional) The entry to be deleted.<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters: Raised if neither a url_string nor an entry<br> |
| are provided in the request.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-add_insert"><strong>add_insert</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an insert request to the operations in this batch request feed.<br> |
| <br> |
| If the entry doesn't yet have an operation or a batch id, these will<br> |
| be set to the insert operation and a batch_id specified as a parameter.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent in the batch feed as an<br> |
| insert request.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. Note that batch_ids should either always be specified or<br> |
| never, mixing could potentially result in duplicate batch ids.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-add_query"><strong>add_query</strong></a>(self, url_string<font color="#909090">=None</font>, entry<font color="#909090">=None</font>, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Adds a query request to the batch request feed.<br> |
| <br> |
| This method takes either the url_string which is the query URL<br> |
| whose results will be added to the result feed. The query URL will<br> |
| be encapsulated in a BatchEntry, and you may pass in the BatchEntry<br> |
| with a query URL instead of sending a url_string.<br> |
| <br> |
| Args:<br> |
| url_string: str (optional)<br> |
| entry: BatchEntry (optional)<br> |
| batch_id_string: str (optional)<br> |
| <br> |
| Raises:<br> |
| MissingRequiredParameters</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-add_update"><strong>add_update</strong></a>(self, entry, batch_id_string<font color="#909090">=None</font>)</dt><dd><tt>Add an update request to the list of batch operations in this feed.<br> |
| <br> |
| Sets the operation type of the entry to insert if it is not already set<br> |
| and assigns the desired batch id to the entry so that it can be<br> |
| referenced in the server's response.<br> |
| <br> |
| Args:<br> |
| entry: BatchEntry The entry which will be sent to the server as an<br> |
| update (HTTP PUT) request. The item must have a valid atom id<br> |
| so that the server knows which entry to replace.<br> |
| batch_id_string: str (optional) The batch ID to be used to reference<br> |
| this batch operation in the results feed. If this parameter is None,<br> |
| the current length of the feed's entry array will be used as a<br> |
| count. See also comments for AddInsert.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_batch_link"><strong>find_batch_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#BatchFeed">gdata.data.BatchFeed</a>:<br> |
| <dl><dt><strong>interrupted</strong> = <class 'gdata.data.BatchInterrupted'><dd><tt>The batch:interrupted element sent if batch request was interrupted.<br> |
| <br> |
| Only appears in a feed if some of the batch entries could not be processed.<br> |
| See: <a href="http://code.google.com/apis/gdata/batch.html#Handling_Errors">http://code.google.com/apis/gdata/batch.html#Handling_Errors</a></tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a>:<br> |
| <dl><dt><a name="VolumeFeed-GetId"><strong>GetId</strong></a> = get_id(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_generator"><strong>get_generator</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_id"><strong>get_id</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.data.html#GDFeed">gdata.data.GDFeed</a>:<br> |
| <dl><dt><strong>etag</strong> = '{http://schemas.google.com/g/2005}etag'</dl> |
| |
| <dl><dt><strong>items_per_page</strong> = <class 'gdata.data.ItemsPerPage'><dd><tt>The opensearch:itemsPerPage element in GData feed.</tt></dl> |
| |
| <dl><dt><strong>start_index</strong> = <class 'gdata.data.StartIndex'><dd><tt>The opensearch:startIndex element in GData feed.</tt></dl> |
| |
| <dl><dt><strong>total_results</strong> = <class 'gdata.data.TotalResults'><dd><tt>opensearch:TotalResults for a GData feed.</tt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#Source">atom.data.Source</a>:<br> |
| <dl><dt><strong>generator</strong> = <class 'atom.data.Generator'><dd><tt>The atom:generator element.</tt></dl> |
| |
| <dl><dt><strong>icon</strong> = <class 'atom.data.Icon'><dd><tt>The atom:icon element.</tt></dl> |
| |
| <dl><dt><strong>logo</strong> = <class 'atom.data.Logo'><dd><tt>The atom:logo element.</tt></dl> |
| |
| <dl><dt><strong>subtitle</strong> = <class 'atom.data.Subtitle'><dd><tt>The atom:subtitle element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><a name="VolumeFeed-__init__"><strong>__init__</strong></a>(self, atom_id<font color="#909090">=None</font>, text<font color="#909090">=None</font>, *args, **kwargs)</dt></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="atom.data.html#FeedEntryParent">atom.data.FeedEntryParent</a>:<br> |
| <dl><dt><strong>author</strong> = [<class 'atom.data.Author'>]</dl> |
| |
| <dl><dt><strong>category</strong> = [<class 'atom.data.Category'>]</dl> |
| |
| <dl><dt><strong>contributor</strong> = [<class 'atom.data.Contributor'>]</dl> |
| |
| <dl><dt><strong>id</strong> = <class 'atom.data.Id'><dd><tt>The atom:id element.</tt></dl> |
| |
| <dl><dt><strong>link</strong> = [<class 'atom.data.Link'>]</dl> |
| |
| <dl><dt><strong>rights</strong> = <class 'atom.data.Rights'><dd><tt>The atom:rights element.</tt></dl> |
| |
| <dl><dt><strong>title</strong> = <class 'atom.data.Title'><dd><tt>The atom:title element.</tt></dl> |
| |
| <dl><dt><strong>updated</strong> = <class 'atom.data.Updated'><dd><tt>The atom:updated element.</tt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><a name="VolumeFeed-FindChildren"><strong>FindChildren</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindExtensions"><strong>FindExtensions</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetAttributes"><strong>GetAttributes</strong></a> = get_attributes(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetElements"><strong>GetElements</strong></a> = get_elements(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-ToString"><strong>ToString</strong></a> = to_string(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-__str__"><strong>__str__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_attributes"><strong>get_attributes</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all attributes which match the tag and namespace.<br> |
| <br> |
| To find all attributes in this object, call get_attributes with the tag<br> |
| and namespace both set to None (the default). This method searches<br> |
| through the object's members and the attributes stored in<br> |
| _other_attributes which did not fit any of the XML parsing rules for this<br> |
| class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching attributes.<br> |
| <br> |
| Returns:<br> |
| A list of XmlAttribute objects for the matching attributes.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_elements"><strong>get_elements</strong></a>(self, tag<font color="#909090">=None</font>, namespace<font color="#909090">=None</font>, version<font color="#909090">=1</font>)</dt><dd><tt>Find all sub elements which match the tag and namespace.<br> |
| <br> |
| To find all elements in this object, call get_elements with the tag and<br> |
| namespace both set to None (the default). This method searches through<br> |
| the object's members and the elements stored in _other_elements which<br> |
| did not match any of the XML parsing rules for this class.<br> |
| <br> |
| Args:<br> |
| tag: str<br> |
| namespace: str<br> |
| version: int Specifies the version of the XML rules to be used when<br> |
| searching for matching elements.<br> |
| <br> |
| Returns:<br> |
| A list of the matching XmlElements.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-to_string"><strong>to_string</strong></a>(self, version<font color="#909090">=1</font>, encoding<font color="#909090">=None</font>, pretty_print<font color="#909090">=None</font>)</dt><dd><tt>Converts this object to XML.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</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> |
| <dl><dt><strong>attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>children</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_attributes</strong></dt> |
| </dl> |
| <dl><dt><strong>extension_elements</strong></dt> |
| </dl> |
| <dl><dt><strong>namespace</strong></dt> |
| </dl> |
| <dl><dt><strong>tag</strong></dt> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.core.html#XmlElement">atom.core.XmlElement</a>:<br> |
| <dl><dt><strong>text</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.data.html#LinkFinder">gdata.data.LinkFinder</a>:<br> |
| <dl><dt><a name="VolumeFeed-FindAclLink"><strong>FindAclLink</strong></a> = find_acl_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindFeedLink"><strong>FindFeedLink</strong></a> = find_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindHtmlLink"><strong>FindHtmlLink</strong></a> = find_html_link(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindPostLink"><strong>FindPostLink</strong></a> = find_post_link(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindPreviousLink"><strong>FindPreviousLink</strong></a> = find_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetAclLink"><strong>GetAclLink</strong></a> = get_acl_link(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetFeedLink"><strong>GetFeedLink</strong></a> = get_feed_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetHtmlLink"><strong>GetHtmlLink</strong></a> = get_html_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetPostLink"><strong>GetPostLink</strong></a> = get_post_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetPreviousLink"><strong>GetPreviousLink</strong></a> = get_previous_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_acl_link"><strong>find_acl_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_feed_link"><strong>find_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_html_link"><strong>find_html_link</strong></a>(self)</dt><dd><tt>Finds the first link with rel of alternate and type of text/html.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_post_link"><strong>find_post_link</strong></a>(self)</dt><dd><tt>Get the URL to which new entries should be POSTed.<br> |
| <br> |
| The POST target URL is used to insert new entries.<br> |
| <br> |
| Returns:<br> |
| A str for the URL in the link with a rel matching the POST type.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_previous_link"><strong>find_previous_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_acl_link"><strong>get_acl_link</strong></a>(self)</dt><dd><tt>Searches for a link or feed_link (if present) with the rel for ACL.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_feed_link"><strong>get_feed_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_html_link"><strong>get_html_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_post_link"><strong>get_post_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_previous_link"><strong>get_previous_link</strong></a>(self)</dt></dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.data.html#LinkFinder">atom.data.LinkFinder</a>:<br> |
| <dl><dt><a name="VolumeFeed-FindAlternateLink"><strong>FindAlternateLink</strong></a> = find_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindEditLink"><strong>FindEditLink</strong></a> = find_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindEditMediaLink"><strong>FindEditMediaLink</strong></a> = find_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindLicenseLink"><strong>FindLicenseLink</strong></a> = find_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindNextLink"><strong>FindNextLink</strong></a> = find_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindSelfLink"><strong>FindSelfLink</strong></a> = find_self_link(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-FindUrl"><strong>FindUrl</strong></a> = find_url(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetAlternateLink"><strong>GetAlternateLink</strong></a> = get_alternate_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetEditLink"><strong>GetEditLink</strong></a> = get_edit_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetEditMediaLink"><strong>GetEditMediaLink</strong></a> = get_edit_media_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetLicenseLink"><strong>GetLicenseLink</strong></a> = get_license_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetLink"><strong>GetLink</strong></a> = get_link(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetNextLink"><strong>GetNextLink</strong></a> = get_next_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-GetSelfLink"><strong>GetSelfLink</strong></a> = get_self_link(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_alternate_link"><strong>find_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_edit_link"><strong>find_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_edit_media_link"><strong>find_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_license_link"><strong>find_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_next_link"><strong>find_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_self_link"><strong>find_self_link</strong></a>(self)</dt><dd><tt>Find the first link with rel set to 'self'<br> |
| <br> |
| Returns:<br> |
| A str containing the link's href or None if none of the links had rel<br> |
| equal to 'self'</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-find_url"><strong>find_url</strong></a>(self, rel)</dt><dd><tt>Returns the URL (as a string) in a link with the desired rel value.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_alternate_link"><strong>get_alternate_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_edit_link"><strong>get_edit_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_edit_media_link"><strong>get_edit_media_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_license_link"><strong>get_license_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_link"><strong>get_link</strong></a>(self, rel)</dt><dd><tt>Returns a link object which has the desired rel value.<br> |
| <br> |
| If you are interested in the URL instead of the link object,<br> |
| consider using find_url instead.</tt></dd></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_next_link"><strong>get_next_link</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="VolumeFeed-get_self_link"><strong>get_self_link</strong></a>(self)</dt></dl> |
| |
| </td></tr></table></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>GBS_TEMPLATE</strong> = '{http://schemas.google.com/books/2008/}%s'<br> |
| <strong>__author__</strong> = 'j.s@google.com (Jeff Scudder)'</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%">j.s@google.com (Jeff Scudder)</td></tr></table> |
| </body></html> |
