Regenerate documentation
This commit is contained in:
Joe Gregorio
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.anyjson</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/anyjson.py">/home/jcgregorio/projects/google-api-python-client/apiclient/anyjson.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/anyjson.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/anyjson.py</a></font></td></tr></table>
|
||||
<p><tt>Utility module to import a JSON module<br>
|
||||
<br>
|
||||
Hides all the messy details of exactly where<br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.contrib.html"><font color="#ffffff">contrib</font></a>.buzz</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/buzz/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/buzz/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/buzz/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/buzz/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.contrib</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.contrib.html"><font color="#ffffff">contrib</font></a>.latitude</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/latitude/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/latitude/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/latitude/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/latitude/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.contrib.html"><font color="#ffffff">contrib</font></a>.moderator</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/moderator/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/contrib/moderator/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/moderator/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/contrib/moderator/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.discovery</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/discovery.py">/home/jcgregorio/projects/google-api-python-client/apiclient/discovery.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/discovery.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/discovery.py</a></font></td></tr></table>
|
||||
<p><tt>Client for discovery based APIs<br>
|
||||
<br>
|
||||
A client library for Google's discovery based APIs.</tt></p>
|
||||
@@ -21,12 +21,14 @@ A client library for Google's discovery based 
|
||||
<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="httplib2.html">httplib2</a><br>
|
||||
<a href="logging.html">logging</a><br>
|
||||
</td><td width="25%" valign=top><a href="os.html">os</a><br>
|
||||
<a href="apiclient.mimeparse.html">apiclient.mimeparse</a><br>
|
||||
</td><td width="25%" valign=top><a href="mimetypes.html">mimetypes</a><br>
|
||||
<a href="os.html">os</a><br>
|
||||
<a href="re.html">re</a><br>
|
||||
</td><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br>
|
||||
<a href="uritemplate.html">uritemplate</a><br>
|
||||
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
|
||||
<a href="urlparse.html">urlparse</a><br>
|
||||
<a href="urllib.html">urllib</a><br>
|
||||
</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a><br>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#eeaa77">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.errors</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/errors.py">/home/jcgregorio/projects/google-api-python-client/apiclient/errors.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/errors.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/errors.py</a></font></td></tr></table>
|
||||
<p><tt>Errors for the library.<br>
|
||||
<br>
|
||||
All exceptions defined by the library<br>
|
||||
@@ -37,6 +37,8 @@ should be defined in this file.</tt></p>
|
||||
<dl>
|
||||
<dt><font face="helvetica, arial"><a href="apiclient.errors.html#HttpError">HttpError</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#InvalidJsonError">InvalidJsonError</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#MediaUploadSizeError">MediaUploadSizeError</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#UnacceptableMimeTypeError">UnacceptableMimeTypeError</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#UnknownLinkType">UnknownLinkType</a>
|
||||
</font></dt></dl>
|
||||
</dd>
|
||||
@@ -217,6 +219,128 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="InvalidJsonError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>args</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>message</strong></dt>
|
||||
</dl>
|
||||
</td></tr></table> <p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="MediaUploadSizeError">class <strong>MediaUploadSizeError</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>Media is larger than the method can accept.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="apiclient.errors.html#MediaUploadSizeError">MediaUploadSizeError</a></dd>
|
||||
<dd><a href="apiclient.errors.html#Error">Error</a></dd>
|
||||
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="MediaUploadSizeError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MediaUploadSizeError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||||
<dl><dt><a name="MediaUploadSizeError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||||
<br>
|
||||
Use of negative indices is not supported.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MediaUploadSizeError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="MediaUploadSizeError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>args</strong></dt>
|
||||
</dl>
|
||||
<dl><dt><strong>message</strong></dt>
|
||||
</dl>
|
||||
</td></tr></table> <p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="UnacceptableMimeTypeError">class <strong>UnacceptableMimeTypeError</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>That is an unacceptable mimetype for this operation.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="apiclient.errors.html#UnacceptableMimeTypeError">UnacceptableMimeTypeError</a></dd>
|
||||
<dd><a href="apiclient.errors.html#Error">Error</a></dd>
|
||||
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#UnacceptableMimeTypeError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||||
<br>
|
||||
Use of negative indices is not supported.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#UnacceptableMimeTypeError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="UnacceptableMimeTypeError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.ext.html"><font color="#ffffff">ext</font></a>.authtools</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/ext/authtools.py">/home/jcgregorio/projects/google-api-python-client/apiclient/ext/authtools.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/authtools.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/authtools.py</a></font></td></tr></table>
|
||||
<p><tt>Command-line tools for authenticating via OAuth 1.0<br>
|
||||
<br>
|
||||
Do the OAuth 1.0 Three Legged Dance for<br>
|
||||
@@ -23,10 +23,11 @@ other example apps in the same directory.</tt></p>
|
||||
|
||||
<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="BaseHTTPServer.html">BaseHTTPServer</a><br>
|
||||
<a href="gflags.html">gflags</a><br>
|
||||
</td><td width="25%" valign=top><a href="logging.html">logging</a><br>
|
||||
</td><td width="25%" valign=top><a href="socket.html">socket</a><br>
|
||||
<a href="socket.html">socket</a><br>
|
||||
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
</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="#eeaa77">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.<a href="apiclient.ext.html"><font color="#ffffff">ext</font></a>.file</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/ext/file.py">/home/jcgregorio/projects/google-api-python-client/apiclient/ext/file.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/file.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/file.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for OAuth.<br>
|
||||
<br>
|
||||
Utilities for making it easier to work with OAuth 1.0 credentials.</tt></p>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.ext</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/ext/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/ext/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/ext/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>apiclient</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/__init__.py">/home/jcgregorio/projects/google-api-python-client/apiclient/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
@@ -19,11 +19,12 @@
|
||||
<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="apiclient.anyjson.html">anyjson</a><br>
|
||||
<a href="apiclient.contrib.html"><strong>contrib</strong> (package)</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.discovery.html">discovery</a><br>
|
||||
<a href="apiclient.errors.html">errors</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.ext.html"><strong>ext</strong> (package)</a><br>
|
||||
<a href="apiclient.discovery.html">discovery</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.errors.html">errors</a><br>
|
||||
<a href="apiclient.ext.html"><strong>ext</strong> (package)</a><br>
|
||||
<a href="apiclient.http.html">http</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.model.html">model</a><br>
|
||||
</td><td width="25%" valign=top><a href="apiclient.mimeparse.html">mimeparse</a><br>
|
||||
<a href="apiclient.model.html">model</a><br>
|
||||
<a href="apiclient.oauth.html">oauth</a><br>
|
||||
</td></tr></table></td></tr></table>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.http</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/http.py">/home/jcgregorio/projects/google-api-python-client/apiclient/http.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/http.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/http.py</a></font></td></tr></table>
|
||||
<p><tt>Classes to encapsulate a single HTTP request.<br>
|
||||
<br>
|
||||
The classes implement a command pattern, with every<br>
|
||||
|
||||
117
docs/apiclient.mimeparse.html
Normal file
117
docs/apiclient.mimeparse.html
Normal file
@@ -0,0 +1,117 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: module apiclient.mimeparse</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="apiclient.html"><font color="#ffffff">apiclient</font></a>.mimeparse</strong></big></big> (version 0.1.3)</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/jcgregorio/projects/apiclient/apiclient/mimeparse.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/mimeparse.py</a></font></td></tr></table>
|
||||
<p><tt>MIME-Type Parser<br>
|
||||
<br>
|
||||
This module provides basic functions for handling mime-types. It can handle<br>
|
||||
matching mime-types against a list of media-ranges. See section 14.1 of the<br>
|
||||
HTTP specification [<a href="http://www.rfc-editor.org/rfc/rfc2616.txt">RFC 2616</a>] for a complete explanation.<br>
|
||||
<br>
|
||||
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1</a><br>
|
||||
<br>
|
||||
Contents:<br>
|
||||
- <a href="#-parse_mime_type">parse_mime_type</a>(): Parses a mime-type into its component parts.<br>
|
||||
- <a href="#-parse_media_range">parse_media_range</a>(): Media-ranges are mime-types with wild-cards and a 'q'<br>
|
||||
quality parameter.<br>
|
||||
- <a href="#-quality">quality</a>(): Determines the quality ('q') of a mime-type when<br>
|
||||
compared against a list of media-ranges.<br>
|
||||
- <a href="#-quality_parsed">quality_parsed</a>(): Just like <a href="#-quality">quality</a>() except the second parameter must be<br>
|
||||
pre-parsed.<br>
|
||||
- <a href="#-best_match">best_match</a>(): Choose the mime-type with the highest quality ('q')<br>
|
||||
from a list of candidates.</tt></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#eeaa77">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><dl><dt><a name="-best_match"><strong>best_match</strong></a>(supported, header)</dt><dd><tt>Return mime-type with the highest quality ('q') from list of candidates.<br>
|
||||
<br>
|
||||
Takes a list of supported mime-types and finds the best match for all the<br>
|
||||
media-ranges listed in header. The value of header must be a string that<br>
|
||||
conforms to the format of the HTTP Accept: header. The value of 'supported'<br>
|
||||
is a list of mime-types. The list of supported mime-types should be sorted<br>
|
||||
in order of increasing desirability, in case of a situation where there is<br>
|
||||
a tie.<br>
|
||||
<br>
|
||||
>>> <a href="#-best_match">best_match</a>(['application/xbel+xml', 'text/xml'],<br>
|
||||
'text/*;q=0.5,*/*; q=0.1')<br>
|
||||
'text/xml'</tt></dd></dl>
|
||||
<dl><dt><a name="-fitness_and_quality_parsed"><strong>fitness_and_quality_parsed</strong></a>(mime_type, parsed_ranges)</dt><dd><tt>Find the best match for a mime-type amongst parsed media-ranges.<br>
|
||||
<br>
|
||||
Find the best match for a given mime-type against a list of media_ranges<br>
|
||||
that have already been parsed by <a href="#-parse_media_range">parse_media_range</a>(). Returns a tuple of<br>
|
||||
the fitness value and the value of the 'q' quality parameter of the best<br>
|
||||
match, or (-1, 0) if no match was found. Just as for <a href="#-quality_parsed">quality_parsed</a>(),<br>
|
||||
'parsed_ranges' must be a list of parsed media ranges.</tt></dd></dl>
|
||||
<dl><dt><a name="-parse_media_range"><strong>parse_media_range</strong></a>(range)</dt><dd><tt>Parse a media-range into its component parts.<br>
|
||||
<br>
|
||||
Carves up a media range and returns a tuple of the (type, subtype,<br>
|
||||
params) where 'params' is a dictionary of all the parameters for the media<br>
|
||||
range. For example, the media range 'application/*;q=0.5' would get parsed<br>
|
||||
into:<br>
|
||||
<br>
|
||||
('application', '*', {'q', '0.5'})<br>
|
||||
<br>
|
||||
In addition this function also guarantees that there is a value for 'q'<br>
|
||||
in the params dictionary, filling it in with a proper default if<br>
|
||||
necessary.</tt></dd></dl>
|
||||
<dl><dt><a name="-parse_mime_type"><strong>parse_mime_type</strong></a>(mime_type)</dt><dd><tt>Parses a mime-type into its component parts.<br>
|
||||
<br>
|
||||
Carves up a mime-type and returns a tuple of the (type, subtype, params)<br>
|
||||
where 'params' is a dictionary of all the parameters for the media range.<br>
|
||||
For example, the media range 'application/xhtml;q=0.5' would get parsed<br>
|
||||
into:<br>
|
||||
<br>
|
||||
('application', 'xhtml', {'q', '0.5'})</tt></dd></dl>
|
||||
<dl><dt><a name="-quality"><strong>quality</strong></a>(mime_type, ranges)</dt><dd><tt>Return the quality ('q') of a mime-type against a list of media-ranges.<br>
|
||||
<br>
|
||||
Returns the quality 'q' of a mime-type when compared against the<br>
|
||||
media-ranges in ranges. For example:<br>
|
||||
<br>
|
||||
>>> <a href="#-quality">quality</a>('text/html','text/*;q=0.3, text/html;q=0.7,<br>
|
||||
text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5')<br>
|
||||
0.7</tt></dd></dl>
|
||||
<dl><dt><a name="-quality_parsed"><strong>quality_parsed</strong></a>(mime_type, parsed_ranges)</dt><dd><tt>Find the best match for a mime-type amongst parsed media-ranges.<br>
|
||||
<br>
|
||||
Find the best match for a given mime-type against a list of media_ranges<br>
|
||||
that have already been parsed by <a href="#-parse_media_range">parse_media_range</a>(). Returns the 'q'<br>
|
||||
quality parameter of the best match, 0 if no match was found. This function<br>
|
||||
bahaves the same as <a href="#-quality">quality</a>() except that 'parsed_ranges' must be a list of<br>
|
||||
parsed media ranges.</tt></dd></dl>
|
||||
</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><strong>__author__</strong> = 'Joe Gregorio'<br>
|
||||
<strong>__credits__</strong> = ''<br>
|
||||
<strong>__email__</strong> = 'joe@bitworking.org'<br>
|
||||
<strong>__license__</strong> = 'MIT License'<br>
|
||||
<strong>__version__</strong> = '0.1.3'</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%">Joe Gregorio</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>Credits</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
||||
<td width="100%"></td></tr></table>
|
||||
</body></html>
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.model</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/model.py">/home/jcgregorio/projects/google-api-python-client/apiclient/model.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/model.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/model.py</a></font></td></tr></table>
|
||||
<p><tt><a href="#Model">Model</a> objects for requests and responses.<br>
|
||||
<br>
|
||||
Each API may support one or more serializations, such<br>
|
||||
@@ -354,6 +354,32 @@ Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<
|
||||
</dl>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#eeaa77">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><dl><dt><a name="-makepatch"><strong>makepatch</strong></a>(original, modified)</dt><dd><tt>Create a patch <a href="__builtin__.html#object">object</a>.<br>
|
||||
<br>
|
||||
Some methods support PATCH, an efficient way to send updates to a resource.<br>
|
||||
This method allows the easy construction of patch bodies by looking at the<br>
|
||||
differences between a resource before and after it was modified.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
original: <a href="__builtin__.html#object">object</a>, the original deserialized resource<br>
|
||||
modified: <a href="__builtin__.html#object">object</a>, the modified deserialized resource<br>
|
||||
Returns:<br>
|
||||
An <a href="__builtin__.html#object">object</a> that contains only the changes from original to modified, in a<br>
|
||||
form suitable to pass to a PATCH method.<br>
|
||||
<br>
|
||||
Example usage:<br>
|
||||
item = service.activities().get(postid=postid, userid=userid).execute()<br>
|
||||
original = copy.deepcopy(item)<br>
|
||||
item['<a href="__builtin__.html#object">object</a>']['content'] = 'This is updated.'<br>
|
||||
service.activities.patch(postid=postid, userid=userid,<br>
|
||||
body=<a href="#-makepatch">makepatch</a>(original, item)).execute()</tt></dd></dl>
|
||||
</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.oauth</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/apiclient/oauth.py">/home/jcgregorio/projects/google-api-python-client/apiclient/oauth.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for OAuth.<br>
|
||||
<br>
|
||||
Utilities for making it easier to work with OAuth.</tt></p>
|
||||
@@ -41,6 +41,7 @@ Utilities for making it easier to work with&n
|
||||
</font></dt><dd>
|
||||
<dl>
|
||||
<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a>
|
||||
</font></dt></dl>
|
||||
</dd>
|
||||
<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Flow">Flow</a>
|
||||
@@ -365,7 +366,9 @@ user_agent - The HTTP User-Agent to provide f
|
||||
|
||||
<dl><dt><a name="OAuthCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="OAuthCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Args:<br>
|
||||
<dl><dt><a name="OAuthCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these <a href="#Credentials">Credentials</a><br>
|
||||
<br>
|
||||
Args:<br>
|
||||
http - An instance of httplib2.Http<br>
|
||||
or something that acts like it.<br>
|
||||
<br>
|
||||
@@ -497,6 +500,95 @@ Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</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="TwoLeggedOAuthCredentials">class <strong>TwoLeggedOAuthCredentials</strong></a>(<a href="apiclient.oauth.html#Credentials">Credentials</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>Two Legged <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 1.0a.<br>
|
||||
<br>
|
||||
The Two Legged <a href="__builtin__.html#object">object</a> is created directly, not from a flow. Once you<br>
|
||||
authorize and httplib2.Http instance you can change the requestor and that<br>
|
||||
change will propogate to the authorized httplib2.Http instance. For example:<br>
|
||||
<br>
|
||||
http = httplib2.Http()<br>
|
||||
http = credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(http)<br>
|
||||
<br>
|
||||
credentials.requestor = 'foo@example.info'<br>
|
||||
http.request(...)<br>
|
||||
credentials.requestor = 'bar@example.info'<br>
|
||||
http.request(...)<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a></dd>
|
||||
<dd><a href="apiclient.oauth.html#Credentials">Credentials</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-__init__"><strong>__init__</strong></a>(self, consumer_key, consumer_secret, user_agent)</dt><dd><tt>Args:<br>
|
||||
consumer_key: string, An OAuth 1.0 consumer key<br>
|
||||
consumer_secret: string, An OAuth 1.0 consumer secret<br>
|
||||
user_agent: string, The HTTP User-Agent to provide for this application.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these <a href="#Credentials">Credentials</a><br>
|
||||
<br>
|
||||
Args:<br>
|
||||
http - An instance of httplib2.Http<br>
|
||||
or something that acts like it.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A modified instance of http that was passed in.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<br>
|
||||
h = httplib2.Http()<br>
|
||||
h = credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(h)<br>
|
||||
<br>
|
||||
You can't create a new OAuth<br>
|
||||
subclass of httplib2.Authenication because<br>
|
||||
it never gets passed the absolute URI, which is<br>
|
||||
needed for signing. So instead we have to overload<br>
|
||||
'request' with a closure that adds in the<br>
|
||||
Authorization header and then calls the original version<br>
|
||||
of 'request()'.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-getrequestor"><strong>getrequestor</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the storage for the credential.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
store: callable, a callable that when passed a Credential<br>
|
||||
will store the credential back to where it came from.<br>
|
||||
This is needed to store the latest access_token if it<br>
|
||||
has been revoked.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="TwoLeggedOAuthCredentials-setrequestor"><strong>setrequestor</strong></a>(self, email)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>invalid</strong></dt>
|
||||
<dd><tt>True if the credentials are invalid, such as being revoked.<br>
|
||||
<br>
|
||||
Always returns False for Two Legged Credentials.</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>requestor</strong></dt>
|
||||
<dd><tt>The email address of the user to act on behalf of</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="apiclient.oauth.html#Credentials">Credentials</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table></td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
|
||||
41
docs/dyn/books.v1.bookshelves.html
Normal file
41
docs/dyn/books.v1.bookshelves.html
Normal file
@@ -0,0 +1,41 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a specific bookshelf for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf to retrieve. (required)<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelves. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of public bookshelves for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelves. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
33
docs/dyn/books.v1.bookshelves.volumes.html
Normal file
33
docs/dyn/books.v1.bookshelves.volumes.html
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves volumes in a specific bookshelf for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf to retrieve volumes. (required)<br>
|
||||
userId: string, Id of user for whom to retrieve bookshelf volumes. (required)</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
32
docs/dyn/books.v1.html
Normal file
32
docs/dyn/books.v1.html
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-bookshelves"><strong><a href="books.v1.bookshelves.html">bookshelves</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-mylibrary"><strong><a href="books.v1.mylibrary.html">mylibrary</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
62
docs/dyn/books.v1.mylibrary.bookshelves.html
Normal file
62
docs/dyn/books.v1.mylibrary.bookshelves.html
Normal file
@@ -0,0 +1,62 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-addVolume"><strong>addVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a volume to a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf to which to add a volume. (required)<br>
|
||||
volumeId: string, Id of volume to add. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-clearVolumes"><strong>clearVolumes</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears all volumes from a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf from which to remove a volume. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a specific bookshelf belonging to the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
shelf: string, Id of bookshelf to retrieve. (required)<br>
|
||||
source: string, String to identify the originator of this request.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of bookshelves belonging to the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
source: string, String to identify the originator of this request.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-removeVolume"><strong>removeVolume</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes a volume from a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, Id of bookshelf from which to remove a volume. (required)<br>
|
||||
volumeId: string, Id of volume to remove. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.mylibrary.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
38
docs/dyn/books.v1.mylibrary.bookshelves.volumes.html
Normal file
38
docs/dyn/books.v1.mylibrary.bookshelves.volumes.html
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets volume information for volumes on a bookshelf.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, The bookshelf id or name retrieve volumes for.<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
startIndex: integer, Index of the first element to return (starts at 0)</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
28
docs/dyn/books.v1.mylibrary.html
Normal file
28
docs/dyn/books.v1.mylibrary.html
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-bookshelves"><strong><a href="books.v1.mylibrary.bookshelves.html">bookshelves</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
68
docs/dyn/books.v1.volumes.html
Normal file
68
docs/dyn/books.v1.volumes.html
Normal file
@@ -0,0 +1,68 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets volume information for a single volume.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
volumeId: string, Id of volume to retrieve. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs a book search.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
orderBy: string, Sort search results.<br>
|
||||
Allowed values<br>
|
||||
newest - Most recently published.<br>
|
||||
relevance - Relevance to search terms.<br>
|
||||
filter: string, Filter search results.<br>
|
||||
Allowed values<br>
|
||||
ebooks - All Google eBooks.<br>
|
||||
free-ebooks - Google eBook with full volume text viewability.<br>
|
||||
full - Public can view entire volume text.<br>
|
||||
paid-ebooks - Google eBook with a price.<br>
|
||||
partial - Public able to see parts of text.<br>
|
||||
projection: string, Restrict information returned to a set of selected fields.<br>
|
||||
Allowed values<br>
|
||||
full - Includes all volume data.<br>
|
||||
lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
langRestrict: string, Restrict results to books with this language code.<br>
|
||||
printType: string, Restrict to books or magazines.<br>
|
||||
Allowed values<br>
|
||||
all - All volume content types.<br>
|
||||
books - Just books.<br>
|
||||
magazines - Just magazines.<br>
|
||||
maxResults: integer, Maximum number of results to return.<br>
|
||||
q: string, Full-text search query string. (required)<br>
|
||||
startIndex: integer, Index of the first result to return (starts at 0)<br>
|
||||
download: string, Restrict to volumes by download availability.<br>
|
||||
Allowed values<br>
|
||||
epub - All volumes with epub.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -108,6 +108,25 @@ in the collection.<br>
|
||||
Returns None if there are no more items in<br>
|
||||
the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update an activity. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
userId: string, ID of the user whose post to update. (required)<br>
|
||||
abuseType: string, A parameter<br>
|
||||
hl: string, Language code to limit language results.<br>
|
||||
scope: string, The collection to which the activity belongs. (required)<br>
|
||||
Allowed values<br>
|
||||
@abuse - Activities reported by the user.<br>
|
||||
@liked - Activities liked by the user.<br>
|
||||
@muted - Activities muted by the user.<br>
|
||||
@self - Activities posted by the user.<br>
|
||||
alt: string, Specifies an alternative representation type.<br>
|
||||
Allowed values<br>
|
||||
atom - Use Atom XML format<br>
|
||||
json - Use JSON format<br>
|
||||
postId: string, ID of the activity to update. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for activities<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
@@ -66,6 +66,24 @@ Args:<br>
|
||||
json - Use JSON format<br>
|
||||
postId: string, ID of the activity for which to get comments. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a comment. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
userId: string, ID of the user being referenced. (required)<br>
|
||||
abuseType: string, A parameter<br>
|
||||
hl: string, Language code to limit language results.<br>
|
||||
commentId: string, ID of the comment being referenced. (required)<br>
|
||||
scope: string, The collection to which the activity belongs. (required)<br>
|
||||
Allowed values<br>
|
||||
@abuse - Comments reported by the user.<br>
|
||||
@self - Comments posted by the user.<br>
|
||||
alt: string, Specifies an alternative representation type.<br>
|
||||
Allowed values<br>
|
||||
atom - Use Atom XML format<br>
|
||||
json - Use JSON format<br>
|
||||
postId: string, ID of the activity for which to update the comment. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a comment<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
@@ -66,6 +66,18 @@ in the collection.<br>
|
||||
Returns None if there are no more items in<br>
|
||||
the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
userId: string, ID of the user being referenced. (required)<br>
|
||||
hl: string, Language code to limit language results.<br>
|
||||
alt: string, Specifies an alternative representation type.<br>
|
||||
Allowed values<br>
|
||||
atom - Use Atom XML format<br>
|
||||
json - Use JSON format<br>
|
||||
groupId: string, ID of the group to update. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
@@ -73,6 +73,19 @@ Args:<br>
|
||||
json - Use JSON format<br>
|
||||
groupId: string, ID of the group for which to list users. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Add a person to a group. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
personId: string, ID of the person to add to the group. (required)<br>
|
||||
userId: string, ID of the owner of the group. (required)<br>
|
||||
hl: string, Language code to limit language results.<br>
|
||||
alt: string, Specifies an alternative representation type.<br>
|
||||
Allowed values<br>
|
||||
atom - Use Atom XML format<br>
|
||||
json - Use JSON format<br>
|
||||
groupId: string, ID of the group to which to add the person. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-reshared"><strong>reshared</strong></a> = method(self, **kwargs)</dt><dd><tt>Get people who reshared an activity<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
@@ -18,6 +18,11 @@
|
||||
<br>
|
||||
Args:</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the profile information for the authenticated user. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the profile information for the authenticated user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
@@ -31,6 +31,12 @@ Args:<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
start_index: integer, Index of the first result to be retrieved.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified series. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
body: object, The request body. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-responses"><strong><a href="moderator.v1.series.responses.html">responses</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-submissions"><strong><a href="moderator.v1.series.submissions.html">submissions</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
@@ -35,6 +35,14 @@ Args:<br>
|
||||
max_results: integer, Maximum number of results to return.<br>
|
||||
start_index: integer, Index of the first result to be retrieved.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the votes by the authenticated user for the specified submission within the specified series. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
seriesId: integer, The decimal ID of the Series. (required)<br>
|
||||
body: object, The request body. (required)<br>
|
||||
userId: string, A parameter<br>
|
||||
submissionId: integer, The decimal ID of the Submission within the Series. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the votes by the authenticated user for the specified submission within the specified series.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
28
docs/dyn/pagespeedonline.v1.html
Normal file
28
docs/dyn/pagespeedonline.v1.html
Normal file
@@ -0,0 +1,28 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-pagespeedapi"><strong><a href="pagespeedonline.v1.pagespeedapi.html">pagespeedapi</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
37
docs/dyn/pagespeedonline.v1.pagespeedapi.html
Normal file
37
docs/dyn/pagespeedonline.v1.pagespeedapi.html
Normal file
@@ -0,0 +1,37 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-runpagespeed"><strong>runpagespeed</strong></a> = method(self, **kwargs)</dt><dd><tt>Runs Page Speed analysis on the page at the specified URL, and returns a Page Speed score, a list of suggestions to make that page faster, and other information.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
locale: string, The locale used to localize formatted results<br>
|
||||
rule: string, A Page Speed rule to run; if none are given, all rules are run (repeated)<br>
|
||||
strategy: string, The analysis strategy to use<br>
|
||||
Allowed values<br>
|
||||
desktop - Fetch and analyze the URL for desktop browsers<br>
|
||||
mobile - Fetch and analyze the URL for mobile devices<br>
|
||||
url: string, The URL to fetch and analyze (required)</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -21,7 +21,7 @@ Args:<br>
|
||||
taxonomy: string, Merchant taxonomy<br>
|
||||
recommendations_useGcsConfig: boolean, This parameter is currently ignored<br>
|
||||
productFields: string, Google Internal<br>
|
||||
accountId: string, Merchant center account id (required)<br>
|
||||
accountId: integer, Merchant center account id (required)<br>
|
||||
source: string, Query source (required)<br>
|
||||
recommendations_include: string, Recommendation specification<br>
|
||||
debug_enabled: boolean, Google Internal<br>
|
||||
@@ -45,11 +45,13 @@ Args:<br>
|
||||
debug_rdcRequest: boolean, Google Internal<br>
|
||||
taxonomy: string, Taxonomy name<br>
|
||||
promotions_enabled: boolean, Whether to return promotion information<br>
|
||||
shelfSpaceAds_enabled: boolean, Whether to return shelf space ads<br>
|
||||
debug_rdcResponse: boolean, Google Internal<br>
|
||||
productFields: string, Google Internal<br>
|
||||
channels: string, Channels specification<br>
|
||||
facets_discover: string, Facets to discover<br>
|
||||
startIndex: integer, Index (1-based) of first product to return<br>
|
||||
attributeFilter: string, Comma separated list of attributes to return<br>
|
||||
crowdBy: string, Crowding specification<br>
|
||||
spelling_enabled: boolean, Whether to return spelling suggestions<br>
|
||||
debug_enabled: boolean, Google Internal<br>
|
||||
@@ -66,7 +68,8 @@ Args:<br>
|
||||
debug_enableLogging: boolean, Google Internal<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
categories_enabled: boolean, Whether to return category information<br>
|
||||
attributeFilter: string, Comma separated list of attributes to return<br>
|
||||
shelfSpaceAds_useGcsConfig: boolean, This parameter is currently ignored<br>
|
||||
shelfSpaceAds_maxResults: integer, The maximum number of shelf space ads to return<br>
|
||||
categories_useGcsConfig: boolean, This parameter is currently ignored<br>
|
||||
promotions_useGcsConfig: boolean, Whether to return promotion information as configured in the GCS account<br>
|
||||
facets_include: string, Facets to include (applies when useGcsConfig == false)<br>
|
||||
|
||||
@@ -27,9 +27,9 @@ Args:<br>
|
||||
<dl><dt><a name="Resource-getToken"><strong>getToken</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a verification token for placing on a website or domain.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
verificationMethod: string, The method to use for verifying a site or domain. (required)<br>
|
||||
identifier: string, The URL or domain to verify. (required)<br>
|
||||
type: string, Type of resource to verify. Can be 'site' (URL) or 'inet_domain' (domain name). (required)</tt></dd></dl>
|
||||
verificationMethod: string, The method to use for verifying a site or domain.<br>
|
||||
identifier: string, The URL or domain to verify.<br>
|
||||
type: string, Type of resource to verify. Can be 'site' (URL) or 'inet_domain' (domain name).</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Attempt verification of a website or domain.<br>
|
||||
<br>
|
||||
@@ -41,6 +41,12 @@ Args:<br>
|
||||
<br>
|
||||
Args:</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify the list of owners for your website or domain. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
id: string, The id of a verified site or domain. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify the list of owners for your website or domain.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
|
||||
30
docs/dyn/tasks.v1.html
Normal file
30
docs/dyn/tasks.v1.html
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-tasklists"><strong><a href="tasks.v1.tasklists.html">tasklists</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-tasks"><strong><a href="tasks.v1.tasks.html">tasks</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
59
docs/dyn/tasks.v1.tasklists.html
Normal file
59
docs/dyn/tasks.v1.tasklists.html
Normal file
@@ -0,0 +1,59 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the authenticated user's specified task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
tasklist: string, Task list identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the authenticated user's specified task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
tasklist: string, Task list identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates a new task list and adds it to the authenticated user's task lists.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns all the authenticated user's task lists.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pageToken: string, Token specifying the result page to return. Optional.<br>
|
||||
maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the authenticated user's specified task list. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the authenticated user's specified task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
90
docs/dyn/tasks.v1.tasks.html
Normal file
90
docs/dyn/tasks.v1.tasks.html
Normal file
@@ -0,0 +1,90 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<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="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-clear"><strong>clear</strong></a> = method(self, **kwargs)</dt><dd><tt>Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the specified task from the task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
task: string, Task identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the specified task.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
task: string, Task identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates a new task on the specified task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
parent: string, Parent task identifier. If the task is created at the top level, this parameter is omitted. Optional.<br>
|
||||
previous: string, Previous sibling task identifier. If the task is created at the first position among its siblings, this parameter is omitted. Optional.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns all tasks in the specified task list.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
dueMax: string, Upper bound for a task's due date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by due date.<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
pageToken: string, Token specifying the result page to return. Optional.<br>
|
||||
updatedMin: string, Lower bound for a task's last modification time (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by last modification time.<br>
|
||||
maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.<br>
|
||||
completedMin: string, Lower bound for a task's completion date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by completion date.<br>
|
||||
showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.<br>
|
||||
completedMax: string, Upper bound for a task's completion date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by completion date.<br>
|
||||
showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.<br>
|
||||
showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.<br>
|
||||
dueMin: string, Lower bound for a task's due date (as a <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp) to filter by. Optional. The default is not to filter by due date.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-move"><strong>move</strong></a> = method(self, **kwargs)</dt><dd><tt>Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
parent: string, New parent task identifier. If the task is moved to the top level, this parameter is omitted. Optional.<br>
|
||||
task: string, Task identifier. (required)<br>
|
||||
previous: string, New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. Optional.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified task. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
task: string, Task identifier. (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified task.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
tasklist: string, Task list identifier. (required)<br>
|
||||
task: string, Task identifier. (required)</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -18,6 +18,7 @@
|
||||
<br>
|
||||
Args:<br>
|
||||
target: string, The target language into which the text should be translated (required)<br>
|
||||
cid: string, The customization id for translate (repeated)<br>
|
||||
format: string, The format of the text<br>
|
||||
Allowed values<br>
|
||||
html - Specifies the input is in HTML<br>
|
||||
|
||||
@@ -6,9 +6,9 @@
|
||||
<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>httplib2</strong></big></big> (version $Rev$)</font></td
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>httplib2</strong></big></big> (version 0.7.0)</font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/httplib2/__init__.py">/home/jcgregorio/projects/google-api-python-client/httplib2/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/httplib2/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/httplib2/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
@@ -142,7 +142,7 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
and more.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Http-__init__"><strong>__init__</strong></a>(self, cache<font color="#909090">=None</font>, timeout<font color="#909090">=None</font>, proxy_info<font color="#909090">=None</font>)</dt><dd><tt>The value of proxy_info is a <a href="#ProxyInfo">ProxyInfo</a> instance.<br>
|
||||
<dl><dt><a name="Http-__init__"><strong>__init__</strong></a>(self, cache<font color="#909090">=None</font>, timeout<font color="#909090">=None</font>, proxy_info<font color="#909090">=None</font>, ca_certs<font color="#909090">=None</font>, disable_ssl_certificate_validation<font color="#909090">=False</font>)</dt><dd><tt>The value of proxy_info is a <a href="#ProxyInfo">ProxyInfo</a> instance.<br>
|
||||
<br>
|
||||
If 'cache' is a string then it is used as a directory name for<br>
|
||||
a disk cache. Otherwise it must be an <a href="__builtin__.html#object">object</a> that supports the<br>
|
||||
@@ -151,7 +151,14 @@ same interface as FileCache.<br>
|
||||
All timeouts are in seconds. If None is passed for timeout<br>
|
||||
then Python's default timeout for sockets will be used. See<br>
|
||||
for example the docs of socket.setdefaulttimeout():<br>
|
||||
<a href="http://docs.python.org/library/socket.html#socket.setdefaulttimeout">http://docs.python.org/library/socket.html#socket.setdefaulttimeout</a></tt></dd></dl>
|
||||
<a href="http://docs.python.org/library/socket.html#socket.setdefaulttimeout">http://docs.python.org/library/socket.html#socket.setdefaulttimeout</a><br>
|
||||
<br>
|
||||
ca_certs is the path of a file containing root CA certificates for SSL<br>
|
||||
server certificate validation. By default, a CA cert file bundled with<br>
|
||||
httplib2 is used.<br>
|
||||
<br>
|
||||
If disable_ssl_certificate_validation is true, SSL cert validation will<br>
|
||||
not be performed.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Http-add_certificate"><strong>add_certificate</strong></a>(self, key, cert, domain)</dt><dd><tt>Add a key and cert that will be used<br>
|
||||
any time a request requires authentication.</tt></dd></dl>
|
||||
@@ -710,7 +717,7 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<strong>__contributors__</strong> = ['Thomas Broyer (t.broyer@ltgt.net)', 'James Antill', 'Xavier Verges Farrero', 'Jonathan Feinberg', 'Blair Zajac', 'Sam Ruby', 'Louis Nyffenegger']<br>
|
||||
<strong>__copyright__</strong> = 'Copyright 2006, Joe Gregorio'<br>
|
||||
<strong>__license__</strong> = 'MIT'<br>
|
||||
<strong>__version__</strong> = '$Rev$'<br>
|
||||
<strong>__version__</strong> = '0.7.0'<br>
|
||||
<strong>debuglevel</strong> = 0</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#7799ee">
|
||||
|
||||
@@ -8,14 +8,14 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="httplib2.html"><font color="#ffffff">httplib2</font></a>.socks</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py">/home/jcgregorio/projects/google-api-python-client/httplib2/socks.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/httplib2/socks.py">/usr/local/google/home/jcgregorio/projects/apiclient/httplib2/socks.py</a></font></td></tr></table>
|
||||
<p><tt>SocksiPy - Python SOCKS module.<br>
|
||||
Version 1.00<br>
|
||||
<br>
|
||||
Copyright 2006 Dan-Haim. All rights reserved.<br>
|
||||
<br>
|
||||
Redistribution and use in source and binary forms, with or without<br>
|
||||
modification, are permitted provided that the following conditions are met:<br>
|
||||
Redistribution and use in source and binary forms, with or without modification,<br>
|
||||
are permitted provided that the following conditions are met:<br>
|
||||
1. Redistributions of source code must retain the above copyright notice, this<br>
|
||||
list of conditions and the following disclaimer.<br>
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,<br>
|
||||
@@ -24,7 +24,7 @@ modification, are permitted provided that the foll
|
||||
3. Neither the name of Dan Haim nor the names of his contributors may be used<br>
|
||||
to endorse or promote products derived from this software without specific<br>
|
||||
prior written permission.<br>
|
||||
<br>
|
||||
<br>
|
||||
THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED<br>
|
||||
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF<br>
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO<br>
|
||||
@@ -33,7 +33,7 @@ INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGE
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA<br>
|
||||
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF<br>
|
||||
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT<br>
|
||||
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br>
|
||||
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMANGE.<br>
|
||||
<br>
|
||||
<br>
|
||||
This module provides a standard socket-like interface for Python<br>
|
||||
@@ -92,17 +92,15 @@ for tunneling connections through SOCKS proxies.</tt></
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="GeneralProxyError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="GeneralProxyError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="GeneralProxyError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#GeneralProxyError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -127,6 +125,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="GeneralProxyError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="GeneralProxyError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#GeneralProxyError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="GeneralProxyError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -151,17 +151,15 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="HTTPError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="HTTPError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="HTTPError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#HTTPError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -186,6 +184,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="HTTPError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="HTTPError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#HTTPError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="HTTPError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -209,17 +209,15 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="ProxyError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="ProxyError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="ProxyError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ProxyError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -244,6 +242,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="ProxyError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="ProxyError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ProxyError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="ProxyError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -268,17 +268,15 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="Socks4Error-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks4Error-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="Socks4Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks4Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -303,6 +301,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="Socks4Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks4Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks4Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Socks4Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -327,17 +327,15 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="Socks5AuthError-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks5AuthError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="Socks5AuthError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks5AuthError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -362,6 +360,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="Socks5AuthError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks5AuthError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5AuthError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Socks5AuthError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -386,17 +386,15 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="Socks5Error-__init__"><strong>__init__</strong></a>(self, value)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks5Error-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="httplib2.socks.html#ProxyError">ProxyError</a>:<br>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><a name="Socks5Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
||||
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Socks5Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>
|
||||
@@ -421,6 +419,8 @@ Use of negative indices is not supported.</tt></dd
|
||||
|
||||
<dl><dt><a name="Socks5Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Socks5Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Socks5Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Socks5Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||||
|
||||
<hr>
|
||||
@@ -439,7 +439,6 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt><a href="#socksocket">socksocket</a>([family[, type[, proto]]]) -> socket object<br>
|
||||
<br>
|
||||
Open a SOCKS enabled socket. The parameters are the same as<br>
|
||||
those of the standard socket init. In order for SOCKS to work,<br>
|
||||
you must specify family=AF_INET, type=SOCK_STREAM and proto=0.<br> </tt></td></tr>
|
||||
@@ -453,7 +452,7 @@ you must specify family=AF_INET, type=SOCK_STREAM and&n
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="socksocket-__init__"><strong>__init__</strong></a>(self, family<font color="#909090">=2</font>, type<font color="#909090">=1</font>, proto<font color="#909090">=0</font>, _sock<font color="#909090">=None</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="socksocket-connect"><strong>connect</strong></a>(self, destpair)</dt><dd><tt><a href="#socksocket-connect">connect</a>(self,despair)<br>
|
||||
<dl><dt><a name="socksocket-connect"><strong>connect</strong></a>(self, destpair)</dt><dd><tt><a href="#socksocket-connect">connect</a>(self, despair)<br>
|
||||
Connects to the specified destination through a proxy.<br>
|
||||
destpar - A tuple of the IP/DNS address and the port number.<br>
|
||||
(identical to socket's connect).<br>
|
||||
@@ -469,8 +468,6 @@ Returns the IP and port number of the pr
|
||||
<dl><dt><a name="socksocket-getproxysockname"><strong>getproxysockname</strong></a>(self)</dt><dd><tt><a href="#socksocket-getsockname">getsockname</a>() -> address info<br>
|
||||
Returns the bound IP address and port number at the proxy.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="socksocket-sendall"><strong>sendall</strong></a>(self, bytes)</dt></dl>
|
||||
|
||||
<dl><dt><a name="socksocket-setproxy"><strong>setproxy</strong></a>(self, proxytype<font color="#909090">=None</font>, addr<font color="#909090">=None</font>, port<font color="#909090">=None</font>, rdns<font color="#909090">=True</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>)</dt><dd><tt><a href="#socksocket-setproxy">setproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])<br>
|
||||
Sets the proxy to be used.<br>
|
||||
proxytype - The type of the proxy to be used. Three types<br>
|
||||
@@ -551,6 +548,13 @@ will allow before refusing new connections.</tt></dd></
|
||||
Return a regular file object corresponding to the socket. The mode<br>
|
||||
and bufsize arguments are as for the built-in open() function.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="socksocket-sendall"><strong>sendall</strong></a>(...)</dt><dd><tt><a href="#socksocket-sendall">sendall</a>(data[, flags])<br>
|
||||
<br>
|
||||
Send a data string to the socket. For the optional flags<br>
|
||||
argument, see the Unix manual. This calls <a href="#socksocket-send">send</a>() repeatedly<br>
|
||||
until all data is sent. If an error occurs, it's impossible<br>
|
||||
to tell how much data has been sent.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="socksocket-setblocking"><strong>setblocking</strong></a>(...)</dt><dd><tt><a href="#socksocket-setblocking">setblocking</a>(flag)<br>
|
||||
<br>
|
||||
Set the socket to blocking (flag is true) or non-blocking (false).<br>
|
||||
@@ -607,10 +611,14 @@ Data descriptors inherited from <a href="socket.html#_socketobject">socket._sock
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||||
|
||||
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||||
<td width="100%"><dl><dt><a name="-bytes"><strong>bytes</strong></a>(obj, enc<font color="#909090">=None</font>)</dt></dl>
|
||||
<dl><dt><a name="-setdefaultproxy"><strong>setdefaultproxy</strong></a>(proxytype<font color="#909090">=None</font>, addr<font color="#909090">=None</font>, port<font color="#909090">=None</font>, rdns<font color="#909090">=True</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>)</dt><dd><tt><a href="#-setdefaultproxy">setdefaultproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])<br>
|
||||
<td width="100%"><dl><dt><a name="-setdefaultproxy"><strong>setdefaultproxy</strong></a>(proxytype<font color="#909090">=None</font>, addr<font color="#909090">=None</font>, port<font color="#909090">=None</font>, rdns<font color="#909090">=True</font>, username<font color="#909090">=None</font>, password<font color="#909090">=None</font>)</dt><dd><tt><a href="#-setdefaultproxy">setdefaultproxy</a>(proxytype, addr[, port[, rdns[, username[, password]]]])<br>
|
||||
Sets a default proxy which all further <a href="#socksocket">socksocket</a> objects will use,<br>
|
||||
unless explicitly changed.</tt></dd></dl>
|
||||
<dl><dt><a name="-wrapmodule"><strong>wrapmodule</strong></a>(module)</dt><dd><tt><a href="#-wrapmodule">wrapmodule</a>(module)<br>
|
||||
Attempts to replace a module's socket library with a SOCKS socket. Must set<br>
|
||||
a default proxy using <a href="#-setdefaultproxy">setdefaultproxy</a>(...) first.<br>
|
||||
This will only work on modules that import socket directly into the namespace;<br>
|
||||
most of the Python Standard Library falls into this category.</tt></dd></dl>
|
||||
</td></tr></table><p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#55aa55">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.client</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/client.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/client.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/client.py">/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/client.py</a></font></td></tr></table>
|
||||
<p><tt>An OAuth 2.0 client<br>
|
||||
<br>
|
||||
Tools for interacting with OAuth 2.0 protected<br>
|
||||
@@ -45,6 +45,7 @@ resources.</tt></p>
|
||||
</font></dt><dd>
|
||||
<dl>
|
||||
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a>
|
||||
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a>
|
||||
</font></dt></dl>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -297,6 +298,88 @@ Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio
|
||||
<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="AssertionCredentials">class <strong>AssertionCredentials</strong></a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>Abstract <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> used for OAuth 2.0 assertion grants<br>
|
||||
<br>
|
||||
This credential does not require a flow to instantiate because it represents<br>
|
||||
a two legged flow, and therefore has all of the required information to<br>
|
||||
generate and refresh its own access tokens. It must be subclassed to<br>
|
||||
generate the appropriate assertion string.<br>
|
||||
<br>
|
||||
<a href="#AssertionCredentials">AssertionCredentials</a> objects may be safely pickled and unpickled.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%"><dl><dt>Method resolution order:</dt>
|
||||
<dd><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a></dd>
|
||||
<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>
|
||||
<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>
|
||||
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Methods defined here:<br>
|
||||
<dl><dt><a name="AssertionCredentials-__init__"><strong>__init__</strong></a>(self, assertion_type, user_agent, token_uri<font color="#909090">='https://accounts.google.com/o/oauth2/token'</font>, **kwargs)</dt><dd><tt>Constructor for AssertionFlowCredentials<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
assertion_type: string, assertion type that will be declared to the auth<br>
|
||||
server<br>
|
||||
user_agent: string, The HTTP User-Agent to provide for this application.<br>
|
||||
token_uri: string, URI for token endpoint. For convenience<br>
|
||||
defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
||||
<dl><dt><a name="AssertionCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="AssertionCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="AssertionCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
http: An instance of httplib2.Http<br>
|
||||
or something that acts like it.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A modified instance of http that was passed in.<br>
|
||||
<br>
|
||||
Example:<br>
|
||||
<br>
|
||||
h = httplib2.Http()<br>
|
||||
h = credentials.<a href="#AssertionCredentials-authorize">authorize</a>(h)<br>
|
||||
<br>
|
||||
You can't create a new OAuth<br>
|
||||
subclass of httplib2.Authenication because<br>
|
||||
it never gets passed the absolute URI, which is<br>
|
||||
needed for signing. So instead we have to overload<br>
|
||||
'request' with a closure that adds in the<br>
|
||||
Authorization header and then calls the original version<br>
|
||||
of 'request()'.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="AssertionCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the storage for the credential.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
store: callable, a callable that when passed a Credential<br>
|
||||
will store the credential back to where it came from.<br>
|
||||
This is needed to store the latest access_token if it<br>
|
||||
has expired and been refreshed.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
||||
<dl><dt><strong>invalid</strong></dt>
|
||||
<dd><tt>True if the credentials are invalid, such as being revoked.</tt></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table> <p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Credentials">class <strong>Credentials</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.file</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/file.py">/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/file.py</a></font></td></tr></table>
|
||||
<p><tt>Utilities for OAuth.<br>
|
||||
<br>
|
||||
Utilities for making it easier to work with OAuth 2.0<br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>oauth2client</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/__init__.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/__init__.py</a></font></td></tr></table>
|
||||
<p></p>
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.tools</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/tools.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/tools.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/tools.py">/usr/local/google/home/jcgregorio/projects/apiclient/oauth2client/tools.py</a></font></td></tr></table>
|
||||
<p><tt>Command-line tools for authenticating via OAuth 2.0<br>
|
||||
<br>
|
||||
Do the OAuth 2.0 Web Server dance for a command line application. Stores the<br>
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
<td valign=bottom> <br>
|
||||
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>uritemplate</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/uritemplate/__init__.py">/home/jcgregorio/projects/google-api-python-client/uritemplate/__init__.py</a></font></td></tr></table>
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/uritemplate/__init__.py">/usr/local/google/home/jcgregorio/projects/apiclient/uritemplate/__init__.py</a></font></td></tr></table>
|
||||
<p><tt># Early, and incomplete implementation of -04.<br>
|
||||
#</tt></p>
|
||||
<p>
|
||||
|
||||
Reference in New Issue
Block a user